Fix typos and remove redundant info in README.rst

This commit is contained in:
Roberto Nobrega 2016-10-25 17:26:09 -02:00 committed by GitHub
parent 4bafa1de19
commit 3b3fc27a42

View File

@ -1,27 +1,27 @@
A Python Mode-S Decoder A Python Mode-S Decoder
======================= =======================
Python library for Mode-S message decoding. Two seprate methods are Python library for Mode-S message decoding. Two separate methods are
develop to decode the following messages: implemented to decode the following messages:
- Automatic Dependent Surveillance - Broadcast (ADS-B) (DF17) - Automatic Dependent Surveillance - Broadcast (ADS-B) (DF17)
- aircraft infomation that cotains: icao address, position, - aircraft information that contains: ICAO address, position,
altitude, velocity (ground speed), and callsign, etc. altitude, velocity (ground speed), callsign, etc.
- Mode-S Enhanced Surveillance (EHS) (DF20 and DF21) - Mode-S Enhanced Surveillance (EHS) (DF20 and DF21)
- additional information in response to SSR interogation, such as: - additional information in response to SSR interrogation, such as:
true airspeed, indicated airspeed, mach number, track angle, true airspeed, indicated airspeed, mach number, track angle,
heading, and roll angle, etc. heading, roll angle, etc.
A detailed manuel on Mode-S decoding is published by the author, at: A detailed manual on Mode-S decoding is published by the author, at:
http://adsb-decode-guide.readthedocs.io http://adsb-decode-guide.readthedocs.io
Source code Source code
----------- -----------
Checkourt and contribute to this open source project at: Checkout and contribute to this open source project at:
https://github.com/junzis/pyModeS https://github.com/junzis/pyModeS
API documentation at: API documentation at:
@ -85,7 +85,7 @@ Core functions for EHS decoding:
.. code:: python .. code:: python
pms.ehs.icao(msg) # icao address pms.ehs.icao(msg) # ICAO address
pms.ehs.BDS(msg) # Comm-B Data Selector Version pms.ehs.BDS(msg) # Comm-B Data Selector Version
# for BDS version 2,0 # for BDS version 2,0
@ -110,15 +110,6 @@ Core functions for EHS decoding:
pms.ehs.baro_vr(msg) # barometric altitude rate (ft/min) pms.ehs.baro_vr(msg) # barometric altitude rate (ft/min)
pms.ehs.ins_vr(msg) # inertial vertical speed (ft/min) pms.ehs.ins_vr(msg) # inertial vertical speed (ft/min)
Some helper functions:
.. code:: python
pms.df(msg) # downlink format of a Mode-S message
pms.hex2bin(msg) # convert hexadecimal string to binary string
pms.hex2int(msg) # convert hexadecimal string to integer
pms.bin2int(msg) # convert binary string to integer
Developement Developement
------------ ------------
To run tests, run the following commands: To run tests, run the following commands: