Skip to content

Latest commit

 

History

History
123 lines (78 loc) · 4.53 KB

DESCRIPTION.rst

File metadata and controls

123 lines (78 loc) · 4.53 KB
Raw

Installation

[sudo [-H]] pip[2|3] install gps3

For example, sudo -H pip3 install gps3 for your default P3 installation. sudo pip2 install gps3 for Python 2.7.

gps3.py will install at /usr/local/lib/python[3.5]/dist-packages/gps3/gps3.py

gps3.py is a Python 2.7-3.5 GPSD interface (http://www.catb.org/gpsd) and defaults to host='127.0.0.1', port=2947, gpsd_protocol='json' in two classes.

  1. GPSDSocket creates a GPSD socket connection & request/retrieve GPSD output.
  2. DataStream unpacks the streamed gpsd data into python dictionaries.

These dictionaries are literated from the JSON data packet sent from the GPSD.

from gps3 import gps3
gpsd_socket = gps3.GPSDSocket()
data_stream = gps3.DataStream()
gpsd_socket.connect()
gpsd_socket.watch()
for new_data in gpsd_socket:
    if new_data:
        data_stream.unpack(new_data)
        print('Altitude = ', data_stream.TPV['alt'])
        print('Latitude = ', data_stream.TPV['lat'])

Consult Lines 147-ff for Attribute/Key possibilities. or http://www.catb.org/gpsd/gpsd_json.html

agps3.py is installed at /usr/local/lib/python[3.5]/dist-packages/gps3/agps3.py

It is functionally similar to gps.py, but literates object attributes rather than Python dictionaries.

agps3.py is also a Python 2.7-3.5 GPSD interface (http://www.catb.org/gpsd) and defaults to host='127.0.0.1', port=2947, gpsd_protocol='json' in two classes.

  1. GPSDSocket creates a GPSD socket connection & request/retrieve GPSD output.
  2. DataStream unpacks the streamed gpsd data into object attribute values.
from gps3 import agps3
gpsd_socket = agps3.GPSDSocket()
data_stream = agps3.DataStream()
gpsd_socket.connect()
gpsd_socket.watch()
for new_data in gpsd_socket:
    if new_data:
        data_stream.unpack(new_data)
        print('Altitude = ', data_stream.alt)
        print('Latitude = ', data_stream.lat)

Consult Lines 140-ff for Attribute-value possibilities.

For a human experience, both versions have trivial showcase scripts, located at

/usr/local/share/gps3/examples/

agpsthreaded.py is agps3 prethreaded as a default daemon thread with all data exposed as attributes of the threaded data stream.

from gps3.agps3threaded import AGPS3mechanism
agps_thread = AGPS3mechanism()  # Instantiate AGPS3 Mechanisms
agps_thread.stream_data()  # From localhost (), or other hosts, by example, (host='gps.ddns.net')
agps_thread.run_thread()  # Throttle time to sleep after an empty lookup, default '()' 0.2 two tenths of a second

while True:  # All data is available via instantiated thread data stream attribute.
    # line #140-ff of /usr/local/lib/python3.5/dist-packages/gps3/agps.py
    print('---------------------')
    print(                   agps_thread.data_stream.time)
    print('Lat:{}   '.format(agps_thread.data_stream.lat))
    print('Lon:{}   '.format(agps_thread.data_stream.lon))
    print('Speed:{} '.format(agps_thread.data_stream.speed))
    print('Course:{}'.format(agps_thread.data_stream.track))
    print('---------------------')
    sleep(60) # Sleep, or do other things for as long as you like.

human.py showcases gps3.py, ahuman.py showcases agps3.py

python[X] /usr/local/share/gps3/examples/[a]human.py [-host] [-port] or --help for list of commandline options.

Toggle Lat/Lon form with '0', '1', '2', '3' for RAW, DDD, DMM, DMS

Toggle units with '0', 'm', 'i', 'n', for 'raw', Metric, Imperial, Nautical

Toggle between JSON and NMEA outputs with 'j' and 'a' respectively.

Refresh the display of device information with 'd' to see the return after issuing gps3.misc.hertz(5) to change capable gps devices to 5Hz

Quit with 'q' or '^c'

Likewise, both versions have trivial applications [a] gegps3.py that creates a 'live' kml file(s) for Google Earth.

python[X] /usr/local/share/gps3/examples/[a]gegps3.py (defaults)

Scant documentation is in the respective file.

Un-installation

[sudo -H] pip[2|3] uninstall gps3

For example, sudo -H pip3 uninstall gps3 for P3 installation. Likewise, for Python 2.7 sudo pip2 uninstall gps3

Problems with installation

Un-install using the method above and y to delete the old files, then

sudo -H pip[2|3] install --ignore-installed gps3

This will bypass the cached version and fetch the most recent typo-free version.

Comments are always appreciated.