doc.readme.txt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.everit.osgi.bundles.net.sf.marineapi Show documentation
Java Marine API is an NMEA 0183 library for Java (http://ktuukkan.github.io/marine-api/).
The newest version!
Java Marine API - README
Version @VERSION@ pre-alpha (b@BUILD_ID@)


Java Marine API is an NMEA-0183 library for decoding and encoding the data
provided by various electronic marine instruments such as GPS, echo sounder and
weather instruments.

SYSTEM REQUIREMENTS

 * Java 2 SE JRE/JDK (1.7+ recommended)

 For serial port communication (choose one):

 * Java Communications API
   

 * RXTX library
   

 * Neuron Robotics Java Serial Library
   

 * PureJavaComm
   

LICENSING

Java Marine API 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 3 of the License, or (at your
option) any later version.

Java Marine API 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.

You should have received a copy of the GNU Lesser General Public License
along with Java Marine API. If not, see .

DISCLAIMER

Java Marine API is not official NMEA software. Further, it is not related to
National Marine Electronics Association . The decoding of
NMEA-0183 sentences is based entirely on publicly available resources in the
Internet. Thus, it is NOT guaranteed that the library would follow and implement
the standard accurately and correctly.

SOURCE CODE

The source code is maintained in Github .

Browse code at Github.com:


Repository URL (read-only):


If you wish to contribute new code or bug fixes, please fork and send pull
requests in Github.

DEVELOPERS

* Kimmo Tuukkanen 

REFERENCES

The NMEA 0183 information for Java Marine API has been acquired from following
documents publicly available in the Internet (URLs checked on 2013-09-08):

 * NMEA 0183 article in Wikipedia
   

 * NMEA Revealed by Eric S. Raymond
   

 * The NMEA Information Sheet (issue 3, 25th Feb 2011) by Actisense
   

 * PB100 WeatherStation Technical Manual by Airmar
   

 * RT Intertial+ NMEA Description (rev. 100720) by Oxford Technical Solutions
   

 * Trimble BD9xx GNSS Receivers Help
   

 * Eye4Software GPS Toolkit - Description of supported NMEA0183 sentences
   

 * NMEA International Conference & Expo - Standards Update October 2014 by Steve Spitzer
   

 * NMEA 0183 Sentences Not Recommended for New Designs by NMEA
   

 * NMEA Sentence Information by Glenn Baddeley
   

 * NMEA Data by Dale DePriest
   

 * The NMEA FAQ by Peter Bennett
    (not found)
    (archived older version)

All warnings concerning the accuracy of information in above documents apply
equally to Java Marine API.