Gimbal feature

event message olympe.messages.gimbal.absolute_attitude_bounds(gimbal_id=None, min_yaw=None, max_yaw=None, min_pitch=None, max_pitch=None, min_roll=None, max_roll=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 0.1), _int_tol=0)

gimbal.absolute_attitude_bounds

Absolute attitude bounds

Parameters:

gimbal_idu8

id of the gimbal.

min_yawfloat

Minimum yaw value, in degrees, in the absolute frame of reference.

max_yawfloat

Maximum yaw value, in degrees, in the absolute frame of reference.

min_pitchfloat

Minimum pitch value, in degrees, in the absolute frame of reference.

max_pitchfloat

Maximum pitch value, in degrees, in the absolute frame of reference.

min_rollfloat

Minimum roll value, in degrees, in the absolute frame of reference.

max_rollfloat

Maximum roll value, in degrees, in the absolute frame of reference.

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

Triggered: when the bounds change.

event message olympe.messages.gimbal.alert(gimbal_id=None, error=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 0.1), _int_tol=0)

gimbal.alert

Gimbal error.

Parameters:

gimbal_idu8

id of the gimbal.

errorBitfieldOf(olympe.enums.gimbal.error, u8)

Error bitfield.

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

Triggered: At connection and when an error occurs.

event message olympe.messages.gimbal.attitude(gimbal_id=None, yaw_frame_of_reference=None, pitch_frame_of_reference=None, roll_frame_of_reference=None, yaw_relative=None, pitch_relative=None, roll_relative=None, yaw_absolute=None, pitch_absolute=None, roll_absolute=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 0.1), _int_tol=0)

gimbal.attitude

Gimbal attitude

Parameters:

gimbal_idu8

id of the gimbal.

yaw_frame_of_referenceolympe.enums.gimbal.frame_of_reference

Current frame of reference used for the yaw axis.

pitch_frame_of_referenceolympe.enums.gimbal.frame_of_reference

Current frame of reference used for the pitch axis.

roll_frame_of_referenceolympe.enums.gimbal.frame_of_reference

Current frame of reference used for the roll axis.

yaw_relativefloat

Yaw orientation of the gimbal in the relative frame of reference, in degrees.

pitch_relativefloat

Pitch orientation of the gimbal in the relative frame of reference, in degrees.

roll_relativefloat

Roll orientation of the gimbal in the relative frame of reference, in degrees.

yaw_absolutefloat

Yaw orientation of the gimbal in the absolute frame of reference, in degrees.

pitch_absolutefloat

Pitch orientation of the gimbal in the absolute frame of reference, in degrees.

roll_absolutefloat

Roll orientation of the gimbal in the absolute frame of reference, in degrees.

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

Triggered: regularly.

event message olympe.messages.gimbal.axis_lock_state(gimbal_id=None, locked=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 0.1), _int_tol=0)

gimbal.axis_lock_state

Axis lock state

Parameters:

gimbal_idu8

id of the gimbal.

lockedBitfieldOf(olympe.enums.gimbal.axis, u8)

Bitfield indicating if each axis is temporarily locked. Bits set to 1 are locked.

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

Triggered: when the axis lock is changed.

command message olympe.messages.gimbal.calibrate(gimbal_id, _timeout=10, _no_expect=False, _float_tol=(1e-07, 0.1), _int_tol=0)

gimbal.calibrate

Start calibration.

Parameters:

gimbal_idu8

id of the gimbal.

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

Result: calibration_state() changes to in_progress. calibration_result() when calibration is terminated.

Expectations: calibration_state(gimbal_id=self.gimbal_id, state='in_progress', _policy='wait')

event message olympe.messages.gimbal.calibration_result(gimbal_id=None, result=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 0.1), _int_tol=0)

gimbal.calibration_result

Calibration result.

Parameters:

gimbal_idu8

id of the gimbal.

resultolympe.enums.gimbal.calibration_result

Calibration result.

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

Triggered: At the end of the gimbal calibration.

event message olympe.messages.gimbal.calibration_state(state=None, gimbal_id=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 0.1), _int_tol=0)

gimbal.calibration_state

Calibration state

