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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-gps-3.10.14.tar.gz
Algorithm Hash digest
SHA256 4a8964cd0677572ff6c9866a90f3a6be8165d99bfee97d9d5faec8e0ba9a2332
MD5 2e0b02f29129e6992580924b871b2d87
BLAKE2b-256 4557e8d906345c865e184eac9f37a388f0c352d79c004ee1a8fa593bc2d69018

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_gps-3.10.14-py3-none-any.whl
Algorithm Hash digest
SHA256 1aafb6fc5f3527b1fb7f6f11844f254e8a9064fe4ede003ffbed2eb63e776d40
MD5 54d2026e0a35759f5dabc0e67cd216c9
BLAKE2b-256 6ab54d39dec8e458be08b5adc53d904a72fbe0e6c14717f6bbe8d1fbed31c17e

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