GNSS Class Reference

#include <GNSS-L86-M33-SOLDERED.h>

Inherits EasyC, and TinyGPSPlus.

Public Member Functions
	GNSS ()
	L86-M33 GNSS Library easyC constructor.
float	getLatitude ()
	Get the last measured latitude by the GPS module.
float	getLongitude ()
	Get the last measured longitude by the GPS module.
uint16_t	getYear ()
	Get the last measured year by the GPS module.
uint8_t	getMonth ()
	Get the last measured month by the GPS module.
uint8_t	getDay ()
	Get the last measured day by the GPS module.
uint8_t	getHour ()
	Get the last measured hour by the GPS module.
uint8_t	getMinute ()
	Get the last measured minute (in current hour) by the GPS module.
uint8_t	getSeconds ()
	Get the last measured seconds (in current minute) by the GPS module.
float	getSpeed ()
	Get the last measured speed by the GPS module.
float	getAltitude ()
	Get the last measured altitude by the GPS module.
uint32_t	getNumSatellites ()
	Get the number of GPS Satellites available.
float	getHDOP ()
	Get HDOP value (precision indicator of GPS)
uint32_t	getAge ()
	Get how long ago the last location was measured (in ms)
uint32_t	getDateTimeAge ()
	Get how long ago the last GPS DateTime was recorded (in ms)
float	getCourseDeg ()
	Get how long ago the last GPS DateTime was recorded (in ms)
uint32_t	getNumCharsProcessed ()
	Get the number of processed chars sent by the GPS module.
uint32_t	getNumSentencesWithFix ()
	Get the number of $GPRMC or $GPGGA sentences that had a fix.
uint32_t	getNumFailedChecksums ()
	Get the number of sentences of all types that failed the checksum test.
bool	GNSSAvailable ()
	Get if the GPS module has sucessfuly decoded some data.
void	setMultiToneAIC (bool _b)
	Turn Multi Tone AIC (Active Interference Cancellation) on or off.
void	setAlwaysLocate (bool _b)
	Turn AlwaysLocateTM mode on or off.
	GNSS (int _rx, int _tx)
	L86-M33 GNSS Library constructor.
void	sendCommand (char *_cmd)
	Sends a custom command to the GNSS module.
void	sendChecksum (char *_s)
	Sends a checksum to the GNSS module for the sent command.
char	intToHexChar (int _c)
	Converts a integer into one HEX Char (for 10 as input it will return 'A')
Public Member Functions inherited from EasyC
	EasyC ()
	Main constructor for easyC version.
bool	begin ()
	Initializes sensors on native or easyC on default address.
bool	begin (uint8_t _address)
	Initializes sensors on supplied i2c address.
virtual void	initializeNative ()=0
int	sendAddress (char regAddr)
	Private function to send a single byte to sensor.
int	readData (char a[], int n)
	Private function to read n bytes over i2c.
int	readRegister (char regAddr, char a[], size_t n)
	Private function to send over i2c and then read n bytes.
int	sendData (const uint8_t *a, int n)
	Private function to write n bytes over i2c.
Public Member Functions inherited from TinyGPSPlus
	TinyGPSPlus ()
bool	encode (char c)
TinyGPSPlus &	operator<< (char c)
uint32_t	charsProcessed () const
uint32_t	sentencesWithFix () const
uint32_t	failedChecksum () const
uint32_t	passedChecksum () const

Public Attributes
SoftwareSerial *	gnssSerial
Public Attributes inherited from EasyC
int	native = 0
bool	beginDone = 0
int	err
char	address
const char	defaultAddress = 0x30
Public Attributes inherited from TinyGPSPlus
TinyGPSLocation	location
TinyGPSDate	date
TinyGPSTime	time
TinyGPSSpeed	speed
TinyGPSCourse	course
TinyGPSAltitude	altitude
TinyGPSInteger	satellites
TinyGPSHDOP	hdop

Protected Member Functions
void	initializeNative ()
	Initializer function for L86-M33 breakout board.

Private Attributes
int	rxPin
int	txPin

Additional Inherited Members
Static Public Member Functions inherited from TinyGPSPlus
static const char *	libraryVersion ()
static double	distanceBetween (double lat1, double long1, double lat2, double long2)
static double	courseTo (double lat1, double long1, double lat2, double long2)
static const char *	cardinal (double course)
static int32_t	parseDecimal (const char *term)
static void	parseDegrees (const char *term, RawDegrees &deg)

Constructor & Destructor Documentation

GNSS() [1/2]

GNSS::GNSS

(

)

L86-M33 GNSS Library easyC constructor.

GNSS() [2/2]

GNSS::GNSS	(	int	_rx,
		int	_tx
	)

L86-M33 GNSS Library constructor.

Parameters

