diff --git a/pyModeS/decoder/adsb.py b/pyModeS/decoder/adsb.py index 4fc95ab..ff27e26 100644 --- a/pyModeS/decoder/adsb.py +++ b/pyModeS/decoder/adsb.py @@ -1,15 +1,11 @@ -"""ADS-B Wrapper. +"""ADS-B module. -The ADS-B wrapper also imports functions from the following modules: +The ADS-B module also imports functions from the following modules: -- pyModeS.decoder.bds.bds05 - Functions: ``airborne_position``, ``airborne_position_with_ref``, ``altitude`` -- pyModeS.decoder.bds.bds06 - Functions: ``surface_position``, ``surface_position_with_ref``, ``surface_velocity`` -- pyModeS.decoder.bds.bds08 - Functions: ``category``, ``callsign`` -- pyModeS.decoder.bds.bds09 - Functions: ``airborne_velocity``, ``altitude_diff`` +- pyModeS.decoder.bds.bds05: ``airborne_position()``, ``airborne_position_with_ref()``, ``altitude()`` +- pyModeS.decoder.bds.bds06: ``surface_position()``, ``surface_position_with_ref()``, ``surface_velocity()`` +- pyModeS.decoder.bds.bds08: ``category()``, ``callsign()`` +- pyModeS.decoder.bds.bds09: ``airborne_velocity()``, ``altitude_diff()`` """ diff --git a/pyModeS/decoder/bds/bds20.py b/pyModeS/decoder/bds/bds20.py index d30cdd4..63e10cd 100644 --- a/pyModeS/decoder/bds/bds20.py +++ b/pyModeS/decoder/bds/bds20.py @@ -36,7 +36,7 @@ def cs20(msg): """Aircraft callsign Args: - msg (str): 28 hexdigits (BDS40) string + msg (str): 28 hexdigits string Returns: string: callsign, max. 8 chars diff --git a/pyModeS/decoder/bds/bds40.py b/pyModeS/decoder/bds/bds40.py index 9ba83a1..bc4950e 100644 --- a/pyModeS/decoder/bds/bds40.py +++ b/pyModeS/decoder/bds/bds40.py @@ -54,7 +54,7 @@ def selalt40mcp(msg): """Selected altitude, MCP/FCU Args: - msg (str): 28 hexdigits (BDS40) string + msg (str): 28 hexdigits string Returns: int: altitude in feet @@ -72,7 +72,7 @@ def selalt40fms(msg): """Selected altitude, FMS Args: - msg (str): 28 hexdigits (BDS40) string + msg (str): 28 hexdigits string Returns: int: altitude in feet @@ -90,7 +90,7 @@ def p40baro(msg): """Barometric pressure setting Args: - msg (str): 28 hexdigits (BDS40) string + msg (str): 28 hexdigits string Returns: float: pressure in millibar diff --git a/pyModeS/decoder/bds/bds50.py b/pyModeS/decoder/bds/bds50.py index fc2f52b..a2e534a 100644 --- a/pyModeS/decoder/bds/bds50.py +++ b/pyModeS/decoder/bds/bds50.py @@ -61,7 +61,7 @@ def roll50(msg): """Roll angle, BDS 5,0 message Args: - msg (str): 28 hexdigits (BDS50) string + msg (str): 28 hexdigits string Returns: float: angle in degrees, @@ -86,7 +86,7 @@ def trk50(msg): """True track angle, BDS 5,0 message Args: - msg (str): 28 hexdigits (BDS50) string + msg (str): 28 hexdigits string Returns: float: angle in degrees to true north (from 0 to 360) @@ -115,7 +115,7 @@ def gs50(msg): """Ground speed, BDS 5,0 message Args: - msg (str): 28 hexdigits (BDS50) string + msg (str): 28 hexdigits string Returns: int: ground speed in knots @@ -133,7 +133,7 @@ def rtrk50(msg): """Track angle rate, BDS 5,0 message Args: - msg (str): 28 hexdigits (BDS50) string + msg (str): 28 hexdigits string Returns: float: angle rate in degrees/second @@ -159,7 +159,7 @@ def tas50(msg): """Aircraft true airspeed, BDS 5,0 message Args: - msg (str): 28 hexdigits (BDS50) string + msg (str): 28 hexdigits string Returns: int: true airspeed in knots diff --git a/pyModeS/decoder/bds/bds53.py b/pyModeS/decoder/bds/bds53.py index 452c405..023f7ef 100644 --- a/pyModeS/decoder/bds/bds53.py +++ b/pyModeS/decoder/bds/bds53.py @@ -62,7 +62,7 @@ def hdg53(msg): """Magnetic heading, BDS 5,3 message Args: - msg (str): 28 hexdigits (BDS53) string + msg (str): 28 hexdigits string Returns: float: angle in degrees to true north (from 0 to 360) diff --git a/pyModeS/decoder/bds/bds60.py b/pyModeS/decoder/bds/bds60.py index b02595a..b8d91cb 100644 --- a/pyModeS/decoder/bds/bds60.py +++ b/pyModeS/decoder/bds/bds60.py @@ -61,7 +61,7 @@ def hdg60(msg): """Megnetic heading of aircraft Args: - msg (str): 28 hexdigits (BDS60) string + msg (str): 28 hexdigits string Returns: float: heading in degrees to megnetic north (from 0 to 360) @@ -90,7 +90,7 @@ def ias60(msg): """Indicated airspeed Args: - msg (str): 28 hexdigits (BDS60) string + msg (str): 28 hexdigits string Returns: int: indicated airspeed in knots @@ -108,7 +108,7 @@ def mach60(msg): """Aircraft MACH number Args: - msg (str): 28 hexdigits (BDS60) string + msg (str): 28 hexdigits string Returns: float: MACH number @@ -126,7 +126,7 @@ def vr60baro(msg): """Vertical rate from barometric measurement, this value may be very noisy. Args: - msg (str): 28 hexdigits (BDS60) string + msg (str): 28 hexdigits string Returns: int: vertical rate in feet/minutes @@ -152,7 +152,7 @@ def vr60ins(msg): """Vertical rate measurd by onbard equiments (IRS, AHRS) Args: - msg (str): 28 hexdigits (BDS60) string + msg (str): 28 hexdigits string Returns: int: vertical rate in feet/minutes diff --git a/pyModeS/decoder/commb.py b/pyModeS/decoder/commb.py index c4409f6..4957681 100644 --- a/pyModeS/decoder/commb.py +++ b/pyModeS/decoder/commb.py @@ -1,21 +1,24 @@ -"""Comm-B Wrapper. +"""Comm-B module. -The Comm-B wrapper imports all functions from the following modules: +The Comm-B module imports all functions from the following modules: -**ELS - elementary surveillance** - - pyModeS.decoder.bds.bds10 - - pyModeS.decoder.bds.bds17 - - pyModeS.decoder.bds.bds20 - - pyModeS.decoder.bds.bds30 +ELS - elementary surveillance -**EHS - enhanced surveillance** - - pyModeS.decoder.bds.bds40 - - pyModeS.decoder.bds.bds50 - - pyModeS.decoder.bds.bds60 +- pyModeS.decoder.bds.bds10 +- pyModeS.decoder.bds.bds17 +- pyModeS.decoder.bds.bds20 +- pyModeS.decoder.bds.bds30 -**MRAR and MHR** - - pyModeS.decoder.bds.bds44 - - pyModeS.decoder.bds.bds45 +EHS - enhanced surveillance + +- pyModeS.decoder.bds.bds40 +- pyModeS.decoder.bds.bds50 +- pyModeS.decoder.bds.bds60 + +MRAR and MHR + +- pyModeS.decoder.bds.bds44 +- pyModeS.decoder.bds.bds45 """