Skyctrl.Calibration*#

command message olympe.messages.skyctrl.Calibration.AbortCalibration(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))#

skyctrl.Calibration.AbortCalibration

Asks the SkyController to abort an in-progress magneto calibration. If no calibration is in progress, this command has no effect.

Parameters:

  • _timeout (int) – command message timeout (defaults to 10)

  • _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)

  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Supported by:

SkyController3:

with an up to date firmware

Result: The SkyController will send a MagnetoCalibrationStateV2() event.

Expectations: MagnetoCalibrationStateV2(_policy='wait')

command message olympe.messages.skyctrl.Calibration.StartCalibration(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))#

skyctrl.Calibration.StartCalibration

Asks the SkyController to start a magneto calibration. If the calibration is already started, this command has no effect.

Parameters:

  • _timeout (int) – command message timeout (defaults to 10)

  • _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)

  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Supported by:

SkyController3:

with an up to date firmware

Result: The SkyController will send a MagnetoCalibrationStateV2() event.

Expectations: MagnetoCalibrationStateV2(_policy='wait')

command message olympe.messages.skyctrl.Calibration.enableMagnetoCalibrationQualityUpdates(enable, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))#

skyctrl.Calibration.enableMagnetoCalibrationQualityUpdates

Asks the SkyController to send (or not) the magneto calibration quality updates. The MagnetoCalibrationState() event will always be sent when the status parameters changes, regardless of this setting.

Parameters:

  • enable (u8) – Flag to enable the feature: 1 = Enable quality updates 0 = Disable quality updates

  • _timeout (int) – command message timeout (defaults to 10)

  • _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)

  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Supported by:

SkyController3:

with an up to date firmware

Result: The SkyController will send a MagnetoCalibrationQualityUpdatesState() event.

Expectations: MagnetoCalibrationQualityUpdatesState(_policy='wait')

event message olympe.messages.skyctrl.CalibrationState.MagnetoCalibrationQualityUpdatesState(enabled=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#

skyctrl.CalibrationState.MagnetoCalibrationQualityUpdatesState

State of the magnetometer calibration quality sender. This determines the trigger of the MagnetoCalibrationState() event.

Parameters:

  • enabled (u8) – Flag (is the feature enabled). 1 = The skycontroller sends updated when quality is updated 0 = The skycontroller only sent updated when state is updated

  • _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Supported by:

SkyController3:

with an up to date firmware

Triggered by an enableMagnetoCalibrationQualityUpdates() command.

event message olympe.messages.skyctrl.CalibrationState.MagnetoCalibrationState(status=None, X_Quality=None, Y_Quality=None, Z_Quality=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#

skyctrl.CalibrationState.MagnetoCalibrationState

The current state of the magnetometer calibration. If the calibration quality updates are enabled, this event is sent at every calibration quality update. This is useful for calibration screens, but creates a lot of traffic on network.When the calibration quality updates are disabled, this event is only sent when the status parameter changes.

Parameters:

  • status (olympe.enums.skyctrl.CalibrationState.MagnetoCalibrationState_Status) –

  • X_Quality (u8) – Calibration quality on X axis. 0 is bad, 255 is perfect

  • Y_Quality (u8) – Calibration quality on Y axis. 0 is bad, 255 is perfect

  • Z_Quality (u8) – Calibration quality on Z axis. 0 is bad, 255 is perfect

  • _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Supported by:

SkyController3:

with an up to date firmware

Deprecated message

Warning

This message is deprecated and should no longer be used

Triggered when the magnetometer calibration state has changed.

event message olympe.messages.skyctrl.CalibrationState.MagnetoCalibrationStateV2(state=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#

skyctrl.CalibrationState.MagnetoCalibrationStateV2

The current state of magnetometer calibration. This event is used by products which does require a step-by-step calibration. When calibrating, the product will go, in order, through X, Y and Z axis calibration, then into calibrated state. If at any point it goes back to not-calibrated, it means that the calibration process failed and should be manually restarted with the StartCalibration() command.

Parameters:

  • state (olympe.enums.skyctrl.CalibrationState.MagnetoCalibrationStateV2_State) –

  • _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Supported by:

SkyController3:

with an up to date firmware

Triggered when the magnetometer calibration state has changed, or by a StartCalibration() or AbortCalibration() command

enum olympe.enums.skyctrl.CalibrationState.MagnetoCalibrationStateV2_State#

The calibration state

NotCalibrated:

A calibration is needed (0)

CalibratingX:

A calibration is in progress on the X axis (1)

CalibratingY:

A calibration is in progress on the Y axis (2)

CalibratingZ:

A calibration is in progress on the Z axis (3)

Calibrated:

The sensor is calibrated (4)

enum olympe.enums.skyctrl.CalibrationState.MagnetoCalibrationState_Status#

The global status of the calibration

Unreliable:

A calibration is needed (0)

Assessing:

A calibration is applied, but still need to be checked (1)

Calibrated:

The sensor is properly calibrated (2)