Mission feature

command message olympe.messages.mission.activate(uid, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

mission.activate

Tells the drone to start the mission. The mission will start only if there is no missing_requirements and if it was previously loaded (.idle state).

Parameters:

uidstring

Unique id of the mission

_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, 1e-09)). 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 Ai:

with an up to date firmware

Result: The drone sends state().

Expectations: state(uid=self.uid, state='active', _policy='wait')

event message olympe.messages.mission.capabilities(uid=None, name=None, desc=None, version=None, recipient_id=None, target_model_id=None, target_min_version=None, target_max_version=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

mission.capabilities

Missions capabilities.

Parameters:

uidstring

Unique id of the mission

namestring

Name of the mission.

descstring

Description of the mission.

versionstring

Version of the mission.

recipient_idu16

Id to use to exchange messages with the mission (given by the drone)

target_model_idu16

Model id of the supported target.

target_min_versionstring

Minimum version of target firmware supported.

target_max_versionstring

Maximum version of target firmware supported.

list_flags : BitfieldOf(olympe.enums.mission.list_flags, u8)

_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, 1e-09)). 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 Ai:

with an up to date firmware

Triggered: At connection.

command message olympe.messages.mission.custom_cmd(recipient_id, service_id, msg_num, payload, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

mission.custom_cmd

Parameters:

recipient_id : u16

service_id : u16

msg_num : u16

payload : binary

_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, 1e-09)). 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 Ai:

with an up to date firmware

event message olympe.messages.mission.custom_evt(recipient_id=None, service_id=None, msg_num=None, payload=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

mission.custom_evt

Parameters:

recipient_id : u16

service_id : u16

msg_num : u16

payload : binary

_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, 1e-09)). 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 Ai:

with an up to date firmware

command message olympe.messages.mission.custom_msg_disable(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

mission.custom_msg_disable

Disable custom messages for all missions.

Parameters:

_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, 1e-09)). 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 Ai:

with an up to date firmware

command message olympe.messages.mission.custom_msg_enable(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

mission.custom_msg_enable

Enable custom messages for all missions.

Parameters:

_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, 1e-09)). 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 Ai:

with an up to date firmware

command message olympe.messages.mission.load(uid, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

mission.load

Tells the drone to load the corresponding mission.

Parameters:

uidstring

Unique id of the mission

_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, 1e-09)). 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 Ai:

with an up to date firmware

Result: The drone sends state().

Expectations: state(uid=self.uid, state='idle', _policy='wait')

event message olympe.messages.mission.state(uid=None, state=None, unavailability_reason=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

mission.state

At connection and whenever there is a change in the mission state.

Parameters:

uidstring

Unique id of the mission

stateolympe.enums.mission.state

State of activation of the mission.

unavailability_reasonolympe.enums.mission.unavailability_reason

Unavailability reason(s) to load the mission. Empty if mission is activate.

_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, 1e-09)). 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 Ai:

with an up to date firmware

event message olympe.messages.mission.suggested_activation(uid=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

mission.suggested_activation

Suggested activation of a mission.

Parameters:

uidstring

Unique id of the mission

_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, 1e-09)). 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 Ai:

with an up to date firmware

Triggered: When a mission is in idle mode, it can trigger this event

command message olympe.messages.mission.unload(uid, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

mission.unload

Tells the drone to unload the mission.

Parameters:

uidstring

Unique id of the mission

_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, 1e-09)). 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 Ai:

with an up to date firmware

Result: The drone sends state().

Expectations: state(uid=self.uid, state='unloaded', _policy='wait')

enum olympe.enums.mission.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.mission.state

State of mission.

unavailable:

Mission is not available. (0)

unloaded:

Mission is not available. (1)

idle:

Mission can be activated. (2)

active:

Mission is active. (3)

enum olympe.enums.mission.unavailability_reason

Unavailability reasons.

none:

No reason. The mission is actually available. (0)

broken:

Broken. Version is not supported or mission is corrupted. The mission will never be able to load or start. (1)

load_failed:

The mission failed to load. (2)