From 3b3fc27a422299614c9db5081c2263af40e93f8a Mon Sep 17 00:00:00 2001 From: Roberto Nobrega Date: Tue, 25 Oct 2016 17:26:09 -0200 Subject: [PATCH] Fix typos and remove redundant info in README.rst --- README.rst | 27 +++++++++------------------ 1 file changed, 9 insertions(+), 18 deletions(-) diff --git a/README.rst b/README.rst index 0157577..cc1dcca 100644 --- a/README.rst +++ b/README.rst @@ -1,27 +1,27 @@ A Python Mode-S Decoder ======================= -Python library for Mode-S message decoding. Two seprate methods are -develop to decode the following messages: +Python library for Mode-S message decoding. Two separate methods are +implemented to decode the following messages: - Automatic Dependent Surveillance - Broadcast (ADS-B) (DF17) - - aircraft infomation that cotains: icao address, position, - altitude, velocity (ground speed), and callsign, etc. + - aircraft information that contains: ICAO address, position, + altitude, velocity (ground speed), callsign, etc. - 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, - 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 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 API documentation at: @@ -85,7 +85,7 @@ Core functions for EHS decoding: .. code:: python - pms.ehs.icao(msg) # icao address + pms.ehs.icao(msg) # ICAO address pms.ehs.BDS(msg) # Comm-B Data Selector Version # 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.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 ------------ To run tests, run the following commands: