Skip to main content

CircuitPython library for GPS modules.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

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

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-gps-3.10.2.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-gps-3.10.2.tar.gz
Algorithm Hash digest
SHA256 bb13d88e75088905c844561501c980a804f4bb1924292b75dfd61188918c2ed7
MD5 a204a7d5fb2e94b1caff3f04cab91369
BLAKE2b-256 89c70f6d4e771669e5559f10cafcab8c4f1e0e6e675e80bcf048cce3e15b2cfb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_gps-3.10.2-py3-none-any.whl
Algorithm Hash digest
SHA256 77d77c2c14816e5519e1c8f26c3e3fea3e6ccfd19bed042e1497376c8055094b
MD5 5cb679e318fa48537e6b0a443fd55096
BLAKE2b-256 6a41b148133cfded09d62368ce001e9406479a9f8bc7babb6f2cf6b2799841ee

See more details on using hashes here.

Supported by

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