kStatus GoSensor_Align

(

GoSensor

sensor

)

Perform alignment using the configured alignment type and target.

NOTE: This operation will result in a sensor start for the duration of the alignment. It can be canceled via GoSensor_Stop. This function's operation status does not correspond to the actual alignment result. In order to retrieve the alignment result, you must enable the data channel before calling this function, receive an alignment data message and then check its status.

Version

Introduced in firmware 4.0.10.27

Parameters

sensor

GoSensor object.

Returns

Operation status.

See also

GoSensor_EnableData, GoSystem_ReceiveData, GoSetup_AlignmentType, GoSetup_AlignmentMovingTarget, GoSetup_AlignmentStationaryTarget, GoAlignMsg_Status, GoSensor_Stop

Remarks

Calling this function will result in writing operations to flash storage. Should the process be disrupted due to power loss or other factors, the sensor may enter Rescue mode.