AssetTrackerRK
Public Member Functions | Static Public Member Functions | Friends
TinyGPSPlus Class Reference

#include <TinyGPS++.h>

Inheritance diagram for TinyGPSPlus:
TinyGPSData

Public Member Functions

 TinyGPSPlus ()
 Constructor.
 
bool encode (char c)
 Encode one character of data from the GPS. More...
 
TinyGPSPlusoperator<< (char c)
 operator<< can be used instead of encode
 
uint32_t charsProcessed () const
 Return the number of characters processed.
 
uint32_t sentencesWithFix () const
 Return the number of GPS sentences parsed with a GPS fix.
 
uint32_t failedChecksum () const
 Return the number of sentences that had a failed checksum.
 
uint32_t passedChecksum () const
 Return the number of sentences with a valid checksum.
 
- Public Member Functions inherited from TinyGPSData
TinyGPSLocation getLocation () const
 Get the location (latitude and longitude)
 
TinyGPSDate getDate () const
 Get the date (year, month, day of month)
 
TinyGPSTime getTime () const
 Get the time (hour, minute, second, centisecond)
 
TinyGPSSpeed getSpeed () const
 Get the speed.
 
TinyGPSCourse getCourse () const
 Get the course.
 
TinyGPSAltitude getAltitude () const
 Get the altitude.
 
TinyGPSAltitude getGeoidSeparation () const
 Get the Geo ID separation. More...
 
TinyGPSInteger getSatellites () const
 Get the number of satellites.
 
TinyGPSDecimal getHDOP () const
 Get the HDOP. More...
 
void copyDataTo (TinyGPSData &other) const
 Copy the data in this object to another object, atomically. More...
 

Static Public Member Functions

static const char * libraryVersion ()
 Returns the version of the TinyGPS++ library.
 
static double distanceBetween (double lat1, double long1, double lat2, double long2)
 Utility to calculate the distance between two locations.
 
static double courseTo (double lat1, double long1, double lat2, double long2)
 Utility to calculate the course angle between two locations.
 
static const char * cardinal (double course)
 Given a course in degrees, returns a cardinal (N, NNE, NE, etc.)
 
static int32_t parseDecimal (const char *term)
 Used internally to parse a GPS decimal value.
 
static void parseDegrees (const char *term, RawDegrees &deg)
 Used internally to parse a GPS degress value.
 

Friends

class TinyGPSCustom
 

Additional Inherited Members

- Data Fields inherited from TinyGPSData
TinyGPSLocation location
 Location (latitude and longitude) More...
 
TinyGPSDate date
 Get the date (year, month, day of month) More...
 
TinyGPSTime time
 Get the time (hour, minute, second, centisecond) More...
 
TinyGPSSpeed speed
 Get the speed. More...
 
TinyGPSCourse course
 Get the course (direction of travel) More...
 
TinyGPSAltitude altitude
 While this field is public, you should instead use getAltitude(). In multi-threaded mode, accessing this field directly is not safe, but for backward compatibility this field remains public.
 
TinyGPSAltitude geoidSeparation
 Get the Geo ID separation. More...
 
TinyGPSInteger satellites
 Get the number of satellites. More...
 
TinyGPSDecimal hdop
 Get the HDOP. More...
 

Detailed Description

Class to parse GPS data and maintain the current state

You typically instantiate one of these per application as a global variable. There is one embedded in the AssetTracker class

Member Function Documentation

◆ encode()

bool TinyGPSPlus::encode ( char  c)

Encode one character of data from the GPS.

Typically you read from serial and call the encode() method. Note that you should empty the serial buffer, not just parse one character per loop!

Returns true if a full sentence was just parsed


The documentation for this class was generated from the following files: