SkyTEM BMAG / Mbed 2 deprecated BMAGThrRev

Bmag incl gps rettelse

Dependencies:   mbed WDT MODSERIAL BME280

Embed: (wiki syntax)

« Back to documentation index

NMEA Class Reference
Public Member Functions

NMEA Class Reference

An NMEA handler class. More...

#include <NMEA.h>

Public Member Functions

 NMEA ()
 NMEA, default constructor.
bool ValidateData (string cstStr)
 ValidateData, method taking a text string for NMEA validation.
void StoreString (string cstStr)
 StoreString, method taking a text string as argument for further handling.
void ParseCurrentUTCFromGPRMC (void)
 ParseCurrentUTCFromGPRMC, grabs UTC timestamp from current stored GPRMC string.
void ParseCurrentLatitudeFromGPRMC (void)
 ParseCurrentLatitudeFromGPRMC, grabs current latitude from current GPRMC string.
void ParseCurrentLongitudeFromGPRMC (void)
 ParseCurrentLongitudeFromGPRMC, grabs current longitude from current GPRMC string.
bool GGAFixVerification (void)
 GGAFixVerification, returns gps fix indication.
void getXFromNMEAString (int desiredCommaCount, string stringToParse)
 getXFromNMEAString, grabs desired data column from NMEA string, stores it for further manipulation in tmpStr
string getCurrentTime (void)
 getCurrentTime, getter method returning current time from gps

Detailed Description

An NMEA handler class.

This class is used to handle NMEA strings, from eg. a GPS device.

Definition at line 11 of file NMEA.h.

Constructor & Destructor Documentation

NMEA (  )

NMEA, default constructor.

Definition at line 4 of file NMEA.cpp.

Member Function Documentation

string getCurrentTime ( void   )

getCurrentTime, getter method returning current time from gps

Returns:
returns current time from gps in format "HH:MM:SS.FFF"

Definition at line 423 of file NMEA.cpp.

void getXFromNMEAString ( int  desiredCommaCount,
string  stringToParse 
)

getXFromNMEAString, grabs desired data column from NMEA string, stores it for further manipulation in tmpStr

Parameters:
desiredCommaCountinteger designating which column to store
stringToParsestring parameter containing the NMEA string.

Definition at line 392 of file NMEA.cpp.

bool GGAFixVerification ( void   )

GGAFixVerification, returns gps fix indication.

GGAFixVerification verifies gga fix status in current GGA string.

Returns:
boolean value indicating GGA fix if true, else false.

Definition at line 252 of file NMEA.cpp.

void ParseCurrentLatitudeFromGPRMC ( void   )

ParseCurrentLatitudeFromGPRMC, grabs current latitude from current GPRMC string.

Converts the latitude into decimaldegrees and stores the current latitude.

Definition at line 290 of file NMEA.cpp.

void ParseCurrentLongitudeFromGPRMC ( void   )

ParseCurrentLongitudeFromGPRMC, grabs current longitude from current GPRMC string.

Converts the longitude into decimaldegrees and stores the current longitude.

Definition at line 339 of file NMEA.cpp.

void ParseCurrentUTCFromGPRMC ( void   )

ParseCurrentUTCFromGPRMC, grabs UTC timestamp from current stored GPRMC string.

ParseCurrentUTCFromGPRMC, grabs UTC timestamp from current stored GPRMC string. Stores the UTC timestamp in local text string.

Depending on the format it will be saved as: HH:MM:SS.FFF In this case FFF are read values fom the string. eg. 14:10:22.007

or

HH:MM:SS.FFF In this case FFF are predetermined values set to 0. eg. 14:10:22.000

Definition at line 140 of file NMEA.cpp.

void StoreString ( string  cstStr )

StoreString, method taking a text string as argument for further handling.

StoreString, replaces current GPRMC or GGA string, with new valid GPRMC or GGA string.

Parameters:
cstStrAn NMEA ascii string.

Definition at line 94 of file NMEA.cpp.

bool ValidateData ( string  cstStr )

ValidateData, method taking a text string for NMEA validation.

ValidateData validates that the NMEA data string isn't corrupted. (Verification of crc)

Parameters:
cstStrAn NMEA ascii string.
Returns:
boolean return value, true if crc corresponds to own calculated crc, else false.

Definition at line 43 of file NMEA.cpp.

Generated on Wed Jul 13 2022 08:04:14 by  doxygen 1.7.2