Skip to main content

CircuitPython library for GPS modules.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

GPS parsing module. Can send commands to, and parse simple NMEA data sentences from serial and I2C GPS modules to read latitude, longitude, and more.

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-gps

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-gps

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-gps

Usage Example

See examples/gps_simpletest.py for a demonstration of parsing and printing GPS location.

Important: Feather boards and many other circuitpython boards will round to two decimal places like this:

>>> float('1234.5678')
1234.57

This isn’t ideal for GPS data as this lowers the accuracy from 0.1m to 11m.

This can be fixed by using string formatting when the GPS data is output.

An implementation of this can be found in examples/gps_simpletest.py

import time
import board
import busio

import adafruit_gps

RX = board.RX
TX = board.TX

uart = busio.UART(TX, RX, baudrate=9600, timeout=30)

gps = adafruit_gps.GPS(uart, debug=False)

gps.send_command(b'PMTK314,0,1,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0')

gps.send_command(b'PMTK220,1000')

last_print = time.monotonic()
while True:

    gps.update()

    current = time.monotonic()
    if current - last_print >= 1.0:
        last_print = current
        if not gps.has_fix:
            print('Waiting for fix...')
            continue
        print('=' * 40)  # Print a separator line.
        print('Latitude: {0:.6f} degrees'.format(gps.latitude))
        print('Longitude: {0:.6f} degrees'.format(gps.longitude))

These two lines are the lines that actually solve the issue:

print('Latitude: {0:.6f} degrees'.format(gps.latitude))
print('Longitude: {0:.6f} degrees'.format(gps.longitude))

Note: Sending multiple PMTK314 packets with gps.send_command() will not work unless there is a substantial amount of time in-between each time gps.send_command() is called. A time.sleep() of 1 second or more should fix this.

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_circuitpython_gps-3.11.6.tar.gz (41.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

adafruit_circuitpython_gps-3.11.6-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

Details for the file adafruit_circuitpython_gps-3.11.6.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_gps-3.11.6.tar.gz
Algorithm Hash digest
SHA256 39e5029990db01d3548a911b31f004330b2a37c5798e82abe79083f363b5942d
MD5 45e6672c76c25f123d3319552358ae0f
BLAKE2b-256 65778765ab2bce45b8c7208d177c88bdd08a2e46441b47eebf9a463116fc4068

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_gps-3.11.6-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_gps-3.11.6-py3-none-any.whl
Algorithm Hash digest
SHA256 61ed61d56a353f2cbfcc3bd14a8ccbbd124b95cebf07821d1b52d7fd605f1015
MD5 41ea520069328e32c5092ff1a73bb2ef
BLAKE2b-256 3ea2ef1b8e53a2e6a42bae62b97da0b6754c217ececde12fea2f5dffe3eebb12

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page