Common.Settings*

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

common.Settings.AllSettings

Ask for all settings. 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:

_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: The product will trigger all settings events (such as CameraSettingsChanged(), or product specific settings as the MaxAltitudeChanged() for the Bebop). Then, it will trigger AllSettingsChanged().

Expectations: AllSettingsChanged(_policy='wait')

command message olympe.messages.common.Settings.AutoCountry(automatic, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

common.Settings.AutoCountry

Enable auto-country. If auto-country is set, the drone will guess its Wifi country by itself by checking other Wifi country around it. Please note that you might be disconnected from the product after changing the country as it changes Wifi parameters.

Parameters:

automaticu8

Boolean : 0 : Manual / 1 : Auto

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

Unsupported message

Todo

Remove unsupported message common.Settings.AutoCountry

Result: The auto-country of the product is changed. Then, it will trigger AutoCountryChanged() and CountryChanged().

Expectations: AutoCountryChanged(automatic=self.automatic, _policy='wait') & CountryChanged(_policy='wait')

command message olympe.messages.common.Settings.Country(code, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

common.Settings.Country

Set the country for Wifi products. This can modify Wifi band and/or channel. Please note that you might be disconnected from the product after changing the country as it changes Wifi parameters.

Parameters:

codestring

Country code with ISO 3166 format

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

Unsupported message

Todo

Remove unsupported message common.Settings.Country

Result: The country is set. Then, it will trigger CountryChanged().

Expectations: CountryChanged(code=self.code, _policy='wait')

command message olympe.messages.common.Settings.ProductName(name, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

common.Settings.ProductName

Set the product name. It also sets the name of the SSID for Wifi products and advertisement name for BLE products (changed after a reboot of the product).

Parameters:

namestring

Product name

_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: Name is changed. Then, it will trigger ProductNameChanged().

Expectations: ProductNameChanged(name=self.name, _policy='wait')

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

common.Settings.Reset

Reset all settings.

Parameters:

_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: It will trigger ResetChanged(). Then, the product will trigger all settings events (such as CameraSettingsChanged(), or product specific settings as the MaxAltitudeChanged() for the Bebop) with factory values.

Expectations: ResetChanged(_policy='wait')

event message olympe.messages.common.SettingsState.AllSettingsChanged(_policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.SettingsState.AllSettingsChanged

All settings have been sent. 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:

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

Triggered: when all settings values have been sent.

event message olympe.messages.common.SettingsState.AutoCountryChanged(automatic=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.SettingsState.AutoCountryChanged

Auto-country changed.

Parameters:

automaticu8

Boolean : 0 : Manual / 1 : Auto

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

Triggered: by AutoCountry().

event message olympe.messages.common.SettingsState.BoardIdChanged(id=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.SettingsState.BoardIdChanged

Board id.

Parameters:

idstring

Board id

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

Triggered: during the connection process.

event message olympe.messages.common.SettingsState.CountryChanged(code=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.SettingsState.CountryChanged

Country changed.

Parameters:

codestring

Country code with ISO 3166 format, empty string means unknown country.

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

Triggered: by Country().

event message olympe.messages.common.SettingsState.ProductNameChanged(name=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.SettingsState.ProductNameChanged

Product name changed.

Parameters:

namestring

Product name

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

Triggered: by ProductName().

event message olympe.messages.common.SettingsState.ProductSerialHighChanged(high=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.SettingsState.ProductSerialHighChanged

Product serial (1st part).

Parameters:

highstring

Serial high number (hexadecimal value)

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

Triggered: during the connection process.

event message olympe.messages.common.SettingsState.ProductSerialLowChanged(low=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.SettingsState.ProductSerialLowChanged

Product serial (2nd part).

Parameters:

lowstring

Serial low number (hexadecimal value)

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

Triggered: during the connection process.

event message olympe.messages.common.SettingsState.ProductVersionChanged(software=None, hardware=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.SettingsState.ProductVersionChanged

Product version.

Parameters:

softwarestring

Product software version

hardwarestring

Product hardware version

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

Triggered: during the connection process.

event message olympe.messages.common.SettingsState.ResetChanged(_policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.SettingsState.ResetChanged

All settings have been reset.

Parameters:

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

Triggered: by Reset().