LEDS feature

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

leds.activate

Activate switch

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:

for firmware release versions 1.5.0

ANAFI Thermal:

for firmware release versions 1.5.0

Deprecated message

Warning

This message is deprecated and should no longer be used

Result: Switch is on, drone can now use its LEDs. Event switch_state() is triggered.

Expectations: switch_state(_policy='wait')

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

leds.capabilities

Capabilities

Parameters:

supported_capabilitiesBitfieldOf(olympe.enums.leds.supported_capabilities, u16)

Supported capabilities.

_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.5.0

ANAFI Thermal:

for firmware release versions 1.5.0

ANAFI_3_MIL:

with an up to date firmware

Deprecated message

Warning

This message is deprecated and should no longer be used

Triggered: At connection only.

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

leds.deactivate

Deactivate switch

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:

for firmware release versions 1.5.0

ANAFI Thermal:

for firmware release versions 1.5.0

Deprecated message

Warning

This message is deprecated and should no longer be used

Result: Switch is off, drone can’t use its LED. Event switch_state() is triggered.

Expectations: switch_state(_policy='wait')

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

leds.ir_state

Infrared LED state

Parameters:

led_stateolympe.enums.leds.switch_state

Infrared LED 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_3_MIL:

with an up to date firmware

Deprecated message

Warning

This message is deprecated and should no longer be used

Triggered: At connection; on changes.

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

leds.set_ir_state

Enable or disable infrared LED

Parameters:

led_stateolympe.enums.leds.switch_state

Desired infrared LED state.

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

with an up to date firmware

Deprecated message

Warning

This message is deprecated and should no longer be used

Result: Infrared LED is on/off. Event ir_state() is triggered.

Expectations: ir_state(led_state=self.led_state, _policy='wait')

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

leds.switch_state

Switch state

Parameters:

switch_stateolympe.enums.leds.switch_state

Switch 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.5.0

ANAFI Thermal:

for firmware release versions 1.5.0

Deprecated message

Warning

This message is deprecated and should no longer be used

Triggered: At connection; on changes.

enum olympe.enums.leds.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.leds.supported_capabilities

Supported capabilites

on_off:

Possibility to activate or deactivate the switch (0)

infrared:

Possibility to set the infrared led state (1)

enum olympe.enums.leds.switch_state

Switch state.

Enum aliases: