DevLogger Files

readme.txt – Release Notes for DevLogger – updated on Dec 7, 2010


STATUS
------

	release 1.0.1


FROM THE AUTHOR
---------------

The results of scientific research must be documented; as they say “it's all in the numbers.”

With my research I had a great need to log information from a variety of instruments; or from a computer perspective a variety of input devices. I looked at what software was out there for my needs in both proprietary and open source software. Proprietary software was usually too expensive, inflexible for new devices, and usually ran only on Windows. Open source software was lacking in that it either wasn't scalable or flexible enough to capture the data I wanted and when.

I was really looking for a software framework that was both scalable and loosely coupled with the various devices that I planned to work with now and in the future. I didn't find any software that met my requirements, and thus DevLogger was born.

It's my hope that by sharing DevLogger and associated documentation other capable programmers will greatly expand the list of devices supported and share their work with the rest community.

For those that aren't programmers but would like to have support for a particular device I am available on a consulting basis. Please contact me at devlogger.gnu@gmail.com if you would like to start a conversation on potential costs. I would need the hardware, which would be returned unless ongoing support is required, and a deposit to start any work.


PLATFORMS SUPPORTED
-------------------
	DevLogger is written in Java and based upon the Eclipse Rich Client Plugin (RCP) architecture and thus (theoretically) runs on the same platforms supported by Eclipse (http://eclipse.org/). 

These platforms include: 
        Linux (packages provided)
        Mac OS X 
        Solaris 
        Windows (packages provided)


REQUIRED SOFTWARE
-----------------
	DevLogger requires the installation of another piece of software called RXTX (2.1-7) which is used to query and support serial ports on each of the platforms listed above. RXTX is included in the DevLogger download. 


DEVICES SUPPORTED
-----------------
	Devices are supported through individual Eclipse plugins which are packaged into the DevLogger application. 

The current devices supported in this release are: 
1.Radio Shack Multimeter 22-812 
2.My Weigh HD Shipping Scales (150 & 300 lbs models) 
3.Demo Clock (a virtual demonstration device) 


USER DOCUMENTATION
------------------

	User documentation is saved in external file (DevLogger_User_Guide.pdf ) as well as incorporated into the context sensitive help system. DevLogger_User_Guide.pdf must be downloaded separately as it is NOT included in the download packages.


INSTALLATION
------------

	Installation must be done manually since there is no installation program. 
Note: The following directions assume that you've already installed Java Platform on your machine. If you don't already have Java installed on your computer DevLogger will automatically use the Java Runtime Edition supplied in the DevLogger directory under “jre”. In this case, the location of the “jre” is required for step 3 below and does not need to be moved or installed in another location. RXTX must still be installed in that location. 

Please follow these simple steps to get DevLogger installed and running: 

1.Download the appropriate DevLogger archive for your platform. 
2.Extract the archive into a new directory. 
3.Enter the directory rxtx-2.1-7-bins-r2 (or current), and open the file called INSTALL with a text editor. 
4.Follow the installation instruction for your platform but ignore the placement of the RXTXcomm.jar as this file has been packaged into the DevLogger application itself. 
5.Return to the new directory created in step 2, and enter the DevLogger directory. 
6.Double click on the DevLogger executable to start the program. Depending on your operating system you may wish to manually create a short cut to this program though your start menu or desktop. 


DEVLOPERS GUIDE NOW AVAILABLE
-----------------------------

	The Developers Guide is saved as an external file called DevLogger_Developers_Guide.pdf and must be downloaded separately as it is NOT included in the download packages. Additionally, JavaDocs are also available for the com.readseal.gnu.devsupport Eclipse project in a separate download called devsupport.javadocs.1.0.tar.gz or devsupport.javadocs.1.0.zip.


BUGS FIXED IN 1.0.1
-------------------

2010.12.2 – DevLogger was not properly calling com.readseal.gnu.devsupport.ConfigPluginPreferences.canFinish(String). The fix also affected the Clock virtual demonstration and thus the code was fixed for both canFinish and getErrorMessage.