LEDS feature#

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

leds.activate

Activate switch

Parameters:
  • _timeout (int) – command message timeout (defaults to 10)

  • _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: 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))#

leds.capabilities

Capabilities

Parameters:
  • supported_capabilities (BitfieldOf(olympe.enums.leds.supported_capabilities, u16)) – Supported capabilities.

  • _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 At connection only.

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

leds.deactivate

Deactivate switch

Parameters:
  • _timeout (int) – command message timeout (defaults to 10)

  • _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: Switch is off, drone can’t use its LED. Event switch_state() is triggered.

Expectations: switch_state(_policy='wait')

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

leds.switch_state

Switch state

Parameters:
  • switch_state (olympe.enums.leds.switch_state) – Switch state.

  • _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 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)

enum olympe.enums.leds.switch_state#

Switch state.

Enum aliases: