Library for EM-406 and MTK3339 GPS modules (NMEA), using UART communication.

Dependents:   Sparkfun_GPS_Shield My_GPS Teste_GPS_luis STM32L152RE ... more

Fork of SerialGPS by Components

Files at this revision

API Documentation at this revision

Comitter:
screamer
Date:
Wed May 07 07:22:16 2014 +0000
Parent:
2:2b6832d3328b
Commit message:
Rename GPS to SerialGPS interface

Changed in this revision

GPS.cpp Show diff for this revision Revisions of this file
GPS.h Show diff for this revision Revisions of this file
SerialGPS.cpp Show annotated file Show diff for this revision Revisions of this file
SerialGPS.h Show annotated file Show diff for this revision Revisions of this file
--- a/GPS.cpp	Wed May 07 07:04:51 2014 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,91 +0,0 @@
-/* mbed GPS Module Library
- * Copyright (c) 2008-2010, sford
- * Copyright (c) 2013, B.Adryan
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- */
- 
-#include "GPS.h"
-
-GPS::GPS(PinName tx, PinName rx, int Baud) : _gps(tx, rx) {
-    _gps.baud(Baud);    
-    longitude = 0.0;
-    latitude = 0.0;        
-}
-
-int GPS::sample() {
-    char ns, ew, unit;
-    int lock;
-
-    while(1) {        
-        getline();
-
-        // Check if it is a GPGGA msg (matches both locked and non-locked msg)
-        if(sscanf(msg, "GPGGA,%f,%f,%c,%f,%c,%d,%d,%f,%f,%c,%f", &time, &latitude, &ns, &longitude, &ew, &lock, &sats, &hdop, &alt, &unit, &geoid) >= 1) { 
-            if(!lock) {
-                time = 0.0;
-                longitude = 0.0;
-                latitude = 0.0;
-                sats = 0;
-                hdop = 0.0;
-                alt = 0.0;
-                geoid = 0.0;        
-                return 0;
-            } else {
-                //GPGGA format according http://aprs.gids.nl/nmea/#gga
-                // time (float), lat (f), (N/S) (c), long (f), (E/W) (c), fix (d), sats (d),
-                // hdop (float), altitude (float), M, geoid (float), M, , ,  
-                //GPGGA,092010.000,5210.9546,N,00008.8913,E,1,07,1.3,9.7,M,47.0,M,,0000*5D
-                
-                if(ns == 'S') {    latitude  *= -1.0; }
-                if(ew == 'W') {    longitude *= -1.0; }
-                float degrees = trunc(latitude / 100.0f);
-                float minutes = latitude - (degrees * 100.0f);
-                latitude = degrees + minutes / 60.0f;    
-                degrees = trunc(longitude / 100.0f * 0.01f);
-                minutes = longitude - (degrees * 100.0f);
-                longitude = degrees + minutes / 60.0f;
-                return 1;
-            }
-        }
-    }
-}
-
-float GPS::trunc(float v) {
-    if(v < 0.0) {
-        v*= -1.0;
-        v = floor(v);
-        v*=-1.0;
-    } else {
-        v = floor(v);
-    }
-    return v;
-}
-
-void GPS::getline() {
-    while(_gps.getc() != '$');    // wait for the start of a line
-    for(int i=0; i<256; i++) {
-        msg[i] = _gps.getc();
-        if(msg[i] == '\r') {
-            msg[i] = 0;
-            return;
-        }
-    }
-    error("Overflowed message limit");
-}
\ No newline at end of file
--- a/GPS.h	Wed May 07 07:04:51 2014 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,80 +0,0 @@
-/* mbed GPS Module Library
- * Copyright (c) 2008-2010, sford
- * Copyright (c) 2013, B.Adryan
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- */
-
-#include "mbed.h"
-
-#ifndef MBED_GPS_H
-#define MBED_GPS_H
-
-/**  A GPS interface for reading from a serial GPS module */
-class GPS {
-public:
-
-    /** Create the GPS interface, connected to the specified serial port and speed.
-     *  for example, GlobalSat EM406-A (e.g. on SparkFun GPS Shield) is 4800 Baud,
-     *  Adafruit Ultimate GPSv3 (connected to serial) is 9600 Baud
-     */    
-    GPS(PinName tx, PinName rx, int Baud);
-    
-    /** Sample the incoming GPS data, returning whether there is a lock
-     * 
-     * @return 1 if there was a lock when the sample was taken (and therefore .longitude and .latitude are valid), else 0
-     */
-    int sample();
-    
-    /** The longitude (call sample() to set) */
-    float longitude;
-
-    /** The latitude (call sample() to set) */
-    float latitude;
-    
-    /** The time (call sample() to set) */
-    float time;
-    
-    /** Number of satellites received (call sample() to set) */
-    int sats;
-    
-    /** Horizontal dilusion of precision (call sample() to set) */
-    float hdop;
-    
-    /** The altitude (call sample() to set)
-     *  Note that the accurate altitude is corrected by the geoid
-     *  See http://homepages.slingshot.co.nz/~geoff36/datum.htm
-     */
-    float alt;
-    
-    /** The geoid (call sample() to set) */
-    float  geoid;
-    
-    /** The NMEA sentence */
-    char msg[256];
-    
-    
-private:
-    float trunc(float v);
-    void getline();
-    
-    Serial _gps;
-};
-
-#endif
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/SerialGPS.cpp	Wed May 07 07:22:16 2014 +0000
@@ -0,0 +1,92 @@
+/* mbed GPS Module Library
+ * Copyright (c) 2008-2010, sford
+ * Copyright (c) 2013, B.Adryan
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+ 
+#include "SerialGPS.h"
+
+SerialGPS::SerialGPS(PinName tx, PinName rx, int Baud) : _gps(tx, rx) {
+    _gps.baud(Baud);    
+    longitude = 0.0;
+    latitude = 0.0;        
+}
+
+int SerialGPS::sample() {
+    char ns, ew, unit;
+    int lock;
+
+    while(1) {        
+        getline();
+
+        // Check if it is a GPGGA msg (matches both locked and non-locked msg)
+        if(sscanf(msg, "GPGGA,%f,%f,%c,%f,%c,%d,%d,%f,%f,%c,%f", &time, &latitude, &ns, &longitude, &ew, &lock, &sats, &hdop, &alt, &unit, &geoid) >= 1) { 
+            if(!lock) {
+                time = 0.0;
+                longitude = 0.0;
+                latitude = 0.0;
+                sats = 0;
+                hdop = 0.0;
+                alt = 0.0;
+                geoid = 0.0;        
+                return 0;
+            } else {
+                //GPGGA format according http://aprs.gids.nl/nmea/#gga
+                // time (float), lat (f), (N/S) (c), long (f), (E/W) (c), fix (d), sats (d),
+                // hdop (float), altitude (float), M, geoid (float), M, , ,  
+                //GPGGA,092010.000,5210.9546,N,00008.8913,E,1,07,1.3,9.7,M,47.0,M,,0000*5D
+                
+                if(ns == 'S') {    latitude  *= -1.0; }
+                if(ew == 'W') {    longitude *= -1.0; }
+                float degrees = trunc(latitude / 100.0f);
+                float minutes = latitude - (degrees * 100.0f);
+                latitude = degrees + minutes / 60.0f;    
+                degrees = trunc(longitude / 100.0f * 0.01f);
+                minutes = longitude - (degrees * 100.0f);
+                longitude = degrees + minutes / 60.0f;
+                return 1;
+            }
+        }
+    }
+}
+
+float SerialGPS::trunc(float v) {
+    if(v < 0.0) {
+        v*= -1.0;
+        v = floor(v);
+        v*=-1.0;
+    } else {
+        v = floor(v);
+    }
+    return v;
+}
+
+void SerialGPS::getline() {
+    while(_gps.getc() != '$');    // wait for the start of a line
+
+    for(int i=0; i<256; i++) {
+        msg[i] = _gps.getc();
+        if(msg[i] == '\r') {
+            msg[i] = 0;
+            return;
+        }
+    }
+    error("Overflowed message limit");
+}
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/SerialGPS.h	Wed May 07 07:22:16 2014 +0000
@@ -0,0 +1,80 @@
+/* mbed GPS Module Library
+ * Copyright (c) 2008-2010, sford
+ * Copyright (c) 2013, B.Adryan
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "mbed.h"
+
+#ifndef MBED_GPS_H
+#define MBED_GPS_H
+
+/**  A SerialGPS interface for reading from a serial GPS module */
+class SerialGPS {
+public:
+
+    /** Create the SerialGPS interface, connected to the specified serial port and speed.
+     *  for example, GlobalSat EM406-A (e.g. on SparkFun GPS Shield) is 4800 Baud,
+     *  Adafruit Ultimate GPSv3 (connected to serial) is 9600 Baud
+     */    
+    SerialGPS(PinName tx, PinName rx, int Baud);
+    
+    /** Sample the incoming GPS data, returning whether there is a lock
+     * 
+     * @return 1 if there was a lock when the sample was taken (and therefore .longitude and .latitude are valid), else 0
+     */
+    int sample();
+    
+    /** The longitude (call sample() to set) */
+    float longitude;
+
+    /** The latitude (call sample() to set) */
+    float latitude;
+    
+    /** The time (call sample() to set) */
+    float time;
+    
+    /** Number of satellites received (call sample() to set) */
+    int sats;
+    
+    /** Horizontal dilusion of precision (call sample() to set) */
+    float hdop;
+    
+    /** The altitude (call sample() to set)
+     *  Note that the accurate altitude is corrected by the geoid
+     *  See http://homepages.slingshot.co.nz/~geoff36/datum.htm
+     */
+    float alt;
+    
+    /** The geoid (call sample() to set) */
+    float  geoid;
+    
+    /** The NMEA sentence */
+    char msg[256];
+    
+    
+private:
+    float trunc(float v);
+    void getline();
+    
+    Serial _gps;
+};
+
+#endif
\ No newline at end of file