afiglee / ols

OpenBench LogicSniffer repository

OpenBench LogicSniffer

This is the public Git repository for the OpenBench LogicSniffer (ols for short) written by J.W. Janssen. It is an alternative client for an open source logic analyzer called the Open Bench Logic Sniffer. Refer to this page for more information about the project.

FEATURES

The alternative Java client provides the following features:

• Cross platform: The client runs on Mac OS X (32/64-bit), Windows (32/64 bit), Linux (32/64 bit) and Solaris (32 bit)

• Simple installation: No longer fiddling with the serial libraries (RXTX) in order to get the client up and running. The client embeds the suitable serial libraries for several operating systems

• Pluggable: Adding new functionality on the fly is possible and as easy as copying files to a single directory

• Looks and feels good: The client has a good look and feel, aiming at being as usable as possible and adhering to the human interface guidelines of the platform it is running on.

DOCUMENTATION

All documentation is maintained in the wiki.

COMPILING THE SOURCES

In case you are interested in cloning this repository and compile it for yourself, you should do the following:

$ git clone http://github.com/jawi/ols.git

For compiling the sources, you need to have at least a valid JDK (1.6+) and Maven installed. For developing, I recommend Eclipse as development environment.

$ cd ols/ $ mvn clean install

After this, you should find the latest binary ZIP or tarball in ols.distribution/target.

DEVELOPING FOR OLS

Developing for ols can be done with any modern IDE, like Eclipse, Netbeans, or even Emacs. Keep in mind that IDE-specific stuff is not committed to the repository as this would clutter it unnecessarily.

Keep in mind that your IDE should provide support for Maven, otherwise it most probably will not compile out of the box. In addition, you probably want support for Git in your IDE as well. To create the needed project files for Eclipse, for example, you can use the following Maven command:

$ mvn eclipse:eclipse

There are similar commands for other IDEs. See the Maven site for more details on this.

Some notes for Eclipe: After having imported the projects into your workspace, you might need to enable Maven support by hand. Simply select all projects, right click on them and choose Enable Dependency Management from the Maven menu should be sufficient. For running the OLS client in Eclipse, you can make use of the launch configurations found in the eclipse/ subdirectory of the OLS repository. The code formatting rules and cleanup rules can be found there, too.

CONTRIBUTIONS

Drop me a line if you want to contribute code to the OLS repository. If needed I can give you write-access to the GitHub or apply your patch directly.

CONTACT

You can reach me at: j dot w dot janssen at lxtreme.nl

DONATIONS

You can support and encourage further development of this project through the following means:

LICENSE

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.