Skip to content

Commit

Permalink
Merge pull request #8 from rwnobrega/patch-1
Browse files Browse the repository at this point in the history
Fix typos and remove redundant info in README.rst
  • Loading branch information
junzis committed Oct 26, 2016
2 parents 4bafa1d + 3b3fc27 commit dad1cd8
Showing 1 changed file with 9 additions and 18 deletions.
27 changes: 9 additions & 18 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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:https://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:
Expand Down Expand Up @@ -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
Expand All @@ -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:
Expand Down

0 comments on commit dad1cd8

Please sign in to comment.