FGFS-4.1/pyModeS
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Junzi Sun 2017-11-01 11:53:10 +01:00
parent 2ae7bf4c19
commit 35b0d63fa9
1 changed files with 72 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.rst
View File

@ -76,8 +76,12 @@ Core functions for ADS-B decoding:
.. code:: python
pms.adsb.icao(msg)
pms.adsb.typecode(msg)
# typecode 1-4
pms.adsb.callsign(msg)
# typecode 5-8 (surface) and 9-18 (airborne)
pms.adsb.position(msg_even, msg_odd, t_even, t_odd, lat_ref=None, lon_ref=None)
pms.adsb.airborne_position(msg_even, msg_odd, t_even, t_odd)
pms.adsb.surface_position(msg_even, msg_odd, t_even, t_odd, lat_ref, lon_ref)
@ -88,6 +92,7 @@ Core functions for ADS-B decoding:
pms.adsb.altitude(msg)
# typecode: 19
pms.adsb.velocity(msg) # handles both surface & airborne messages
pms.adsb.speed_heading(msg) # handles both surface & airborne messages
pms.adsb.surface_velocity(msg)
@ -165,6 +170,7 @@ Core functions for EHS decoding:
Developement
------------
To perform unit tests. First install ``tox`` through pip, Then, run the following commands:
```
.. code:: bash
$ tox
```