Drone Manager feature¶

event messageolympe.messages.drone_manager.authentication_failed(serial=None, model=None, name=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

drone_manager.authentication_failed

Authentication failed because of a wrong key (passphrase).

Parameters

serial (string) – Serial number of the drone.
model (u16) – Model id of the drone.
name (string) – Name (SSID) of the drone.
_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:

Triggered when trying to connect() to a protected drone with a wrong key (passphrase)

command messageolympe.messages.drone_manager.connect(serial, key, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

drone_manager.connect

Request connection to a specific drone. Override the auto-selected drone.

Parameters

serial (string) – Serial number of the drone.
key (string) – Security key (passphrase) to use. This arg is ignored if the drone security is ‘none’. If the drone manager has a saved key for the drone, pass an empty string to use it
_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:

Result: The drone manager will send an update of its connection_state(), if relevant

Expectations: connection_state(_policy='wait')

event messageolympe.messages.drone_manager.connection_refused(serial=None, model=None, name=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

drone_manager.connection_refused

Connection refused by the drone because another peer is already connected to.

Parameters

serial (string) – Serial number of the drone.
model (u16) – Model id of the drone.
name (string) – Name (SSID) of the drone.
_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:

Triggered Try to connect() to a drone where another peer is already connected to.

event messageolympe.messages.drone_manager.connection_state(state=None, serial=None, model=None, name=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

drone_manager.connection_state

State of the connection.

Parameters

state (olympe.enums.drone_manager.connection_state) – Current state of the connection.
serial (string) – Serial number of the drone.
model (u16) – Model id of the drone.
name (string) – Name (SSID) of the drone.
_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:

Triggered when the state changes. If the state is ‘searching’, all informations about the drone will refer to the last connected drone. Otherwise, these informations will refer to the active drone.

command messageolympe.messages.drone_manager.discover_drones(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

drone_manager.discover_drones

The list will contain: * known drones not currently visible. * known drones currently visible. * unknown drones currently visible.

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:

Result: The drone manager will answer with a list of drone_list_item()

Expectations: (drone_list_item(list_flags='Last', _policy='wait') | drone_list_item(list_flags='Empty', _policy='wait'))

event messageolympe.messages.drone_manager.drone_list_item(serial=None, model=None, name=None, connection_order=None, active=None, visible=None, security=None, has_saved_key=None, rssi=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

drone_manager.drone_list_item

Item describing a drone.

Parameters

serial (string) – Serial number of the drone.
model (u16) – Model id of the drone.
name (string) – Name (SSID) of the drone.
connection_order (u8) – 0 if the drone is unknown (never connected). Else, order of last connection (1 = most recent)
active (u8) – 1 if the drone is active (the drone manager tries to connect or is connected to it) 0 if the drone is not the active one.
visible (BitfieldOf(olympe.enums.drone_manager.visible_state, u8)) – Whether the drone is cellular online and/or in wifi scan results.
security (olympe.enums.drone_manager.security) – Security method used by the drone.
has_saved_key (u8) – 1 if the drone manager has a saved security key for the drone, 0 otherwise. If security method is not ‘none’, and this value is 0, then the controller should prompt the user for a passphrase before sending a connect.
rssi (i8) – The drone rssi (wifi signal strength estimation). The value is meaningless if the drone is not visible.
list_flags (BitfieldOf(olympe.enums.drone_manager.list_flags, u8)) –
_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:

Triggered when requested discover_drones().

command messageolympe.messages.drone_manager.forget(serial, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

drone_manager.forget

Forget the given drone. If the drone is the selected one, the auto- selection will run again.

Parameters

serial (string) – Serial number of the drone to forget.
_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:

Result: The drone manager will send known_drone_item() message.

Expectations: known_drone_item(serial=self.serial, _policy='wait')

event messageolympe.messages.drone_manager.known_drone_item(serial=None, model=None, name=None, security=None, has_saved_key=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

drone_manager.known_drone_item

Item describing a known drone (already connected).

Parameters

serial (string) – Serial number of the drone.
model (u16) – Model id of the drone.
name (string) – Last visible Name (SSID) of the drone.
security (olympe.enums.drone_manager.security) – Security method used by the drone.
has_saved_key (u8) – 1 if the drone manager has a saved security key for the drone, 0 otherwise. If security method is not ‘none’, and this value is 0, then the controller should prompt the user for a passphrase before sending a connect.
list_flags (BitfieldOf(olympe.enums.drone_manager.list_flags, u8)) –
_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:

Triggered when AllSettings() is requested or when a drone is forgotten or connected for the first time.

enumolympe.enums.drone_manager.connection_state¶

The state of the connection to a drone.

enumolympe.enums.drone_manager.list_flags¶

Arsdk built-in “list_flags” enum that is used to in “LIST_ITEM” event messages

enumolympe.enums.drone_manager.security¶

The security of the drone network.

enumolympe.enums.drone_manager.visible_state¶

Whether the drone is cellular online and/or in wifi scan results.