Skyctrl.Common*#

command message olympe.messages.skyctrl.Common.AllStates(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))#

skyctrl.Common.AllStates

Request the controller to send all its states.

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 states events and will finally trigger AllStatesChanged().

Expectations: AllStatesChanged(_policy='wait')

command message olympe.messages.skyctrl.Common.CurrentDateTime(datetime, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))#

skyctrl.Common.CurrentDateTime

Set both the date and the time with only one command. If using this command, do not use CurrentDate() and CurrentTime() commands. This datetime is taken by the remote controller as its own datetime. So medias and other files will be dated from this datetime Please note that you should not send this command if you are using the libARController API as this library is handling the connection process for you.

Parameters:

  • datetime (string) – DateTime with the ISO-8601 complete short format: “%Y%m%dT%H%M%S%z”

  • _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 datetime of the product is set. Then, it will trigger CurrentDateTimeChanged().

Expectations: CurrentDateTimeChanged(_policy='wait')

event message olympe.messages.skyctrl.CommonState.AllStatesChanged(_policy='check_wait', _float_tol=(1e-07, 1e-09))#

skyctrl.CommonState.AllStatesChanged

All states 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 states that have been requested by AllStates() are sent.

event message olympe.messages.skyctrl.CommonState.BootId(bootId=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#

skyctrl.CommonState.BootId

Controller Boot id. A Boot Id identifies a boot session and does not change between controller power on and power off.

Parameters:

  • bootId (string) – Id of the boot

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

SkyController4:

with an up to date firmware

Triggered At connection.

event message olympe.messages.skyctrl.CommonState.CurrentDateTimeChanged(datetime=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#

skyctrl.CommonState.CurrentDateTimeChanged

Both date and time changed. Corresponds to the latest datetime set on the drone. Please note that you should not care about this event if you are using the libARController API as this library is handling the connection process for you.

Parameters:

  • datetime (string) – Datetime with the ISO-8601 complete short format: “%Y%m%dT%H%M%S%z”

  • _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 by CurrentDateTime().

event message olympe.messages.skyctrl.CommonState.ImminentShutdownChanged(duration=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#

skyctrl.CommonState.ImminentShutdownChanged

The skycontroller will shutdown in ‘duration’ ms.

Parameters:

  • duration (i16) – Remaining time (in milliseconds) before the Skycontroller shutdown. ‘-1’ means aborted shutdown (when the power button is released before the end).

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

SkyController4:

with an up to date firmware

Triggered when the user start to press power button