Skyctrl.SkyControllerState

event message olympe.messages.skyctrl.SkyControllerState.AttitudeChanged(q0=None, q1=None, q2=None, q3=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

skyctrl.SkyControllerState.AttitudeChanged

SkyController Attitude in north-east-down (NED) coordinate system. Attitude is provided as a quaternion.

Parameters:

q0float

SkyController Attitude q0 (quaternion scalar part)

q1float

SkyController Attitude q1 (quaternion vector part)

q2float

SkyController Attitude q2 (quaternion vector part)

q3float

SkyController Attitude q3 (quaternion vector part)

_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 the SkyController attitude changes.

event message olympe.messages.skyctrl.SkyControllerState.BatteryChanged(percent=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

skyctrl.SkyControllerState.BatteryChanged

The battery percentage has changed.

Parameters:

percentu8

Controller battery: from 0 (empty) to 100 (full charge). Value of 255 when charging.

_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 the battery level changes.

event message olympe.messages.skyctrl.SkyControllerState.BatteryState(state=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

skyctrl.SkyControllerState.BatteryState

The state of the controller battery

Parameters:

state : olympe.enums.skyctrl.SkyControllerState.BatteryState_State

_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 the controller battery state has changed.

event message olympe.messages.skyctrl.SkyControllerState.ChargeTimeLeft(time=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

skyctrl.SkyControllerState.ChargeTimeLeft

Time left in minute until the controller is fully charged

Parameters:

timeu16

Time left (in minutes) until controller is fully charged

_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.SkyControllerState.ChargeTimeLeft

Triggered: Every minute when the controller is charging

event message olympe.messages.skyctrl.SkyControllerState.ChargerType(type=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

skyctrl.SkyControllerState.ChargerType

The type of charger connected to the controller

Parameters:

type : olympe.enums.skyctrl.SkyControllerState.ChargerType_Type

_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.SkyControllerState.ChargerType

Triggered: when the controller charger type has changed.

event message olympe.messages.skyctrl.SkyControllerState.GpsFixChanged(fixed=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

skyctrl.SkyControllerState.GpsFixChanged

The SkyController GPS has gained or lost the fix. If the fix is lost, thent the GpsPositionChanged() event will contain invalid values for the position.

Parameters:

fixedu8

SkyController fixed

_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.SkyControllerState.GpsFixChanged

Triggered: when the GPS accuracy goes under/over a certain level.

event message olympe.messages.skyctrl.SkyControllerState.GpsPositionChanged(latitude=None, longitude=None, altitude=None, heading=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

skyctrl.SkyControllerState.GpsPositionChanged

The SkyController position or heading values changed. Some of the values can be invalid and should be ignored.

Parameters:

latitudedouble

SkyController latitude (500. if not available)

longitudedouble

SkyController longiture (500. if not available)

altitudedouble

Altitude (in meters) above sea level. Only meaningful if latitude and longiture are available

headingfloat

SkyController heading relative to magnetic north (500.f if not available)

_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.SkyControllerState.GpsPositionChanged

Triggered: each time the position or heading of the SkyController is updated, or when a data becomes (un)available.

enum olympe.enums.skyctrl.SkyControllerState.BatteryState_State

Current battery state

charging:

Battery is charging (0)

charged:

Battery is fully charged (1)

discharging:

Battery is discharging (normal case when on and unplugged) (2)

discharging_low:

Battery is low (Can still work for a few minutes) (3)

discharging_critical:

Battery is critically low (the product will automatically shut down if not plugged) (4)

enum olympe.enums.skyctrl.SkyControllerState.ChargerType_Type

Current battery state

disconnected:

No charger connected (0)

sdp:

Standard Downstream Port charger (Slow speed) (1)

cdp:

Charging Downstream Port charger (Slow speed) (2)

dcp:

Dedicated Charging Port charger (Normal speed) (3)

power_delivery:

Power Delivery charger (Fast speed) (4)