Common.Common*

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

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

Result: The product will trigger all states events (such as FlyingStateChanged() for the Bebop). Then, it will trigger AllStatesChanged().

Expectations: AllStatesChanged(_policy='wait')

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

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:
  • date (string) – Date with ISO-8601 format
  • _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

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

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

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

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:
  • time (string) – Time with ISO-8601 format
  • _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

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

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

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

Common.Common.Reboot

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

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

Result: The product will reboot if it can.

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

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:
  • datetime (string) – DateTime with the ISO-8601 complete short format: “%Y%m%dT%H%M%S%z”
  • _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

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

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

event messageolympe.messages.common.CommonState.AllStatesChanged(_policy='check_wait', _float_tol=(1e-07, 1e-09))

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

Triggered when all states values have been sent.

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

Common.CommonState.BatteryStateChanged

Battery state.

Parameters:
  • percent (u8) – Battery percentage
  • _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

Triggered when the battery level changes.

event messageolympe.messages.common.CommonState.MassStorageStateListChanged(mass_storage_id=None, name=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Common.CommonState.MassStorageStateListChanged

Mass storage state list.

Parameters:
  • mass_storage_id (u8) – Mass storage id (unique)
  • name (string) – Mass storage name
  • _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

Triggered when a mass storage is inserted or ejected.

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

Common.CommonState.MassStorageInfoStateListChanged

Mass storage info state list.

Parameters:
  • mass_storage_id (u8) – Mass storage state id (unique)
  • size (u32) – Mass storage size in MBytes
  • used_size (u32) – Mass storage used size in MBytes
  • plugged (u8) – Mass storage plugged (1 if mass storage is plugged, otherwise 0)
  • full (u8) – Mass storage full information state (1 if mass storage full, 0 otherwise).
  • internal (u8) – Mass storage internal type state (1 if mass storage is internal, 0 otherwise)
  • _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

Triggered when a mass storage info changes.

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

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:
  • date (string) – Date with ISO-8601 format
  • _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

Triggered by CurrentDate().

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

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:
  • time (string) – Time with ISO-8601 format
  • _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

Triggered by CurrentTime().

event messageolympe.messages.common.CommonState.MassStorageInfoRemainingListChanged(free_space=None, rec_time=None, photo_remaining=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Common.CommonState.MassStorageInfoRemainingListChanged

Mass storage remaining data list.

Parameters:
  • free_space (u32) – Mass storage free space in MBytes
  • rec_time (u16) – Mass storage record time reamining in minute
  • photo_remaining (u32) – Mass storage photo remaining
  • _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
event messageolympe.messages.common.CommonState.WifiSignalChanged(rssi=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Common.CommonState.WifiSignalChanged

Rssi (Wifi Signal between controller and product) changed.

Parameters:
  • rssi (i16) – RSSI of the signal between controller and the product (in dbm)
  • _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

Triggered regularly.

event messageolympe.messages.common.CommonState.SensorsStatesListChanged(sensorName=None, sensorState=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Common.CommonState.SensorsStatesListChanged

Sensors state list.

Parameters:
  • sensorName (olympe.enums.common.CommonState.SensorsStatesListChanged_SensorName) –
  • sensorState (u8) – Sensor state (1 if the sensor is OK, 0 if the sensor is NOT OK)
  • _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

Triggered at connection and when a sensor state changes.

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

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

Triggered at connection.

event messageolympe.messages.common.CommonState.CountryListKnown(listFlags=None, countryCodes=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Common.CommonState.CountryListKnown

List of countries known by the drone.

Parameters:
  • listFlags (u8) – 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.
  • countryCodes (string) – 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.
  • _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
event messageolympe.messages.common.CommonState.DeprecatedMassStorageContentChanged(mass_storage_id=None, nbPhotos=None, nbVideos=None, nbPuds=None, nbCrashLogs=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Common.CommonState.DeprecatedMassStorageContentChanged

Mass storage content changed.

Parameters:
  • mass_storage_id (u8) – Mass storage id (unique)
  • nbPhotos (u16) – Number of photos (does not include raw photos)
  • nbVideos (u16) – Number of videos
  • nbPuds (u16) – Number of puds
  • nbCrashLogs (u16) – Number of crash logs
  • _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
event messageolympe.messages.common.CommonState.MassStorageContent(mass_storage_id=None, nbPhotos=None, nbVideos=None, nbPuds=None, nbCrashLogs=None, nbRawPhotos=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Common.CommonState.MassStorageContent

Mass storage content.

Parameters:
  • mass_storage_id (u8) – Mass storage id (unique)
  • nbPhotos (u16) – Number of photos (does not include raw photos)
  • nbVideos (u16) – Number of videos
  • nbPuds (u16) – Number of puds
  • nbCrashLogs (u16) – Number of crash logs
  • nbRawPhotos (u16) – Number of raw photos
  • _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

Triggered when the content of the mass storage changes.

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

Common.CommonState.MassStorageContentForCurrentRun

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

Parameters:
  • mass_storage_id (u8) – Mass storage id (unique)
  • nbPhotos (u16) – Number of photos (does not include raw photos)
  • nbVideos (u16) – Number of videos
  • nbRawPhotos (u16) – Number of raw photos
  • _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

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

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

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:
  • startTimestamp (u64) – Timestamp in milliseconds since 00:00:00 UTC on 1 January 1970.
  • stopTimestamp (u64) – Timestamp in milliseconds since 00:00:00 UTC on 1 January 1970. 0 mean that video is still recording.
  • _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

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

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

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:
  • datetime (string) – Datetime with the ISO-8601 complete short format: “%Y%m%dT%H%M%S%z”
  • _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

Triggered by CurrentDateTime().

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

Common.CommonState.LinkSignalQuality

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

Parameters:
  • value (u8) – 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.
  • _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

Triggered when the link signal quality changes.

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

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:
  • bootId (string) – Id of the boot
  • _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

Triggered At connection.

enumolympe.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)
enumolympe.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)