int	_rx UART receive data pin (connected to the TX data pin on GNSS module)
int	_tx UART transmit data pin (connected to the RX data pin on GNSS module)

Member Function Documentation

getAge()

uint32_t GNSS::getAge

(

)

Get how long ago the last location was measured (in ms)

Returns

uint32_t number of ms since last DateTime

getAltitude()

float GNSS::getAltitude

(

)

Get the last measured altitude by the GPS module.

Returns

float value of the altitude in meters

getCourseDeg()

float GNSS::getCourseDeg

(

)

Get how long ago the last GPS DateTime was recorded (in ms)

Returns

uint32_t number of ms since last DateTime

getDateTimeAge()

uint32_t GNSS::getDateTimeAge

(

)

Get how long ago the last GPS DateTime was recorded (in ms)

Returns

uint32_t number of ms since last DateTime

getDay()

uint8_t GNSS::getDay

(

)

Get the last measured day by the GPS module.

Returns

uint8_t value of the day

getHDOP()

float GNSS::getHDOP

(

)

Get HDOP value (precision indicator of GPS)

Returns

float value of HDOP

getHour()

uint8_t GNSS::getHour

(

)

Get the last measured hour by the GPS module.

Returns

uint8_t value of the hour

getLatitude()

float GNSS::getLatitude

(

)

Get the last measured latitude by the GPS module.

Returns

float value of the latitude

getLongitude()

float GNSS::getLongitude

(

)

Get the last measured longitude by the GPS module.

Returns

float value of the longitude

getMinute()

uint8_t GNSS::getMinute

(

)

Get the last measured minute (in current hour) by the GPS module.

Returns

uint8_t value of the minute

getMonth()

uint8_t GNSS::getMonth

(

)

Get the last measured month by the GPS module.

Returns

uint8_t value of the month

getNumCharsProcessed()

uint32_t GNSS::getNumCharsProcessed

(

)

Get the number of processed chars sent by the GPS module.

Returns

uint32_t number of processed chars

getNumFailedChecksums()

uint32_t GNSS::getNumFailedChecksums

(

)

Get the number of sentences of all types that failed the checksum test.

Returns

uint32_t number of sentences of all types that failed the checksum test

getNumSatellites()

uint32_t GNSS::getNumSatellites

(

)

Get the number of GPS Satellites available.

Returns

uint32_t value of the number of Satellites available

getNumSentencesWithFix()

uint32_t GNSS::getNumSentencesWithFix

(

)

Get the number of $GPRMC or $GPGGA sentences that had a fix.

Returns

uint32_t number of sentences that had a fix

getSeconds()

uint8_t GNSS::getSeconds

(

)

Get the last measured seconds (in current minute) by the GPS module.

Returns

float value of the seconds

getSpeed()

float GNSS::getSpeed

(

)

Get the last measured speed by the GPS module.

Returns

float value of the speed

getYear()

uint16_t GNSS::getYear

(

)

Get the last measured year by the GPS module.

Returns

uint16_t value of the year

GNSSAvailable()

bool GNSS::GNSSAvailable

(

)

Get if the GPS module has sucessfuly decoded some data.

Returns

bool true if yes, false if no

initializeNative()

void GNSS::initializeNative ( )

protectedvirtual

Initializer function for L86-M33 breakout board.

Implements EasyC.

intToHexChar()

char GNSS::intToHexChar

(

int

_c

)

Converts a integer into one HEX Char (for 10 as input it will return 'A')

Parameters

int	_c Integer that needs to be converted into HEX Char

Returns

char HEX Char (for 10 as input, result will be char 'A')

sendChecksum()

void GNSS::sendChecksum

(

char *

_s

)

Sends a checksum to the GNSS module for the sent command.

Parameters

char	*_s Command string

Note

There must be no checksum at the end of the command. It will be calculated and added automatically.

sendCommand()

void GNSS::sendCommand

(

char *

_cmd

)

Sends a custom command to the GNSS module.

Parameters

char	*_cmd Command string

Note

There must be no checksum at the end of the command. It will be calculated and added automatically.

setAlwaysLocate()

void GNSS::setAlwaysLocate

(

bool

_b

)

Turn AlwaysLocateTM mode on or off.

Parameters

_b	True if it's to be turned on, false to turn off

Returns

None

setMultiToneAIC()

void GNSS::setMultiToneAIC

(

bool

_b

)

Turn Multi Tone AIC (Active Interference Cancellation) on or off.

Parameters

_b	True if it's to be turned on, false to turn off

Returns

None

Member Data Documentation

gnssSerial

SoftwareSerial* GNSS::gnssSerial

rxPin

int GNSS::rxPin

private

txPin

int GNSS::txPin

private

---

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

• GNSS-L86-M33-SOLDERED.h
• GNSS-L86-M33-SOLDERED.cpp