Debug feature#

command messageolympe.messages.debug.get_all_settings(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))#

debug.get_all_settings

Cmd sent by controller to get all settings info (generate “settings_info” events).

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

Unsupported message

command messageolympe.messages.debug.set_setting(id, value, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))#

debug.set_setting

Change setting value. Cmd sent by controller to change a writable setting.

Parameters

  • id (u16) – Setting Id.

  • value (string) – New setting value (string encoded).

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

Unsupported message

event messageolympe.messages.debug.settings_info(list_flags=None, id=None, label=None, type=None, mode=None, range_min=None, range_max=None, range_step=None, value=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#

debug.settings_info

Sent by the drone as answer to get_settings_info Describe a debug setting and give the current value.

Parameters

  • list_flags (BitfieldOf(olympe.enums.debug.list_flags, u8)) – List entry attribute Bitfield. 0x01: First: indicate it’s the first element of the list. 0x02: Last: indicate it’s the last element of the list. 0x04: Empty: indicate the list is empty (implies First/Last). All other arguments should be ignored.

  • id (u16) – Setting Id.

  • label (string) – Setting displayed label (single line).

  • type (olympe.enums.debug.setting_type) – Setting type.

  • mode (olympe.enums.debug.setting_mode) – Setting mode.

  • range_min (string) – Setting range minimal value for decimal type.

  • range_max (string) – Setting range max value for decimal type.

  • range_step (string) – Setting step value for decimal type

  • value (string) – Current Setting value (string encoded).

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

Unsupported message

event messageolympe.messages.debug.settings_list(id=None, value=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#

debug.settings_list

Setting value changed. Cmd sent by drone when setting changed occurred.

Parameters

  • id (u16) – Setting Id.

  • value (string) – New setting value (string encoded).

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

Unsupported message

command messageolympe.messages.debug.tag(value, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))#

debug.tag

Send a debug tag for drone and remote to log

Parameters

  • value (string) – tag value (single line).

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

Unsupported message

Expectations: tag_notify(_policy='wait')

event messageolympe.messages.debug.tag_notify(id=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#

debug.tag_notify

Sent to notify a debug tag has been received

Parameters

  • id (string) – id of debug tag as generated by the drone

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

Unsupported message

enumolympe.enums.debug.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)

enumolympe.enums.debug.setting_mode#

Setting mode.

READ_ONLY

Controller can only read setting. (0)

READ_WRITE

Controller can read and write setting. (1)

enumolympe.enums.debug.setting_type#

Setting type.

BOOL

Boolean Setting. (ex: 0, 1) (0)

DECIMAL

Decimal Setting. (ex: -3.5, 0, 2, 3.6, 6.5) (1)

TEXT

Single line text Setting. (2)