vmount: make the parameter descriptions a little nicer

This commit is contained in:
Nicolas de Palezieux 2017-08-10 16:37:48 +02:00 committed by Beat Küng
parent 281ee5e5af
commit c3faf587cc

View File

@ -39,9 +39,11 @@
/**
* Mount input mode
*
* RC uses the AUX input channels (see MNT_MAN_* parameters),
* MAVLINK_ROI uses the MAV_CMD_DO_SET_ROI Mavlink message, and MAVLINK_DO_MOUNT the
* MAV_CMD_DO_MOUNT_CONFIGURE and MAV_CMD_DO_MOUNT_CONTROL messages to control a mount.
*
* @value -1 DISABLED
* @value 0 AUTO
* @value 1 RC
@ -56,9 +58,11 @@ PARAM_DEFINE_INT32(MNT_MODE_IN, -1);
/**
* Mount output mode
*
* AUX uses the mixer output Control Group #2.
* MAVLINK uses the MAV_CMD_DO_MOUNT_CONFIGURE and MAV_CMD_DO_MOUNT_CONTROL MavLink messages
* to control a mount (set MNT_MAV_SYSID & MNT_MAV_COMPID)
*
* @value 0 AUX
* @value 1 MAVLINK
* @min 0
@ -68,14 +72,18 @@ PARAM_DEFINE_INT32(MNT_MODE_IN, -1);
PARAM_DEFINE_INT32(MNT_MODE_OUT, 0);
/**
* Mavlink System ID (if MNT_MODE_OUT is MAVLINK)
* Mavlink System ID of the mount
*
* If MNT_MODE_OUT is MAVLINK, mount configure/control commands will be sent with this target ID.
*
* @group Mount
*/
PARAM_DEFINE_INT32(MNT_MAV_SYSID, 1);
/**
* Mavlink Component ID (if MNT_MODE_OUT is MAVLINK)
* Mavlink Component ID of the mount
*
* If MNT_MODE_OUT is MAVLINK, mount configure/control commands will be sent with this component ID.
*
* @group Mount
*/
@ -84,6 +92,7 @@ PARAM_DEFINE_INT32(MNT_MAV_COMPID, 154);
/**
* Mixer value for selecting normal mode
* if required by the gimbal (only in AUX output mode)
*
* @min -1.0
* @max 1.0
* @decimal 3
@ -94,6 +103,7 @@ PARAM_DEFINE_FLOAT(MNT_OB_NORM_MODE, -1.0f);
/**
* Mixer value for selecting a locking mode
* if required for the gimbal (only in AUX output mode)
*
* @min -1.0
* @max 1.0
* @decimal 3