Gocator API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages

kStatus GoSystem_StartAlignment | ( | GoSystem | system | ) |

Performs alignment for sensors in the ready state.

WARNING! This operation writes to flash storage. Review the user manual for implications.

NOTE: This operation will result in sensor starts for the duration of the alignment. It can be canceled via GoSystem_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

  system | GoSystem object.

Returns
  Operation status.

See also
  GoSystem_EnableData, GoSystem_ReceiveData, GoSystem_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.