LEDS feature

event messageolympe.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/AnafiFPV:with an up to date firmware
AnafiThermal:with an up to date firmware

Triggered At connection only.

command messageolympe.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/AnafiFPV:with an up to date firmware
AnafiThermal: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')

command messageolympe.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/AnafiFPV:with an up to date firmware
AnafiThermal: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 messageolympe.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/AnafiFPV:with an up to date firmware
AnafiThermal:with an up to date firmware

Triggered At connection; on changes.

enumolympe.enums.leds.switch_state

Switch state.

off:Switch is off. (0)
on:Switch is on. (1)
enumolympe.enums.leds.supported_capabilities

Supported capabilites

on_off:Possibility to activate or deactivate the switch (0)
enumolympe.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)