From da7f6cccd466c7bb8996f4888cf2ebc4ebf12d19 Mon Sep 17 00:00:00 2001 From: Balduin Date: Tue, 17 Nov 2026 18:36:24 +0100 Subject: [PATCH] fix(parameters): add missing units to parameter metadata (#29819) * docs(parameters): add 4 new units - A/V (ampere per volt) - Pa (pascal) - Pa/V (pascal per volt) - MHz (megahertz) * docs(parameters): add missing units These parameters have a physical unit (often stated in their own description) but no unit field, so QGC and the parameter reference show them as unitless. Add the missing units to 116 parameters. Assisted-by: Claude:claude-opus-5-5 * docs(parameters): drop units from descriptions now in the unit field Assisted-by: Claude:claude-opus-5-5 * fix(microstrain): label orientation parameters deg src/drivers/ins/microstrain/MicroStrain.cpp requires these to be in degrees (they are converted to radians at line 1121-1124), but the param docstring mentioned which was moved to the unit field just before. Fix by labelling correctly as degrees. Signed-off-by: Balduin * docs(parameters): fix smaller inconsistencies Address review from @dakejahl: - mc_nn_control: MC_NN_MIN_RPM also in units of rpm - sensors: remove redundant '#unit: Pa' comment - microstrain: Typo in MS_GNSS_OFF2_Z Signed-off-by: Balduin --------- Signed-off-by: Balduin --- src/drivers/actuators/vertiq_io/module.yaml | 5 +- src/drivers/ins/microstrain/module.yaml | 69 ++++++++++++------- src/drivers/osd/msp_osd/module.yaml | 10 +-- .../power_monitor/ina220/ina220_params.yaml | 4 ++ .../power_monitor/ina226/ina226_params.yaml | 2 + .../power_monitor/ina228/ina228_params.yaml | 2 + .../power_monitor/ina238/ina238_params.yaml | 2 + .../power_monitor/voxlpm/voxlpm_params.yaml | 2 + src/drivers/vtx/module.yaml | 3 +- src/lib/battery/module.yaml | 3 +- .../performance_model_params.yaml | 2 + src/lib/parameters/px4params/srcparser.py | 2 +- .../analog_battery_params_common.yaml | 3 +- src/modules/battery_status/module.yaml | 3 +- .../follow_target_params.yaml | 4 +- .../fw_lat_long_params.yaml | 5 ++ src/modules/gimbal/gimbal_params.yaml | 3 +- .../mc_nn_control/mc_nn_control_params.yaml | 2 + .../multicopter_autonomous_params.yaml | 2 + .../multicopter_responsiveness_params.yaml | 2 + src/modules/sensors/module.yaml | 5 +- src/modules/sensors/sensor_params.yaml | 6 +- .../sensor_baro_sim/parameters.yaml | 1 + .../spacecraft_position_params.yaml | 1 + .../temp_comp_params_accel_0.yaml | 3 + .../temp_comp_params_accel_1.yaml | 3 + .../temp_comp_params_accel_2.yaml | 3 + .../temp_comp_params_accel_3.yaml | 3 + .../temp_comp_params_baro_0.yaml | 3 + .../temp_comp_params_baro_1.yaml | 3 + .../temp_comp_params_baro_2.yaml | 3 + .../temp_comp_params_baro_3.yaml | 3 + .../temp_comp_params_gyro_0.yaml | 3 + .../temp_comp_params_gyro_1.yaml | 3 + .../temp_comp_params_gyro_2.yaml | 3 + .../temp_comp_params_gyro_3.yaml | 3 + .../temp_comp_params_mag_0.yaml | 3 + .../temp_comp_params_mag_1.yaml | 3 + .../temp_comp_params_mag_2.yaml | 3 + .../temp_comp_params_mag_3.yaml | 3 + .../uuv_att_control_params.yaml | 3 +- .../uuv_pos_control_params.yaml | 1 + .../vtol_att_control_params.yaml | 1 + validation/module_schema.yaml | 2 +- 44 files changed, 157 insertions(+), 41 deletions(-) diff --git a/src/drivers/actuators/vertiq_io/module.yaml b/src/drivers/actuators/vertiq_io/module.yaml index cfcc8a0499d..74be5d4f3fc 100644 --- a/src/drivers/actuators/vertiq_io/module.yaml +++ b/src/drivers/actuators/vertiq_io/module.yaml @@ -25,8 +25,9 @@ parameters: description: short: The IQUART driver's baud rate long: | - The baud rate (in bits per second) used by the serial port connected with IQUART communication + The baud rate used by the serial port connected with IQUART communication type: int32 + unit: bit/s reboot_required: true default: 115200 VTQ_NUM_CVS: @@ -124,6 +125,7 @@ parameters: long: | Only relevant in Voltage Mode. This is the voltage the controller will command at full throttle. type: float + unit: V default: 0 VTQ_MOTOR_DIR: description: @@ -187,6 +189,7 @@ parameters: long: | This sets the max pulsing voltage limit when in Voltage Limit Mode. type: float + unit: V default: 0 VTQ_X_CVI: description: diff --git a/src/drivers/ins/microstrain/module.yaml b/src/drivers/ins/microstrain/module.yaml index 786db170942..22b3ecfe78a 100644 --- a/src/drivers/ins/microstrain/module.yaml +++ b/src/drivers/ins/microstrain/module.yaml @@ -27,9 +27,10 @@ parameters: description: short: MicroStrain IMU data rate long: | - Accelerometer and Gyroscope data rate (Hz). + Accelerometer and Gyroscope data rate. Valid rates: 0 or any factor of 1000. type: int32 + unit: Hz max: 1000 min: 0 reboot_required: true @@ -39,9 +40,10 @@ parameters: description: short: MicroStrain magnetometer data rate long: | - Magnetometer data rate (Hz). + Magnetometer data rate. Valid rates: 0 or any factor of 1000. type: int32 + unit: Hz max: 1000 min: 0 reboot_required: true @@ -51,9 +53,10 @@ parameters: description: short: MicroStrain barometer data rate long: | - Barometer data rate (Hz). + Barometer data rate. Valid rates: 0 or any factor of 1000. type: int32 + unit: Hz max: 1000 min: 0 reboot_required: true @@ -63,9 +66,10 @@ parameters: description: short: MicroStrain EKF data rate long: | - The rate at which the INS data is published (Hz). + The rate at which the INS data is published. Valid rates: 0 or any factor of 1000. type: int32 + unit: Hz max: 1000 min: 0 reboot_required: true @@ -75,9 +79,10 @@ parameters: description: short: MicroStrain GNSS data rate long: | - GNSS receiver 1 and 2 data rate (Hz). + GNSS receiver 1 and 2 data rate. Valid rates: 0, 1 or 5. type: int32 + unit: Hz max: 5 min: 0 reboot_required: true @@ -213,9 +218,10 @@ parameters: description: short: MicroStrain GNSS lever arm offset 1 (X) long: | - Lever arm offset (m) in the X direction for the external GNSS receiver. + Lever arm offset in the X direction for the external GNSS receiver. In the case of a dual antenna setup, this is antenna 1. type: float + unit: m reboot_required: true default: 0.0 @@ -223,9 +229,10 @@ parameters: description: short: MicroStrain GNSS lever arm offset 1 (Y) long: | - Lever arm offset (m) in the Y direction for the external GNSS receiver. + Lever arm offset in the Y direction for the external GNSS receiver. In the case of a dual antenna setup, this is antenna 1. type: float + unit: m reboot_required: true default: 0.0 @@ -233,9 +240,10 @@ parameters: description: short: MicroStrain GNSS lever arm offset 1 (Z) long: | - Lever arm offset (m) in the Z direction for the external GNSS receiver. + Lever arm offset in the Z direction for the external GNSS receiver. In the case of a dual antenna setup, this is antenna 1. type: float + unit: m reboot_required: true default: 0.0 @@ -243,9 +251,10 @@ parameters: description: short: MicroStrain GNSS lever arm offset 2 (X) long: | - Lever arm offset (m) in the X direction for antenna 2 + Lever arm offset in the X direction for antenna 2 This will only be used if the device supports a dual antenna setup. type: float + unit: m reboot_required: true default: 0.0 @@ -253,9 +262,10 @@ parameters: description: short: MicroStrain GNSS lever arm offset 2 (Y) long: | - Lever arm offset (m) in the Y direction for antenna 2. + Lever arm offset in the Y direction for antenna 2. This will only be used if the device supports a dual antenna setup. type: float + unit: m reboot_required: true default: 0.0 @@ -263,9 +273,10 @@ parameters: description: short: MicroStrain GNSS lever arm offset 2 (Z) long: | - Lever arm offset (m) in the X direction for antenna 2. + Lever arm offset in the Z direction for antenna 2. This will only be used if the device supports a dual antenna setup. type: float + unit: m reboot_required: true default: 0.0 @@ -273,9 +284,10 @@ parameters: description: short: MicroStrain Sensor to vehicle transform (Roll) long: | - The orientation of the device (Radians) with respect to the vehicle frame around the x axis. + The orientation of the device with respect to the vehicle frame around the x axis. Requires MS_SVT_EN to be enabled to be used. type: float + unit: deg reboot_required: true default: 0.0 @@ -283,9 +295,10 @@ parameters: description: short: MicroStrain Sensor to Vehicle Transform (Pitch) long: | - The orientation of the device (Radians) with respect to the vehicle frame around the y axis. + The orientation of the device with respect to the vehicle frame around the y axis. Requires MS_SVT_EN to be enabled to be used. type: float + unit: deg reboot_required: true default: 0.0 @@ -293,9 +306,10 @@ parameters: description: short: MicroStrain Sensor to Vehicle Transform (Yaw) long: | - The orientation of the device (Radians) with respect to the vehicle frame around the z axis. + The orientation of the device with respect to the vehicle frame around the z axis. Requires MS_SVT_EN to be enabled to be used. type: float + unit: deg reboot_required: true default: 0.0 @@ -303,9 +317,10 @@ parameters: description: short: MicroStrain External Magnetometer Orientation (Roll) long: | - The orientation of the device (Radians) with respect to the vehicle frame around the x axis. + The orientation of the device with respect to the vehicle frame around the x axis. Requires MS_EXT_MAG_EN to be enabled to be used. type: float + unit: rad reboot_required: true default: 0.0 @@ -313,9 +328,10 @@ parameters: description: short: MicroStrain External Magnetometer Orientation (Pitch) long: | - The orientation of the device (Radians) with respect to the vehicle frame around the y axis. + The orientation of the device with respect to the vehicle frame around the y axis. Requires MS_EXT_MAG_EN to be enabled to be used. type: float + unit: rad reboot_required: true default: 0.0 @@ -323,9 +339,10 @@ parameters: description: short: MicroStrain External Magnetometer Orientation (Yaw) long: | - The orientation of the device (Radians) with respect to the vehicle frame around the z axis. + The orientation of the device with respect to the vehicle frame around the z axis. Requires MS_EXT_MAG_EN to be enabled to be used. type: float + unit: rad reboot_required: true default: 0.0 @@ -333,9 +350,10 @@ parameters: description: short: MicroStrain optical flow offset (X) long: | - Offset (m) in the X direction if an Optical Flow sensor is connected. + Offset in the X direction if an Optical Flow sensor is connected. Requires MS_OPT_FLOW_EN to be enabled to be used. type: float + unit: m reboot_required: true default: 0.0 @@ -343,9 +361,10 @@ parameters: description: short: MicroStrain optical flow offset (Y) long: | - Offset (m) in the Y direction if an Optical Flow sensor is connected. + Offset in the Y direction if an Optical Flow sensor is connected. Requires MS_OPT_FLOW_EN to be enabled to be used. type: float + unit: m reboot_required: true default: 0.0 @@ -353,9 +372,10 @@ parameters: description: short: MicroStrain optical flow offset (Z) long: | - Offset (m) in the Z direction if an Optical Flow sensor is connected. + Offset in the Z direction if an Optical Flow sensor is connected. Requires MS_OPT_FLOW_EN to be enabled to be used. type: float + unit: m reboot_required: true default: 0.0 @@ -363,9 +383,10 @@ parameters: description: short: MicroStrain External Heading Orientation (Yaw) long: | - The orientation of the device (Radians) with respect to the vehicle frame around the z axis. + The orientation of the device with respect to the vehicle frame around the z axis. Requires MS_EXT_HEAD_EN to be enabled to be used. type: float + unit: rad reboot_required: true default: 0.0 @@ -373,9 +394,10 @@ parameters: description: short: MicroStrain external magnetometer uncertainty long: | - The 1-sigma uncertainty (in Gauss) for all axes, which will remain constant across all aiding measurements. + The 1-sigma uncertainty for all axes, which will remain constant across all aiding measurements. Requires MS_EXT_MAG_EN to be enabled to be used. type: float + unit: gauss reboot_required: true default: 0.1 @@ -383,9 +405,10 @@ parameters: description: short: MicroStrain optical flow uncertainty long: | - The 1-sigma uncertainty (in m/s) for the X and Y axes, which will remain constant across all aiding measurements. + The 1-sigma uncertainty for the X and Y axes, which will remain constant across all aiding measurements. The Z axis is not used for aiding. Requires MS_OPT_FLOW_EN to be enabled to be used. type: float + unit: m/s reboot_required: true default: 0.1 diff --git a/src/drivers/osd/msp_osd/module.yaml b/src/drivers/osd/msp_osd/module.yaml index d40db900e7a..f39874b0f83 100644 --- a/src/drivers/osd/msp_osd/module.yaml +++ b/src/drivers/osd/msp_osd/module.yaml @@ -91,11 +91,12 @@ parameters: # Scroll Speed OSD_SCROLL_RATE: description: - short: OSD Scroll Rate (ms) + short: OSD Scroll Rate long: | - Scroll rate in milliseconds for OSD messages longer than available character width. + Scroll rate for OSD messages longer than available character width. This is lower-bounded by the nominal loop rate of this module. type: int32 + unit: ms min: 100 max: 1000 default: 125 @@ -103,10 +104,11 @@ parameters: # Dwell TIme OSD_DWELL_TIME: description: - short: OSD Dwell Time (ms) + short: OSD Dwell Time long: | - Amount of time in milliseconds to dwell at the beginning of the display, when scrolling. + Amount of time to dwell at the beginning of the display, when scrolling. type: int32 + unit: ms min: 100 max: 10000 default: 500 diff --git a/src/drivers/power_monitor/ina220/ina220_params.yaml b/src/drivers/power_monitor/ina220/ina220_params.yaml index 7ce03a2003d..bdbda50d126 100644 --- a/src/drivers/power_monitor/ina220/ina220_params.yaml +++ b/src/drivers/power_monitor/ina220/ina220_params.yaml @@ -22,6 +22,7 @@ parameters: description: short: INA220 Power Monitor Battery Max Current type: float + unit: A default: 164.0 min: 0.1 max: 500.0 @@ -31,6 +32,7 @@ parameters: description: short: INA220 Power Monitor Battery Shunt type: float + unit: Ohm default: 0.0005 min: 1.0e-09 max: 0.1 @@ -40,6 +42,7 @@ parameters: description: short: INA220 Power Monitor Regulator Max Current type: float + unit: A default: 164.0 min: 0.1 max: 500.0 @@ -49,6 +52,7 @@ parameters: description: short: INA220 Power Monitor Regulator Shunt type: float + unit: Ohm default: 0.0005 min: 1.0e-09 max: 0.1 diff --git a/src/drivers/power_monitor/ina226/ina226_params.yaml b/src/drivers/power_monitor/ina226/ina226_params.yaml index 0f579e8e239..dbe56efd75a 100644 --- a/src/drivers/power_monitor/ina226/ina226_params.yaml +++ b/src/drivers/power_monitor/ina226/ina226_params.yaml @@ -13,6 +13,7 @@ parameters: description: short: INA226 Power Monitor Max Current type: float + unit: A default: 164.0 min: 0.1 max: 200.0 @@ -23,6 +24,7 @@ parameters: description: short: INA226 Power Monitor Shunt type: float + unit: Ohm default: 0.0005 min: 1.0e-09 max: 0.1 diff --git a/src/drivers/power_monitor/ina228/ina228_params.yaml b/src/drivers/power_monitor/ina228/ina228_params.yaml index bf133d3a601..2db928a5025 100644 --- a/src/drivers/power_monitor/ina228/ina228_params.yaml +++ b/src/drivers/power_monitor/ina228/ina228_params.yaml @@ -13,6 +13,7 @@ parameters: description: short: INA228 Power Monitor Max Current type: float + unit: A default: 327.68 min: 0.1 max: 1638.40 @@ -23,6 +24,7 @@ parameters: description: short: INA228 Power Monitor Shunt type: float + unit: Ohm default: 0.0005 min: 1.0e-09 max: 0.1 diff --git a/src/drivers/power_monitor/ina238/ina238_params.yaml b/src/drivers/power_monitor/ina238/ina238_params.yaml index 18a482fe776..4f07a30d6fc 100644 --- a/src/drivers/power_monitor/ina238/ina238_params.yaml +++ b/src/drivers/power_monitor/ina238/ina238_params.yaml @@ -13,6 +13,7 @@ parameters: description: short: INA238 Power Monitor Max Current type: float + unit: A default: 327.68 min: 0.1 max: 1638.40 @@ -23,6 +24,7 @@ parameters: description: short: INA238 Power Monitor Shunt type: float + unit: Ohm default: 0.0005 min: 1.0e-09 max: 0.1 diff --git a/src/drivers/power_monitor/voxlpm/voxlpm_params.yaml b/src/drivers/power_monitor/voxlpm/voxlpm_params.yaml index 60c715d000a..2ae33e95edb 100644 --- a/src/drivers/power_monitor/voxlpm/voxlpm_params.yaml +++ b/src/drivers/power_monitor/voxlpm/voxlpm_params.yaml @@ -6,6 +6,7 @@ parameters: description: short: VOXL Power Monitor Shunt, Battery type: float + unit: Ohm default: 0.00063 reboot_required: true min: 1.0e-09 @@ -16,6 +17,7 @@ parameters: description: short: VOXL Power Monitor Shunt, Regulator type: float + unit: Ohm default: 0.0056 reboot_required: true min: 1.0e-09 diff --git a/src/drivers/vtx/module.yaml b/src/drivers/vtx/module.yaml index bde8530ea5c..0e7f0b3fd03 100644 --- a/src/drivers/vtx/module.yaml +++ b/src/drivers/vtx/module.yaml @@ -65,11 +65,12 @@ parameters: default: 0 VTX_FREQUENCY: description: - short: VTX frequency in MHz + short: VTX frequency long: | If the VTX frequency is set, it will overwrite the band and channel settings. Set to 0 to use band and channel settings. type: int32 + unit: MHz min: 0 max: 32000 default: 0 diff --git a/src/lib/battery/module.yaml b/src/lib/battery/module.yaml index cdf5f756c51..cfe3a0f5cad 100644 --- a/src/lib/battery/module.yaml +++ b/src/lib/battery/module.yaml @@ -121,8 +121,9 @@ parameters: BAT${i}_I_OVERWRITE: description: short: Battery ${i} idle current overwrite - long: While disarmed, replaces the measured current with this value in amps, for ESCs that measure current inaccurately at no load. Set to 0 or less to disable. + long: While disarmed, replaces the measured current with this value, for ESCs that measure current inaccurately at no load. Set to 0 or less to disable. type: float + unit: A decimal: 2 num_instances: *max_num_config_instances instance_start: 1 diff --git a/src/lib/fw_performance_model/performance_model_params.yaml b/src/lib/fw_performance_model/performance_model_params.yaml index 025c6f14707..dcb05cd821d 100644 --- a/src/lib/fw_performance_model/performance_model_params.yaml +++ b/src/lib/fw_performance_model/performance_model_params.yaml @@ -22,6 +22,7 @@ parameters: Set to 0 to disable mapping of airspeed to trim throttle below FW_AIRSPD_TRIM. type: float + unit: norm default: 0.0 min: 0 max: 1 @@ -35,6 +36,7 @@ parameters: Set to 0 to disable mapping of airspeed to trim throttle. type: float + unit: norm default: 0.0 min: 0 max: 1 diff --git a/src/lib/parameters/px4params/srcparser.py b/src/lib/parameters/px4params/srcparser.py index 7444125ba8e..d9c92eaf7f8 100644 --- a/src/lib/parameters/px4params/srcparser.py +++ b/src/lib/parameters/px4params/srcparser.py @@ -370,7 +370,7 @@ class SourceParser(object): 'celcius', 'gauss', 'gauss/s', 'gauss^2', 'liters', 'hPa', 'kg', 'kg/m^2', 'kg m^2', 'kg/m^3', 'mm', 'm', 'm/s', 'm^2', 'm/s^2', 'm/s^3', 'm/s^2/sqrt(Hz)', '1/s/sqrt(Hz)', 'm/s/rad', 'g0', - 'Ohm', 'V', 'A', + 'Ohm', 'V', 'A', 'A/V', 'Pa', 'Pa/V', 'MHz', 'us', 'ms', 's', 'S', 'A/%', '(m/s^2)^2', 'm/m', 'tan(rad)^2', '(m/s)^2', 'm/rad', 'm/s^3/sqrt(Hz)', 'm/s/sqrt(Hz)', 's/(1000*PWM)', '%m/s', 'min', 'us/C', diff --git a/src/modules/battery_status/analog_battery_params_common.yaml b/src/modules/battery_status/analog_battery_params_common.yaml index 1d792006355..01089976dab 100644 --- a/src/modules/battery_status/analog_battery_params_common.yaml +++ b/src/modules/battery_status/analog_battery_params_common.yaml @@ -4,10 +4,11 @@ parameters: definitions: BAT_V_OFFS_CURR: description: - short: Offset in volt as seen by the ADC input of the current sensor + short: Offset as seen by the ADC input of the current sensor long: |- This offset will be subtracted before calculating the battery current based on the voltage. type: float + unit: V default: 0.0 decimal: 8 diff --git a/src/modules/battery_status/module.yaml b/src/modules/battery_status/module.yaml index a908a87ff07..e5a10319276 100644 --- a/src/modules/battery_status/module.yaml +++ b/src/modules/battery_status/module.yaml @@ -23,13 +23,14 @@ parameters: BAT${i}_A_PER_V: description: - short: Battery ${i} current per volt (A/V) + short: Battery ${i} current per volt long: | The voltage seen by the ADC multiplied by this factor will determine the battery current. A value of -1 means to use the board default. type: float + unit: A/V decimal: 8 reboot_required: true num_instances: *max_num_config_instances diff --git a/src/modules/flight_mode_manager/tasks/AutoFollowTarget/follow_target_params.yaml b/src/modules/flight_mode_manager/tasks/AutoFollowTarget/follow_target_params.yaml index 76d600be763..6921615812f 100644 --- a/src/modules/flight_mode_manager/tasks/AutoFollowTarget/follow_target_params.yaml +++ b/src/modules/flight_mode_manager/tasks/AutoFollowTarget/follow_target_params.yaml @@ -30,7 +30,7 @@ parameters: min: 1.0 FLW_TGT_FA: description: - short: Follow Angle setting in degrees + short: Follow Angle setting long: |- Angle to follow the target from. 0.0 Equals straight in front of the target's course (direction of motion) and the angle increases in clockwise direction, @@ -39,6 +39,7 @@ parameters: Note: When the user force sets the angle out of the min/max range, it will be wrapped (e.g. 480 -> 120) in the range to gracefully handle the out of range. type: float + unit: deg default: 180.0 min: -180.0 max: 180.0 @@ -68,6 +69,7 @@ parameters: This is the maximum tangential velocity the drone will circle around the target whenever an orbit angle setpoint changes. Higher value means more aggressive follow behavior. type: float + unit: m/s default: 5.0 min: 0.0 max: 20.0 diff --git a/src/modules/fw_lateral_longitudinal_control/fw_lat_long_params.yaml b/src/modules/fw_lateral_longitudinal_control/fw_lat_long_params.yaml index 42c9dfb0e5f..d8bcd5fb8f9 100644 --- a/src/modules/fw_lateral_longitudinal_control/fw_lat_long_params.yaml +++ b/src/modules/fw_lateral_longitudinal_control/fw_lat_long_params.yaml @@ -34,6 +34,7 @@ parameters: short: Throttle max slew rate long: Maximum slew rate for the commanded throttle type: float + unit: 1/s default: 0.0 min: 0.0 max: 1.0 @@ -129,6 +130,7 @@ parameters: description: short: Altitude error time constant type: float + unit: s default: 5.0 min: 2.0 decimal: 2 @@ -140,6 +142,7 @@ parameters: Minimum altitude error needed to descend with max airspeed and minimal throttle. A negative value disables fast descend. type: float + unit: m default: -1.0 min: -1.0 decimal: 0 @@ -156,6 +159,7 @@ parameters: description: short: True airspeed error time constant type: float + unit: s default: 5.0 min: 2.0 decimal: 2 @@ -166,6 +170,7 @@ parameters: long: This filter is applied to the specific total energy rate used for throttle damping. type: float + unit: s default: 0.4 min: 0.0 max: 2 diff --git a/src/modules/gimbal/gimbal_params.yaml b/src/modules/gimbal/gimbal_params.yaml index 373b4c86615..7b4eec9526b 100644 --- a/src/modules/gimbal/gimbal_params.yaml +++ b/src/modules/gimbal/gimbal_params.yaml @@ -198,12 +198,13 @@ parameters: description: short: Time constant for open-loop AUX gimbal control long: |- - Alpha filter time constant defining the convergence rate (in seconds) for open-loop AUX mount control + Alpha filter time constant defining the convergence rate for open-loop AUX mount control Use when no angular position feedback is available. With MNT_MODE_OUT set to AUX, the mount operates in open-loop and directly commands the servo output. Parameters must be tuned for the specific servo to approximate its speed and response. type: float + unit: s default: 0.3 min: 0.0 MNT_RC_IN_MODE: diff --git a/src/modules/mc_nn_control/mc_nn_control_params.yaml b/src/modules/mc_nn_control/mc_nn_control_params.yaml index 6cb2ff72807..9385b2d2766 100644 --- a/src/modules/mc_nn_control/mc_nn_control_params.yaml +++ b/src/modules/mc_nn_control/mc_nn_control_params.yaml @@ -15,6 +15,7 @@ parameters: sets the part of the action range the motor can reproduce, which the module reports at startup. type: int32 + unit: rpm default: 22000 min: 0 max: 80000 @@ -24,6 +25,7 @@ parameters: long: The minimum RPM of the motors. Used to normalize the output of the neural network. Actions that ask for less than this idle the motor. type: int32 + unit: rpm default: 1000 min: 0 max: 80000 diff --git a/src/modules/mc_pos_control/multicopter_autonomous_params.yaml b/src/modules/mc_pos_control/multicopter_autonomous_params.yaml index 5407e6cbbcb..72606ed4644 100644 --- a/src/modules/mc_pos_control/multicopter_autonomous_params.yaml +++ b/src/modules/mc_pos_control/multicopter_autonomous_params.yaml @@ -126,6 +126,7 @@ parameters: capabilities of the vehicle. Set to 0 to disable the horizontal time-stretch. type: float + unit: m default: 2.0 min: 0 max: 10 @@ -143,6 +144,7 @@ parameters: estimate is refined in flight). Set to 0 to disable the vertical time-stretch. type: float + unit: m default: 1.0 min: 0 max: 10 diff --git a/src/modules/mc_pos_control/multicopter_responsiveness_params.yaml b/src/modules/mc_pos_control/multicopter_responsiveness_params.yaml index 715108cdd73..574bff7c393 100644 --- a/src/modules/mc_pos_control/multicopter_responsiveness_params.yaml +++ b/src/modules/mc_pos_control/multicopter_responsiveness_params.yaml @@ -26,6 +26,7 @@ parameters: MPC_XY_VEL_MAX or MPC_VEL_MANUAL). If set to a negative value, the existing individual parameters are used. type: float + unit: m/s default: -10.0 min: -20 max: 20 @@ -39,6 +40,7 @@ parameters: MPC_Z_VEL_MAX_UP or MPC_LAND_SPEED). If set to a negative value, the existing individual parameters are used. type: float + unit: m/s default: -3.0 min: -3 max: 8 diff --git a/src/modules/sensors/module.yaml b/src/modules/sensors/module.yaml index 43f76fe13a6..83cb7673812 100644 --- a/src/modules/sensors/module.yaml +++ b/src/modules/sensors/module.yaml @@ -203,9 +203,9 @@ parameters: short: Barometer ${i} offset category: System type: float + unit: Pa default: 0.0 decimal: 3 - #unit: Pa volatile: true num_instances: *max_num_sensor_instances instance_start: 0 @@ -224,9 +224,10 @@ parameters: CAL_DPRES${i}_OFF: description: short: Differential pressure sensor ${i} offset - long: The zero-reading of this differential pressure sensor, in Pascal. + long: The zero-reading of this differential pressure sensor. category: System type: float + unit: Pa default: 0.0 decimal: 3 volatile: true diff --git a/src/modules/sensors/sensor_params.yaml b/src/modules/sensors/sensor_params.yaml index ce731b413a0..99bc57daa99 100644 --- a/src/modules/sensors/sensor_params.yaml +++ b/src/modules/sensors/sensor_params.yaml @@ -6,12 +6,13 @@ parameters: description: short: Differential pressure sensor offset of the first airspeed sensor long: |- - The offset (zero-reading) in Pascal of the sensor holding calibration slot 0. + The offset (zero-reading) of the sensor holding calibration slot 0. Kept as a mirror of CAL_DPRES0_OFF so that ground stations can still detect whether airspeed has been calibrated. The firmware applies CAL_DPRESx_OFF, not this value. category: System type: float + unit: Pa default: 0.0 volatile: true SENS_DPRES_REV: @@ -29,11 +30,12 @@ parameters: long: |- Pick the appropriate scaling from the datasheet. this number defines the (linear) conversion from voltage - to Pascal (pa). For the MPXV7002DP this is 1000. + to pressure. For the MPXV7002DP this is 1000. NOTE: If the sensor always registers zero, try switching the static and dynamic tubes. type: float + unit: Pa/V default: 0 - group: Sensors definitions: diff --git a/src/modules/simulation/sensor_baro_sim/parameters.yaml b/src/modules/simulation/sensor_baro_sim/parameters.yaml index 996604464a3..2e8b111771b 100644 --- a/src/modules/simulation/sensor_baro_sim/parameters.yaml +++ b/src/modules/simulation/sensor_baro_sim/parameters.yaml @@ -19,6 +19,7 @@ parameters: description: short: simulated barometer pressure offset type: float + unit: Pa default: 0.0 SIM_BARO_OFF_T: description: diff --git a/src/modules/spacecraft/spacecraft_position_params.yaml b/src/modules/spacecraft/spacecraft_position_params.yaml index 700bda83ad2..1c49c74cd13 100644 --- a/src/modules/spacecraft/spacecraft_position_params.yaml +++ b/src/modules/spacecraft/spacecraft_position_params.yaml @@ -93,6 +93,7 @@ parameters: MPC_VEL_MAX or MPC_VEL_MANUAL). If set to a negative value, the existing individual parameters are used. type: float + unit: m/s default: -10.0 min: -20 max: 20 diff --git a/src/modules/temperature_compensation/temp_comp_params_accel_0.yaml b/src/modules/temperature_compensation/temp_comp_params_accel_0.yaml index 67858e49f92..b8e7f6a3f47 100644 --- a/src/modules/temperature_compensation/temp_comp_params_accel_0.yaml +++ b/src/modules/temperature_compensation/temp_comp_params_accel_0.yaml @@ -85,16 +85,19 @@ parameters: short: Accelerometer calibration reference temperature category: System type: float + unit: celcius default: 25.0 TC_A0_TMIN: description: short: Accelerometer calibration minimum temperature category: System type: float + unit: celcius default: 0.0 TC_A0_TMAX: description: short: Accelerometer calibration maximum temperature category: System type: float + unit: celcius default: 100.0 diff --git a/src/modules/temperature_compensation/temp_comp_params_accel_1.yaml b/src/modules/temperature_compensation/temp_comp_params_accel_1.yaml index 637a27ffeb6..b991bb1e972 100644 --- a/src/modules/temperature_compensation/temp_comp_params_accel_1.yaml +++ b/src/modules/temperature_compensation/temp_comp_params_accel_1.yaml @@ -85,16 +85,19 @@ parameters: short: Accelerometer calibration reference temperature category: System type: float + unit: celcius default: 25.0 TC_A1_TMIN: description: short: Accelerometer calibration minimum temperature category: System type: float + unit: celcius default: 0.0 TC_A1_TMAX: description: short: Accelerometer calibration maximum temperature category: System type: float + unit: celcius default: 100.0 diff --git a/src/modules/temperature_compensation/temp_comp_params_accel_2.yaml b/src/modules/temperature_compensation/temp_comp_params_accel_2.yaml index acbe656ed6a..287d84508b6 100644 --- a/src/modules/temperature_compensation/temp_comp_params_accel_2.yaml +++ b/src/modules/temperature_compensation/temp_comp_params_accel_2.yaml @@ -85,16 +85,19 @@ parameters: short: Accelerometer calibration reference temperature category: System type: float + unit: celcius default: 25.0 TC_A2_TMIN: description: short: Accelerometer calibration minimum temperature category: System type: float + unit: celcius default: 0.0 TC_A2_TMAX: description: short: Accelerometer calibration maximum temperature category: System type: float + unit: celcius default: 100.0 diff --git a/src/modules/temperature_compensation/temp_comp_params_accel_3.yaml b/src/modules/temperature_compensation/temp_comp_params_accel_3.yaml index 6467c20607b..e1f4d27eb88 100644 --- a/src/modules/temperature_compensation/temp_comp_params_accel_3.yaml +++ b/src/modules/temperature_compensation/temp_comp_params_accel_3.yaml @@ -85,16 +85,19 @@ parameters: short: Accelerometer calibration reference temperature category: System type: float + unit: celcius default: 25.0 TC_A3_TMIN: description: short: Accelerometer calibration minimum temperature category: System type: float + unit: celcius default: 0.0 TC_A3_TMAX: description: short: Accelerometer calibration maximum temperature category: System type: float + unit: celcius default: 100.0 diff --git a/src/modules/temperature_compensation/temp_comp_params_baro_0.yaml b/src/modules/temperature_compensation/temp_comp_params_baro_0.yaml index cc3f2cf25fd..5f6aa7e86bb 100644 --- a/src/modules/temperature_compensation/temp_comp_params_baro_0.yaml +++ b/src/modules/temperature_compensation/temp_comp_params_baro_0.yaml @@ -49,16 +49,19 @@ parameters: short: Barometer calibration reference temperature category: System type: float + unit: celcius default: 40.0 TC_B0_TMIN: description: short: Barometer calibration minimum temperature category: System type: float + unit: celcius default: 5.0 TC_B0_TMAX: description: short: Barometer calibration maximum temperature category: System type: float + unit: celcius default: 75.0 diff --git a/src/modules/temperature_compensation/temp_comp_params_baro_1.yaml b/src/modules/temperature_compensation/temp_comp_params_baro_1.yaml index 3d5094bb469..59d27aff448 100644 --- a/src/modules/temperature_compensation/temp_comp_params_baro_1.yaml +++ b/src/modules/temperature_compensation/temp_comp_params_baro_1.yaml @@ -49,16 +49,19 @@ parameters: short: Barometer calibration reference temperature category: System type: float + unit: celcius default: 40.0 TC_B1_TMIN: description: short: Barometer calibration minimum temperature category: System type: float + unit: celcius default: 5.0 TC_B1_TMAX: description: short: Barometer calibration maximum temperature category: System type: float + unit: celcius default: 75.0 diff --git a/src/modules/temperature_compensation/temp_comp_params_baro_2.yaml b/src/modules/temperature_compensation/temp_comp_params_baro_2.yaml index 9e8602e66a9..3377a644c5a 100644 --- a/src/modules/temperature_compensation/temp_comp_params_baro_2.yaml +++ b/src/modules/temperature_compensation/temp_comp_params_baro_2.yaml @@ -49,16 +49,19 @@ parameters: short: Barometer calibration reference temperature category: System type: float + unit: celcius default: 40.0 TC_B2_TMIN: description: short: Barometer calibration minimum temperature category: System type: float + unit: celcius default: 5.0 TC_B2_TMAX: description: short: Barometer calibration maximum temperature category: System type: float + unit: celcius default: 75.0 diff --git a/src/modules/temperature_compensation/temp_comp_params_baro_3.yaml b/src/modules/temperature_compensation/temp_comp_params_baro_3.yaml index c2ad5c5597a..e63de1aff16 100644 --- a/src/modules/temperature_compensation/temp_comp_params_baro_3.yaml +++ b/src/modules/temperature_compensation/temp_comp_params_baro_3.yaml @@ -49,16 +49,19 @@ parameters: short: Barometer calibration reference temperature category: System type: float + unit: celcius default: 40.0 TC_B3_TMIN: description: short: Barometer calibration minimum temperature category: System type: float + unit: celcius default: 5.0 TC_B3_TMAX: description: short: Barometer calibration maximum temperature category: System type: float + unit: celcius default: 75.0 diff --git a/src/modules/temperature_compensation/temp_comp_params_gyro_0.yaml b/src/modules/temperature_compensation/temp_comp_params_gyro_0.yaml index b700d82f9d4..b1d0cdf00ee 100644 --- a/src/modules/temperature_compensation/temp_comp_params_gyro_0.yaml +++ b/src/modules/temperature_compensation/temp_comp_params_gyro_0.yaml @@ -85,16 +85,19 @@ parameters: short: Gyro calibration reference temperature category: System type: float + unit: celcius default: 25.0 TC_G0_TMIN: description: short: Gyro calibration minimum temperature category: System type: float + unit: celcius default: 0.0 TC_G0_TMAX: description: short: Gyro calibration maximum temperature category: System type: float + unit: celcius default: 100.0 diff --git a/src/modules/temperature_compensation/temp_comp_params_gyro_1.yaml b/src/modules/temperature_compensation/temp_comp_params_gyro_1.yaml index c3bf746fef6..df7012e8351 100644 --- a/src/modules/temperature_compensation/temp_comp_params_gyro_1.yaml +++ b/src/modules/temperature_compensation/temp_comp_params_gyro_1.yaml @@ -85,16 +85,19 @@ parameters: short: Gyro calibration reference temperature category: System type: float + unit: celcius default: 25.0 TC_G1_TMIN: description: short: Gyro calibration minimum temperature category: System type: float + unit: celcius default: 0.0 TC_G1_TMAX: description: short: Gyro calibration maximum temperature category: System type: float + unit: celcius default: 100.0 diff --git a/src/modules/temperature_compensation/temp_comp_params_gyro_2.yaml b/src/modules/temperature_compensation/temp_comp_params_gyro_2.yaml index efbe6c7d427..56b9224dd31 100644 --- a/src/modules/temperature_compensation/temp_comp_params_gyro_2.yaml +++ b/src/modules/temperature_compensation/temp_comp_params_gyro_2.yaml @@ -85,16 +85,19 @@ parameters: short: Gyro calibration reference temperature category: System type: float + unit: celcius default: 25.0 TC_G2_TMIN: description: short: Gyro calibration minimum temperature category: System type: float + unit: celcius default: 0.0 TC_G2_TMAX: description: short: Gyro calibration maximum temperature category: System type: float + unit: celcius default: 100.0 diff --git a/src/modules/temperature_compensation/temp_comp_params_gyro_3.yaml b/src/modules/temperature_compensation/temp_comp_params_gyro_3.yaml index 4db6e6b93b4..b8438c19667 100644 --- a/src/modules/temperature_compensation/temp_comp_params_gyro_3.yaml +++ b/src/modules/temperature_compensation/temp_comp_params_gyro_3.yaml @@ -85,16 +85,19 @@ parameters: short: Gyro calibration reference temperature category: System type: float + unit: celcius default: 25.0 TC_G3_TMIN: description: short: Gyro calibration minimum temperature category: System type: float + unit: celcius default: 0.0 TC_G3_TMAX: description: short: Gyro calibration maximum temperature category: System type: float + unit: celcius default: 100.0 diff --git a/src/modules/temperature_compensation/temp_comp_params_mag_0.yaml b/src/modules/temperature_compensation/temp_comp_params_mag_0.yaml index b72f7dead5e..b200e61178e 100644 --- a/src/modules/temperature_compensation/temp_comp_params_mag_0.yaml +++ b/src/modules/temperature_compensation/temp_comp_params_mag_0.yaml @@ -85,16 +85,19 @@ parameters: short: Magnetometer calibration reference temperature category: System type: float + unit: celcius default: 25.0 TC_M0_TMIN: description: short: Magnetometer calibration minimum temperature category: System type: float + unit: celcius default: 0.0 TC_M0_TMAX: description: short: Magnetometer calibration maximum temperature category: System type: float + unit: celcius default: 100.0 diff --git a/src/modules/temperature_compensation/temp_comp_params_mag_1.yaml b/src/modules/temperature_compensation/temp_comp_params_mag_1.yaml index 0e456fa100e..65daaf55a0b 100644 --- a/src/modules/temperature_compensation/temp_comp_params_mag_1.yaml +++ b/src/modules/temperature_compensation/temp_comp_params_mag_1.yaml @@ -85,16 +85,19 @@ parameters: short: Magnetometer calibration reference temperature category: System type: float + unit: celcius default: 25.0 TC_M1_TMIN: description: short: Magnetometer calibration minimum temperature category: System type: float + unit: celcius default: 0.0 TC_M1_TMAX: description: short: Magnetometer calibration maximum temperature category: System type: float + unit: celcius default: 100.0 diff --git a/src/modules/temperature_compensation/temp_comp_params_mag_2.yaml b/src/modules/temperature_compensation/temp_comp_params_mag_2.yaml index 84ff032523a..5aeb3d3ca8d 100644 --- a/src/modules/temperature_compensation/temp_comp_params_mag_2.yaml +++ b/src/modules/temperature_compensation/temp_comp_params_mag_2.yaml @@ -85,16 +85,19 @@ parameters: short: Magnetometer calibration reference temperature category: System type: float + unit: celcius default: 25.0 TC_M2_TMIN: description: short: Magnetometer calibration minimum temperature category: System type: float + unit: celcius default: 0.0 TC_M2_TMAX: description: short: Magnetometer calibration maximum temperature category: System type: float + unit: celcius default: 100.0 diff --git a/src/modules/temperature_compensation/temp_comp_params_mag_3.yaml b/src/modules/temperature_compensation/temp_comp_params_mag_3.yaml index d8faeccad0a..1ec10eabc4c 100644 --- a/src/modules/temperature_compensation/temp_comp_params_mag_3.yaml +++ b/src/modules/temperature_compensation/temp_comp_params_mag_3.yaml @@ -85,16 +85,19 @@ parameters: short: Magnetometer calibration reference temperature category: System type: float + unit: celcius default: 25.0 TC_M3_TMIN: description: short: Magnetometer calibration minimum temperature category: System type: float + unit: celcius default: 0.0 TC_M3_TMAX: description: short: Magnetometer calibration maximum temperature category: System type: float + unit: celcius default: 100.0 diff --git a/src/modules/uuv_att_control/uuv_att_control_params.yaml b/src/modules/uuv_att_control/uuv_att_control_params.yaml index 412b80dc969..9f5f834aa02 100644 --- a/src/modules/uuv_att_control/uuv_att_control_params.yaml +++ b/src/modules/uuv_att_control/uuv_att_control_params.yaml @@ -140,8 +140,9 @@ parameters: decimal: 2 UUV_SP_MAX_AGE: description: - short: Maximum time (in seconds) before resetting setpoint + short: Maximum time before resetting setpoint type: float + unit: s default: 2.0 UUV_STICK_MODE: description: diff --git a/src/modules/uuv_pos_control/uuv_pos_control_params.yaml b/src/modules/uuv_pos_control/uuv_pos_control_params.yaml index a7de0aad38c..232dfdcea43 100644 --- a/src/modules/uuv_pos_control/uuv_pos_control_params.yaml +++ b/src/modules/uuv_pos_control/uuv_pos_control_params.yaml @@ -38,6 +38,7 @@ parameters: long: maximum Height distance controlled by manual input. Diff between actual and desired Height cannot be higher than that type: float + unit: m default: 0.3 decimal: 2 UUV_HGT_B_UP: diff --git a/src/modules/vtol_att_control/vtol_att_control_params.yaml b/src/modules/vtol_att_control/vtol_att_control_params.yaml index 5c433cd60e3..e2f0885a87f 100644 --- a/src/modules/vtol_att_control/vtol_att_control_params.yaml +++ b/src/modules/vtol_att_control/vtol_att_control_params.yaml @@ -48,6 +48,7 @@ parameters: short: Target throttle value for the transition to fixed-wing flight long: Scaled by the square root of the weight ratio (WEIGHT_GROSS / WEIGHT_BASE). type: float + unit: norm default: 1.0 min: 0.0 max: 1.0 diff --git a/validation/module_schema.yaml b/validation/module_schema.yaml index edc245f485e..87c3ad4ae16 100644 --- a/validation/module_schema.yaml +++ b/validation/module_schema.yaml @@ -149,7 +149,7 @@ parameters: 'celcius', 'gauss', 'gauss/s', 'mgauss', 'mgauss^2', 'hPa', 'kg', 'kg/m^2', 'kg m^2', 'kg/m^3', 'mm', 'm', 'm/s', 'm^2', 'm/s^2', 'm/s^3', 'm/s^2/sqrt(Hz)', 'm/s/rad', 'g0', - 'Ohm', 'V', 'A', + 'Ohm', 'V', 'A', 'A/V', 'Pa', 'Pa/V', 'MHz', 'us', 'ms', 's', 'S', 'A/%', '(m/s^2)^2', 'm/m', 'tan(rad)^2', '(m/s)^2', 'm/rad', 'm/s^3/sqrt(Hz)', 'm/s/sqrt(Hz)', 's/(1000*PWM)', '%m/s', 'min', 'us/C',