dark0707
/
px4-firmware
forked from Archive/PX4-Autopilot
1
0
Fork 0
Code Pull Requests Activity

Clarified parameter comments and added @group attributed for auto-generation.

This commit is contained in:
Darryl Taylor 2014-06-22 16:43:05 +08:00
parent 45d5e26009
commit ebd68f4ffa
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/modules/sensors/sensor_params.c
View File

@ -243,26 +243,32 @@ PARAM_DEFINE_INT32(SENS_DPRES_ANA, 0);
PARAM_DEFINE_INT32(SENS_BOARD_ROT, 0); PARAM_DEFINE_INT32(SENS_BOARD_ROT, 0);
/** /**
* Board rotation pitch offset * Board rotation Y (Pitch) offset
* *
* This parameter defines a pitch offset from the board rotation. It allows the user * 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. * to fine tune the board offset in the event of misalignment.
*
* @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(SENS_BOARD_Y_OFF, 0.0f); PARAM_DEFINE_FLOAT(SENS_BOARD_Y_OFF, 0.0f);
/** /**
* Board rotation roll offset * Board rotation X (Roll) offset
* *
* This parameter defines a roll offset from the board rotation. It allows the user * 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. * to fine tune the board offset in the event of misalignment.
*
* @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(SENS_BOARD_X_OFF, 0.0f); PARAM_DEFINE_FLOAT(SENS_BOARD_X_OFF, 0.0f);
/** /**
* Board rotation YAW offset * Board rotation Z (YAW) offset
* *
* This parameter defines a yaw offset from the board rotation. It allows the user * 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. * to fine tune the board offset in the event of misalignment.
*
* @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(SENS_BOARD_Z_OFF, 0.0f); PARAM_DEFINE_FLOAT(SENS_BOARD_Z_OFF, 0.0f);