PreciseHome feature

event message olympe.messages.precise_home.capabilities(modes=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

precise_home.capabilities

Capabilities

Parameters:

modesBitfieldOf(olympe.enums.precise_home.mode, u8)

Supported precise home modes.

_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:

for firmware release versions 1.2.0

Triggered: At connection only.

event message olympe.messages.precise_home.mode(mode=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

precise_home.mode

Current precise home mode

Parameters:

modeolympe.enums.precise_home.mode

Current precise home mode

_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:

for firmware release versions 1.2.0

Triggered: At connection; on changes by set_mode().

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

precise_home.set_mode

Configures precise home mode.

Parameters:

modeolympe.enums.precise_home.mode

Requested precise home mode.

_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:

for firmware release versions 1.2.0

Result: mode() event with the new mode.

Expectations: mode(mode=self.mode, _policy='wait')

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

precise_home.state

Current precise home state

Parameters:

stateolympe.enums.precise_home.state

Current precise home 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, 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:

for firmware release versions 1.2.0

Triggered: At connection; on changes.

enum olympe.enums.precise_home.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.precise_home.mode

Obstacle avoidance mode.

disabled:

Obstacle avoidance is disabled. (0)

standard:

Obstacle avoidance is enabled, in standard mode. (1)

enum olympe.enums.precise_home.state

Precise home feature state.

unavailable:

It is currently impossible to activate precise home if the drone lands. (0)

available:

Precise home will be activated if the drone lands. (1)

active:

Precise home is currently active (drone is landing). (2)