Metadata-Version: 2.1
Name: adafruit-circuitpython-gps
Version: 3.6.3
Summary: CircuitPython library for GPS modules.
Home-page: https://github.com/adafruit/Adafruit_CircuitPython_GPS
Author: Adafruit Industries
Author-email: circuitpython@adafruit.com
License: MIT
Description: 
        Introduction
        ============
        
        .. image:: https://readthedocs.org/projects/adafruit-circuitpython-gps/badge/?version=latest
            :target: https://circuitpython.readthedocs.io/projects/gps/en/latest/
            :alt: Documentation Status
        
        .. image :: https://img.shields.io/discord/327254708534116352.svg
            :target: https://discord.gg/nBQh6qu
            :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
        
        GPS parsing module.  Can parse simple NMEA data sentences from serial 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 .env
            source .env/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.
        
        About NMEA Data
        ===============
        This GPS module uses the NMEA 0183 protocol.
        
        This data is formatted by the GPS in one of two ways.
        
        The first of these is GGA. GGA has more or less everything you need.
        
        Here's an explanation of GGA:
        ::
        
                                                                11
                   1         2       3 4        5 6 7  8   9  10 |  12 13  14   15
                   |         |       | |        | | |  |   |   | |   | |   |    |
            $--GGA,hhmmss.ss,llll.ll,a,yyyyy.yy,a,x,xx,x.x,x.x,M,x.x,M,x.x,xxxx*hh
        
        
        1. Time (UTC)
        2. Latitude
        3. N or S (North or South)
        4. Longitude
        5. E or W (East or West)
        6. GPS Quality Indicator,
        
           * 0 - fix not available,
           * 1 - GPS fix,
           * 2 - Differential GPS fix
            
        7. Number of satellites in view, 00 - 12
        8. Horizontal Dilution of precision
        9. Antenna Altitude above/below mean-sea-level (geoid)
        10. Units of antenna altitude, meters
        11. Geoidal separation, the difference between the WGS-84 earth ellipsoid and mean-sea-level (geoid), "-" means mean-sea-level below ellipsoid
        12. Units of geoidal separation, meters
        13. Age of differential GPS data, time in seconds since last SC104 type 1 or 9 update, null field when DGPS is not used
        14. Differential reference station ID, 0000-1023
        15. Checksum
        
        The second of these is RMC. RMC is Recommended Minimum Navigation Information.
        
        Here's an explanation of RMC:
        ::
        
                                                                       12
                   1         2 3       4 5        6 7   8   9   10   11|
                   |         | |       | |        | |   |   |    |   | |
            $--RMC,hhmmss.ss,A,llll.ll,a,yyyyy.yy,a,x.x,x.x,xxxx,x.x,a*hh
        
        1. Time (UTC)
        2. Status, V = Navigation receiver warning
        3. Latitude
        4. N or S
        5. Longitude
        6. E or W
        7. Speed over ground, knots
        8. Track made good, degrees true
        9. Date, ddmmyy
        10. Magnetic Variation, degrees
        11. E or W
        12. Checksum
        
        
        `Info about NMEA taken from here
        <https://www.tronico.fi/OH6NT/docs/NMEA0183.pdf>`_.
        
        Contributing
        ============
        
        Contributions are welcome! Please read our `Code of Conduct
        <https://github.com/adafruit/Adafruit_CircuitPython_gps/blob/master/CODE_OF_CONDUCT.md>`_
        before contributing to help this project stay welcoming.
        
        Documentation
        =============
        
        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>`_.
        
Keywords: adafruit gps module latitude longitude breakout hardware micropython circuitpython
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Hardware
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Description-Content-Type: text/x-rst