Parameters:

stateolympe.enums.gimbal.calibration_state

Current state

gimbal_idu8

id of the gimbal.

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

Triggered: at connection and when calibration state changes.

command message olympe.messages.gimbal.cancel_calibration(gimbal_id, _timeout=10, _no_expect=False, _float_tol=(1e-07, 0.1), _int_tol=0)

gimbal.cancel_calibration

Cancel calibration.

Parameters:

gimbal_idu8

id of the gimbal.

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

Result: calibration_state() changes to required or ok. calibration_result() with canceled result.

Expectations: calibration_result(gimbal_id=self.gimbal_id, result='canceled', _policy='wait')

event message olympe.messages.gimbal.gimbal_capabilities(gimbal_id=None, model=None, axes=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 0.1), _int_tol=0)

gimbal.gimbal_capabilities

Gimbal capabilities

Parameters:

gimbal_idu8

id of the gimbal. Gimbal id is unique and persistent: the same gimbal model on a same drone model always has the same id. Main/Built-in gimbal has id zero.

modelolympe.enums.gimbal.model

Camera model.

axesBitfieldOf(olympe.enums.gimbal.axis, u8)

Bitfield of axes that can be controlled. If bit is set to 1, it means that the axis can be controlled.

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

Triggered: at connection.

event message olympe.messages.gimbal.max_speed(gimbal_id=None, min_bound_yaw=None, max_bound_yaw=None, current_yaw=None, min_bound_pitch=None, max_bound_pitch=None, current_pitch=None, min_bound_roll=None, max_bound_roll=None, current_roll=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 0.1), _int_tol=0)

gimbal.max_speed

Max speed

Parameters:

gimbal_idu8

id of the gimbal. Gimbal id is unique and persistent: the same gimbal model on a same drone model always has the same id. Main/Built-in gimbal has id zero.

min_bound_yawfloat

Lower bound of the max yaw speed, in degrees per seconds.

max_bound_yawfloat

Upper bound of the max yaw speed, in degrees per seconds.

current_yawfloat

Maximum yaw speed value, in degrees per seconds.

min_bound_pitchfloat

Lower bound of the max pitch speed, in degrees per seconds.

max_bound_pitchfloat

Upper bound of the max pitch speed, in degrees per seconds.

current_pitchfloat

Maximum pitch speed value, in degrees per seconds.

min_bound_rollfloat

Lower bound of the max roll speed, in degrees per seconds.

max_bound_rollfloat

Upper bound of the max roll speed, in degrees per seconds.

current_rollfloat

Maximum roll speed value, in degrees per seconds.

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

Triggered: by set_max_speed() or when the speed bounds changes.

event message olympe.messages.gimbal.offsets(gimbal_id=None, update_state=None, min_bound_yaw=None, max_bound_yaw=None, current_yaw=None, min_bound_pitch=None, max_bound_pitch=None, current_pitch=None, min_bound_roll=None, max_bound_roll=None, current_roll=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 0.1), _int_tol=0)

gimbal.offsets

Get the offsets

Parameters:

gimbal_idu8

id of the gimbal.

update_stateolympe.enums.gimbal.state

offset update states.

min_bound_yawfloat

Lower bound of the offset that can be set on the yaw axis, in degrees.

max_bound_yawfloat

Upper bound of the offset that can be set on the yaw axis, in degrees.

current_yawfloat

Current offset applied to the yaw axis, in degrees.

min_bound_pitchfloat

Lower bound of the offset that can be set on the pitch axis, in degrees.

max_bound_pitchfloat

Upper bound of the offset that can be set on the pitch axis, in degrees.

current_pitchfloat

Current offset applied to the pitch axis, in degrees.

min_bound_rollfloat

Lower bound of the offset that can be set on the roll axis, in degrees.

max_bound_rollfloat

Upper bound of the offset that can be set on the roll axis, in degrees.

current_rollfloat

Current offset applied to the roll axis, in degrees.

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

Triggered: at connection and by set_offsets().

event message olympe.messages.gimbal.relative_attitude_bounds(gimbal_id=None, min_yaw=None, max_yaw=None, min_pitch=None, max_pitch=None, min_roll=None, max_roll=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 0.1), _int_tol=0)

