Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos and remove redundant info in README.rst #8

Merged
merged 1 commit into from
Oct 26, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Fix typos and remove redundant info in README.rst
  • Loading branch information
rwnobrega committed Oct 25, 2016
commit 3b3fc27a422299614c9db5081c2263af40e93f8a
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