Skyctrl.Settings*

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

skyctrl.Settings.AllSettings

Request the controller to send all its settings.

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:

SkyController3:

with an up to date firmware

Result: The controller will trigger all settings events and will finally trigger AllSettingsChanged().

Expectations: AllSettingsChanged(_policy='wait')

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

skyctrl.Settings.Reset

Reset all settings (i.e. everything except drone pairing).

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:

SkyController3:

with an up to date firmware

Result: All settings are reset.

event message olympe.messages.skyctrl.SettingsState.AllSettingsChanged(_policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

skyctrl.SettingsState.AllSettingsChanged

All settings have been sent by the controller.

Parameters:

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

SkyController3:

with an up to date firmware

Triggered: when all settings that have been requested by AllSettings() are sent.

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

skyctrl.SettingsState.CPUID

The serial number (or any other UID) for the main CPU.

Parameters:

idstring

Product main cpu id

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

SkyController3:

with an up to date firmware

Triggered: during the AllSettings() phase.

event message olympe.messages.skyctrl.SettingsState.ProductSerialChanged(serialNumber=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

skyctrl.SettingsState.ProductSerialChanged

The product serial of the controller.

Parameters:

serialNumberstring

Serial number (hexadecimal value)

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

SkyController3:

with an up to date firmware

Triggered: during the AllSettings() phase.

event message olympe.messages.skyctrl.SettingsState.ProductVariantChanged(variant=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

skyctrl.SettingsState.ProductVariantChanged

This event allow differentiation between SkyController variants of a same model.

Parameters:

variant : olympe.enums.skyctrl.SettingsState.ProductVariantChanged_Variant

_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

Todo

Remove unsupported message skyctrl.SettingsState.ProductVariantChanged

Triggered: during the AllSettings() phase.

event message olympe.messages.skyctrl.SettingsState.ProductVersionChanged(software=None, hardware=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

skyctrl.SettingsState.ProductVersionChanged

Software and hardware versions of the controller.

Parameters:

softwarestring

Product software version

hardwarestring

Product hardware version

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

SkyController3:

with an up to date firmware

Triggered: during the AllSettings() phase.

event message olympe.messages.skyctrl.SettingsState.ResetChanged(_policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

skyctrl.SettingsState.ResetChanged

This command is not implemented.

Parameters:

_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

Todo

Remove unsupported message skyctrl.SettingsState.ResetChanged

Deprecated message

Warning

This message is deprecated and should no longer be used

Triggered: by a Reset() command.

enum olympe.enums.skyctrl.SettingsState.ProductVariantChanged_Variant

Variant of the product

bebop:

SkyController 1 of the Bebop drone generation. (Bebop battery, original key layout, red/blue/yellow) (0)

bebop2:

SkyController 1 of the Bebop2 generation. (Bebop2 battery, updated key layout, black) (1)

standard:

SkyController standard variant (with either MARS or Wifi radio). (2)

mission:

SkyController mission variant (without radio). (3)

mee:

SkyController MEE variant (for remote antenna usage). (4)