diff --git a/README.md b/README.md index 2b64386..d011483 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # TinyGPSPlus A new, customizable Arduino NMEA parsing library A *NEW* Full-featured GPS/NMEA Parser for Arduino -TinyGPS++ is a new Arduino library for parsing NMEA data streams provided by GPS modules. +TinyGPSPlus is a new Arduino library for parsing NMEA data streams provided by GPS modules. Like its predecessor, TinyGPS, this library provides compact and easy-to-use methods for extracting position, date, time, altitude, speed, and course from consumer GPS devices. -However, TinyGPS++’s programmer interface is considerably simpler to use than TinyGPS, and the new library can extract arbitrary data from any of the myriad NMEA sentences out there, even proprietary ones. +However, TinyGPSPlus’s programmer interface is considerably simpler to use than TinyGPS, and the new library can extract arbitrary data from any of the myriad NMEA sentences out there, even proprietary ones. -See [Arduiniana - TinyGPS++](http://arduiniana.org/libraries/tinygpsplus/) for more detailed information on how to use TinyGPSPlus +See [Arduiniana - TinyGPSPlus](http://arduiniana.org/libraries/tinygpsplus/) for more detailed information on how to use TinyGPSPlus diff --git a/examples/BasicExample/BasicExample.ino b/examples/BasicExample/BasicExample.ino index da62825..c5ea35b 100644 --- a/examples/BasicExample/BasicExample.ino +++ b/examples/BasicExample/BasicExample.ino @@ -1,7 +1,7 @@ -#include +#include /* - This sample sketch should be the first you try out when you are testing a TinyGPS++ - (TinyGPSPlus) installation. In normal use, you feed TinyGPS++ objects characters from + This sample sketch should be the first you try out when you are testing a TinyGPSPlus + (TinyGPSPlus) installation. In normal use, you feed TinyGPSPlus objects characters from a serial NMEA GPS device, but this example uses static strings for simplicity. */ @@ -14,7 +14,7 @@ const char *gpsStream = "$GPRMC,045251.000,A,3014.4275,N,09749.0626,W,0.51,217.94,030913,,,A*7D\r\n" "$GPGGA,045252.000,3014.4273,N,09749.0628,W,1,09,1.3,206.9,M,-22.5,M,,0000*6F\r\n"; -// The TinyGPS++ object +// The TinyGPSPlus object TinyGPSPlus gps; void setup() @@ -22,8 +22,8 @@ void setup() Serial.begin(115200); Serial.println(F("BasicExample.ino")); - Serial.println(F("Basic demonstration of TinyGPS++ (no device needed)")); - Serial.print(F("Testing TinyGPS++ library v. ")); Serial.println(TinyGPSPlus::libraryVersion()); + Serial.println(F("Basic demonstration of TinyGPSPlus (no device needed)")); + Serial.print(F("Testing TinyGPSPlus library v. ")); Serial.println(TinyGPSPlus::libraryVersion()); Serial.println(F("by Mikal Hart")); Serial.println(); diff --git a/examples/DeviceExample/DeviceExample.ino b/examples/DeviceExample/DeviceExample.ino index 489c30b..1660890 100644 --- a/examples/DeviceExample/DeviceExample.ino +++ b/examples/DeviceExample/DeviceExample.ino @@ -1,14 +1,14 @@ -#include +#include #include /* - This sample sketch demonstrates the normal use of a TinyGPS++ (TinyGPSPlus) object. + This sample sketch demonstrates the normal use of a TinyGPSPlus (TinyGPSPlus) object. It requires the use of SoftwareSerial, and assumes that you have a 4800-baud serial GPS device hooked up on pins 4(rx) and 3(tx). */ static const int RXPin = 4, TXPin = 3; static const uint32_t GPSBaud = 4800; -// The TinyGPS++ object +// The TinyGPSPlus object TinyGPSPlus gps; // The serial connection to the GPS device @@ -20,8 +20,8 @@ void setup() ss.begin(GPSBaud); Serial.println(F("DeviceExample.ino")); - Serial.println(F("A simple demonstration of TinyGPS++ with an attached GPS module")); - Serial.print(F("Testing TinyGPS++ library v. ")); Serial.println(TinyGPSPlus::libraryVersion()); + Serial.println(F("A simple demonstration of TinyGPSPlus with an attached GPS module")); + Serial.print(F("Testing TinyGPSPlus library v. ")); Serial.println(TinyGPSPlus::libraryVersion()); Serial.println(F("by Mikal Hart")); Serial.println(); } diff --git a/examples/FullExample/FullExample.ino b/examples/FullExample/FullExample.ino index 52d5c16..d781963 100644 --- a/examples/FullExample/FullExample.ino +++ b/examples/FullExample/FullExample.ino @@ -1,14 +1,14 @@ -#include +#include #include /* - This sample code demonstrates the normal use of a TinyGPS++ (TinyGPSPlus) object. + This sample code demonstrates the normal use of a TinyGPSPlus (TinyGPSPlus) object. It requires the use of SoftwareSerial, and assumes that you have a 4800-baud serial GPS device hooked up on pins 4(rx) and 3(tx). */ static const int RXPin = 4, TXPin = 3; static const uint32_t GPSBaud = 4800; -// The TinyGPS++ object +// The TinyGPSPlus object TinyGPSPlus gps; // The serial connection to the GPS device @@ -20,8 +20,8 @@ void setup() ss.begin(GPSBaud); Serial.println(F("FullExample.ino")); - Serial.println(F("An extensive example of many interesting TinyGPS++ features")); - Serial.print(F("Testing TinyGPS++ library v. ")); Serial.println(TinyGPSPlus::libraryVersion()); + Serial.println(F("An extensive example of many interesting TinyGPSPlus features")); + Serial.print(F("Testing TinyGPSPlus library v. ")); Serial.println(TinyGPSPlus::libraryVersion()); Serial.println(F("by Mikal Hart")); Serial.println(); Serial.println(F("Sats HDOP Latitude Longitude Fix Date Time Date Alt Course Speed Card Distance Course Card Chars Sentences Checksum")); diff --git a/examples/KitchenSink/KitchenSink.ino b/examples/KitchenSink/KitchenSink.ino index d70ee61..3c64349 100644 --- a/examples/KitchenSink/KitchenSink.ino +++ b/examples/KitchenSink/KitchenSink.ino @@ -1,14 +1,14 @@ -#include +#include #include /* - This sample code demonstrates just about every built-in operation of TinyGPS++ (TinyGPSPlus). + This sample code demonstrates just about every built-in operation of TinyGPSPlus (TinyGPSPlus). It requires the use of SoftwareSerial, and assumes that you have a 4800-baud serial GPS device hooked up on pins 4(rx) and 3(tx). */ static const int RXPin = 4, TXPin = 3; static const uint32_t GPSBaud = 4800; -// The TinyGPS++ object +// The TinyGPSPlus object TinyGPSPlus gps; // The serial connection to the GPS device @@ -23,8 +23,8 @@ void setup() ss.begin(GPSBaud); Serial.println(F("KitchenSink.ino")); - Serial.println(F("Demonstrating nearly every feature of TinyGPS++")); - Serial.print(F("Testing TinyGPS++ library v. ")); Serial.println(TinyGPSPlus::libraryVersion()); + Serial.println(F("Demonstrating nearly every feature of TinyGPSPlus")); + Serial.print(F("Testing TinyGPSPlus library v. ")); Serial.println(TinyGPSPlus::libraryVersion()); Serial.println(F("by Mikal Hart")); Serial.println(); } diff --git a/examples/SatElevTracker/SatElevTracker.ino b/examples/SatElevTracker/SatElevTracker.ino index afc6d8a..eac7307 100644 --- a/examples/SatElevTracker/SatElevTracker.ino +++ b/examples/SatElevTracker/SatElevTracker.ino @@ -1,9 +1,9 @@ -#include +#include #include /* This sample code tracks satellite elevations using TinyGPSCustom objects. - Satellite numbers and elevations are not normally tracked by TinyGPS++, but + Satellite numbers and elevations are not normally tracked by TinyGPSPlus, but by using TinyGPSCustom we get around this. It requires the use of SoftwareSerial and assumes that you have a @@ -14,7 +14,7 @@ static const uint32_t GPSBaud = 4800; static const int MAX_SATELLITES = 40; static const int PAGE_LENGTH = 40; -// The TinyGPS++ object +// The TinyGPSPlus object TinyGPSPlus gps; // The serial connection to the GPS device @@ -40,7 +40,7 @@ void setup() Serial.println(F("SatElevTracker.ino")); Serial.println(F("Displays GPS satellite elevations as they change")); - Serial.print(F("Testing TinyGPS++ library v. ")); Serial.println(TinyGPSPlus::libraryVersion()); + Serial.print(F("Testing TinyGPSPlus library v. ")); Serial.println(TinyGPSPlus::libraryVersion()); Serial.println(F("by Mikal Hart")); Serial.println(); diff --git a/examples/SatElevTracker/sample_satellite_elevation_log.txt b/examples/SatElevTracker/sample_satellite_elevation_log.txt index 659fae9..1a2be7c 100644 --- a/examples/SatElevTracker/sample_satellite_elevation_log.txt +++ b/examples/SatElevTracker/sample_satellite_elevation_log.txt @@ -1,6 +1,6 @@ SatElevTracker.ino Displays GPS satellite elevations as they change -Testing TinyGPS++ library v. 1 +Testing TinyGPSPlus library v. 1 by Mikal Hart Time 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 diff --git a/examples/SatelliteTracker/SatelliteTracker.ino b/examples/SatelliteTracker/SatelliteTracker.ino index af78edd..c694de9 100644 --- a/examples/SatelliteTracker/SatelliteTracker.ino +++ b/examples/SatelliteTracker/SatelliteTracker.ino @@ -1,11 +1,11 @@ -#include +#include #include /* This sample code demonstrates how to use an array of TinyGPSCustom objects to monitor all the visible satellites. Satellite numbers, elevation, azimuth, and signal-to-noise ratio are not - normally tracked by TinyGPS++, but by using TinyGPSCustom we get around this. + normally tracked by TinyGPSPlus, but by using TinyGPSCustom we get around this. The simple code also demonstrates how to use arrays of TinyGPSCustom objects, each monitoring a different field of the $GPGSV sentence. @@ -16,7 +16,7 @@ static const int RXPin = 4, TXPin = 3; static const uint32_t GPSBaud = 4800; -// The TinyGPS++ object +// The TinyGPSPlus object TinyGPSPlus gps; // The serial connection to the GPS device @@ -70,7 +70,7 @@ void setup() Serial.println(F("SatelliteTracker.ino")); Serial.println(F("Monitoring satellite location and signal strength using TinyGPSCustom")); - Serial.print(F("Testing TinyGPS++ library v. ")); Serial.println(TinyGPSPlus::libraryVersion()); + Serial.print(F("Testing TinyGPSPlus library v. ")); Serial.println(TinyGPSPlus::libraryVersion()); Serial.println(F("by Mikal Hart")); Serial.println(); diff --git a/examples/UsingCustomFields/UsingCustomFields.ino b/examples/UsingCustomFields/UsingCustomFields.ino index d6cb568..6e00139 100644 --- a/examples/UsingCustomFields/UsingCustomFields.ino +++ b/examples/UsingCustomFields/UsingCustomFields.ino @@ -1,9 +1,9 @@ -#include +#include #include /* - This sample demonstrates TinyGPS++'s capacity for extracting custom - fields from any NMEA sentence. TinyGPS++ has built-in facilities for + This sample demonstrates TinyGPSPlus's capacity for extracting custom + fields from any NMEA sentence. TinyGPSPlus has built-in facilities for extracting latitude, longitude, altitude, etc., from the $GPGGA and $GPRMC sentences. But with the TinyGPSCustom type, you can extract other NMEA fields, even from non-standard NMEA sentences. @@ -14,7 +14,7 @@ static const int RXPin = 4, TXPin = 3; static const uint32_t GPSBaud = 4800; -// The TinyGPS++ object +// The TinyGPSPlus object TinyGPSPlus gps; // The serial connection to the GPS device @@ -45,7 +45,7 @@ void setup() Serial.println(F("UsingCustomFields.ino")); Serial.println(F("Demonstrating how to extract any NMEA field using TinyGPSCustom")); - Serial.print(F("Testing TinyGPS++ library v. ")); Serial.println(TinyGPSPlus::libraryVersion()); + Serial.print(F("Testing TinyGPSPlus library v. ")); Serial.println(TinyGPSPlus::libraryVersion()); Serial.println(F("by Mikal Hart")); Serial.println(); } diff --git a/keywords.txt b/keywords.txt index 91d119b..5c76379 100644 --- a/keywords.txt +++ b/keywords.txt @@ -1,5 +1,5 @@ ####################################### -# Syntax Coloring Map for TinyGPS++ +# Syntax Coloring Map for TinyGPSPlus ####################################### ####################################### diff --git a/library.json b/library.json index cb3da90..1c1db8d 100644 --- a/library.json +++ b/library.json @@ -1,6 +1,6 @@ { "name": "TinyGPSPlus", - "version": "1.0.2", + "version": "1.0.3", "keywords": "gps,NMEA", "description": "A new, customizable Arduino NMEA parsing library", "repository": diff --git a/library.properties b/library.properties index 2cf9799..ecd008c 100644 --- a/library.properties +++ b/library.properties @@ -1,9 +1,9 @@ -name=TinyGPS++ -version=1.0.2 +name=TinyGPSPlus +version=1.0.3 author=Mikal Hart maintainer=Mikal Hart -sentence=TinyGPS++ provides object-oriented parsing of GPS (NMEA) sentences -paragraph=NMEA is the standard format GPS devices use to report location, time, altitude, etc. TinyGPS++ is a compact, resilient library that parses the most common NMEA 'sentences' used: GGA and RMC. It can also be customized to extract data from *any* compliant sentence. +sentence=TinyGPSPlus provides object-oriented parsing of GPS (NMEA) sentences +paragraph=NMEA is the standard format GPS devices use to report location, time, altitude, etc. TinyGPSPlus is a compact, resilient library that parses the most common NMEA 'sentences' used: GGA and RMC. It can also be customized to extract data from *any* compliant sentence. category=Communication url=https://github.com/mikalhart/TinyGPSPlus architectures=* diff --git a/src/TinyGPSPlus.h b/src/TinyGPSPlus.h new file mode 100644 index 0000000..7adf0e7 --- /dev/null +++ b/src/TinyGPSPlus.h @@ -0,0 +1,26 @@ +/* +TinyGPSPlus - a small GPS library for Arduino providing universal NMEA parsing +Based on work by and "distanceBetween" and "courseTo" courtesy of Maarten Lamers. +Suggestion to add satellites, courseTo(), and cardinal() by Matt Monson. +Location precision improvements suggested by Wayne Holder. +Copyright (C) 2008-2013 Mikal Hart +All rights reserved. + +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. + +You should have received a copy of the GNU Lesser General Public +License along with this library; if not, write to the Free Software +Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#ifndef __TinyGPSPlus_h +#include "TinyGPS++.h" +#endif \ No newline at end of file