Common.Common*

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

common.Common.AllStates

Ask for all states. 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 states events (such as FlyingStateChanged() for the Bebop). Then, it will trigger AllStatesChanged().

Expectations: AllStatesChanged(_policy='wait')

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

common.Common.CurrentDate

Set the date. This date is taken by the drone as its own date. So medias and other files will be dated from this date 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:

datestring

Date with ISO-8601 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)

Supported by every drone product

Result: The date of the product is set. Then, it will trigger CurrentDateChanged().

Expectations: CurrentDateChanged(date=self.date, _policy='wait')

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

common.Common.CurrentDateTime

Set both the date and the time with only one command. If using this command, do not use CurrentDate() and CurrentTime() commands. This datetime is taken by the drone as its own datetime. So medias and other files will be dated from this datetime 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:

datetimestring

DateTime with the ISO-8601 complete short format: “%Y%m%dT%H%M%S%z”

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

ANAFI:

with an up to date firmware

ANAFI Thermal:

with an up to date firmware

Result: The datetime of the product is set. Then, it will trigger CurrentDateTimeChanged().

Expectations: CurrentDateTimeChanged(datetime=self.datetime, _policy='wait')

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

common.Common.CurrentTime

Set the time. This time is taken by the drone as its own time. So medias and other files will be dated from this time 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:

timestring

Time with ISO-8601 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)

Supported by every drone product

Result: The time of the product is set. Then, it will trigger CurrentTimeChanged().

Expectations: CurrentTimeChanged(time=self.time, _policy='wait')

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

common.Common.PowerOff

Shutdown and power off the product. The product will accept this command only if is not flying.

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:

ANAFI_3_INSPECT:

for firmware release versions 8.3.0

ANAFI_3_MIL:

for firmware release versions 8.3.0

ANAFI_3_GOV:

for firmware release versions 8.3.0

Result: The product will shutdown and power off if it can.

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

common.Common.Reboot

Reboot the product. The product will accept this command only if is not flying.

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 reboot if it can.

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

common.CommonState.AllStatesChanged

All states 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 states values have been sent.

