qwiic_titan_gps.QwiicTitanGps Class Reference

QwiicTitanGps. More...

Inheritance diagram for qwiic_titan_gps.QwiicTitanGps:

Public Member Functions
def	__init__ (self, address=None, i2c_driver=None)
def	is_connected (self)
	Determine if a GPS device is connected to the system. More...
def	begin (self)
	Initialize the data transmission lines. More...
def	get_raw_data (self)
	This function pulls GPS data from the module 255 bytes at a time. More...
def	prepare_data (self)
	This function seperates raw GPS data from the module into sentences of GNSS data. More...
def	get_nmea_data (self)
	This function takes a list of GNSS sentences and uses the pynmea2 parser to parse the data. More...
def	feed_sentence (self, sentence)
	Feeds a NMEA sentence to the GPS parser one character at a time. More...
def	add_to_gnss_messages (self)
	This function takes parsed GNSS data and assigns them to the respective dictionary key. More...

Public Attributes
	address
	gps

Static Public Attributes
	device_name = _DEFAULT_NAME
	available_addresses = _AVAILABLE_I2C_ADDRESS
int	MAX_I2C_BUFFER = 32
int	MAX_GPS_BUFFER = 255
dictionary	gnss_messages

Properties
	connected = property(is_connected)

Detailed Description

QwiicTitanGps.

Parameters

address	The I2C address to use for the device. If not provided, the default address is used.
i2c_driver	An existing i2c driver object. If not provided a driver object is created.

Returns

Object The Qwiic Titan GPS device object.

Constructor & Destructor Documentation

__init__()

def qwiic_titan_gps.QwiicTitanGps.__init__	(		self,
			address = None,
			i2c_driver = None
	)

Member Function Documentation

add_to_gnss_messages()

def qwiic_titan_gps.QwiicTitanGps.add_to_gnss_messages

(

self

)

This function takes parsed GNSS data and assigns them to the respective dictionary key.

Returns

Boolean Returns True

begin()

def qwiic_titan_gps.QwiicTitanGps.begin

(

self

)

Initialize the data transmission lines.

Returns

boolean Returns True on success, False on failure

feed_sentence()

def qwiic_titan_gps.QwiicTitanGps.feed_sentence	(		self,
			sentence
	)

Feeds a NMEA sentence to the GPS parser one character at a time.

get_nmea_data()

def qwiic_titan_gps.QwiicTitanGps.get_nmea_data

(

self

)

This function takes a list of GNSS sentences and uses the pynmea2 parser to parse the data.

Returns

Boolean Returns True on success and False otherwise

get_raw_data()

def qwiic_titan_gps.QwiicTitanGps.get_raw_data

(

self

)

This function pulls GPS data from the module 255 bytes at a time.

Returns

String A string of all the GPS data.

is_connected()

def qwiic_titan_gps.QwiicTitanGps.is_connected

(

self

)

Determine if a GPS device is connected to the system.

Returns

bool True if the device is connected, otherwise False.

prepare_data()

def qwiic_titan_gps.QwiicTitanGps.prepare_data

(

self

)

This function seperates raw GPS data from the module into sentences of GNSS data.

Returns

List A list of all the gathered GPS data.

Member Data Documentation

address

qwiic_titan_gps.QwiicTitanGps.address

available_addresses

qwiic_titan_gps.QwiicTitanGps.available_addresses = _AVAILABLE_I2C_ADDRESS

static

device_name

qwiic_titan_gps.QwiicTitanGps.device_name = _DEFAULT_NAME

static

gnss_messages

dictionary qwiic_titan_gps.QwiicTitanGps.gnss_messages

static

Initial value:

=  {
        'Time'           : 0,
        'Latitude'       : 0,
        'Lat_Direction'  : "",
        'Longitude'      : 0,
        'Long_Direction' : "",
        'Altitude'       : 0,
        'Sat_Number'     : 0,
        'Geo_Separation' : 0,
    }

gps

qwiic_titan_gps.QwiicTitanGps.gps

MAX_GPS_BUFFER

int qwiic_titan_gps.QwiicTitanGps.MAX_GPS_BUFFER = 255

static

MAX_I2C_BUFFER

int qwiic_titan_gps.QwiicTitanGps.MAX_I2C_BUFFER = 32

static

Property Documentation

connected

qwiic_titan_gps.QwiicTitanGps.connected = property(is_connected)

static

---

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

• qwiic_titan_gps/qwiic_titan_gps.py