Common.Calibration*#
- command message olympe.messages.common.Calibration.MagnetoCalibration(calibrate, _timeout=3, _no_expect=False, _float_tol=(1e-07, 1e-09))#
common.Calibration.MagnetoCalibration
Start or abort magnetometer calibration process.
- Parameters:
calibrate (u8) – 1 if the calibration should be started, 0 if it should be aborted
_timeout (int) – command message timeout (defaults to 3)
_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:
- ANAFI:
with an up to date firmware
- ANAFI Thermal:
with an up to date firmware
Result: The magnetometer calibration process is started or aborted. Then, event
MagnetoCalibrationStartedChanged()
is triggered. If started, eventMagnetoCalibrationStartedChanged()
is triggered with the current calibration state: a list of all axis and their calibration states. It will also triggerMagnetoCalibrationAxisToCalibrateChanged()
, that will inform the controller about the current axis to calibrate.Expectations:
MagnetoCalibrationStartedChanged(_policy='wait')
&MagnetoCalibrationAxisToCalibrateChanged(_policy='wait')
- command message olympe.messages.common.Calibration.PitotCalibration(calibrate, _timeout=3, _no_expect=False, _float_tol=(1e-07, 1e-09))#
common.Calibration.PitotCalibration
Start or abort Pitot tube calibration process.
- Parameters:
calibrate (u8) – 1 if the calibration should be started, 0 if it should be aborted
_timeout (int) – command message timeout (defaults to 3)
_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
Unsupported message
Todo
Remove unsupported message common.Calibration.PitotCalibration
Result: The pitot calibration process is started or aborted. Then, event
PitotCalibrationStateChanged()
is triggered with the current calibration state.Expectations:
PitotCalibrationStateChanged(_policy='wait')
- event message olympe.messages.common.CalibrationState.MagnetoCalibrationAxisToCalibrateChanged(axis=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#
common.CalibrationState.MagnetoCalibrationAxisToCalibrateChanged
Axis to calibrate during calibration process.
- Parameters:
axis (
olympe.enums.common.CalibrationState.MagnetoCalibrationAxisToCalibrateChanged_Axis
) –_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:
- ANAFI:
with an up to date firmware
- ANAFI Thermal:
with an up to date firmware
Triggered during the calibration process when the axis to calibrate changes.
- event message olympe.messages.common.CalibrationState.MagnetoCalibrationRequiredState(required=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#
common.CalibrationState.MagnetoCalibrationRequiredState
Calibration required.
- Parameters:
required (u8) – 1 if calibration is required, 0 if current calibration is still valid, 2 if calibration is recommended
_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:
- ANAFI:
with an up to date firmware
- ANAFI Thermal:
with an up to date firmware
Triggered when the calibration requirement changes.
- event message olympe.messages.common.CalibrationState.MagnetoCalibrationStartedChanged(started=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#
common.CalibrationState.MagnetoCalibrationStartedChanged
Calibration process state.
- Parameters:
started (u8) – 1 if calibration has started, 0 otherwise
_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:
- ANAFI:
with an up to date firmware
- ANAFI Thermal:
with an up to date firmware
Triggered by
MagnetoCalibration()
or when the process ends because it succeeded.
- event message olympe.messages.common.CalibrationState.MagnetoCalibrationStateChanged(xAxisCalibration=None, yAxisCalibration=None, zAxisCalibration=None, calibrationFailed=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#
common.CalibrationState.MagnetoCalibrationStateChanged
Magneto calib process axis state.
- Parameters:
xAxisCalibration (u8) – State of the x axis (roll) calibration : 1 if calibration is done, 0 otherwise
yAxisCalibration (u8) – State of the y axis (pitch) calibration : 1 if calibration is done, 0 otherwise
zAxisCalibration (u8) – State of the z axis (yaw) calibration : 1 if calibration is done, 0 otherwise
calibrationFailed (u8) – 1 if calibration has failed, 0 otherwise. If this arg is 1, consider all previous arg as 0
_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:
- ANAFI:
with an up to date firmware
- ANAFI Thermal:
with an up to date firmware
Triggered when the calibration process is started with
MagnetoCalibration()
and each time an axis calibration state changes.
- event message olympe.messages.common.CalibrationState.PitotCalibrationStateChanged(state=None, lastError=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#
common.CalibrationState.PitotCalibrationStateChanged
Sent when the state of the pitot calibration has changed
- Parameters:
state (
olympe.enums.common.CalibrationState.PitotCalibrationStateChanged_State
) –lastError (u8) – lastError : 1 if an error occured and 0 if not
_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
Unsupported message
Todo
Remove unsupported message common.CalibrationState.PitotCalibrationStateChanged
- enum olympe.enums.common.CalibrationState.MagnetoCalibrationAxisToCalibrateChanged_Axis#
The axis to calibrate
- xAxis:
If the current calibration axis should be the x axis (0)
- yAxis:
If the current calibration axis should be the y axis (1)
- zAxis:
If the current calibration axis should be the z axis (2)
- none:
If none of the axis should be calibrated (3)
- enum olympe.enums.common.CalibrationState.PitotCalibrationStateChanged_State#
State of pitot calibration
- done:
Calibration is ok (0)
- ready:
Calibration is started, waiting user action (1)
- in_progress:
Calibration is in progress (2)
- required:
Calibration is required (3)