From 5a184d2f5c02390ac380d3185d207441ba0b16cc Mon Sep 17 00:00:00 2001 From: Silvan Fuhrer Date: Mon, 5 Oct 2020 11:55:35 +0200 Subject: [PATCH] Commenting and formating fixes Signed-off-by: Silvan Fuhrer --- msg/airspeed_validated.msg | 12 ++++++------ src/lib/airspeed/airspeed.h | 7 +++---- 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/msg/airspeed_validated.msg b/msg/airspeed_validated.msg index fe86d110ad..06731cc410 100644 --- a/msg/airspeed_validated.msg +++ b/msg/airspeed_validated.msg @@ -1,12 +1,12 @@ -uint64 timestamp # time since system start (microseconds) +uint64 timestamp # time since system start (microseconds) -float32 indicated_airspeed_m_s # indicated airspeed in m/s (IAS), set to NAN if invalid -float32 calibrated_airspeed_m_s # calibrated airspeed in m/s (CAS, accounts for instrumentation errors), set to NAN if invalid +float32 indicated_airspeed_m_s # indicated airspeed in m/s (IAS), set to NAN if invalid +float32 calibrated_airspeed_m_s # calibrated airspeed in m/s (CAS, accounts for instrumentation errors), set to NAN if invalid float32 true_airspeed_m_s # true filtered airspeed in m/s (TAS), set to NAN if invalid -float32 calibrated_ground_minus_wind_m_s # CAS calculated from groundspeed - windspeed, where windspeed is estimated based on a zero-sideslip assumption, set to NAN if invalid +float32 calibrated_ground_minus_wind_m_s # CAS calculated from groundspeed - windspeed, where windspeed is estimated based on a zero-sideslip assumption, set to NAN if invalid float32 true_ground_minus_wind_m_s # TAS calculated from groundspeed - windspeed, where windspeed is estimated based on a zero-sideslip assumption, set to NAN if invalid -bool airspeed_sensor_measurement_valid # True if data from at least one airspeed sensor is declared valid. +bool airspeed_sensor_measurement_valid # True if data from at least one airspeed sensor is declared valid. -int8 selected_airspeed_index # 1-3: airspeed sensor index, 0: groundspeed-windspeed, -1: airspeed invalid +int8 selected_airspeed_index # 1-3: airspeed sensor index, 0: groundspeed-windspeed, -1: airspeed invalid diff --git a/src/lib/airspeed/airspeed.h b/src/lib/airspeed/airspeed.h index e7fb1624e9..6b53a8710c 100644 --- a/src/lib/airspeed/airspeed.h +++ b/src/lib/airspeed/airspeed.h @@ -58,7 +58,7 @@ enum AIRSPEED_COMPENSATION_MODEL { }; /** - * Calculate indicated airspeed (IAS). + * Calculate indicated airspeed (IAS) and correct for friction inside pitot and tube. * * Note that the indicated airspeed is not the true airspeed because it * lacks the air density compensation. Use the calc_true_airspeed functions to get @@ -88,7 +88,7 @@ __EXPORT float calc_IAS(float differential_pressure); /** * Calculate true airspeed (TAS) from calibrated airspeed (CAS). * - * Note that the true airspeed is NOT the groundspeed, because of the effects of wind + * Note that the true airspeed is NOT the groundspeed, because of the effects of wind. * * @param speed_equivalent current calibrated airspeed * @param pressure_ambient pressure at the side of the tube/airplane @@ -109,7 +109,7 @@ __EXPORT float calc_CAS_from_IAS(float speed_indicated, float scale); /** - * Directly calculate true airspeed (TAS) + * Directly calculate true airspeed (TAS). * * Here we assume to have no instrument or pitot position error (IAS = CAS). * Note that the true airspeed is NOT the groundspeed, because of the effects of wind. @@ -133,7 +133,6 @@ __EXPORT float get_air_density(float static_pressure, float temperature_celsius) * Calculate calibrated airspeed (CAS) from true airspeed (TAS). * It is the inverse function to calc_TAS_from_CAS() * - * * @param speed_true current true airspeed * @param pressure_ambient pressure at the side of the tube/airplane * @param temperature_celsius air temperature in degrees celcius