MTK3339Sensor Class Reference

Implementation of the Adafruit MTK3339 GPS sensor. More...

#include <MTK3339Sensor.h>

Inheritance diagram for MTK3339Sensor:

Collaboration diagram for MTK3339Sensor:

Public Member Functions
	MTK3339Sensor ()
	Default constructor for the MTK3339Sensor, sets minimum_period to 0 ms.
	MTK3339Sensor (unsigned long minimum_period)
	Constructor for the MTK3339Sensor.
bool	verify () override
	Verifies if the sensor is connected and working.
String	readData () override
	Reads and returns data from the MTK3339 GPS corresponding to the CSV header.
void	readDataPacket (uint8_t *&packet) override
	Appends the MTK3339 sensor data to the packet buffer as raw bytes.
String	decodeToCSV (uint8_t *&packet) override
	Decodes the MTK3339 sensor data from the packet buffer into a CSV string.
Public Member Functions inherited from Sensor
	Sensor (String sensor_name, String csv_header, unsigned long minimum_period)
	Sensor (String sensor_name, String csv_header)
	Sensor (String sensor_name, String csv_header, int fields)
	Construct a new Sensor object with default minimum_period of 0 (depreciated)
	Sensor (String sensor_name, String csv_header, int fields, unsigned long minimum_period)
	Construct a new Sensor object (Depreciated)
unsigned long	getPeriod () const
	Get the minimum minimum_period between sensor reads in ms.
void	setPeriod (int minimum_period)
	Set the minimum minimum_period between sensor reads in ms.
unsigned long	getLastExecution () const
	Get the system time of the last execution in ms.
void	setLastExecution (int last_execution)
	Set the system time of the last execution in ms.
const String &	getSensorCSVHeader () const
	Get the csv header string associated with this sensor.
void	getDataPacket (uint32_t &sensor_id, uint8_t *&packet)
	Append the data from a sensor to the packet if the minium period is satisfied.
String	readEmpty () const
	Returns CSV line in the same format as readData() but with "-" instead of data.
String	getDataCSV ()
	Uses readData and readEmpty to get the data-filled or empty-celled CSV line for the sensor.
Public Member Functions inherited from Device
	Device (String device_name)
	Default constructor, sets a max_attempt of 1 (device recovery won't be attempted)
	Device (String device_name, int max_attempts, int wait_factor)
const String &	getDeviceName ()
bool	getVerified ()
	Get if the Device is Verified.
void	recoveryConfig (int max_attempts, int wait_factor)
	Set recovery config (used keep default constructor)
void	setWaitFactor (int wait_factor)
	Set wait_factor.
void	setMaxAttempts (int max_attempts)
	Set max_attempts.
bool	attemptConnection ()
	If the sensor is verified, return true, if not and it has been long enough since the last attempt (decided by wait_factor and attempt_number), attempt to reverify (reinitialize) it.

Private Attributes
SFE_UBLOX_GNSS	GPS

Additional Inherited Members
Protected Attributes inherited from Sensor
int	num_fields
Protected Attributes inherited from Device
bool	verified
String	device_name

Detailed Description

Implementation of the Adafruit MTK3339 GPS sensor.

Constructor & Destructor Documentation

MTK3339Sensor() [1/2]

MTK3339Sensor::MTK3339Sensor

(

)

Default constructor for the MTK3339Sensor, sets minimum_period to 0 ms.

MTK3339Sensor() [2/2]

MTK3339Sensor::MTK3339Sensor

(

unsigned long

minimum_period

)

Constructor for the MTK3339Sensor.

Parameters

minimum_period

Minimum period between sensor reads in ms

Member Function Documentation

decodeToCSV()

String MTK3339Sensor::decodeToCSV ( uint8_t *&  packet )

overridevirtual

Decodes the MTK3339 sensor data from the packet buffer into a CSV string.

The data are read in the same order they were written and reconstructed as a string "day/month/year" and the remaining fields are appended as CSV values.

Parameters

packet

Pointer to the packet byte array and this packet pointer is incremented.

Returns

String The decoded sensor data in CSV format.

Reimplemented from Sensor.

readData()

String MTK3339Sensor::readData ( )

overridevirtual

Reads and returns data from the MTK3339 GPS corresponding to the CSV header.

Returns

String CSV segment in form of Date, Latitude, Longitude, Speed, Angle, Altitude, Satellites,

Implements Sensor.

Here is the call graph for this function:

readDataPacket()

void MTK3339Sensor::readDataPacket ( uint8_t *&  packet )

overridevirtual

Appends the MTK3339 sensor data to the packet buffer as raw bytes.

The following data are appended in order:

• Date: day (uint8_t), month (uint8_t), year (uint16_t)
• Latitude (float)
• Longitude (float)
• Speed (float)
• Angle (float)
• Altitude (float)
• Satellites (uint8_t)

If no valid fix is available, default value (0) is appended for all fields.

Parameters

packet

Pointer to the packet byte array. This pointer is incremented as each value is copied.

Reimplemented from Sensor.

verify()

bool MTK3339Sensor::verify ( )

overridevirtual

Verifies if the sensor is connected and working.

Returns

true if it is connected and working

false if it is not connected and working

Implements Sensor.

Member Data Documentation

GPS

SFE_UBLOX_GNSS MTK3339Sensor::GPS

private

---

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

• MTK3339Sensor.h
• MTK3339Sensor.cpp