Updted docstrings for velocity messages

This commit is contained in:
Alexander Hirsch
2019-05-27 08:25:11 -07:00
parent f27fe6c8aa
commit 6fc68841ce
3 changed files with 10 additions and 7 deletions
+4 -3
View File
@@ -159,9 +159,10 @@ def velocity(msg, rtn_sources=False):
ground track or heading (degree), ground track or heading (degree),
rate of climb/descent (ft/min), speed type rate of climb/descent (ft/min), speed type
('GS' for ground speed, 'AS' for airspeed), ('GS' for ground speed, 'AS' for airspeed),
direction source ('true_north' for ground track, 'mag_north' for direction source ('true_north' for ground track / true north
magnetic heading), rate of climb/descent source ('Baro' for as refrence, 'mag_north' for magnetic north as reference),
barometer, 'GNSS' for GNSS constellation). rate of climb/descent source ('Baro' for barometer, 'GNSS'
for GNSS constellation).
In the case of surface messages, None will be put in place In the case of surface messages, None will be put in place
for vertical rate and its respective sources. for vertical rate and its respective sources.
+2 -1
View File
@@ -154,7 +154,8 @@ def surface_velocity(msg, rtn_sources=False):
(int, float, int, string, string, None): speed (kt), (int, float, int, string, string, None): speed (kt),
ground track (degree), None for rate of climb/descend (ft/min), ground track (degree), None for rate of climb/descend (ft/min),
and speed type ('GS' for ground speed), direction source and speed type ('GS' for ground speed), direction source
('true_north' for ground track), None rate of climb/descent source. ('true_north' for ground track / true north as reference),
None rate of climb/descent source.
""" """
if common.typecode(msg) < 5 or common.typecode(msg) > 8: if common.typecode(msg) < 5 or common.typecode(msg) > 8:
+4 -3
View File
@@ -40,9 +40,10 @@ def airborne_velocity(msg, rtn_sources=False):
ground track or heading (degree), ground track or heading (degree),
rate of climb/descent (ft/min), speed type rate of climb/descent (ft/min), speed type
('GS' for ground speed, 'AS' for airspeed), ('GS' for ground speed, 'AS' for airspeed),
direction source ('true_north' for ground track, 'mag_north' for direction source ('true_north' for ground track / true north
magnetic heading), rate of climb/descent source ('Baro' for as refrence, 'mag_north' for magnetic north as reference),
barometer, 'GNSS' for GNSS constellation) rate of climb/descent source ('Baro' for barometer, 'GNSS'
for GNSS constellation).
""" """
if common.typecode(msg) != 19: if common.typecode(msg) != 19: