From 03920f2ae3293c8c5c50bb5de391feea183dbde7 Mon Sep 17 00:00:00 2001 From: Nuno Marques Date: Thu, 16 May 2024 12:31:26 +0100 Subject: [PATCH] msg: FuelTankStatus: updated field descriptions for clarity, specified default values and handling of NaN and unknown cases --- msg/FuelTankStatus.msg | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/msg/FuelTankStatus.msg b/msg/FuelTankStatus.msg index cddd8b73d5..22d21e4a4a 100644 --- a/msg/FuelTankStatus.msg +++ b/msg/FuelTankStatus.msg @@ -1,15 +1,15 @@ uint64 timestamp # time since system start (microseconds) -float32 maximum_fuel_capacity # maximum fuel capacity -float32 consumed_fuel # consumed fuel, NaN if unavailable -float32 fuel_consumption_rate # fuel consumption rate +float32 maximum_fuel_capacity # maximum fuel capacity. Must always be provided, either from the driver or a parameter +float32 consumed_fuel # consumed fuel, NaN if not measured. Should not be inferred from the max fuel capacity +float32 fuel_consumption_rate # fuel consumption rate, NaN if not measured -uint8 percent_remaining # percentage of remaining fuel -float32 remaining_fuel # remaining fuel +uint8 percent_remaining # percentage of remaining fuel, UINT8_MAX if not provided +float32 remaining_fuel # remaining fuel, NaN if not measured. Should not be inferred from the max fuel capacity -uint8 fuel_tank_id # identifier for the fuel tank +uint8 fuel_tank_id # identifier for the fuel tank. Must match ID of other messages for same fuel system. 0 by default when only a single tank exists -uint32 fuel_type # type of fuel based on MAV_FUEL_TYPE enum +uint32 fuel_type # type of fuel based on MAV_FUEL_TYPE enum. Set to MAV_FUEL_TYPE_UNKNOWN if unknown or it does not fit the provided types uint8 MAV_FUEL_TYPE_UNKNOWN = 0 # fuel type not specified. Fuel levels are normalized (i.e., maximum is 1, and other levels are relative to 1). uint8 MAV_FUEL_TYPE_LIQUID = 1 # represents generic liquid fuels, such as gasoline or diesel. Fuel levels are measured in millilitres (ml), and flow rates in millilitres per second (ml/s). uint8 MAV_FUEL_TYPE_GAS = 2 # represents a gas fuel, such as hydrogen, methane, or propane. Fuel levels are in kilo-Pascal (kPa), and flow rates are in milliliters per second (ml/s).