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.7.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.7-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_gps-3.11.7.tar.gz
Algorithm Hash digest
SHA256 5a35b0ee7c7ec8e072822b1797f8f59d0df5f9e1c8e9457c55acb7451eac18b1
MD5 7eb48a6ad215db9d6ffe82f1aa346ac4
BLAKE2b-256 a349e786f6fdc49b27b73d37595ace1a65fe17b5947089c0395429b5543abdd5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_gps-3.11.7-py3-none-any.whl
Algorithm Hash digest
SHA256 875695732974d82e618fb045395ec37c86b0ea3eed8567abd3ba64c96967fafb
MD5 42ebfe64d4aa87689af0bd82312dc6f6
BLAKE2b-256 64843f242d1cdf295e7b0d423a9a9a820d6d82a40ecf6ce71eccd15f7eda7222

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