AP_OpticalFlow: Update parameter documentation

Add brief description of body frame conventions.
This commit is contained in:
priseborough 2016-10-19 09:38:36 +11:00 committed by Andrew Tridgell
parent 1dec6dd9b0
commit 1bde180f98

View File

@ -37,19 +37,19 @@ const AP_Param::GroupInfo OpticalFlow::var_info[] = {
// @Param: _POS_X // @Param: _POS_X
// @DisplayName: X position offset // @DisplayName: X position offset
// @Description: X position of the optical flow sensor focal point in body frame. // @Description: X position of the optical flow sensor focal point in body frame. Positive X is forward of the origin.
// @Units: m // @Units: m
// @User: Advanced // @User: Advanced
// @Param: _POS_Y // @Param: _POS_Y
// @DisplayName: Y position offset // @DisplayName: Y position offset
// @Description: Y position of the optical flow sensor focal point in body frame. // @Description: Y position of the optical flow sensor focal point in body frame. Positive Y is to the right of the origin.
// @Units: m // @Units: m
// @User: Advanced // @User: Advanced
// @Param: _POS_Z // @Param: _POS_Z
// @DisplayName: Z position offset // @DisplayName: Z position offset
// @Description: Z position of the optical flow sensor focal point in body frame. // @Description: Z position of the optical flow sensor focal point in body frame. Positive Z is down from the origin.
// @Units: m // @Units: m
// @User: Advanced // @User: Advanced
AP_GROUPINFO("_POS", 4, OpticalFlow, _pos_offset, 0.0f), AP_GROUPINFO("_POS", 4, OpticalFlow, _pos_offset, 0.0f),