Rxtx - User contributions [en]

FAQ

Niko.delarich — Thu, 05 Nov 2009 16:08:58 GMT

Niko.delarich: /* On MacOS X I get a 'PortInUseException', even though it isn't? */

== 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.

=== 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]].

You can specify the available ports by
System.setProperty("gnu.io.rxtx.SerialPorts", portFileNames);
where the file names of the ports are separated by File.pathSeparator.

=== 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.

Talk:Download

Niko.delarich — Thu, 05 Nov 2009 16:06:52 GMT

Niko.delarich:

It would be interesting to distribute a version of RxTx with the debug constants set to 'true'.

== Linux,AMD 64, & 2.2 ==

Adding a note that you may need the 2.2 pre-release if your running 64 bit may save some people a bit of time. I wasn't able to get any of the stable releases working on Ubuntu 9.04

== MacOS Snow Leopard ==

RXTX 2.2pre is needed for MacOS Snow Leopard os.version 10.6 and above.
:Only works partially for me (SerialPort.close() is broken/hangs forever) --[[User:Niko.delarich|Niko.delarich]] 16:06, 5 November 2009 (UTC)

The issue is that this version does not work with MacOS 10.4 - there the stable version is needed...

It is fairly difficult (maybe impossible) to get a single setup for webstart.

Would it be possible to provide/implement/explain a way to have the nativelib selection done partly in the Java code itself while providing several native libs through webstarts.

By the way, the error is:
"Symbol not found: _open$UNIX2003"

FAQ

Niko.delarich — Sat, 15 Aug 2009 17:40:45 GMT

Niko.delarich: /* On MacOS X I get a 'PortInUseException', even though it isn't? */

== 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?
There you go: <strike>http://www.mediafire.com/download.php?zx1hlhghyyh</strike> Offline... -- [[User:Niko.delarich|Niko.delarich]] 17:40, 15 August 2009 (UTC)
'TODO': Can anyone who knows how please upload this file to rxtx.org?

=== 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]].

You can specify the available ports by
System.setProperty("gnu.io.rxtx.SerialPorts", portFileNames);
where the file names of the ports are separated by File.pathSeparator.

=== 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.

FAQ

Niko.delarich — Sat, 16 May 2009 16:25:35 GMT

Niko.delarich:

== 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?
There you go: http://www.mediafire.com/download.php?zx1hlhghyyh
'TODO': Can anyone who knows how please upload this file to rxtx.org?

=== 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]].

You can specify the available ports by
System.setProperty("gnu.io.rxtx.SerialPorts", portFileNames);
where the file names of the ports are separated by File.pathSeparator.

=== 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.

FAQ

Niko.delarich — Sat, 16 May 2009 16:24:48 GMT

Niko.delarich:

== 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?
There you go: http://www.mediafire.com/?sharekey=261f0b4bfc5aff850c814df2efeadc50e04e75f6e8ebb871
'TODO': Can anyone who knows how please upload this file to rxtx.org?

=== 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]].

You can specify the available ports by
System.setProperty("gnu.io.rxtx.SerialPorts", portFileNames);
where the file names of the ports are separated by File.pathSeparator.

=== 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.

FAQ

Niko.delarich — Sat, 16 May 2009 16:23:42 GMT

Niko.delarich: Added a link to a compiled librxtxSerial.jnilib (2.2pre2) for MacOS X

== 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?
There you go: http://www.mediafire.com/?sharekey=261f0b4bfc5aff850c814df2efeadc50e04e75f6e8ebb871
'TODO': Can anyone who knows how please upload this file to rxtx.org?

=== 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]].

You can specify the available ports by
System.setProperty("gnu.io.rxtx.SerialPorts", portFileNames);
where the file names of the ports are separated by File.pathSeparator.

=== 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.

Installation on MacOS X

Niko.delarich — Sat, 16 May 2009 16:15:47 GMT

Niko.delarich: typos i guess

== Installing From Source ==
Before you start installing RXTX you will need to make sure that XCode, Apple's development environment is installed. It should be on one of the system installation disks, or the more recent version is available from [http://www.apple.com/developer/ Apple's developer web site]. As for Java, MacOS X already comes with Java installed so no need to install it again.

Once you have XCode installed download RXTX. See the [[download]] page on how to get the latest version.

Once you have downloaded the source extract it, in a terminal window navigate to the extracted directory and enter the command:

sh ./configure

This will configure the build and generate the necessary make files.

Note, that there may be supplementary options you may want to configure, though the standard options should suffice. To see what they are:

sh ./configure --help

Once confiugre has finished running start the make process:

make

If everything has gone to plan you should have a directory corresponding to the system's unix name, for example "powerpc-apple-darwin8.11.0", with the native library 'librxtxSerial.jnilib' and in the current directory there should be the java librar 'RXTXcomm.jar'. See the section on "installing binaries" below, on where to put things.

== Installing Binaries ==

Whether you compiled from source, or got a binary distribution you should have two files: RXTXcomm.jar and librxtxSerial.jnilib. You will need to copy them to an appropriate location. If you want them to be available to all programs, then the standard locations are:
* /Library/Java/Extensions - to make available to all users
* ~/Library/Java/Extensions - to make available to only your user

Also, if you are using an IDE such as Eclipse, you can opt to include them in your project instead. If your project is MyHelloWorld then locations would be:
* MyHelloWorld/lib/RXTXcomm.jar
* MyHelloWorld/librxtxSerial.jnilib
Don't forget to include them in your build path.

== Environment Variables ==

It should be noted that if you have issues configuring or building RXTX, then the first thing to check out are any environment variable that could be causing problems. For example:
* PATH - ensure that /usr/bin & /bin are first, since it has been know for other libraries to conflict, such as those installed with Fink or MacPorts
* CFLAGS - here it has been know the '-ansi' flags to cause issues with the RXTX source and gcc.

Also, if you run configure again, after changing environment variables, removing the config.status file would be handy, since that acts a cache for the values taken from the first run.

Additionally, if you wish to add support for 64-bit architectures, then you can add the following to your CFLAGS and LDFLAGS environment variables before you run configure:

-arch x86_64 -arch ppc64

It should be noted that you will need MacOS X 10.5 for 64-bit support on Intel machines and at least 10.4 for 64-bit support for PowerPC machines.

For 64-bit Java 6 you will also need to patch SerialImpl.c and SerialImpl.h according to the note on the forum here: [[http://mailman.qbang.org/pipermail/rxtx/2007-June/3368151.html]]. A user has provided a binary download of librxtxSerial.jnilib here: [[http://iharder.sourceforge.net/current/java/] http://iharder.sourceforge.net/current/java/]