pynmeaparser 1.0.0

A package to parse general form of NMEA sentences. It is not specific to just certain devices only.

pyNMEAParser

A package to parse general form of NMEA sentences. It is not specific to just certain devices only. After successfully parsing an NMEA data, it will return a list of fields in the NMEA sentence.

API

NMEAParser()

Description: The constructor for NMEAParser class.

Returns: NMEAParser object.

# Create NMEAParser object
parser = NMEAParser()

---

add_handler(id:str, fn:Callable)

Description: Attach a handler function to be called when id matches the key.

Parameters:

id: A string representing the key.

fn: The handler function of which will be called if id matches the key. The function needs to accept a list as a parameter.

def my_handler(fields):
    print(fields)


parser.add_handler('GPGGA', my_handler)

---

process(sentence:str)

Description: Process the string passed to the function. This string will be concatenated with the previously incomplete processed string.

Parameters:

sentence: NMEA string format. This can be an arbitrary data, but needs to adhere to NMEA standard.

# Process an NMEA string
parser.process('$GPZDA,024008.97,24,11,2022,00,00*62')
parser.process('$MY_OWN,SOME,DATA,HERE*2F') # Can be arbitrary as long as adhering to NMEA standard.

---

get_buffer()

Description: Process the string passed to the function. This string will be concatenated with the previously incomplete processed string.

Returns: The string currently in the buffer.

print('Unprocessed string:', parser.get_buffer()) # Display the string that is still not processed.

Usage

Examples

Simple parse

from pynmeaparser import NMEAParser

def my_handler(fields):
    print(fields)

parser = NMEAParser() # Create parser object
parser.add_handler('GPZDA', handler) # Add handler. The handler function will be called if the first field contains the key.
parser.process('$GPZDA,024008.97,24,11,2022,00,00*62') # Process NMEA string here.
# Output: ['GPZDA', '024008.97', '24', '11', '2022', '00', '00']