rxtx Goto Github PK

/*-------------------------------------------------------------------------
|   RXTX License v 2.1 - LGPL v 2.1 + Linking Over Controlled Interface.
|   RXTX is a native interface to serial ports in java.
|   Copyright 1997-2012 by Trent Jarvi [email protected] and others who
|   actually wrote it.  See individual source files for more information.
|
|   A copy of the LGPL v 2.1 may be found at
|   http://www.gnu.org/licenses/lgpl.txt on March 4th 2007.  A copy is
|   here for your convenience.
|
|   This library is free software; you can redistribute it and/or
|   modify it under the terms of the GNU Lesser General Public
|   License as published by the Free Software Foundation; either
|   version 2.1 of the License, or (at your option) any later version.
|
|   This library is distributed in the hope that it will be useful,
|   but WITHOUT ANY WARRANTY; without even the implied warranty of
|   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
|   Lesser General Public License for more details.
|
|   An executable that contains no derivative of any portion of RXTX, but
|   is designed to work with RXTX by being dynamically linked with it,
|   is considered a "work that uses the Library" subject to the terms and
|   conditions of the GNU Lesser General Public License.
|
|   The following has been added to the RXTX License to remove
|   any confusion about linking to RXTX.   We want to allow in part what
|   section 5, paragraph 2 of the LGPL does not permit in the special
|   case of linking over a controlled interface.  The intent is to add a
|   Java Specification Request or standards body defined interface in the 
|   future as another exception but one is not currently available.
|
|   http://www.fsf.org/licenses/gpl-faq.html#LinkingOverControlledInterface
|
|   As a special exception, the copyright holders of RXTX give you
|   permission to link RXTX with independent modules that communicate with
|   RXTX solely through the Sun Microsytems CommAPI interface version 2,
|   regardless of the license terms of these independent modules, and to copy
|   and distribute the resulting combined work under terms of your choice,
|   provided that every copy of the combined work is accompanied by a complete
|   copy of the source code of RXTX (the version of RXTX used to produce the
|   combined work), being distributed under the terms of the GNU Lesser General
|   Public License plus this exception.  An independent module is a
|   module which is not derived from or based on RXTX.
|
|   Note that people who make modified versions of RXTX are not obligated
|   to grant this special exception for their modified versions; it is
|   their choice whether to do so.  The GNU Lesser General Public License
|   gives permission to release a modified version without this exception; this
|   exception also makes it possible to release a modified version which
|   carries forward this exception.
|
|   You should have received a copy of the GNU Lesser General Public
|   License along with this library; if not, write to the Free
|   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
|   All trademarks belong to their respective owners.
--------------------------------------------------------------------------*/
This is README Wed Apr 25 22:37:26 MDT 2007

See Also:

INSTALL:   install instructions and solutions to common problems
TODO:      Comments for developers
COPYING:   The LGPL license
PORTING:   hints for people trying to port rxtx
Authors:   who wrote what.
ChangeLog: when they wrote it.
RMISecurityManager.html:  Comments for people using RMISecurityManager 
SerialPortInstructions.txt:  HOWTO on read/writing to your com ports on linux for beginners

There are numerous possibilities for projects that involve serial communication.
Java is an excellent language for putting GUI apps together.  Well have fun.  
Send back stories. 

Copies of the latest RXTX will be on http://www.rxtx.org/download
The primary source for information/support is http://www.rxtx.org.
The rxtx mail-list is at [email protected].
Send email with "subscribe rxtx" in the subject without the quotes to join. 

This is a native lib for jdk 1.1.* and newer.  If you find changes required
for different platforms or OS's please pass them back this way so we may share
it with others.  Credit will be given unless one specifically requests no 
credit.

We chopped rxtx out of my program and tried to put a small example together.  
There is plenty of room for configurability, safe guarding and error reporting.
If you have some time please contribute some improvements.

We are interested in sharing this code in hopes that a more versatile lib may
be developed and released with minimal restrictions.  Please send any patches 
back my way if you like.

If you are interested in using rxtx for things like RS485, I2C or raw IO Please
get the latest CVS version.  Some work has been done for each of them.  The
latest development version is a stand alone implementation of CommAPI.

For bug reports please follow the directions in INSTALL

Trent Jarvi
taj@www.linux.org.uk