Rxtx - User contributions [en]

Development

Ajmas — Fri, 25 Feb 2011 19:28:23 GMT

Ajmas:

This page is for content regarding programming rxtx and writing programs that use rxtx. Feel free to add your own content and links.

*[[Retrieving Source Code]] - How to get the source code from CVS
*[[Development/Source Code|Source Code]] - explanation of the source code and conventions in use.
*[http://users.frii.com/jarvi/rxtx/doc/index.html gnu.io JavaDoc]
*[http://java.sun.com/products/javacomm/reference/api/index.html javax.comm JavaDoc] - provided as a point of comparison.
*[[Installers]]
*[[WebStart]]
*[[Examples]]

Development/Source Code

Ajmas — Fri, 25 Feb 2011 19:25:18 GMT

Ajmas: Created page with 'The latest source code is available from the repository and instructions on how to build and install are documented on the 'Installation' page. Cu…'

The latest source code is available from the [[Retrieving_Source_Code|repository]] and instructions on how to build and install are documented on the '[[Installation]]' page.

Current minimum JVM targeted is Java 1.4, so this means no use of generics, amongst other things. The interface between Java and the native library is done using JNI.

Below is an explanation of certain folders in the source tree:

MACOSX_IDE/ - XCode projects for building on MacOS X
CNI/ -
ReWrite2010/ - source code [[Development/ReWrite2010‎|Rewrite]]
WinCE/ -
contrib/ -
debian/ -
src/ - current source code: Java & C

[[category:Development]]

Development/ReWrite2010

Ajmas — Fri, 25 Feb 2011 16:16:58 GMT

Ajmas:

== Introduction ==

The intended objectives and architecture are documented in the RxTX_Rewrite.pdf document in the ReWrite2010 of the in the source repository. To summarise:

Provide a reference implementation of the javax.comm package using open source code. The existing version 2.x source code will be completely re-written.

Design Objectives:
* Reference implementation – strictly adheres to the javax.comm API.
* Small footprint - Java and C code should strive to be as small as possible.
* Good performance – Java code should provide the shortest path possible to the native code. Native code should provide the shortest path possible to the underlying system.
* Fault tolerant - Java and C code should handle I/O errors gracefully, providing good error recovery.
* Proven – Java unit tests should achieve 100% code coverage.
* Compatible – the rewrite should be a drop-in replacement for the javax.comm library.

The rewrite was discussed in a [http://mailman.qbang.org/pipermail/rxtx/2010-September/8084235.html mailing-list thread].

== Milestones ==

To do...

== What is left to be done and known issues ==

* Java Unit Tests
* Native code for MacOS X and Unix systems

== Building the code ==

To do...

[[category:development]]

Development/ReWrite2010

Ajmas — Fri, 25 Feb 2011 16:16:04 GMT

Ajmas: initial

== Introduction ==

The intended objectives and architecture are documented in the RxTX_Rewrite.pdf document in the ReWrite2010 of the in the source repository. To summarise:

Provide a reference implementation of the javax.comm package using open source code. The existing version 2.x source code will be completely re-written.

Design Objectives:
* Reference implementation – strictly adheres to the javax.comm API.
* Small footprint - Java and C code should strive to be as small as possible.
* Good performance – Java code should provide the shortest path possible to the native code. Native code should provide the shortest path possible to the underlying system.
* Fault tolerant - Java and C code should handle I/O errors gracefully, providing good error recovery.
* Proven – Java unit tests should achieve 100% code coverage.
* Compatible – the rewrite should be a drop-in replacement for the javax.comm library.

The rewrite was discussed in a [http://mailman.qbang.org/pipermail/rxtx/2010-September/8084235.html mailing-list thread].

== Milestones ==

== What is left to be done and known issues ==

* Java Unit Tests
* Native code for MacOS X and Unix systems

== Building the code ==

[[category:development]]

Download

Ajmas — Sat, 19 Feb 2011 02:22:52 GMT

Ajmas: corrected file labelling

== Distributables ==
RXTX 2.1 Is the main development branch for RXTX. The namespace used is gnu.io.*. Unless you have any specific reasons, this is the recommended download. If you need to be comptable with javax.comm.* then download RXTX 2.0, but note that not much development effort is provided for this branch so you will be missing out on all the fixes that the main branch is getting.

It should also be noted that there was a change in the way things were distributed. 2.1 includes a binary package that contains the binaries for the various platforms and a source package. 2.0 on the other hand is a bit of a muddle. Things change, things improve.

Binary version <strike>rxtx 2.0-7pre1 (stable)</strike> is incomplete, at least for Windows. Use newer binary version such as rxtx 2.1-7r2 (stable), which does work on Windows.

{|
|- style="background-color: #ddddff"
! Release !! Binary !! Source
|-
| rxtx 2.1-7r2 (stable)
| [http://rxtx.qbang.org/pub/rxtx/rxtx-2.1-7-bins-r2.zip rxtx-2.1-7-bins-r2.zip]
| [http://rxtx.qbang.org/pub/rxtx/rxtx-2.1-7r2.zip rxtx-2.1-7r2.zip]
|-
| rxtx 2.0-7pre2 (stable)
| [http://rxtx.qbang.org/pub/rxtx/rxtx-2.0-7pre1-i686-pc-linux-gnu.tar.gz Linux/x86] [http://rxtx.qbang.org/pub/rxtx/rxtx-2.0-7pre1-i386-pc-mingw32.zip Win32 (incomplete)]
| [http://rxtx.qbang.org/pub/rxtx/rxtx-2.0-7pre1.tar.gz source]
|}

RXTX 2.2 will replace RXTX 2.1 once it is stable.

{|
|- style="background-color: #ddddff"
! Release !! Binary !! Source
|-
| rxtx 2.2pre2 (prerelease)
| [http://rxtx.qbang.org/pub/rxtx/rxtx-2.2pre2-bins.zip rxtx-2.2pre2-bins.zip]
| [http://rxtx.qbang.org/pub/rxtx/rxtx-2.2pre2.zip rxtx-2.2pre2.zip]
|}

TODO: The 2.2pre2 bins contain the 2.2pre1 jar file and the 2.2pre2 native lib which causes a mismatch warning

Other releases can be found in the [http://rxtx.qbang.org/pub/rxtx/ archive] and you can also check the change history in the [[change log]].

{|
|- style="background-color: #ddddff"
! UN-ZIP Procedure
|-
|cp/mv the download rxtx-[].zip to rxtx-[].jar.gz;
|gunzip rxtx-[].jar.gz;
|jar -xf rxtx-[].jar;
|}

== ToyBox Distributables ==

The ToyBox has about 35 platforms (and growing). If you have a toy (even an s390), we have the ToyBox. Find the OS, Libc, and CPU You are looking for. Please report any problems to the mail-list. Unix users can extract zip files with jar -xf foo.zip. It works fine and on all platforms we support. Distributables can be found in the [http://rxtx.qbang.org//ToyBox ToyBox directory].

== Source Repository ==

If you wish to get the latest code from CVS see [[Retrieving Source Code]].

== x64 Binaries ==

Should you wish to use RxTx on a x64 based computer, note that the downloads on this page will not work, for x64 compiled binaries go to: [http://www.cloudhopper.com/opensource/rxtx/ Cloudhopper RxTx page]. Binaries have been tested successfully on Windows Server 2008 R2, although they are slightly outdated (december 2008).

FAQ

Ajmas — Mon, 13 Apr 2009 17:07:06 GMT

Ajmas: /* Is there a way to access seria and parallel port with standard Java API ? */

== General ==

=== What is RXTX? ===

RXTX is a Java library, using a native implementation (via JNI), providing serial and parallel communication for the Java Development Toolkit (JDK). All deliverables are under the GNU LGPL license. It is based on the specification for Sun's [http://java.sun.com/products/javacomm/index.jsp Java Communications API], though while many of the class descriptions are the same the package used it not, since gnu.io is used instead. A certain amount of compatibility is intended with API, though this project should be considered as a fork and therefore compatible in spirit, but not in implementation.

=== Do you have a Mailing List? ===

Yes, see the [[mailing-list]] page for details.

=== Where can I find information about how to write apps using RXTX? ===

Take a look at the [[Examples]]

=== What does RXTX install where? ===

The RXTX installation procedures installs files directly underneath $JAVA_HOME, i.e. directly into the JDK distribution.

In case you are using the Sun JDK:

The 'gnu.io' Java .class files are all packed into:

$JAVA_HOME/jre/lib/ext/RXTXcomm.jar

The [http://en.wikipedia.org/wiki/Library_(computer_science)#Shared_library Shared Object] files necessary to access OS-level functionality can be found underneath:

$JAVA_HOME/jre/lib/<architecture>/

and they are:

librxtxI2C-2.1-7.so
librxtxI2C.la
librxtxI2C.so -> librxtxI2C-2.1-7.so

librxtxParallel-2.1-7.so
librxtxParallel.la
librxtxParallel.so -> librxtxParallel-2.1-7.so

librxtxRaw-2.1-7.so
librxtxRaw.la
librxtxRaw.so -> librxtxRaw-2.1-7.so

librxtxRS485-2.1-7.so
librxtxRS485.la
librxtxRS485.so -> librxtxRS485-2.1-7.so

librxtxSerial-2.1-7.so
librxtxSerial.la
librxtxSerial.so -> librxtxSerial-2.1-7.so

Also see the '[[installation]]' page for more information.

=== Is there a Change Log? ===

Yes, see the '[[Change Log]]' page.

=== What License does RXTX use? ===

RXTX is license under the LGPL with an exception for linking over controlled interfaces, a copy of which can be found in the '[[License]]' page. The exception allows people to use RXTX as a service plugin with Sun's CommAPI: 'A Controlled Interface.'

=== What Platforms does RXTX run on? ===

See the page entitled '[[Porting]]', for more information.

== Problems and Workarounds ==

=== On MacOS X I get a 'PortInUseException', even though it isn't? ===

Versions prior to 2.1-8 use lock files, which is not the MacOS X way of doing things, and therefore has issues. For this reason make sure that you have version 2.1-8 or higher, which makes use of [http://developer.apple.com/documentation/DeviceDrivers/Conceptual/IOKitFundamentals/ I/O Kit]. At this point in time 2.1-8 is only availble from CVS, in source form. See the section [[Retrieving Source Code]], on getting the latest code - be sure to get the code from the 'gnu.io' branch.

'TODO': Can anyone who knows how please make an easy download available like the 2.1-7 version?

=== RXTX does not find my device, what's wrong? ===

There may be a number of reasons, but most often it is because your operating system can't find it either. RXTX is built upon the functionality provided by your operating system, and therefore is dependent on its limitations. For this reason find out whether your system can find the port, if it can and you still can't work what is going on, then there may be some help on the [[Mailing-List]].

=== RXTX installation fails with JDK 1.6 ===

This applies to the source package of RXTX 2.1-7r2.

After having run ''./configure; make; make install'', the following message appears:

make all-am
make[1]: Entering directory `/<mumble mumble your directory>/rxtx-2.1-7r2'
make[1]: Nothing to be done for `all-am'.
make[1]: Leaving directory `/<mumble mumble your directory>/rxtx-2.1-7r2'
libtool: install: `x86_64-unknown-linux-gnu/librxtxRS485.la' is not a directory
Try `libtool --help --mode=install' for more information.
make: *** [install] Error 1

This is caused by a missing case in the 'configure' script generated from 'configure.in', which
causes the variable RXTX_PATH to not be set which causes the above confusion.
You can change the 'configure' script directly. Look for the case instruction that matches JDK version strings:

1.2*|1.3*|1.4*|1.5*

and extend it to

1.2*|1.3*|1.4*|1.5*|1.6*

Note that there are matches for Linux, BSD, Solaris and Win32.

Then run ''./configure; make; make install'' as usual.

=== RXTX and the Equinox SST-4P/LP multiport card ===

A note for those who want to install an Equinox board (in this case "SST-4P/LP") and try to
run it with RXTX under Linux (in this case, Red Hat ES 4)

Get the driver source from the [http://www.equinox.com/support/download-drivers/ www.equinox.com driver page] and
compile it as described therein.

The four serial ports of the Equinox SST-4P are available as the device files:

/dev/ttyQ1a1 ... /dev/ttyQ1a4

These device files are created by the 'ssmkn' (alias 'make device nodes') executable.

In order to make things work, you have to:

Modify the 'eqnx' startup script '/etc/rc.d/init.d/eqnx'
and make it set the permissions of the devices files in the
'start' section, immediately after the call to 'ssmkn':

# create device files
/usr/bin/ssmkn
# fix rights on device files
LIST=`ls /dev/ttyQ*`
for DEV in $LIST; do
chown root.uucp $DEV
chmod 660 $DEV
done

Modify 'src/RXTXCommDriver.java' in the RXTX distribution. Add
the 'ttyQ1a' radical to the list of port radicals that RXTX checks:

if(osName.equals("Linux"))
{
String[] Temp = {
"ttyS", // linux Serial Ports
"ttySA", // for the IPAQs
"ttyUSB", // for USB frobs
"ttyQ1a" // Equinox
};
CandidatePortPrefixes=Temp;
}

Then recompile and reinstall.

=== Is there a way to access serial and parallel port with standard Java API ? ===

Currently no. This includes all Java versions including JDK 1.6 and probably JDK 1.7 when it is released. The [http://java.sun.com/products/javacomm/ Java Communications] API is a Java extension providing the necessary support for serial and parallel communication. RxTx is the most complete and currently maintained implementation of this API.

JMRI

Ajmas — Thu, 08 Jan 2009 18:41:51 GMT

Ajmas:

[http://jmri.sourceforge.net JMRI] uses RXTX to connect to the serial ports on model railroad hardware.

JMRI was originally written to use the Sun javax.comm API, and still uses those classes. We moved to RXTX for platforms where the Sun implementation wasn't available, or wasn't reliable. Currently, we use RXTX for MacOS X, Linux, and certain flavors of Windows.

The source tree is available from SourceForge either via
[http://jmri.sourceforge.net/doc/Technical/getcode.html anonymous download] or their
[http://cvs.sourceforge.net/viewcvs.py/jmri/jmri/ CVS web browser].

[http://cvs.sourceforge.net/viewcvs.py/jmri/jmri/jmrix/nce/serialdriver/SerialDriverAdapter.java?view=markup Sample class using RXTX]

Using RXTX In Eclipse

Ajmas — Thu, 08 Jan 2009 18:40:50 GMT

Ajmas:

This is how I add and use RXTX in Eclipse for Win32 Projects, there are probably other ways but it works for me. [mailto:seaton@gateway.net.au]

# Copy RXTXcomm.jar file and dll files to the lib directory of your project
# Under Project | Properties | Java Build Path | Libraries
# click Add JARs... Button
# Select the RXTXComm.jar from lib directory
# Jar should now be in the Build Path
# expand the RXTXComm.jar entry in the list and select "Native Library Location"
# Select the project lib directory and apply

Be careful when using System.in.read() and rxtx in win32; It can trip across a known JRE [http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4809647 deadlock] bug

Deploying JAVA with RXTX

Ajmas — Thu, 08 Jan 2009 18:40:07 GMT

Ajmas:

Saving the RXTX jar-file and DLL in the JRE is not optimal if you indend to distribute your JAVA application and do not want to bundle it with a customized JRE.

== Windows ==
For Windows, the [http://sourceforge.net/projects/janel Janel] JAVA launcher can be used.
* create a directory for your application, and save the Janel executable and lap-file to it;
* create a subfolder named "classes" and save the jar-file of your application as well as the RXTXcomm.jar in it;
* create a subfolder named "lib" and save the rxtxSerial.dll to it;
* make the following entries in the lap-file:
** "-Djava.class.path=;${SELF_HOME}\classes\YourApp.jar;${SELF_HOME}\classes\RXTXcomm.jar;"
** "janel.main.class=YourAppMainClass"
** "janel.library.path.dir=${SELF_HOME}\lib"

== Simpler approach for Windows ==

Using a simpler approach (confirmed to work when using NetBeans or Borland JBuilder):
*Add RXTXcomm.jar as a library
*compile (build) your application
*add the rxtxSerial.dll to the root of the distribution folder (*projectname*/dist when using NetBeans)

== unjar ==
It should be possible to unjar the RXTXcomm.jar and then add the .classes into YourApp.jar. This should eliminate the secon .jar and the need to modify java.class.path. Please clarify the steps if you pursue this.

I was successful in doing this on my Mac. First, unzip the RXTX.jar file. I didn't try unjar, as unzip worked fine. Then, place the gnu folder in the same folder as your application jar file. Execute the following command from the command line:

jar uvf Your_Apps_Name_here.jar gnu

to update the jar with the contents of the classes in the gnu folder. Your app will now run by double clicking on it, provided the .dll or .jnilib library is in the same folder. I would love to include the OS specific libraries in the jar for a single, monolithic package, but after researching this on the web, it is apparently very difficult at best and probably impossible.

== Other Platforms ==
It would be great if someone with access to Linux boxes could provide us with similar recipes for their operating system.

The above unjar instructions and subsequent jars worked fine for my app on both Mac and Windows machines.

Examples

Ajmas — Thu, 08 Jan 2009 18:39:31 GMT

Ajmas:

Note that all the examples below require that you import the gnu.io package.

*[[Two way communcation with the serial port]]
*[[Event based two way Communication]]
*[[Parallel Communications]]
*[[Discovering comm ports]]
*[[Discovering available comm ports]]
*[[Writing "Hello World" to a USB to serial converter]]

Talk:Main Page

Ajmas — Thu, 08 Jan 2009 18:38:49 GMT

Ajmas: Replacing page with ''''Note:''' Please post ask your questions on the mailing-list, that's what it is there for. Questions will NOT be answered in the discussion pages of the wiki.'

'''Note:''' Please post ask your questions on the [[mailing-list]], that's what it is there for. Questions will NOT be answered in the discussion pages of the wiki.

Discovering comm ports

Ajmas — Thu, 08 Jan 2009 18:36:48 GMT

Ajmas:

This code snippet shows how to find out the available comms ports on your computer.:

<pre>
static void listPorts()
{
java.util.Enumeration portEnum = CommPortIdentifier.getPortIdentifiers();
while ( portEnum.hasMoreElements() )
{
CommPortIdentifier portIdentifier = (CommPortIdentifier) portEnum.nextElement();
System.out.println(portIdentifier.getName() + " - " + getPortTypeName(portIdentifier.getPortType()) );
}
}

static String getPortTypeName ( int portType )
{
switch ( portType )
{
case CommPortIdentifier.PORT_I2C:
return "I2C";
case CommPortIdentifier.PORT_PARALLEL:
return "Parallel";
case CommPortIdentifier.PORT_RAW:
return "Raw";
case CommPortIdentifier.PORT_RS485:
return "RS485";
case CommPortIdentifier.PORT_SERIAL:
return "Serial";
default:
return "unknown type";
}
}
</pre>

Installation on Toybox

Ajmas — Thu, 08 Jan 2009 18:35:54 GMT

Ajmas: Removing all content from page

Rxtx:Community Portal

Ajmas — Thu, 08 Jan 2009 18:35:06 GMT

Ajmas: Removing all content from page

FAQ

Ajmas — Thu, 08 Jan 2009 18:34:07 GMT

Ajmas:

== General ==

=== What RXTX? ===

RXTX is a Java library, using a native implementation (via JNI), providing serial and parallel communication for the Java Development Toolkit (JDK). All deliverables are under the GNU LGPL license. It is based on the specification for Sun's [http://java.sun.com/products/javacomm/index.jsp Java Communications API], though while many of the class descriptions are the same the package used it not, since gnu.io is used instead. A certain amount of compatibility is intended with API, though this project should be considered as a fork and therefore compatible in spirit, but not in implementation.

=== Do you have a Mailing List? ===

Yes, see the [[mailing-list]] page for details.

=== Where can I find information about how to write apps using RXTX? ===

Take a look at the [[Examples]]

=== What does RXTX install where? ===

The RXTX installation procedures installs files directly underneath $JAVA_HOME, i.e. directly into the JDK distribution.

In case you are using the Sun JDK:

The 'gnu.io' Java .class files are all packed into:

$JAVA_HOME/jre/lib/ext/RXTXcomm.jar

The [http://en.wikipedia.org/wiki/Library_(computer_science)#Shared_library Shared Object] files necessary to access OS-level functionality can be found underneath:

$JAVA_HOME/jre/lib/<architecture>/

and they are:

librxtxI2C-2.1-7.so
librxtxI2C.la
librxtxI2C.so -> librxtxI2C-2.1-7.so

librxtxParallel-2.1-7.so
librxtxParallel.la
librxtxParallel.so -> librxtxParallel-2.1-7.so

librxtxRaw-2.1-7.so
librxtxRaw.la
librxtxRaw.so -> librxtxRaw-2.1-7.so

librxtxRS485-2.1-7.so
librxtxRS485.la
librxtxRS485.so -> librxtxRS485-2.1-7.so

librxtxSerial-2.1-7.so
librxtxSerial.la
librxtxSerial.so -> librxtxSerial-2.1-7.so

Also see the '[[installation]]' page for more information.

=== Is there a Change Log? ===

Yes, see the '[[Change Log]]' page.

=== What License does RXTX use? ===

RXTX is license under the LGPL with an exception for linking over controlled interfaces, a copy of which can be found in the '[[License]]' page. The exception allows people to use RXTX as a service plugin with Sun's CommAPI: 'A Controlled Interface.'

=== What Platforms does RXTX run on? ===

See the page entitled '[[Porting]]', for more information.

== Problems and Workarounds ==

=== On MacOS X I get a 'PortInUseException', even though it isn't? ===

Versions prior to 2.1-8 use lock files, which is not the MacOS X way of doing things, and therefore has issues. For this reason make sure that you have version 2.1-8 or higher, which makes use of [http://developer.apple.com/documentation/DeviceDrivers/Conceptual/IOKitFundamentals/ I/O Kit]. At this point in time 2.1-8 is only availble from CVS, in source form. See the section [[Retrieving Source Code]], on getting the latest code - be sure to get the code from the 'gnu.io' branch.

'TODO': Can anyone who knows how please make an easy download available like the 2.1-7 version?

=== RXTX does not find my device, what's wrong? ===

There may be a number of reasons, but most often it is because your operating system can't find it either. RXTX is built upon the functionality provided by your operating system, and therefore is dependent on its limitations. For this reason find out whether your system can find the port, if it can and you still can't work what is going on, then there may be some help on the [[Mailing-List]].

=== RXTX installation fails with JDK 1.6 ===

This applies to the source package of RXTX 2.1-7r2.

After having run ''./configure; make; make install'', the following message appears:

make all-am
make[1]: Entering directory `/<mumble mumble your directory>/rxtx-2.1-7r2'
make[1]: Nothing to be done for `all-am'.
make[1]: Leaving directory `/<mumble mumble your directory>/rxtx-2.1-7r2'
libtool: install: `x86_64-unknown-linux-gnu/librxtxRS485.la' is not a directory
Try `libtool --help --mode=install' for more information.
make: *** [install] Error 1

This is caused by a missing case in the 'configure' script generated from 'configure.in', which
causes the variable RXTX_PATH to not be set which causes the above confusion.
You can change the 'configure' script directly. Look for the case instruction that matches JDK version strings:

1.2*|1.3*|1.4*|1.5*

and extend it to

1.2*|1.3*|1.4*|1.5*|1.6*

Note that there are matches for Linux, BSD, Solaris and Win32.

Then run ''./configure; make; make install'' as usual.

=== RXTX and the Equinox SST-4P/LP multiport card ===

A note for those who want to install an Equinox board (in this case "SST-4P/LP") and try to
run it with RXTX under Linux (in this case, Red Hat ES 4)

Get the driver source from the [http://www.equinox.com/support/download-drivers/ www.equinox.com driver page] and
compile it as described therein.

The four serial ports of the Equinox SST-4P are available as the device files:

/dev/ttyQ1a1 ... /dev/ttyQ1a4

These device files are created by the 'ssmkn' (alias 'make device nodes') executable.

In order to make things work, you have to:

Modify the 'eqnx' startup script '/etc/rc.d/init.d/eqnx'
and make it set the permissions of the devices files in the
'start' section, immediately after the call to 'ssmkn':

# create device files
/usr/bin/ssmkn
# fix rights on device files
LIST=`ls /dev/ttyQ*`
for DEV in $LIST; do
chown root.uucp $DEV
chmod 660 $DEV
done

Modify 'src/RXTXCommDriver.java' in the RXTX distribution. Add
the 'ttyQ1a' radical to the list of port radicals that RXTX checks:

if(osName.equals("Linux"))
{
String[] Temp = {
"ttyS", // linux Serial Ports
"ttySA", // for the IPAQs
"ttyUSB", // for USB frobs
"ttyQ1a" // Equinox
};
CandidatePortPrefixes=Temp;
}

Then recompile and reinstall.

=== Is there a way to access seria and parallel port with standard Java API ? ===

Answer wanted ...

Installation for Windows

Ajmas — Thu, 08 Jan 2009 18:33:37 GMT

Ajmas:

RXTX installation procedure if you want to run RXTX enabled programs ==

If you just want to run RXTX enabled programs, follow this procedure.

Identify your Java Runtime Environment's folder. For version <code>1.6.0</code>, this usually is
:<code>c:\Program Files\Java\jre1.6.0_01\</code>

* Copy <code>rxtxParallel.dll</code> to <code>c:\Program Files\Java\jre1.6.0_01\bin\</code>
* Copy <code>rxtxSerial.dll</code> to <code>c:\Program Files\Java\jre1.6.0_01\bin\</code>
* Copy <code>RXTXcomm.jar</code> to <code>c:\Program Files\Java\jre1.6.0_01\lib\ext\</code>

''NOTE: When installing on Windows XP Embedded, make sure you include crtdll.dll (in the C Runtime Component) as it is required by rxtxSerial.dll''

==RXTX installation procedure if you want to develop or compile RXTX enabled programs ==

If you want to develop and compile RXTX enabled programs, for example with the NetBeans IDE, follow this procedure.

Identify your Java Development Kit's folder. For version <code>1.6.0</code>, this usually is
:<code>c:\Program Files\Java\jdk1.6.0_01\</code>

* Copy <code>rxtxParallel.dll</code> to <code>c:\Program Files\Java\jdk1.6.0_01\jre\bin\</code>
* Copy <code>rxtxSerial.dll</code> to <code>c:\Program Files\Java\jdk1.6.0_01\jre\bin\</code>
* Copy <code>RXTXcomm.jar</code> to <code>c:\Program Files\Java\jdk1.6.0_01\jre\lib\ext\</code>

Note that there is an additional <code>\jre\</code> subfolder in this path!

Help talk:Contents

Ajmas — Thu, 08 Jan 2009 18:33:14 GMT

Ajmas: Removing all content from page

Discovering available comm ports

Ajmas — Thu, 08 Jan 2009 18:31:28 GMT

Ajmas:

This code snippet shows how to retrieve the available comms ports on your computer. A CommPort is available if it is not being used by another application. Note the difference between the two examples is that the version for JDK 5.0 up uses [http://java.sun.com/j2se/1.5.0/docs/guide/language/generics.html generics]:

JDK <= 1.4
<pre>
/**
* @return A HashSet containing the CommPortIdentifier for all serial ports that are not currently being used.
*/
public static HashSet getAvailableSerialPorts() {
HashSet h = new HashSet();
Enumeration thePorts = CommPortIdentifier.getPortIdentifiers();
while (thePorts.hasMoreElements()) {
CommPortIdentifier com = (CommPortIdentifier) thePorts.nextElement();
switch (com.getPortType()) {
case CommPortIdentifier.PORT_SERIAL:
try {
CommPort thePort = com.open("CommUtil", 50);
thePort.close();
h.add(com);
} catch (PortInUseException e) {
System.out.println("Port, " + com.getName() + ", is in use.");
} catch (Exception e) {
System.err.println("Failed to open port " + com.getName());
e.printStackTrace();
}
}
}
return h;
}
</pre>

JDK >= 5.0
<pre>
/**
* @return A HashSet containing the CommPortIdentifier for all serial ports that are not currently being used.
*/
public static HashSet<CommPortIdentifier> getAvailableSerialPorts() {
HashSet<CommPortIdentifier> h = new HashSet<CommPortIdentifier>();
Enumeration thePorts = CommPortIdentifier.getPortIdentifiers();
while (thePorts.hasMoreElements()) {
CommPortIdentifier com = (CommPortIdentifier) thePorts.nextElement();
switch (com.getPortType()) {
case CommPortIdentifier.PORT_SERIAL:
try {
CommPort thePort = com.open("CommUtil", 50);
thePort.close();
h.add(com);
} catch (PortInUseException e) {
System.out.println("Port, " + com.getName() + ", is in use.");
} catch (Exception e) {
System.err.println("Failed to open port " + com.getName());
e.printStackTrace();
}
}
}
return h;
}
</pre>

Event Based Two Way Communication

Ajmas — Sun, 17 Aug 2008 15:14:27 GMT

Ajmas:

Below is a simple program that shows how to open a connection to a serial device and then interact with it (receiving data and sending data). One thing to note is that the package gnu.io is used instead of javax.comm, though other than the change in package name the API follows the [http://java.sun.com/products/javacomm/ Java Communication API]. To find the names of the available ports, see the [[Discovering comm ports]] example.

This varies from the [[Two way communcation with the serial port|other]] 'Two Way Communication' example in that this uses an event to trigger the reading. One advantage of this approach is that you are not having to poll the device to see if data is available.

<pre>
import gnu.io.CommPort;
import gnu.io.CommPortIdentifier;
import gnu.io.SerialPort;
import gnu.io.SerialPortEvent;
import gnu.io.SerialPortEventListener;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

/**
* This version of the TwoWaySerialComm example makes use of the
* SerialPortEventListener to avoid polling.
*
*/
public class TwoWaySerialComm
{
public TwoWaySerialComm()
{
super();
}

void connect ( String portName ) throws Exception
{
CommPortIdentifier portIdentifier = CommPortIdentifier.getPortIdentifier(portName);
if ( portIdentifier.isCurrentlyOwned() )
{
System.out.println("Error: Port is currently in use");
}
else
{
CommPort commPort = portIdentifier.open(this.getClass().getName(),2000);

if ( commPort instanceof SerialPort )
{
SerialPort serialPort = (SerialPort) commPort;
serialPort.setSerialPortParams(57600,SerialPort.DATABITS_8,SerialPort.STOPBITS_1,SerialPort.PARITY_NONE);

InputStream in = serialPort.getInputStream();
OutputStream out = serialPort.getOutputStream();

(new Thread(new SerialWriter(out))).start();

serialPort.addEventListener(new SerialReader(in));

}
else
{
System.out.println("Error: Only serial ports are handled by this example.");
}
}
}

/**
* Handles the input coming from the serial port. A new line character
* is treated as the end of a block in this example.
*/
public static class SerialReader implements SerialPortEventListener
{
private InputStream in;
private byte[] buffer = new byte[1024];

public SerialReader ( InputStream in )
{
this.in = in;
}

public void serialEvent(SerialPortEvent arg0) {
int data;

try
{
int len = 0;
while ( ( data = in.read()) > -1 )
{
if ( data != '\n' ) {
break;
}
buffer[len++] = (byte) data;
}
System.out.print(new String(buffer,0,len));
}
catch ( IOException e )
{
e.printStackTrace();
System.exit(-1);
}
}

}

/** */
public static class SerialWriter implements Runnable
{
OutputStream out;

public SerialWriter ( OutputStream out )
{
this.out = out;
}

public void run ()
{
try
{
int c = 0;
while ( ( c = System.in.read()) > -1 )
{
this.out.write(c);
}
}
catch ( IOException e )
{
e.printStackTrace();
System.exit(-1);
}
}
}

public static void main ( String[] args )
{
try
{
(new TwoWaySerialComm()).connect("COM3");
}
catch ( Exception e )
{
// TODO Auto-generated catch block
e.printStackTrace();
}
}

}
</pre>

Event based two way Communication

Ajmas — Sun, 17 Aug 2008 15:13:33 GMT

Ajmas: Event based two way Communication moved to Event Based Two Way Communication

#REDIRECT [[Event Based Two Way Communication]]

Event Based Two Way Communication

Ajmas — Sun, 17 Aug 2008 15:13:33 GMT

Ajmas: Event based two way Communication moved to Event Based Two Way Communication

Below is a simple program that shows how to open a connection to a serial device and then interact with it (receiving data and sending data). One thing to note is that the package gnu.io is used instead of javax.comm, though other than the change in package name the API follows the [http://java.sun.com/products/javacomm/ Java Communication API]. To find the names of the available ports, see the [[Discovering comm ports]] example.

This varies from the other 'Two Way Communication' example in that this uses an event to trigger the reading. One advantage of this approach is that you are not having to poll the device to see if data is available.

<pre>
import gnu.io.CommPort;
import gnu.io.CommPortIdentifier;
import gnu.io.SerialPort;
import gnu.io.SerialPortEvent;
import gnu.io.SerialPortEventListener;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

/**
* This version of the TwoWaySerialComm example makes use of the
* SerialPortEventListener to avoid polling.
*
*/
public class TwoWaySerialComm
{
public TwoWaySerialComm()
{
super();
}

void connect ( String portName ) throws Exception
{
CommPortIdentifier portIdentifier = CommPortIdentifier.getPortIdentifier(portName);
if ( portIdentifier.isCurrentlyOwned() )
{
System.out.println("Error: Port is currently in use");
}
else
{
CommPort commPort = portIdentifier.open(this.getClass().getName(),2000);

if ( commPort instanceof SerialPort )
{
SerialPort serialPort = (SerialPort) commPort;
serialPort.setSerialPortParams(57600,SerialPort.DATABITS_8,SerialPort.STOPBITS_1,SerialPort.PARITY_NONE);

InputStream in = serialPort.getInputStream();
OutputStream out = serialPort.getOutputStream();

(new Thread(new SerialWriter(out))).start();

serialPort.addEventListener(new SerialReader(in));

}
else
{
System.out.println("Error: Only serial ports are handled by this example.");
}
}
}

/**
* Handles the input coming from the serial port. A new line character
* is treated as the end of a block in this example.
*/
public static class SerialReader implements SerialPortEventListener
{
private InputStream in;
private byte[] buffer = new byte[1024];

public SerialReader ( InputStream in )
{
this.in = in;
}

public void serialEvent(SerialPortEvent arg0) {
int data;

try
{
int len = 0;
while ( ( data = in.read()) > -1 )
{
if ( data != '\n' ) {
break;
}
buffer[len++] = (byte) data;
}
System.out.print(new String(buffer,0,len));
}
catch ( IOException e )
{
e.printStackTrace();
System.exit(-1);
}
}

}

/** */
public static class SerialWriter implements Runnable
{
OutputStream out;

public SerialWriter ( OutputStream out )
{
this.out = out;
}

public void run ()
{
try
{
int c = 0;
while ( ( c = System.in.read()) > -1 )
{
this.out.write(c);
}
}
catch ( IOException e )
{
e.printStackTrace();
System.exit(-1);
}
}
}

public static void main ( String[] args )
{
try
{
(new TwoWaySerialComm()).connect("COM3");
}
catch ( Exception e )
{
// TODO Auto-generated catch block
e.printStackTrace();
}
}

}
</pre>

Examples

Ajmas — Sun, 17 Aug 2008 15:13:13 GMT

Ajmas:

Examples

Ajmas — Sun, 17 Aug 2008 15:13:03 GMT

Ajmas:

Note that all the examples below require that you import the gnu.io package.

*[[Two way communcation with the serial port]]
*[[Event based two way communication]]
*[[Parallel Communications]]
*[[Discovering comm ports]]
*[[Discovering available comm ports]]
*[[Writing "Hello World" to a USB to serial converter]]

Event Based Two Way Communication

Ajmas — Sun, 17 Aug 2008 15:12:27 GMT

Ajmas: New page: Below is a simple program that shows how to open a connection to a serial device and then interact with it (receiving data and sending data). One thing to note is that the package gnu.io i...

Below is a simple program that shows how to open a connection to a serial device and then interact with it (receiving data and sending data). One thing to note is that the package gnu.io is used instead of javax.comm, though other than the change in package name the API follows the [http://java.sun.com/products/javacomm/ Java Communication API]. To find the names of the available ports, see the [[Discovering comm ports]] example.

This varies from the other 'Two Way Communication' example in that this uses an event to trigger the reading. One advantage of this approach is that you are not having to poll the device to see if data is available.

<pre>
import gnu.io.CommPort;
import gnu.io.CommPortIdentifier;
import gnu.io.SerialPort;
import gnu.io.SerialPortEvent;
import gnu.io.SerialPortEventListener;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

/**
* This version of the TwoWaySerialComm example makes use of the
* SerialPortEventListener to avoid polling.
*
*/
public class TwoWaySerialComm
{
public TwoWaySerialComm()
{
super();
}

void connect ( String portName ) throws Exception
{
CommPortIdentifier portIdentifier = CommPortIdentifier.getPortIdentifier(portName);
if ( portIdentifier.isCurrentlyOwned() )
{
System.out.println("Error: Port is currently in use");
}
else
{
CommPort commPort = portIdentifier.open(this.getClass().getName(),2000);

if ( commPort instanceof SerialPort )
{
SerialPort serialPort = (SerialPort) commPort;
serialPort.setSerialPortParams(57600,SerialPort.DATABITS_8,SerialPort.STOPBITS_1,SerialPort.PARITY_NONE);

InputStream in = serialPort.getInputStream();
OutputStream out = serialPort.getOutputStream();

(new Thread(new SerialWriter(out))).start();

serialPort.addEventListener(new SerialReader(in));

}
else
{
System.out.println("Error: Only serial ports are handled by this example.");
}
}
}

/**
* Handles the input coming from the serial port. A new line character
* is treated as the end of a block in this example.
*/
public static class SerialReader implements SerialPortEventListener
{
private InputStream in;
private byte[] buffer = new byte[1024];

public SerialReader ( InputStream in )
{
this.in = in;
}

public void serialEvent(SerialPortEvent arg0) {
int data;

try
{
int len = 0;
while ( ( data = in.read()) > -1 )
{
if ( data != '\n' ) {
break;
}
buffer[len++] = (byte) data;
}
System.out.print(new String(buffer,0,len));
}
catch ( IOException e )
{
e.printStackTrace();
System.exit(-1);
}
}

}

/** */
public static class SerialWriter implements Runnable
{
OutputStream out;

public SerialWriter ( OutputStream out )
{
this.out = out;
}

public void run ()
{
try
{
int c = 0;
while ( ( c = System.in.read()) > -1 )
{
this.out.write(c);
}
}
catch ( IOException e )
{
e.printStackTrace();
System.exit(-1);
}
}
}

public static void main ( String[] args )
{
try
{
(new TwoWaySerialComm()).connect("COM3");
}
catch ( Exception e )
{
// TODO Auto-generated catch block
e.printStackTrace();
}
}

}
</pre>

Examples

Ajmas — Sun, 17 Aug 2008 15:10:31 GMT

Ajmas:

Development

Ajmas — Sun, 17 Aug 2008 01:07:51 GMT

Ajmas:

This page is for content regarding programming rxtx and writing programs that use rxtx. Feel free to add your own content and links.

*[[Retrieving Source Code]] - How to get the source code from CVS
*[http://users.frii.com/jarvi/rxtx/doc/index.html gnu.io JavaDoc]
*[http://java.sun.com/products/javacomm/reference/api/index.html javax.comm JavaDoc] - provided as a point of comparison.
*[[Installers]]
*[[WebStart]]
*[[Examples]]

Discovering available comm ports

Ajmas — Thu, 24 Jul 2008 01:09:34 GMT

Ajmas: Changed protection level for "Discovering available comm ports": providing access to registered users - spammer issue has been reduced [edit=autoconfirmed:move=autoconfirmed]

This code snippet shows how to retrieve the available comms ports on your computer. A CommPort is available if it is not being used by another application. Note the difference between the two examples is that the version for JDK 5.0 up uses [http://java.sun.com/j2se/1.5.0/docs/guide/language/generics.html generics]:

JDK <= 1.4
<pre>
/**
* @return A HashSet containing the CommPortIdentifier for all serial ports that are not currently being used.
*/
public static HashSet getAvailableSerialPorts() {
HashSet h = new HashSet();
Enumeration thePorts = CommPortIdentifier.getPortIdentifiers();
while (thePorts.hasMoreElements()) {
CommPortIdentifier com = (CommPortIdentifier) thePorts.nextElement();
switch (com.getPortType()) {
case CommPortIdentifier.PORT_SERIAL:
try {
CommPort thePort = com.open("CommUtil", 50);
thePort.close();
h.add(com);
} catch (PortInUseException e) {
System.out.println("Port, " com.getName() ", is in use.");
} catch (Exception e) {
System.err.println("Failed to open port " com.getName());
e.printStackTrace();
}
}
}
return h;
}
</pre>

JDK >= 5.0
<pre>
/**
* @return A HashSet containing the CommPortIdentifier for all serial ports that are not currently being used.
*/
public static HashSet<CommPortIdentifier> getAvailableSerialPorts() {
HashSet<CommPortIdentifier> h = new HashSet<CommPortIdentifier>();
Enumeration thePorts = CommPortIdentifier.getPortIdentifiers();
while (thePorts.hasMoreElements()) {
CommPortIdentifier com = (CommPortIdentifier) thePorts.nextElement();
switch (com.getPortType()) {
case CommPortIdentifier.PORT_SERIAL:
try {
CommPort thePort = com.open("CommUtil", 50);
thePort.close();
h.add(com);
} catch (PortInUseException e) {
System.out.println("Port, " com.getName() ", is in use.");
} catch (Exception e) {
System.err.println("Failed to open port " com.getName());
e.printStackTrace();
}
}
}
return h;
}
</pre>

User:Ajmas

Ajmas — Mon, 14 Jul 2008 15:00:02 GMT

Ajmas:

=User Details=
Real Name: André-John Mas

=Scratch=

==Spaceball 5000==
===Introduction===

Because of my interest in 3D input devices I decided to purchase myself, a serial based, Spaceball 5000. I chose this model because it had a spherical grip and was in a suitable price range for the hobby developer, when bought off eBay. Having a serial based deviced was not an issue, since I already had a PL2303 based USB to RS232 adaptor and the an appropriate driver (http://sourceforge.net/projects/osx-pl2303/). The problem was that there were no drivers for my operating system (MacOS X), and the communication protocol was not document anywhere that I had access to. I had found some source for the Spaceball 3003 and the Spaceball 4000, but a forum I came across indicated that the communication protocol was not the same for the Spaceball 5000.

The first thing I tried was running the ‘screen’ tool from the command line to see what was being sent to the computer. Doing this revealed that data for the key presses were being sent back to the computer, but no information on the ball movement. Further research on the web confirmed that the ball would not sent back any data until it was initialised.

The solution to my problem was to somehow know what communication was being performed in a normal scenario. To do this I got out my old Windows PC, running MS Windows 2000, downloaded and installed the driver. After confirming that it was working I got myself a copy of ‘portmon’ from Microsoft. Running portmon after reconnecting the Spaceball allowed me to see what initial handshake was being performed and what data it was being sent back.

Follows are the details on what I found out, but it is far from complete.

===Details===

Serial port configuration: 9600 baud, parity: none, word length: 8

A packet starts with a packet type id, is terminated by byte of value 13 (carriage return). The length of the packet depends on the packet type.

Getting version:
* Send request: vQ
* Response: v SPACEBALL Version 8.20 3Dconnexion GmbH 05/11/02

Readying the ball
* Send requests: m3, q00, pAA, n?
* Response: none

Key input:
* Send request: none
* Response: k000

Ball input
* Send request: none
* Response: dH000H000H000H000H000H000

Development

Ajmas — Mon, 14 Jul 2008 14:46:50 GMT

Ajmas: Reverted edits by LidelSitac (Talk); changed back to last version by Ajmas

JMRI

Ajmas — Mon, 14 Jul 2008 14:46:38 GMT

Ajmas: Reverted edits by TroccOeltr (Talk); changed back to last version by Rxtxsysop

Examples

Ajmas — Mon, 14 Jul 2008 14:45:33 GMT

Ajmas: Reverted edits by AlpasEllid (Talk); changed back to last version by Ajmas

Note that all the examples below require that you import the gnu.io package.

*[[Two way communcation with the serial port]]
*[[Parallel Communications]]
*[[Discovering comm ports]]
*[[Discovering available comm ports]]
*[[Writing "Hello World" to a USB to serial converter]]

User:Ajmas

Ajmas — Tue, 01 Jul 2008 17:29:28 GMT

Ajmas: New page: ==Spaceball 5000== ===Introduction=== Because of my interest in 3D input devices I decided to purchase myself, a serial based, Spaceball 5000. I chose this model because it had a spherica...

==Spaceball 5000==
===Introduction===

Because of my interest in 3D input devices I decided to purchase myself, a serial based, Spaceball 5000. I chose this model because it had a spherical grip and was in a suitable price range for the hobby developer, when bought off eBay. Having a serial based deviced was not an issue, since I already had a PL2303 based USB to RS232 adaptor and the an appropriate driver (http://sourceforge.net/projects/osx-pl2303/). The problem was that there were no drivers for my operating system (MacOS X), and the communication protocol was not document anywhere that I had access to. I had found some source for the Spaceball 3003 and the Spaceball 4000, but a forum I came across indicated that the communication protocol was not the same for the Spaceball 5000.

The first thing I tried was running the ‘screen’ tool from the command line to see what was being sent to the computer. Doing this revealed that data for the key presses were being sent back to the computer, but no information on the ball movement. Further research on the web confirmed that the ball would not sent back any data until it was initialised.

The solution to my problem was to somehow know what communication was being performed in a normal scenario. To do this I got out my old Windows PC, running MS Windows 2000, downloaded and installed the driver. After confirming that it was working I got myself a copy of ‘portmon’ from Microsoft. Running portmon after reconnecting the Spaceball allowed me to see what initial handshake was being performed and what data it was being sent back.

Follows are the details on what I found out, but it is far from complete.

===Details===

Serial port configuration: 9600 baud, parity: none, word length: 8

A packet starts with a packet type id, is terminated by byte of value 13 (carriage return). The length of the packet depends on the packet type.

Getting version:
* Send request: vQ
* Response: v SPACEBALL Version 8.20 3Dconnexion GmbH 05/11/02

Readying the ball
* Send requests: m3, q00, pAA, n?
* Response: none

Key input:
* Send request: none
* Response: k000

Ball input
* Send request: none
* Response: dH000H000H000H000H000H000

Main Page

Ajmas — Sun, 20 Apr 2008 22:07:23 GMT

Ajmas:

Welcome to the RXTX wiki!

This Wiki is intended to be by and for RXTX users and developers. There is already a lot of information provided, but feel free to add your own content. Note that you will need to create an account before editing pages, as part of an effort to battle spambots.

*[http://www.rxtx.org RXTX home page]
*[[FAQ]]
*[[Installation]]
*[[Using RXTX]]
*[[Development]]
*[http://bugzilla.qbang.org Reporting Bugs]
*[[Projects | Projects using RXTX]]

If after checking through the Wiki you don't find an answer to your question, then you can ask your question on the [[mailing-list]]. Posting questions in the talk pages is not the right place to ask your questions.

There is also the [http://users.frii.com/jarvi/rxtx/ original RXTX website], which is still around, though most of the information has been migrated to the Wiki.

{| style="background-color: #ffffdd"
|Send mail to [mailto:tjarvi@qbang.org Trent] if you spot spambot activity.
|}

Talk:Main Page

Ajmas — Sun, 20 Apr 2008 22:05:39 GMT

Ajmas: /* Lock Files and serialPort.close() */

In linux I am unsatisfied link error. I donot know what is problem. Can anyone help me

== LINUX + WINDOWS ==

Hello, I'm new on this subject.
I'm not sure if I've understood everything.

Is it now posible to write an application using RXTX, and then run it on Linux
AND Windows?

Thanks

Japetos

== Linux + WINDOWS ==

RXTX is tested on Linux, Solaris and Windows. The package is also tested by the Mac OSX community.

Other systems should work but are not tested as much.

So the answer to your question is yes.

== Maximum baud rate ==

I need to talk 4Mbit/s between a Java application and a CDC virtual serial port (COM4). The Windows driver supports the 4Mbit/s speed.

Can I open a serial port with RXTX with higher speed than 115kbps?

== Mailing List ==

I highly recommend you join the mailing-list, since you will get more answers there.

== Lock Files and serialPort.close() ==

Hi,

I am running into the lock file permission problems, even though I've added my user to the uucp group. using Debian Sarge.

when I run my app as root, it clears out any stake lock files, but when it tries to close the serialPort with serialPort.close() it just stalls.

the next time a scheduled read happens, I see this error:

RXTX fhs_lock() Error: creating lock file: /var/lock/LCK..ttyS0: File exists

which makes sense. but why can't I close the serial port when running even as root?

thanks - trying to port from javax.comm, which does work for this stuff (but maybe not for other issues..)

thanks, John

'''Answer:''' Please post ask your questions on the [[mailing-list]], that's what it is there for.

Talk:Main Page

Ajmas — Sun, 20 Apr 2008 22:05:19 GMT

Ajmas: /* Lock Files and serialPort.close() */

In linux I am unsatisfied link error. I donot know what is problem. Can anyone help me

== LINUX + WINDOWS ==

Hello, I'm new on this subject.
I'm not sure if I've understood everything.

Is it now posible to write an application using RXTX, and then run it on Linux
AND Windows?

Thanks

Japetos

== Linux + WINDOWS ==

RXTX is tested on Linux, Solaris and Windows. The package is also tested by the Mac OSX community.

Other systems should work but are not tested as much.

So the answer to your question is yes.

== Maximum baud rate ==

I need to talk 4Mbit/s between a Java application and a CDC virtual serial port (COM4). The Windows driver supports the 4Mbit/s speed.

Can I open a serial port with RXTX with higher speed than 115kbps?

== Mailing List ==

I highly recommend you join the mailing-list, since you will get more answers there.

== Lock Files and serialPort.close() ==

Hi,

I am running into the lock file permission problems, even though I've added my user to the uucp group. using Debian Sarge.

when I run my app as root, it clears out any stake lock files, but when it tries to close the serialPort with serialPort.close() it just stalls.

the next time a scheduled read happens, I see this error:

RXTX fhs_lock() Error: creating lock file: /var/lock/LCK..ttyS0: File exists

which makes sense. but why can't I close the serial port when running even as root?

thanks - trying to port from javax.comm, which does work for this stuff (but maybe not for other issues..)

thanks, John

Please post ask your questions on the [[mailing-list]], that's what it is there for.

Mailing list

Ajmas — Sun, 20 Apr 2008 22:03:38 GMT

Ajmas: New page: see Mailing-List.

see [[Mailing-List]].

Talk:Using RXTX

Ajmas — Sun, 20 Apr 2008 22:03:05 GMT

Ajmas: /* error with finding files */

== error with finding files ==

Hi,

I followed the linux installation of the rxtx libraries, and placed the librxtxSerial.so and the RXTXcomm.jar in the right directories.

I have set the CLASSPATH, the JAVA_HOME and the LD_LIBRARY_PATH directories ok.

but when I run the following application, I seem to not find the right library. is there any reason for this?

thanks, John

/usr/lib/jvm/java-1.5.0-sun-1.5.0.10/jre/bin/java -Djava.library.path=lib SerialAITest /dev/ttyS0 1 11 1

Exception in thread "main" java.lang.NoClassDefFoundError: javax/comm/SerialPortEventListener
at java.lang.ClassLoader.defineClass1(Native Method)
at java.lang.ClassLoader.defineClass(ClassLoader.java:620)
at java.security.SecureClassLoader.defineClass(SecureClassLoader.java:124)
at java.net.URLClassLoader.defineClass(URLClassLoader.java:260)
at java.net.URLClassLoader.access$100(URLClassLoader.java:56)
at java.net.URLClassLoader$1.run(URLClassLoader.java:195)
at java.security.AccessController.doPrivileged(Native Method)
at java.net.URLClassLoader.findClass(URLClassLoader.java:188)
at java.lang.ClassLoader.loadClass(ClassLoader.java:306)
at java.lang.ClassLoader.loadClass(ClassLoader.java:299)
at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:268)
at java.lang.ClassLoader.loadClass(ClassLoader.java:251)
at java.lang.ClassLoader.loadClassInternal(ClassLoader.java:319)

Please post questions to the [[mailing list]].

Talk:Main Page

Ajmas — Thu, 03 Apr 2008 17:06:30 GMT

Ajmas:

Installation on MS-Windows

Ajmas — Fri, 21 Mar 2008 14:14:19 GMT

Ajmas: /* cross-compiling from Linux */

The instuctions below are a little dated, and have been copied over from the old docs. Please can someone update them:

== Installing From Source==

Get the Sun CommAPI if you want a plug-in solution. The code is provided for people that may have demanding needs and coding ability.

There is only serial port code at this time.

Three ways of compiling win32 libraries are offered:

mingw32 tools in DOS
lcc tools in DOS
cross-compiling from Linux

=== mingw32 tools in DOS ===

Install mingw32 http://www.mingw.org
Install a jdk http://java.sun.com/j2se
Make sure the ming32\bin and jdk\bin directories are in your path. In the rxtx top directory to the following:
mkdir build
copy Makefile.mingw32 build\Makefile
cd build
edit the Makefile and make sure the directories are correct.
execute the following:
make
make install

=== lcc tools in DOS ===

Install a jdk http://java.sun.com/j2se
Install lcc http://www.cs.virginia.edu/~lcc-win32/

A make file (Makefile.lcc) for compiling rxtx with lcc contributed by Valentin Pavlov

You will need a config.h file in the src directory. Other builds usually generate them automatically. The following should work.

#define HAVE_FCNTL_H
#define HAVE_SIGNAL_H
#undef HAVE_SYS_FCNTL_H
#undef HAVE_SYS_FILE_H
#undef HAVE_SYS_SIGNAL_H
#undef HAVE_TERMIOS_H
#undef HAVE_SYS_TIME_H

if you know how to create the above in a dos Makefile send in the changes.

the following commands should then work fine on the command line.

cd src
make -f ..\Makefile.lcc

=== cross-compiling from Linux ===

Grab ming32:

Wayne Roberts contributed the version used by the maintainer. (Wayne is largely responsible for bringing rxtx back to win32.)
http://www.linuxgrrls.org/~taj/crossmingw32-2.95-1.i386.rpm
A more current version can be obtained:
http://www.devolution.com/~slouken/SDL/Xmingw32/crossgcc/index.html
prebuilt Binaries:
http://www.devolution.com/~slouken/SDL/Xmingw32/mingw32-linux-x86-glibc-2.1.tar.gz

I built the dll with jdk-1.2.2 for linux using jdk-1.2.2 include files from the win32 JDK.

Make sure that ming32 bin dir is the first in your path (at least before /usr/bin/gcc)

$ export PATH=" \
/usr/local/cross-tools/i386-mingw32/bin/: \
$PATH:/usr/X11R6/bin:/usr/local/java/bin: \
/usr/local/java/jre/bin/:"

Place Sun jdk 1.2.2 win32 include files in a known location.

$ mkdir /home/jarvi/win32java
$ cp -r /mnt/win98//java/include /home/jarvi/win32java

If you are developing win32 support you may want to export the location to make the config script non interactive

$ export WIN32INCLUDE=/home/jarvi/tools/win32-include

run configure to generate a Makefile

$ cd /home/jarvi/rxtx-*
$ mkdir build
$ cd build
$ ../configure --target=i386-mingw32 \
--host=i386-redhat-linux

build the class files and dll.

$ make

the files will be located in

rxtx-*/build/...

If you're looking at rxtx as an example of cross-compiling you may be interested in looking at the examples provided at:

ftp.xraylith.wisc.edu
/pub/khan/gnu-win32/mingw32/misc/java-jni-examples.zip

=== Building with Eclipse/CDT ===
These builds instructions currently depend on a [http://www.codeskin.com/pubsvn/rxtx/tags/rxtx-2.1-7r2/Makefile makefile] available from CodeSkin.

* Install Eclipse with CDT and Subclipse. Subclipse is the eclipse interface to subversion and instructions for installing it are at http://subclipse.tigris.org/install.html
* Install MinGW
* In Eclipse, select "New Project > Checkout Projects from SVN" and choose this repository location: http://www.codeskin.com/pubsvn/rxtx/tags/rxtx-2.1-7r2.
* Check out as a "project configured using the New Project Wizard" and choose "Java Project".
* Once the project has been created, right-click on the project, select "new>other>C++>Convert to a C/C++ Make Project"
* Right-click on project again and select "properties>C/C++Build" and change "Build command" to
C:\MinGW\bin\mingw32-make
* Finally, hit "Build All", which should create RXTXcomm.jar and rxtxSerial.dll

== Installing Binaries ==

To do...

Consider merging with [[Installation for Windows]].

== External References ==

Follows are some links that might be useful:

* http://www.codeskin.com/c2oooProg_faq.html#rxtx
* http://www.codeskin.com/pubsvn/rxtx/tags/rxtx-2.1-7r2/Makefile

Installation on MS-Windows

Ajmas — Fri, 21 Mar 2008 14:13:40 GMT

Ajmas: reformatting

Installation on MS-Windows

Ajmas — Fri, 21 Mar 2008 14:11:23 GMT

Ajmas: reformatting

The instuctions below are a little dated, and have been copied over from the old docs. Please can someone update them:

== Installing From Source==

Get the Sun CommAPI if you want a plug-in solution. The code is provided for people that may have demanding needs and coding ability.

There is only serial port code at this time.

Three ways of compiling win32 libraries are offered:

mingw32 tools in DOS
lcc tools in DOS
cross-compiling from Linux

===== mingw32 tools in DOS =====

Install mingw32 http://www.mingw.org
Install a jdk http://java.sun.com/j2se
Make sure the ming32\bin and jdk\bin directories are in your path. In the rxtx top directory to the following:
mkdir build
copy Makefile.mingw32 build\Makefile
cd build
edit the Makefile and make sure the directories are correct.
execute the following:
make
make install

===== lcc tools in DOS =====

Install a jdk http://java.sun.com/j2se
Install lcc http://www.cs.virginia.edu/~lcc-win32/

A make file (Makefile.lcc) for compiling rxtx with lcc contributed by Valentin Pavlov

You will need a config.h file in the src directory. Other builds usually generate them automatically. The following should work.

#define HAVE_FCNTL_H
#define HAVE_SIGNAL_H
#undef HAVE_SYS_FCNTL_H
#undef HAVE_SYS_FILE_H
#undef HAVE_SYS_SIGNAL_H
#undef HAVE_TERMIOS_H
#undef HAVE_SYS_TIME_H

if you know how to create the above in a dos Makefile send in the changes.

the following commands should then work fine on the command line.

cd src
make -f ..\Makefile.lcc

===== cross-compiling from Linux =====

Grab ming32:

Wayne Roberts contributed the version used by the maintainer. (Wayne is largely responsible for bringing rxtx back to win32.)
http://www.linuxgrrls.org/~taj/crossmingw32-2.95-1.i386.rpm
A more current version can be obtained:
http://www.devolution.com/~slouken/SDL/Xmingw32/crossgcc/index.html
prebuilt Binaries:
http://www.devolution.com/~slouken/SDL/Xmingw32/mingw32-linux-x86-glibc-2.1.tar.gz

I built the dll with jdk-1.2.2 for linux using jdk-1.2.2 include files from the win32 JDK.

Make sure that ming32 bin dir is the first in your path (at least before /usr/bin/gcc)

$ export PATH=" \
/usr/local/cross-tools/i386-mingw32/bin/: \
$PATH:/usr/X11R6/bin:/usr/local/java/bin: \
/usr/local/java/jre/bin/:"

Place Sun jdk 1.2.2 win32 include files in a known location.

$ mkdir /home/jarvi/win32java
$ cp -r /mnt/win98//java/include /home/jarvi/win32java

If you are developing win32 support you may want to export the location to make the config script non interactive

$ export WIN32INCLUDE=/home/jarvi/tools/win32-include

run configure to generate a Makefile

$ cd /home/jarvi/rxtx-*
$ mkdir build
$ cd build
$ ../configure --target=i386-mingw32 \
--host=i386-redhat-linux

build the class files and dll.

$ make

the files will be located in

rxtx-*/build/...

If you're looking at rxtx as an example of cross-compiling you may be interested in looking at the examples provided at:

ftp.xraylith.wisc.edu
/pub/khan/gnu-win32/mingw32/misc/java-jni-examples.zip

=== Building with Eclipse/CDT ===
These builds instructions currently depend on a [http://www.codeskin.com/pubsvn/rxtx/tags/rxtx-2.1-7r2/Makefile makefile] available from CodeSkin.

* Install Eclipse with CDT and Subclipse. Subclipse is the eclipse interface to subversion and instructions for installing it are at http://subclipse.tigris.org/install.html
* Install MinGW
* In Eclipse, select "New Project > Checkout Projects from SVN" and choose this repository location: http://www.codeskin.com/pubsvn/rxtx/tags/rxtx-2.1-7r2.
* Check out as a "project configured using the New Project Wizard" and choose "Java Project".
* Once the project has been created, right-click on the project, select "new>other>C++>Convert to a C/C++ Make Project"
* Right-click on project again and select "properties>C/C++Build" and change "Build command" to
C:\MinGW\bin\mingw32-make
* Finally, hit "Build All", which should create RXTXcomm.jar and rxtxSerial.dll

== Installing Binaries ==

To do...

Consider merging with [[Installation for Windows]].

== External References ==

Follows are some links that might be useful:

* http://www.codeskin.com/c2oooProg_faq.html#rxtx
* http://www.codeskin.com/pubsvn/rxtx/tags/rxtx-2.1-7r2/Makefile

Installation on MS-Windows

Ajmas — Thu, 28 Feb 2008 01:53:06 GMT

Ajmas: /* Installing From Source */

The instuctions below are a little dated, and have been copied over from the old docs. Please can someone update them:

== Installing From Source==
==== Compiling for Win32 support ====

Get the Sun CommAPI if you want a plug-in solution. The code
is provided for people that may have demanding needs and coding
ability.

There is only serial port code at this time.

Three ways of compiling win32 libraries are offered:

mingw32 tools in DOS
lcc tools in DOS
cross-compiling from Linux
===== mingw32 tools in DOS =====

Install mingw32 http://www.mingw.org
Install a jdk http://java.sun.com/j2se
Make sure the ming32\bin and jdk\bin directories are in your
path.
In the rxtx top directory to the following:
mkdir build
copy Makefile.mingw32 build\Makefile
cd build
edit the Makefile and make sure the directories are correct.
execute the following:
make
make install

===== lcc tools in DOS =====

Install a jdk http://java.sun.com/j2se
Install lcc http://www.cs.virginia.edu/~lcc-win32/

A make file (Makefile.lcc) for compiling rxtx with lcc
contributed by Valentin Pavlov

You will need a config.h file in the src directory. Other
builds usually generate them automatically. The following
should work.

#define HAVE_FCNTL_H
#define HAVE_SIGNAL_H
#undef HAVE_SYS_FCNTL_H
#undef HAVE_SYS_FILE_H
#undef HAVE_SYS_SIGNAL_H
#undef HAVE_TERMIOS_H
#undef HAVE_SYS_TIME_H

if you know how to create the above in a dos Makefile send in the changes.

the following commands should then work fine on the command
line.

cd src
make -f ..\Makefile.lcc

===== cross-compiling from Linux =====

Grab ming32:

Wayne Roberts contributed the version used by the maintainer.
(Wayne is largely responsible for bringing rxtx back to win32.)
http://www.linuxgrrls.org/~taj/crossmingw32-2.95-1.i386.rpm
A more current version can be obtained:
http://www.devolution.com/~slouken/SDL/Xmingw32/crossgcc/index.html
prebuilt Binaries:
http://www.devolution.com/~slouken/SDL/Xmingw32/mingw32-linux-x86-glibc-2.1.tar.gz

I built the dll with jdk-1.2.2 for linux using jdk-1.2.2
include files from the win32 JDK.

Make sure that ming32 bin dir is the first in your path (at
least before /usr/bin/gcc)

$ export PATH=" \
/usr/local/cross-tools/i386-mingw32/bin/: \
$PATH:/usr/X11R6/bin:/usr/local/java/bin: \
/usr/local/java/jre/bin/:"

Place Sun jdk 1.2.2 win32 include files in a known location.

$ mkdir /home/jarvi/win32java
$ cp -r /mnt/win98//java/include /home/jarvi/win32java

If you are developing win32 support you may want to
export the location to make the config script
non interactive

$ export WIN32INCLUDE=/home/jarvi/tools/win32-include

run configure to generate a Makefile

$ cd /home/jarvi/rxtx-*
$ mkdir build
$ cd build
$ ../configure --target=i386-mingw32 \
--host=i386-redhat-linux

build the class files and dll.

$ make

the files will be located in

rxtx-*/build/...

If you're looking at rxtx as an example of cross-compiling you
may be interested in looking at the examples provided at:

ftp.xraylith.wisc.edu
/pub/khan/gnu-win32/mingw32/misc/java-jni-examples.zip

=== Building with Eclipse/CDT ===
These builds instructions currently depend on a patch available from CodeSkin.

* Install Eclipse with CDT
* Install MinGW
* In Eclipse, select "New Project > Checkout Projects from SVN" and choose this repository location: http://www.codeskin.com/pubsvn/rxtx/tags/rxtx-2.1-7r2-DTR-patch.
* Check out as a "project configured using the New Project Wizard" and choose "Java Project".
* Once the project has been created, right-click on the project, select "new>other>Convert to a C/C++ Make Project"
* Right-click on project again and select "properties>C/C++Build" and change "Build command" to
C:\MinGW\bin\mingw32-make
* Finally, hit "Build All", which should create RXTXcomm.jar and rxtxSerial.dll

== Installing Binaries ==

To do...

Consider merging with [[Installation for Windows]].

== External References ==

Follows are some links that might be useful:

* http://www.codeskin.com/c2oooProg_faq.html#rxtx
* http://www.codeskin.com/pubsvn/rxtx/tags/rxtx-2.1-7r2-DTR-patch/Makefile

Installation on MS-Windows

Ajmas — Thu, 28 Feb 2008 01:42:43 GMT

Ajmas:

The instuctions below are a little dated, and have been copied over from the old docs. Please can someone update them:

== Installing From Source==
==== Compiling for Win32 support ====

Get the Sun CommAPI if you want a plug-in solution. The code
is provided for people that may have demanding needs and coding
ability.

There is only serial port code at this time.

Three ways of compiling win32 libraries are offered:

mingw32 tools in DOS
lcc tools in DOS
cross-compiling from Linux
===== mingw32 tools in DOS =====

Install mingw32 http://www.mingw.org
Install a jdk http://java.sun.com/j2se
Make sure the ming32\bin and jdk\bin directories are in your
path.
In the rxtx top directory to the following:
mkdir build
copy Makefile.mingw32 build\Makefile
cd build
edit the Makefile and make sure the directories are correct.
execute the following:
make
make install

===== lcc tools in DOS =====

Install a jdk http://java.sun.com/j2se
Install lcc http://www.cs.virginia.edu/~lcc-win32/

A make file (Makefile.lcc) for compiling rxtx with lcc
contributed by Valentin Pavlov

You will need a config.h file in the src directory. Other
builds usually generate them automatically. The following
should work.

#define HAVE_FCNTL_H
#define HAVE_SIGNAL_H
#undef HAVE_SYS_FCNTL_H
#undef HAVE_SYS_FILE_H
#undef HAVE_SYS_SIGNAL_H
#undef HAVE_TERMIOS_H
#undef HAVE_SYS_TIME_H

if you know how to create the above in a dos Makefile send in the changes.

the following commands should then work fine on the command
line.

cd src
make -f ..\Makefile.lcc

===== cross-compiling from Linux =====

Grab ming32:

Wayne Roberts contributed the version used by the maintainer.
(Wayne is largely responsible for bringing rxtx back to win32.)
http://www.linuxgrrls.org/~taj/crossmingw32-2.95-1.i386.rpm
A more current version can be obtained:
http://www.devolution.com/~slouken/SDL/Xmingw32/crossgcc/index.html
prebuilt Binaries:
http://www.devolution.com/~slouken/SDL/Xmingw32/mingw32-linux-x86-glibc-2.1.tar.gz

I built the dll with jdk-1.2.2 for linux using jdk-1.2.2
include files from the win32 JDK.

Make sure that ming32 bin dir is the first in your path (at
least before /usr/bin/gcc)

$ export PATH=" \
/usr/local/cross-tools/i386-mingw32/bin/: \
$PATH:/usr/X11R6/bin:/usr/local/java/bin: \
/usr/local/java/jre/bin/:"

Place Sun jdk 1.2.2 win32 include files in a known location.

$ mkdir /home/jarvi/win32java
$ cp -r /mnt/win98//java/include /home/jarvi/win32java

If you are developing win32 support you may want to
export the location to make the config script
non interactive

$ export WIN32INCLUDE=/home/jarvi/tools/win32-include

run configure to generate a Makefile

$ cd /home/jarvi/rxtx-*
$ mkdir build
$ cd build
$ ../configure --target=i386-mingw32 \
--host=i386-redhat-linux

build the class files and dll.

$ make

the files will be located in

rxtx-*/build/...

If you're looking at rxtx as an example of cross-compiling you
may be interested in looking at the examples provided at:

ftp.xraylith.wisc.edu
/pub/khan/gnu-win32/mingw32/misc/java-jni-examples.zip

== Installing Binaries ==

To do...

Consider merging with [[Installation for Windows]].

== External References ==

Follows are some links that might be useful:

* http://www.codeskin.com/c2oooProg_faq.html#rxtx
* http://www.codeskin.com/pubsvn/rxtx/tags/rxtx-2.1-7r2-DTR-patch/Makefile

User talk:203.88.192.104

Ajmas — Wed, 20 Feb 2008 15:42:31 GMT

Ajmas: Reverted edits by C4telCacor (Talk); changed back to last version by Ajmas

Help:Contents

Ajmas — Wed, 20 Feb 2008 03:35:35 GMT

Ajmas: Protected "Help:Contents" [edit=sysop:move=sysop]

WebStart

Ajmas — Wed, 20 Feb 2008 03:34:14 GMT

Ajmas:

== Introduction ==

Using Java [http://java.sun.com/products/javawebstart/ Web Start] technology, standalone Java software applications can be deployed with a single click over the network. This page explains what you need to do to make you application web startable.

The first thing to do is create two JNLP files, one for the libraries and one for your application. While this approach is not strictly necessary, it helps provide a separation between what is usable between projects and what is specific to a given project. Below are two sample JNLP files that you can use as a starting point.

JNLP For your application:

<pre>
<?xml version="1.0" encoding="utf-8"?>
<jnlp codebase="http://myserver/webstart/applications"
href="gpsviewer.jnlp">
<information>
<title>GPSViewer</title>
<vendor>ajmas</vendor>
<homepage href="http://mysite/"/>
<description>Program displaying data from NMEA compatible GPS device</description>
<description kind="short">Displays data from a NMEA GPS device</description>
<offline-allowed/>
</information>
<security>
<all-permissions/>
</security>
<resources>
<j2se href="http://java.sun.com/products/autodl/j2se" version="1.5+"/>
<jar href="geonavapps.jar" main="true"/>
<jar href="geonav.jar" main="false"/>
<extension name="rxtx" href="http://myserver/webstart/rxtx/rxtx.jnlp" />
</resources>

<application-desc main-class="osj.geonav.gpsviewer.GPSViewer"/>
</jnlp>
</pre>

JNLP for library:

<pre>
<?xml version="1.0" encoding="utf-8"?>
<jnlp codebase="http://myserver/webstart/rxtx/"
href="rxtx.jnlp">
<information>
<title>RXTX</title>
<vendor>ajmas</vendor>
<homepage href="http://www.rxtx.org"/>
<description>Java API for serial port communication</description>
<description kind="short">Java API for serial port communication.</description>
<offline-allowed/>
</information>
<security>
<all-permissions/>
</security>
<resources>
<jar href="rxtx-comm.jar" />
</resources>
<resources os="Windows" arch="x86">
<nativelib href="rxtx-comm-natives-windows-i586.jar" />
</resources>
<resources os="Linux" arch="i686">
<nativelib href="rxtx-comm-natives-linux-i686-32.jar" />
</resources>
<resources os="Linux" arch="i386">
<nativelib href="rxtx-comm-natives-linux-i686-32.jar" />
</resources>
<resources os="Linux" arch="x86">
<nativelib href="rxtx-comm-natives-linux-i686-32.jar" />
</resources>
<resources os="Mac OS X" >
<nativelib href="rxtx-comm-natives-macosx-universal.jar" />
</resources>
<component-desc />
</jnlp>
</pre>

It should be noted that the 'codebase' attribute is an absolute URL and generally points back to the file that contains it, so if your JNLP is located at

http://www.mysite.com/myapp.jnlp

then the codebase URL should match.

The native libraries are all added to individual archives for each platform, the library file being without a path prefix. For example the contents of the 'rxtx-comm-natives-macosx-universal.jar' would be something as follows:

META-INF/MANIFEST.MF
META-INF/
librxtxSerial.jnilib

All the Java archives referenced by the JNLP files should be signed, so that the application and libraries can access native functions, such as accessing the serial port. See the section on signing your Jars.

== Signing Your Jars ==

=== Generating the Keys ===

The following instructions explain how to sign a JAR using a self signed certificate.

To generate the key:

keytool -genkey -alias alias-name -keystore keystore-name

The alias-name and keystore-name are optional and if not provided default to ''mykey'' and .keystore (in your home directory). If the keystore that is specified does not exist, then it will be created, otherwise it will modify the existing keystore. After typing this command, you will be asked for the keystore password (or to create one if the keystore does not yet exist). At this point you will be asked some questions:

What is your first and last name?
[Unknown]: your name
What is the name of your organizational unit?
[Unknown]:
What is the name of your organization?
[Unknown]: My Company
What is the name of your City or Locality?
[Unknown]: Montreal
What is the name of your State or Province?
[Unknown]: QC
What is the two-letter country code for this unit?
[Unknown]: CA
Is <CN=your name, OU=Unknown, O=My Company,
L=Montreal, ST=QC, C=CA> correct?
[no]: y

After having specifed yes, you can either specify a different password for the key, or use the same one as the key store.

Note that that the key is valid for 90 days by default, and if you wish for a longer period then you should use the ''-validity'' option.

===Signing the Jar ===

To sign the Jar use the following ''jarsigner'' command:

jarsigner -keystore keystore-name -storepass keystore-password
-keypass key-password jar-file alias-name

For example, if your keystore name is 'myKeyStore', with both keystore password and key passwords being pass123, the jar you wish to sign being myapp.jar and the key name being 'mykey', then you would use the command as follows:

jarsigner -keystore myKeyStore -storepass pass123
-keypass pass123 myapp.jar mykey

== Related Link ==

* [http://www.cs.princeton.edu/introcs/85application/jar/sign.html JAR Signing]
* [http://www.autexier.de/jmau/dev/webstart/ Javer WebStart Tutorial]

WebStart

Ajmas — Tue, 19 Feb 2008 23:06:09 GMT

Ajmas:

This page is currently a stub for information on WebStart (JNLP) and RxTx.

'''To Do'''

* Skeleton JNLP for Application and Libraries
* Signing
* Possibly an Ant build file
* Gotchas

Using Java [http://java.sun.com/products/javawebstart/ Web Start] technology, standalone Java software applications can be deployed with a single click over the network.

JNLP For your application:

<pre>
<?xml version="1.0" encoding="utf-8"?>
<jnlp codebase="http://myserver/webstart/applications"
href="gpsviewer.jnlp">
<information>
<title>GPSViewer</title>
<vendor>ajmas</vendor>
<homepage href="http://mysite/"/>
<description>Program displaying data from NMEA compatible GPS device</description>
<description kind="short">Displays data from a NMEA GPS device</description>
<offline-allowed/>
</information>
<security>
<all-permissions/>
</security>
<resources>
<j2se href="http://java.sun.com/products/autodl/j2se" version="1.5+"/>
<jar href="geonavapps.jar" main="true"/>
<jar href="geonav.jar" main="false"/>
<extension name="rxtx" href="http://myserver/webstart/rxtx/rxtx.jnlp" />
</resources>

<application-desc main-class="osj.geonav.gpsviewer.GPSViewer"/>
</jnlp>
</pre>

JNLP for library:

<pre>
<?xml version="1.0" encoding="utf-8"?>
<jnlp codebase="http://myserver/webstart/rxtx/"
href="rxtx.jnlp">
<information>
<title>RXTX</title>
<vendor>ajmas</vendor>
<homepage href="http://www.rxtx.org"/>
<description>Java API for serial port communication</description>
<description kind="short">Java API for serial port communication.</description>
<offline-allowed/>
</information>
<security>
<all-permissions/>
</security>
<resources>
<jar href="rxtx-comm.jar" />
</resources>
<resources os="Windows" arch="x86">
<nativelib href="rxtx-comm-natives-windows-i586.jar" />
</resources>
<resources os="Linux" arch="i686">
<nativelib href="rxtx-comm-natives-linux-i686-32.jar" />
</resources>
<resources os="Linux" arch="i386">
<nativelib href="rxtx-comm-natives-linux-i686-32.jar" />
</resources>
<resources os="Linux" arch="x86">
<nativelib href="rxtx-comm-natives-linux-i686-32.jar" />
</resources>
<resources os="Mac OS X" >
<nativelib href="rxtx-comm-natives-macosx-universal.jar" />
</resources>
<component-desc />
</jnlp>
</pre>

Help:Contents

Ajmas — Tue, 19 Feb 2008 22:08:09 GMT

Ajmas: Reverted edits by GetgeTc4to (Talk); changed back to last version by Ajmas

WebStart

Ajmas — Tue, 19 Feb 2008 03:11:42 GMT

Ajmas:

This page is currently a stub for information on WebStart (JNLP) and RxTx.

'''To Do'''

* Skeleton JNLP for Application and Libraries
* Signing
* Possibly an Ant build file
* Gotchas

JNLP For your application:

<pre>
<?xml version="1.0" encoding="utf-8"?>
<jnlp codebase="http://myserver/webstart/applications"
href="gpsviewer.jnlp">
<information>
<title>GPSViewer</title>
<vendor>ajmas</vendor>
<homepage href="http://mysite/"/>
<description>Program displaying data from NMEA compatible GPS device</description>
<description kind="short">Displays data from a NMEA GPS device</description>
<offline-allowed/>
</information>
<security>
<all-permissions/>
</security>
<resources>
<j2se href="http://java.sun.com/products/autodl/j2se" version="1.5+"/>
<jar href="geonavapps.jar" main="true"/>
<jar href="geonav.jar" main="false"/>
<extension name="rxtx" href="http://myserver/webstart/rxtx/rxtx.jnlp" />
</resources>

<application-desc main-class="osj.geonav.gpsviewer.GPSViewer"/>
</jnlp>
</pre>

JNLP for library:

<pre>
<?xml version="1.0" encoding="utf-8"?>
<jnlp codebase="http://myserver/webstart/rxtx/"
href="rxtx.jnlp">
<information>
<title>RXTX</title>
<vendor>ajmas</vendor>
<homepage href="http://www.rxtx.org"/>
<description>Java API for serial port communication</description>
<description kind="short">Java API for serial port communication.</description>
<offline-allowed/>
</information>
<security>
<all-permissions/>
</security>
<resources>
<jar href="rxtx-comm.jar" />
</resources>
<resources os="Windows" arch="x86">
<nativelib href="rxtx-comm-natives-windows-i586.jar" />
</resources>
<resources os="Linux" arch="i686">
<nativelib href="rxtx-comm-natives-linux-i686-32.jar" />
</resources>
<resources os="Linux" arch="i386">
<nativelib href="rxtx-comm-natives-linux-i686-32.jar" />
</resources>
<resources os="Linux" arch="x86">
<nativelib href="rxtx-comm-natives-linux-i686-32.jar" />
</resources>
<resources os="Mac OS X" >
<nativelib href="rxtx-comm-natives-macosx-universal.jar" />
</resources>
<component-desc />
</jnlp>
</pre>

WebStart

Ajmas — Tue, 19 Feb 2008 01:07:38 GMT

Ajmas: New page: This page is currently a stub for information on WebStart (JNLP) and RxTx. '''To Do''' * Skeleton JNLP for Application and Libraries * Signing * Possibly an Ant build file * Gotchas

This page is currently a stub for information on WebStart (JNLP) and RxTx.

'''To Do'''

* Skeleton JNLP for Application and Libraries
* Signing
* Possibly an Ant build file
* Gotchas

Development

Ajmas — Tue, 19 Feb 2008 01:04:20 GMT

Ajmas: