Skyctrl.Settings*#
- command message olympe.messages.skyctrl.Settings.AllSettings(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))#
skyctrl.Settings.AllSettings
Request the controller to send all its settings.
- 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:
- 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))#
skyctrl.Settings.Reset
Reset all settings (i.e. everything except drone pairing).
- 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:
- 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))#
skyctrl.SettingsState.AllSettingsChanged
All settings have been sent by the controller.
- Parameters:
_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:
- 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))#
skyctrl.SettingsState.CPUID
The serial number (or any other UID) for the main CPU.
- Parameters:
id (string) – Product main cpu id
_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:
- 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))#
skyctrl.SettingsState.ProductSerialChanged
The product serial of the controller.
- Parameters:
serialNumber (string) – Serial number (hexadecimal value)
_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:
- 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))#
skyctrl.SettingsState.ProductVariantChanged
This event allow differentiation between original (red/blue/yellow) SkyControllers, and the Black Edition SkyControllers.
- Parameters:
variant (
olympe.enums.skyctrl.SettingsState.ProductVariantChanged_Variant
) –_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
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))#
skyctrl.SettingsState.ProductVersionChanged
Software and hardware versions of the controller.
- Parameters:
software (string) – Product software version
hardware (string) – Product hardware version
_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:
- 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))#
skyctrl.SettingsState.ResetChanged
This command is not implemented.
- Parameters:
_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
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 of the bebop generation. (Bebop battery, original key layout, red/blue/yellow) (0)
- bebop2:
SkyController of the bebop2 generation. (Bebop2 battery, updated key layout, black) (1)