Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-gps/badge/?version=latest
:target: https://docs.circuitpython.org/projects/gps/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_GPS/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_GPS/actions/
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: 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:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-gps/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-gps
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-gps
To install in a virtual environment in your current project:
.. code-block:: shell
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:
.. code-block:: python
>>> 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
.. code-block:: python
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:
.. code-block:: python
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 <https://docs.circuitpython.org/projects/gps/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_gps/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-gps",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, gps, module, latitude, longitude, breakout, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/f3/65/928e48654b38a4e9067f68493bb6d62b4e94caae141e2cb85ff6bd20f3f3/adafruit_circuitpython_gps-3.11.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-gps/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/gps/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_GPS/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_GPS/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nGPS parsing module. Can send commands to, and parse simple NMEA data sentences\nfrom serial and I2C GPS modules to read latitude, longitude, and more.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-gps/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-gps\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-gps\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-gps\n\nUsage Example\n=============\n\nSee examples/gps_simpletest.py for a demonstration of parsing and printing GPS location.\n\nImportant:\nFeather boards and many other circuitpython boards will round to two decimal places like this:\n\n.. code-block:: python\n\n >>> float('1234.5678')\n 1234.57\n\nThis isn't ideal for GPS data as this lowers the accuracy from 0.1m to 11m.\n\nThis can be fixed by using string formatting when the GPS data is output.\n\nAn implementation of this can be found in examples/gps_simpletest.py\n\n.. code-block:: python\n\n import time\n import board\n import busio\n\n import adafruit_gps\n\n RX = board.RX\n TX = board.TX\n\n uart = busio.UART(TX, RX, baudrate=9600, timeout=30)\n\n gps = adafruit_gps.GPS(uart, debug=False)\n\n gps.send_command(b'PMTK314,0,1,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0')\n\n gps.send_command(b'PMTK220,1000')\n\n last_print = time.monotonic()\n while True:\n\n gps.update()\n\n current = time.monotonic()\n if current - last_print >= 1.0:\n last_print = current\n if not gps.has_fix:\n print('Waiting for fix...')\n continue\n print('=' * 40) # Print a separator line.\n print('Latitude: {0:.6f} degrees'.format(gps.latitude))\n print('Longitude: {0:.6f} degrees'.format(gps.longitude))\n\n\nThese two lines are the lines that actually solve the issue:\n\n.. code-block:: python\n\n print('Latitude: {0:.6f} degrees'.format(gps.latitude))\n print('Longitude: {0:.6f} degrees'.format(gps.longitude))\n\n\nNote: Sending multiple PMTK314 packets with ``gps.send_command()`` will not\nwork unless there is a substantial amount of time in-between each time\n``gps.send_command()`` is called. A ``time.sleep()`` of 1 second or more\nshould fix this.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/gps/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_gps/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for GPS modules.",
"version": "3.11.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_GPS"
},
"split_keywords": [
"adafruit",
" gps",
" module",
" latitude",
" longitude",
" breakout",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5172962e06281d9e1ee4754e2c8c393b400ad79a21fe05520a1fd174e646ed50",
"md5": "bdf883b531e65001cbbd4403452eb17b",
"sha256": "88e69d5f6a4d83544a5f3b89d33f6fcd4b7ba34b6ec9e602f363d0412f3803f9"
},
"downloads": -1,
"filename": "adafruit_circuitpython_gps-3.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bdf883b531e65001cbbd4403452eb17b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11731,
"upload_time": "2024-10-10T15:49:32",
"upload_time_iso_8601": "2024-10-10T15:49:32.214000Z",
"url": "https://files.pythonhosted.org/packages/51/72/962e06281d9e1ee4754e2c8c393b400ad79a21fe05520a1fd174e646ed50/adafruit_circuitpython_gps-3.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f365928e48654b38a4e9067f68493bb6d62b4e94caae141e2cb85ff6bd20f3f3",
"md5": "f1e6c8c5e0f8ca7b7cbe8206be6b4b6f",
"sha256": "305b2f456888fb82d458acaf9795178db7494e47c892a047fc2499f233c627e4"
},
"downloads": -1,
"filename": "adafruit_circuitpython_gps-3.11.0.tar.gz",
"has_sig": false,
"md5_digest": "f1e6c8c5e0f8ca7b7cbe8206be6b4b6f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 44524,
"upload_time": "2024-10-10T15:49:33",
"upload_time_iso_8601": "2024-10-10T15:49:33.189202Z",
"url": "https://files.pythonhosted.org/packages/f3/65/928e48654b38a4e9067f68493bb6d62b4e94caae141e2cb85ff6bd20f3f3/adafruit_circuitpython_gps-3.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-10 15:49:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_GPS",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-gps"
}
JSON
