sensors param @unit

This commit is contained in:
Daniel Agar 2016-03-13 16:01:19 -04:00 committed by Lorenz Meier
parent 3e44957d20
commit d840eac923
1 changed files with 47 additions and 17 deletions

View File

@ -329,6 +329,7 @@ PARAM_DEFINE_INT32(CAL_MAG1_ID, 0);
* should only attempt to configure the rotation if the value is
* greater than or equal to zero.
*
* @unit enum
* @value -1 Internal mag
* @value 0 No rotation
* @value 1 Yaw 45°
@ -535,6 +536,7 @@ PARAM_DEFINE_INT32(CAL_MAG2_ID, 0);
* should only attempt to configure the rotation if the value is
* greater than or equal to zero.
*
* @unit enum
* @value -1 Internal mag
* @value 0 No rotation
* @value 1 Yaw 45°
@ -732,6 +734,8 @@ PARAM_DEFINE_FLOAT(SENS_BARO_QNH, 1013.25f);
* Board rotation
*
* This parameter defines the rotation of the FMU board relative to the platform.
*
* @unit enum
* @value 0 No rotation
* @value 1 Yaw 45°
* @value 2 Yaw 90°
@ -769,6 +773,7 @@ PARAM_DEFINE_INT32(SENS_BOARD_ROT, 0);
* This parameter defines the rotation of the PX4FLOW board relative to the platform.
* Zero rotation is defined as Y on flow board pointing towards front of vehicle
*
* @unit enum
* @value 0 No rotation
* @value 1 Yaw 45°
* @value 2 Yaw 90°
@ -788,7 +793,7 @@ PARAM_DEFINE_INT32(SENS_FLOW_ROT, 0);
* This parameter defines a rotational offset in degrees around the Y (Pitch) axis. It allows the user
* to fine tune the board offset in the event of misalignment.
*
* @unit degrees
* @unit deg
* @group Sensor Calibration
*/
PARAM_DEFINE_FLOAT(SENS_BOARD_Y_OFF, 0.0f);
@ -799,7 +804,7 @@ PARAM_DEFINE_FLOAT(SENS_BOARD_Y_OFF, 0.0f);
* This parameter defines a rotational offset in degrees around the X (Roll) axis It allows the user
* to fine tune the board offset in the event of misalignment.
*
* @unit degrees
* @unit deg
* @group Sensor Calibration
*/
PARAM_DEFINE_FLOAT(SENS_BOARD_X_OFF, 0.0f);
@ -810,7 +815,7 @@ PARAM_DEFINE_FLOAT(SENS_BOARD_X_OFF, 0.0f);
* This parameter defines a rotational offset in degrees around the Z (Yaw) axis. It allows the user
* to fine tune the board offset in the event of misalignment.
*
* @unit degrees
* @unit deg
* @group Sensor Calibration
*/
PARAM_DEFINE_FLOAT(SENS_BOARD_Z_OFF, 0.0f);
@ -818,6 +823,7 @@ PARAM_DEFINE_FLOAT(SENS_BOARD_Z_OFF, 0.0f);
/**
* External magnetometer rotation
*
* @unit enum
* @value 0 No rotation
* @value 1 Yaw 45°
* @value 2 Yaw 90°
@ -852,6 +858,7 @@ PARAM_DEFINE_INT32(SENS_EXT_MAG_ROT, 0);
/**
* Select primary magnetometer
*
* @unit enum
* @min 0
* @max 2
* @value 0 Auto-select Mag
@ -1160,6 +1167,7 @@ PARAM_DEFINE_FLOAT(RC5_DZ, 10.0f);
*
* Minimum value for this channel.
*
* @unit us
* @min 800.0
* @max 1500.0
* @group Radio Calibration
@ -1217,6 +1225,7 @@ PARAM_DEFINE_FLOAT(RC6_DZ, 10.0f);
*
* Minimum value for this channel.
*
* @unit us
* @min 800.0
* @max 1500.0
* @group Radio Calibration
@ -1910,6 +1919,7 @@ PARAM_DEFINE_FLOAT(RC18_DZ, 0.0f);
/**
* Enable relay control of relay 1 mapped to the Spektrum receiver power supply
*
* @unit enum
* @min 0
* @max 1
* @value 0 Disabled
@ -1921,14 +1931,16 @@ PARAM_DEFINE_INT32(RC_RL1_DSM_VCC, 0); /* Relay 1 controls DSM VCC */
/**
* DSM binding trigger.
*
* @unit enum
* @value -1 Inactive
* @value 0 Start DSM2 bind
* @value 1 Start DSMX bind
* @min -1
* @max 1
* @group Radio Calibration
*/
PARAM_DEFINE_INT32(RC_DSM_BIND, -1);
/**
* Scaling factor for battery voltage sensor on PX4IO.
*
@ -1970,7 +1982,7 @@ PARAM_DEFINE_FLOAT(BAT_C_SCALING, -1.0);
PARAM_DEFINE_INT32(RC_CHAN_CNT, 0);
/**
* RC mode switch threshold automaic distribution
* RC mode switch threshold automatic distribution
*
* This parameter is used by Ground Station software to specify whether
* the threshold values for flight mode switches were automatically calculated.
@ -1978,8 +1990,7 @@ PARAM_DEFINE_INT32(RC_CHAN_CNT, 0);
* indicates that the threshold value where automatically set by the ground
* station software. It is only meant for ground station use.
*
* @min 0
* @max 1
* @unit boolean
* @group Radio Calibration
*/
@ -1992,6 +2003,7 @@ PARAM_DEFINE_INT32(RC_TH_USER, 1);
* which channel should be used for reading roll inputs from.
* A value of zero indicates the switch is not assigned.
*
* @unit enum
* @min 0
* @max 18
* @value 0 Unassigned
@ -2024,6 +2036,7 @@ PARAM_DEFINE_INT32(RC_MAP_ROLL, 0);
* which channel should be used for reading pitch inputs from.
* A value of zero indicates the switch is not assigned.
*
* @unit enum
* @min 0
* @max 18
* @value 0 Unassigned
@ -2056,6 +2069,7 @@ PARAM_DEFINE_INT32(RC_MAP_PITCH, 0);
* If 0, whichever channel is mapped to throttle is used
* otherwise the value indicates the specific rc channel to use
*
* @unit enum
* @min 0
* @max 18
* @value 0 Unassigned
@ -2087,6 +2101,7 @@ PARAM_DEFINE_INT32(RC_MAP_FAILSAFE, 0); //Default to throttle function
* which channel should be used for reading throttle inputs from.
* A value of zero indicates the switch is not assigned.
*
* @unit enum
* @min 0
* @max 18
* @value 0 Unassigned
@ -2119,6 +2134,7 @@ PARAM_DEFINE_INT32(RC_MAP_THROTTLE, 0);
* which channel should be used for reading yaw inputs from.
* A value of zero indicates the switch is not assigned.
*
* @unit enum
* @min 0
* @max 18
* @value 0 Unassigned
@ -2150,6 +2166,7 @@ PARAM_DEFINE_INT32(RC_MAP_YAW, 0);
* If this parameter is non-zero, flight modes are only selected
* by this channel and are assigned to six slots.
*
* @unit enum
* @min 0
* @max 18
* @group Radio Switches
@ -2183,6 +2200,7 @@ PARAM_DEFINE_INT32(RC_MAP_FLTMODE, 0);
* which channel should be used for deciding about the main mode.
* A value of zero indicates the switch is not assigned.
*
* @unit enum
* @min 0
* @max 18
* @group Radio Switches
@ -2211,6 +2229,7 @@ PARAM_DEFINE_INT32(RC_MAP_MODE_SW, 0);
/**
* Return switch channel
*
* @unit enum
* @min 0
* @max 18
* @group Radio Switches
@ -2239,6 +2258,7 @@ PARAM_DEFINE_INT32(RC_MAP_RETURN_SW, 0);
/**
* Rattitude switch channel
*
* @unit enum
* @min 0
* @max 18
* @group Radio Switches
@ -2267,6 +2287,7 @@ PARAM_DEFINE_INT32(RC_MAP_RATT_SW, 0);
/**
* Position Control switch channel
*
* @unit enum
* @min 0
* @max 18
* @group Radio Switches
@ -2295,6 +2316,7 @@ PARAM_DEFINE_INT32(RC_MAP_POSCTL_SW, 0);
/**
* Loiter switch channel
*
* @unit enum
* @min 0
* @max 18
* @group Radio Switches
@ -2323,6 +2345,7 @@ PARAM_DEFINE_INT32(RC_MAP_LOITER_SW, 0);
/**
* Acro switch channel
*
* @unit enum
* @min 0
* @max 18
* @group Radio Switches
@ -2351,6 +2374,7 @@ PARAM_DEFINE_INT32(RC_MAP_ACRO_SW, 0);
/**
* Offboard switch channel
*
* @unit enum
* @min 0
* @max 18
* @group Radio Switches
@ -2379,6 +2403,7 @@ PARAM_DEFINE_INT32(RC_MAP_OFFB_SW, 0);
/**
* Kill switch channel
*
* @unit enum
* @min 0
* @max 18
* @group Radio Switches
@ -2407,6 +2432,7 @@ PARAM_DEFINE_INT32(RC_MAP_KILL_SW, 0);
/**
* Flaps channel
*
* @unit enum
* @min 0
* @max 18
* @group Radio Switches
@ -2437,6 +2463,7 @@ PARAM_DEFINE_INT32(RC_MAP_FLAPS, 0);
*
* Default function: Camera pitch
*
* @unit enum
* @min 0
* @max 18
* @group Radio Calibration
@ -2467,6 +2494,7 @@ PARAM_DEFINE_INT32(RC_MAP_AUX1, 0);
*
* Default function: Camera roll
*
* @unit enum
* @min 0
* @max 18
* @group Radio Calibration
@ -2497,6 +2525,7 @@ PARAM_DEFINE_INT32(RC_MAP_AUX2, 0);
*
* Default function: Camera azimuth / yaw
*
* @unit enum
* @min 0
* @max 18
* @group Radio Calibration
@ -2528,6 +2557,7 @@ PARAM_DEFINE_INT32(RC_MAP_AUX3, 0);
* Can be used for parameter tuning with the RC. This one is further referenced as the 1st parameter channel.
* Set to 0 to deactivate *
*
* @unit enum
* @min 0
* @max 18
* @group Radio Calibration
@ -2559,6 +2589,7 @@ PARAM_DEFINE_INT32(RC_MAP_PARAM1, 0);
* Can be used for parameter tuning with the RC. This one is further referenced as the 2nd parameter channel.
* Set to 0 to deactivate *
*
* @unit enum
* @min 0
* @max 18
* @group Radio Calibration
@ -2590,6 +2621,7 @@ PARAM_DEFINE_INT32(RC_MAP_PARAM2, 0);
* Can be used for parameter tuning with the RC. This one is further referenced as the 3th parameter channel.
* Set to 0 to deactivate *
*
* @unit enum
* @min 0
* @max 18
* @group Radio Calibration
@ -2798,6 +2830,7 @@ PARAM_DEFINE_FLOAT(RC_KILLSWITCH_TH, 0.25f);
*
* Specify the range for RSSI input with RC_RSSI_PWM_MIN and RC_RSSI_PWM_MAX parameters.
*
* @unit enum
* @min 0
* @max 18
* @value 0 Unassigned
@ -2853,10 +2886,7 @@ PARAM_DEFINE_INT32(RC_RSSI_PWM_MIN, 2000);
*
* @reboot_required true
*
* @min 0
* @max 1
* @value 0 Disabled
* @value 1 Enabled
* @unit boolean
* @group Sensor Enable
*/
PARAM_DEFINE_INT32(SENS_EN_LL40LS, 0);
@ -2874,7 +2904,7 @@ PARAM_DEFINE_INT32(SENS_EN_LL40LS, 0);
*
* @min 800
* @max 1400
* @unit microseconds
* @unit us
* @group PWM Outputs
*/
PARAM_DEFINE_INT32(PWM_MIN, 1000);
@ -2892,7 +2922,7 @@ PARAM_DEFINE_INT32(PWM_MIN, 1000);
*
* @min 1600
* @max 2200
* @unit microseconds
* @unit us
* @group PWM Outputs
*/
PARAM_DEFINE_INT32(PWM_MAX, 2000);
@ -2911,7 +2941,7 @@ PARAM_DEFINE_INT32(PWM_MAX, 2000);
*
* @min 0
* @max 2200
* @unit microseconds
* @unit us
* @group PWM Outputs
*/
PARAM_DEFINE_INT32(PWM_DISARMED, 0);
@ -2929,7 +2959,7 @@ PARAM_DEFINE_INT32(PWM_DISARMED, 0);
*
* @min 800
* @max 1400
* @unit microseconds
* @unit us
* @group PWM Outputs
*/
PARAM_DEFINE_INT32(PWM_AUX_MIN, 1000);
@ -2947,7 +2977,7 @@ PARAM_DEFINE_INT32(PWM_AUX_MIN, 1000);
*
* @min 1600
* @max 2200
* @unit microseconds
* @unit us
* @group PWM Outputs
*/
PARAM_DEFINE_INT32(PWM_AUX_MAX, 2000);
@ -2966,7 +2996,7 @@ PARAM_DEFINE_INT32(PWM_AUX_MAX, 2000);
*
* @min 0
* @max 2200
* @unit microseconds
* @unit us
* @group PWM Outputs
*/
PARAM_DEFINE_INT32(PWM_AUX_DISARMED, 1000);