Debug feature

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

debug.get_all_settings

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

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)

Unsupported message

command message olympe.messages.debug.set_setting(id, value, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

debug.set_setting

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

Parameters:

idu16

Setting Id.

valuestring

New setting value (string encoded).

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

Unsupported message

event message olympe.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), _int_tol=0)

debug.settings_info

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

Parameters:

list_flagsBitfieldOf(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.

idu16

Setting Id.

labelstring

Setting displayed label (single line).

typeolympe.enums.debug.setting_type

Setting type.

modeolympe.enums.debug.setting_mode

Setting mode.

range_minstring

Setting range minimal value for decimal type.

range_maxstring

Setting range max value for decimal type.

range_stepstring

Setting step value for decimal type

valuestring

Current Setting value (string encoded).

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

Unsupported message

event message olympe.messages.debug.settings_list(id=None, value=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

debug.settings_list

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

Parameters:

idu16

Setting Id.

valuestring

New setting value (string encoded).

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

Unsupported message

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

debug.tag

Send a debug tag for drone and remote to log

Parameters:

valuestring

tag value (single line).

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

Unsupported message

Expectations: tag_notify(_policy='wait')

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

debug.tag_notify

Sent to notify a debug tag has been received

Parameters:

idstring

id of debug tag as generated by the drone

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

Unsupported message

enum olympe.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)

enum olympe.enums.debug.setting_mode

Setting mode.

READ_ONLY:

Controller can only read setting. (0)

READ_WRITE:

Controller can read and write setting. (1)

enum olympe.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)