Skyctrl.CommonEventState

event message olympe.messages.skyctrl.CommonEventState.Shutdown(reason=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

skyctrl.CommonEventState.Shutdown

Skycontroller will disconnect. This event is triggered when the user presses on the power button of the product. This event is a notification, you can’t retrieve it in the cache of the device controller.

Parameters:

• reason (olympe.enums.skyctrl.CommonEventState.Shutdown_Reason) –

• _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 the SkyController shutdowns for one of the given reasons

enum olympe.enums.skyctrl.CommonEventState.Shutdown_Reason

Reason of the shutdown of the product

poweroff_button:

The power off button has been pressed (0)

update:

The product is going to be updated (1)

low_battery:

The product battery is too low. (2)

factory_reset:

The product is going to be factory reset (3)