gimbal.relative_attitude_bounds

Relative attitude bounds

Parameters:

gimbal_idu8

id of the gimbal.

min_yawfloat

Minimum yaw value, in degrees, in the relative frame of reference.

max_yawfloat

Maximum yaw value, in degrees, in the relative frame of reference.

min_pitchfloat

Minimum pitch value, in degrees, in the relative frame of reference.

max_pitchfloat

Maximum pitch value, in degrees, in the relative frame of reference.

min_rollfloat

Minimum roll value, in degrees, in the relative frame of reference.

max_rollfloat

Maximum roll value, in degrees, in the relative frame of reference.

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

Triggered: when the bounds change.

command message olympe.messages.gimbal.reset_orientation(gimbal_id, _timeout=10, _no_expect=False, _float_tol=(1e-07, 0.1), _int_tol=0)

gimbal.reset_orientation

Reset the reference orientation of the gimbal

Parameters:

gimbal_idu8

id of the gimbal.

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

Result: Orientation of the gimbal is reset.

command message olympe.messages.gimbal.set_max_speed(gimbal_id, yaw, pitch, roll, _timeout=10, _no_expect=False, _float_tol=(1e-07, 0.1), _int_tol=0)

gimbal.set_max_speed

Set max speed

Parameters:

gimbal_idu8

id of the gimbal.

yawfloat

Deprecated, only the pitch value is used for all axes.

pitchfloat

Maximum speed value, in degrees per seconds. This value will be clamped between max_speed() min_bound_pitch and max_bound_pitch.

rollfloat

Deprecated, only the pitch value is used for all axes.

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

Result: set the max speed setting then max_speed() is triggered.

Expectations: max_speed(gimbal_id=self.gimbal_id, _policy='wait')

command message olympe.messages.gimbal.set_offsets(gimbal_id, yaw, pitch, roll, _timeout=10, _no_expect=False, _float_tol=(1e-07, 0.1), _int_tol=0)

gimbal.set_offsets

Set gimbal offsets

Parameters:

gimbal_idu8

id of the gimbal.

yawfloat

Offset, in degrees, that should be applied to the yaw axis. This value will be clamped between offsets() min_bound_yaw and max_bound_yaw.

pitchfloat

Offset, in degrees, that should be applied to the pitch axis. This value will be clamped between [offsets() min_bound_pitch and max_bound_pitch.

rollfloat

Offset, in degrees, that should be applied to the roll axis. This value will be clamped between offsets() min_bound_roll and max_bound_roll.

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

Result: if the offset update process has been started, the offsets are set on each axis then offsets() is triggered.

Expectations: offsets(gimbal_id=self.gimbal_id, _policy='wait')

command message olympe.messages.gimbal.set_target(gimbal_id, control_mode, yaw_frame_of_reference, yaw, pitch_frame_of_reference, pitch, roll_frame_of_reference, roll, _timeout=10, _no_expect=False, _float_tol=(1e-07, 0.1), _int_tol=0)

gimbal.set_target

Set the gimbal target

Parameters:

gimbal_idu8

id of the gimbal.

control_modeolympe.enums.gimbal.control_mode

Mode of changing the gimbal attitude. This parameter will caracterize following parameters units.

yaw_frame_of_referenceolympe.enums.gimbal.frame_of_reference

Frame of reference of the yaw value. none if the yaw target should not be changed.

yawfloat

Yaw value. Frame of reference is given by the value of yaw_frame_of_reference. Units depend on the control_mode value: - position: value is in degrees - velocity, value is in signed ratio (from -1 to 1) of the max_speed() current_yaw parameter

pitch_frame_of_referenceolympe.enums.gimbal.frame_of_reference

Frame of reference of the pitch value. none if the pitch target should not be changed.

pitchfloat

Pitch value. Frame of reference is given by the value of pitch_frame_of_reference. Units depend on the control_mode value: - position: value is in degrees - velocity, value is in signed ratio (from -1 to 1) of the max_speed() current_pitch parameter

roll_frame_of_referenceolympe.enums.gimbal.frame_of_reference

Frame of reference of the roll value. none if the roll target should not be changed.

rollfloat

Roll value. Frame of reference is given by the value of roll_frame_of_reference. Units depend on the control_mode value: - position: value is in degrees - velocity, value is in signed ratio (from -1 to 1) of the max_speed() current_roll parameter

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

Result: set the target.

event message olympe.messages.gimbal.stabilization_state(gimbal_id=None, state=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 0.1), _int_tol=0)