event message olympe.messages.common.CommonState.BatteryStateChanged(percent=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.CommonState.BatteryStateChanged

Battery state.

Parameters:

percentu8

Battery percentage

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

event message olympe.messages.common.CommonState.BootId(bootId=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.CommonState.BootId

Current Drone Boot id. A Boot Id identifies a drone session and do not change between drone power on and power off. Also, each medias contains the Boot Id.

Parameters:

bootIdstring

Id of the boot

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

ANAFI:

with an up to date firmware

ANAFI Thermal:

with an up to date firmware

Triggered: At connection.

event message olympe.messages.common.CommonState.CountryListKnown(listFlags=None, countryCodes=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.CommonState.CountryListKnown

List of countries known by the drone.

Parameters:

listFlagsu8

List entry attribute Bitfield. 0x01: First: indicate it’s the first element of the list. 0x02: Last: indicate it’s the last element of the list. 0x04: Empty: indicate the list is empty (implies First/Last). All other arguments should be ignored.

countryCodesstring

Following of country code with ISO 3166 format, separated by “;”. Be careful of the command size allowed by the network used. If necessary, split the list in several commands.

_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 common.CommonState.CountryListKnown

Deprecated message

Warning

This message is deprecated and should no longer be used

event message olympe.messages.common.CommonState.CurrentDateChanged(date=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.CommonState.CurrentDateChanged

Date changed. Corresponds to the latest date set on the drone. 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:

datestring

Date with ISO-8601 format

_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 CurrentDate().

event message olympe.messages.common.CommonState.CurrentDateTimeChanged(datetime=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.CommonState.CurrentDateTimeChanged

Both date and time changed. Corresponds to the latest datetime set on the drone. 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:

datetimestring

Datetime with the ISO-8601 complete short format: “%Y%m%dT%H%M%S%z”

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

ANAFI:

with an up to date firmware

ANAFI Thermal:

with an up to date firmware

Triggered: by CurrentDateTime().

event message olympe.messages.common.CommonState.CurrentTimeChanged(time=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.CommonState.CurrentTimeChanged

Time changed. Corresponds to the latest time set on the drone. 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:

timestring

Time with ISO-8601 format

_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 CurrentTime().

event message olympe.messages.common.CommonState.DeprecatedMassStorageContentChanged(mass_storage_id=None, nbPhotos=None, nbVideos=None, nbPuds=None, nbCrashLogs=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.CommonState.DeprecatedMassStorageContentChanged

Mass storage content changed.

Parameters:

mass_storage_idu8

Mass storage id (unique)

nbPhotosu16

Number of photos (does not include raw photos)

nbVideosu16

Number of videos

nbPudsu16

Number of puds

nbCrashLogsu16

Number of crash logs

_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 common.CommonState.DeprecatedMassStorageContentChanged

Deprecated message

Warning

This message is deprecated and should no longer be used

event message olympe.messages.common.CommonState.FlightId(flightId=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.CommonState.FlightId

Current Drone Flight id. A Flight Id identifies a drone flight (between takeoff and land).

Parameters:

flightIdstring

Id of the flight

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

ANAFI:

with an up to date firmware

ANAFI Thermal:

with an up to date firmware

ANAFI Ai:

with an up to date firmware

ANAFI_UA:

with an up to date firmware

ANAFI USA:

with an up to date firmware

Triggered: At connection, and at each takeoff. Also at each landing, flightid is updated with an empty string value

event message olympe.messages.common.CommonState.LinkSignalQuality(value=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.CommonState.LinkSignalQuality

Link signal quality. Gives a overal indication of the radio link quality

Parameters:

valueu8

Bits 0-3: indicate the Link signal quality. The quality varies from 1 to 5. 1 means that a disconnection is highly probable, 5 means that the link signal quality is very good. Bit 6: 1 when there is a probable 4G interference coming from the smartphone. Zero otherwise. Bit 7: 1 when the link signal quality is low although the radio RSSI is good. This indicate that the radio link is perturbed by external elements. Zero otherwise.

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

ANAFI:

with an up to date firmware

ANAFI Thermal:

with an up to date firmware

Triggered: when the link signal quality changes.

event message olympe.messages.common.CommonState.MassStorageContent(mass_storage_id=None, nbPhotos=None, nbVideos=None, nbPuds=None, nbCrashLogs=None, nbRawPhotos=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.CommonState.MassStorageContent

Mass storage content.

Parameters:

mass_storage_idu8

Mass storage id (unique)

nbPhotosu16

Number of photos (does not include raw photos)

nbVideosu16

Number of videos

nbPudsu16

Number of puds

nbCrashLogsu16

Number of crash logs

nbRawPhotosu16

Number of raw photos

_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 common.CommonState.MassStorageContent

Deprecated message

Warning

This message is deprecated and should no longer be used

Triggered: when the content of the mass storage changes.

event message olympe.messages.common.CommonState.MassStorageContentForCurrentRun(mass_storage_id=None, nbPhotos=None, nbVideos=None, nbRawPhotos=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.CommonState.MassStorageContentForCurrentRun

Mass storage content for current run. Only counts the files related to the current run (see RunIdChanged())

Parameters:

mass_storage_idu8

Mass storage id (unique)

nbPhotosu16

Number of photos (does not include raw photos)

nbVideosu16

Number of videos

nbRawPhotosu16

Number of raw photos

_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 common.CommonState.MassStorageContentForCurrentRun

Deprecated message

Warning

This message is deprecated and should no longer be used

Triggered: when the content of the mass storage changes and this content is related to the current run.

event message olympe.messages.common.CommonState.MassStorageInfoRemainingListChanged(free_space=None, rec_time=None, photo_remaining=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.CommonState.MassStorageInfoRemainingListChanged

Mass storage remaining data list.

Parameters:

free_spaceu32

Mass storage free space in MBytes

rec_timeu16

Mass storage record time reamining in minute

photo_remainingu32

Mass storage photo remaining

_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 common.CommonState.MassStorageInfoRemainingListChanged

Deprecated message

Warning

This message is deprecated and should no longer be used

event message olympe.messages.common.CommonState.MassStorageInfoStateListChanged(mass_storage_id=None, size=None, used_size=None, plugged=None, full=None, internal=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.CommonState.MassStorageInfoStateListChanged

Mass storage info state list.

Parameters:

mass_storage_idu8

Mass storage state id (unique)

sizeu32

Mass storage size in MBytes

used_sizeu32

Mass storage used size in MBytes

pluggedu8

Mass storage plugged (1 if mass storage is plugged, otherwise 0)

fullu8

Mass storage full information state (1 if mass storage full, 0 otherwise).

internalu8

Mass storage internal type state (1 if mass storage is internal, 0 otherwise)

_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 a mass storage info changes.

event message olympe.messages.common.CommonState.MassStorageStateListChanged(mass_storage_id=None, name=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.CommonState.MassStorageStateListChanged

Mass storage state list.

Parameters:

mass_storage_idu8

Mass storage id (unique)

namestring

Mass storage 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: when a mass storage is inserted or ejected.

event message olympe.messages.common.CommonState.ProductModel(model=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.CommonState.ProductModel

Product sub-model. This can be used to customize the UI depending on the product.

Parameters:

model : olympe.enums.common.CommonState.ProductModel_Model

_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 common.CommonState.ProductModel

Triggered: at connection.

event message olympe.messages.common.CommonState.SensorsStatesListChanged(sensorName=None, sensorState=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.CommonState.SensorsStatesListChanged

Sensors state list.

Parameters:

sensorName : olympe.enums.common.CommonState.SensorsStatesListChanged_SensorName

sensorStateu8

Sensor state (1 if the sensor is OK, 0 if the sensor is NOT OK)

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

ANAFI:

with an up to date firmware

ANAFI Thermal:

with an up to date firmware

Triggered: at connection and when a sensor state changes.

event message olympe.messages.common.CommonState.VideoRecordingTimestamp(startTimestamp=None, stopTimestamp=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.CommonState.VideoRecordingTimestamp

Current or last video recording timestamp. Timestamp in milliseconds since 00:00:00 UTC on 1 January 1970. Please note that values don’t persist after drone reboot

Parameters:

startTimestampu64

Timestamp in milliseconds since 00:00:00 UTC on 1 January 1970.

stopTimestampu64

Timestamp in milliseconds since 00:00:00 UTC on 1 January 1970. 0 mean that video is still recording.

_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 common.CommonState.VideoRecordingTimestamp

Deprecated message

Warning

This message is deprecated and should no longer be used

Triggered: on video recording start and video recording stop or after that the date/time of the drone changed.

event message olympe.messages.common.CommonState.WifiSignalChanged(rssi=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.CommonState.WifiSignalChanged

Rssi (Wifi Signal between controller and product) changed.

Parameters:

rssii16

RSSI of the signal between controller and the product (in dbm)

_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 common.CommonState.WifiSignalChanged

Triggered: regularly.

enum olympe.enums.common.CommonState.ProductModel_Model

The Model of the product.

RS_TRAVIS:

Travis (RS taxi) model. (0)

RS_MARS:

Mars (RS space) model (1)

RS_SWAT:

SWAT (RS SWAT) model (2)

RS_MCLANE:

Mc Lane (RS police) model (3)

RS_BLAZE:

Blaze (RS fire) model (4)

RS_ORAK:

Orak (RS carbon hydrofoil) model (5)

RS_NEWZ:

New Z (RS wooden hydrofoil) model (6)

JS_MARSHALL:

Marshall (JS fire) model (7)

JS_DIESEL:

Diesel (JS SWAT) model (8)

JS_BUZZ:

Buzz (JS space) model (9)

JS_MAX:

Max (JS F1) model (10)

JS_JETT:

Jett (JS flames) model (11)

JS_TUKTUK:

Tuk-Tuk (JS taxi) model (12)

SW_BLACK:

Swing black model (13)

SW_WHITE:

Swing white model (14)

enum olympe.enums.common.CommonState.SensorsStatesListChanged_SensorName

Sensor name

IMU:

Inertial Measurement Unit sensor (0)

barometer:

Barometer sensor (1)

ultrasound:

Ultrasonic sensor (2)

GPS:

GPS sensor (3)

magnetometer:

Magnetometer sensor (4)

vertical_camera:

Vertical Camera sensor (5)

vertical_tof:

Vertical Time Of Flight sensor (6)