Common.Controller

command message olympe.messages.common.Controller.PeerStateChanged(state, type, peerName, peerId, peerType, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

common.Controller.PeerStateChanged

A SDK peer (ie FreeFlight) has connected/disconnected to the Skycontroller. This is only meant to be sent by the Skycontroller, as it is acting as a proxy.

Parameters:

state : olympe.enums.common.Controller.PeerStateChanged_State

type : olympe.enums.common.Controller.PeerStateChanged_Type

peerNamestring

Peer name. May not be available at disconnection.

peerIdstring

Peer id. May not be available at disconnection.

peerTypestring

Peer type. May not be available at disconnection.

_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

Triggered: at connection and when the peer state changes.

command message olympe.messages.common.Controller.isPiloting(piloting, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

common.Controller.isPiloting

Inform about hud entering. Tell the drone that the controller enters/leaves the piloting hud. On a non-flying products it is used to know when a run begins.

Parameters:

pilotingu8

0 when the application is not in the piloting HUD, 1 when it enters the HUD.

_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 every drone product

Result: If yes, the product will begin a new session (so it should send a new RunIdChanged()). Also, on the JumpingSumos, if the video is in autorecord mode, it will start recording.

enum olympe.enums.common.Controller.PeerStateChanged_State

Update status

Enum aliases:

connected:

Peer connected to Skycontroller. (0)

disconnected:

Peer disconnected from Skycontroller. (1)

enum olympe.enums.common.Controller.PeerStateChanged_Type

SDK connection type.

unknown:

Unknown. (0)

net:

Net. (1)

mux:

Mux. (2)