gimbal.stabilization_state

Gimbal stabilization state.

Parameters:

gimbal_idu8

id of the gimbal.

stateolympe.enums.gimbal.state

Stabilization state.

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

Triggered: At connection and on state change.

command message olympe.messages.gimbal.start_offsets_update(gimbal_id, _timeout=10, _no_expect=False, _float_tol=(1e-07, 0.1), _int_tol=0)

gimbal.start_offsets_update

Start offset update

Parameters:

gimbal_idu8

id of the gimbal.

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

Result: actual offsets and update state offsets() is triggered, with update_state set to active.

Expectations: offsets(gimbal_id=self.gimbal_id, update_state='active', _policy='wait')

command message olympe.messages.gimbal.stop_offsets_update(gimbal_id, _timeout=10, _no_expect=False, _float_tol=(1e-07, 0.1), _int_tol=0)

gimbal.stop_offsets_update

Stop offset update

Parameters:

gimbal_idu8

id of the gimbal.

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

Result: offsets() is triggered, with update_state set to inactive.

Expectations: offsets(gimbal_id=self.gimbal_id, update_state='inactive', _policy='wait')

enum olympe.enums.gimbal.axis

Axis.

yaw:

Yaw axis. (0)

pitch:

Pitch axis. (1)

roll:

Roll axis. (2)

enum olympe.enums.gimbal.calibration_result

Calibration result.

success:

Calibration completed successfully. (0)

failure:

Calibration failed. (1)

canceled:

Calibration canceled, with command cancel_calibration. (2)

enum olympe.enums.gimbal.calibration_state

Calibration state.

required:

Calibration is required. (0)

in_progress:

Calibration is in progress. (1)

ok:

Calibration is ok. (2)

enum olympe.enums.gimbal.control_mode

Gimbal control mode.

position:

Attitude is set by giving a position. (0)

velocity:

Attitude is set by giving a velocity. (1)

enum olympe.enums.gimbal.error

Gimbal error.

calibration_error:

Calibration error. Verify that nothing is blocking the gimbal movement. (0)

overload_error:

Overload error. Verify that nothing is blocking the gimbal movement. (1)

comm_error:

Communication error. Wait for retry. (2)

critical_error:

Critical error. Drone must be restarted. (3)

enum olympe.enums.gimbal.frame_of_reference

Frame of reference.

none:

None, references are ignored. (0)

relative:

References are expressed in the drone frame of reference, where as seen from the drone: - roll axis points forward - pitch axis points on the right hand side - yaw axis points downward (1)

absolute:

References are expressed in the NED frame of reference, where: - roll axis points North - pitch axis points East - yaw axis points toward the center of the Earth (Down) (2)

enum olympe.enums.gimbal.list_flags

Arsdk built-in “list_flags” enum that is used to in “LIST_ITEM” event messages

First:

Arsdk built-in “list_flags” enum that is used to in “LIST_ITEM” event messages (0)

Last:

Arsdk built-in “list_flags” enum that is used to in “LIST_ITEM” event messages (1)

Empty:

Arsdk built-in “list_flags” enum that is used to in “LIST_ITEM” event messages (2)

Remove:

Arsdk built-in “list_flags” enum that is used to in “LIST_ITEM” event messages (3)

enum olympe.enums.gimbal.model

Gimbal model.

main:

Main gimbal. Only one gimbal of this kind is allowed at a time on a drone. (0)

fstcam:

Front Stereo Camera Only one gimbal of this kind is allowed at a time on a drone. (1)

enum olympe.enums.gimbal.state

Feature current state.

inactive:

Feature is not currently active. (0)

active:

Feature is currently active. (1)

partial:

Feature is partially active. (2)