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.3.tar.gz (41.1 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_gps-3.11.3.tar.gz
Algorithm Hash digest
SHA256 dfef2de6ac794ec791cc9057c64f4d22ba3e0f2f89e56da0096d2602a741f4e8
MD5 8fe7ce12e6cf99f730311012648ba1ca
BLAKE2b-256 d94433034601b55913d05868f282be9e9369c42a31924847650f62102f06b3f5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_gps-3.11.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a55f8d0e9d0a9b73a573a665feca7a6590f21453289220d0bfaf28af94ba8c1c
MD5 c75003460ab3518d0210f99b54f759f2
BLAKE2b-256 4737f2c337c45027c5ab57d182d3c913d210d94a75d86899a858a294abda2715

See more details on using hashes here.

Supported by

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