ARSDK commands: Common
Part of the ARSDK command reference. Read its section on how to read the tables first. Tags in the cells: V Verified, A Agent-cited, I Inference, O Open.
Project id 0. Commands shared by all Parrot products: connection, settings, date and time, flight plan (Mavlink) and calibration. Documented in common.xml.
Common.Network (class 0)
Section titled “Common.Network (class 0)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| Disconnect | 0.0.0 | receive | (none) | Signals the remote that the host will disconnect. (V: XML) | REG 0x621d8 cb 0x62100; msg 3 DISCONNECTED (A) | XML: deprecated; XML support “none” lists no 090c |
Common.NetworkEvent (class 1)
Section titled “Common.NetworkEvent (class 1)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| Disconnection | 0.1.0 | send | cause:enum{off_button="0,unknown=1,reset_factory=2"} | Drone will disconnect. This event is mainly triggered when the user presses on the power button of the product. This event is a notification, you can’t retrieve it in the cache of the device controller. (V: XML) | GEN 0x62430 | differs from firmware: arg cause enum values XML [off_button,unknown,reset_factory], firmware [OFF_BUTTON,UNKNOWN] |
Common.Settings (class 2)
Section titled “Common.Settings (class 2)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| AllSettings | 0.2.0 | receive | (none) | 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. (V: XML) | REG 0x62228 cb 0x61a30; msg 60 GET_ALL_SETTINGS (A) | XML support “drones” (generic) |
| Reset | 0.2.1 | receive | (none) | Reset all settings. (V: XML) | REG 0x62250 cb 0x62058; msg 84 RESET_SETTINGS (A) | XML support “drones” (generic) |
| ProductName | 0.2.2 | receive | name:string | Set product name. 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). (V: XML) | REG 0x6223c cb 0x61bb4; msg 61 SET_PRODUCT_NAME (A) | XML support “drones” (generic) |
| Country | 0.2.3 | receive | code:string | 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. (V: XML) | REG 0x62264 cb 0x61b8c; msg 81 SET_COUNTRY (A) | |
| AutoCountry | 0.2.4 | receive | automatic:u8 | 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. (V: XML) | REG 0x62278 cb 0x619ac; msg 82 SET_AUTOCOUNTRY (A) |
Common.SettingsState (class 3)
Section titled “Common.SettingsState (class 3)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| AllSettingsChanged | 0.3.0 | send | (none) | 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. (V: XML) | GEN 0x63148 | XML support “drones” (generic) |
| ResetChanged | 0.3.1 | send | (none) | All settings have been reset. (V: XML) | GEN 0x63008 | XML support “drones” (generic) |
| ProductNameChanged | 0.3.2 | send | name:string | Product name changed. (V: XML) | GEN 0x62838 | XML support “drones” (generic) |
| ProductVersionChanged | 0.3.3 | send | software:string; hardware:string | Product version. (V: XML) | GEN 0x62ec0 | XML support “drones” (generic) |
| ProductSerialHighChanged | 0.3.4 | send | high:string | Product serial (1st part). (V: XML) | GEN 0x62c20 | XML support “drones” (generic) |
| ProductSerialLowChanged | 0.3.5 | send | low:string | Product serial (2nd part). (V: XML) | GEN 0x62d6c | XML support “drones” (generic) |
| CountryChanged | 0.3.6 | send | code:string | Country changed. (V: XML) | GEN 0x62984 | XML support “drones” (generic) |
| AutoCountryChanged | 0.3.7 | send | automatic:u8 | Auto-country changed. (V: XML) | GEN 0x62ad0 | XML support “drones” (generic) |
Common.Common (class 4)
Section titled “Common.Common (class 4)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| AllStates | 0.4.0 | receive | (none) | 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. (V: XML) | REG 0x622a0 cb 0x618b4; msg 58 ALL_STATES_ASKED (A) | XML support “drones” (generic) |
| CurrentDate | 0.4.1 | receive | date:string | Set the date. This date is taken by the drone as its own date. (V: XML) | REG 0x621ec cb 0x61f64; msg 55 DATE (A) | XML support “drones” (generic) |
| CurrentTime | 0.4.2 | receive | time:string | Set the time. This time is taken by the drone as its own time. (V: XML) | REG 0x62200 cb 0x61e70; msg 56 TIME (A) | XML support “drones” (generic) |
| Reboot | 0.4.3 | receive | (none) | Reboot the product. The product will accept this command only if is not flying. (V: XML) | REG 0x62214 cb 0x61aa4; msg 57 REBOOT, 135 STOP_ALL_ANIM (A) | XML support “drones” (generic) |
Common.CommonState (class 5)
Section titled “Common.CommonState (class 5)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| AllStatesChanged | 0.5.0 | send | (none) | 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. (V: XML) | GEN 0x63670 | XML support “drones” (generic) |
| BatteryStateChanged | 0.5.1 | send | percent:u8 | Battery state. (V: XML) | GEN 0x633e0 | XML support “drones” (generic) |
| MassStorageStateListChanged | 0.5.2 | send | mass_storage_id:u8; name:string | Mass storage state list. (V: XML) | GEN 0x637c4 | XML support “drones” (generic) |
| MassStorageInfoStateListChanged | 0.5.3 | send | mass_storage_id:u8; size:u32; used_size:u32; plugged:u8; full:u8; internal:u8 | Mass storage info state list. (V: XML) | GEN 0x63940 | XML support “drones” (generic) |
| CurrentDateChanged | 0.5.4 | send | date:string | 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. (V: XML) | GEN 0x625a0 | XML support “drones” (generic) |
| CurrentTimeChanged | 0.5.5 | send | time:string | 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. (V: XML) | GEN 0x626ec | XML support “drones” (generic) |
| WifiSignalChanged | 0.5.7 | send | rssi:i16 | Rssi changed. Rssi (Wifi Signal between controller and product) changed. (V: XML) | GEN 0x63be4 | |
| SensorsStatesListChanged | 0.5.8 | send | sensorName:enum{IMU="0,barometer=1,ultrasound=2,GPS=3,magnetometer=4,vertical_camera=5"}; sensorState:u8 | Sensors state list. (V: XML) | GEN 0x63ab8 | |
| DeprecatedMassStorageContentChanged | 0.5.11 | send | mass_storage_id:u8; nbPhotos:u16; nbVideos:u16; nbPuds:u16; nbCrashLogs:u16 | Mass storage content changed. (V: XML) | GEN 0x6404c | XML: deprecated; XML gives no support value |
| MassStorageContent | 0.5.12 | send | mass_storage_id:u8; nbPhotos:u16; nbVideos:u16; nbPuds:u16; nbCrashLogs:u16; nbRawPhotos:u16 | Mass storage content. (V: XML) | GEN 0x63ee4 | XML: 090c from firmware 4.0.0 |
| MassStorageContentForCurrentRun | 0.5.13 | send | mass_storage_id:u8; nbPhotos:u16; nbVideos:u16; nbRawPhotos:u16 | Mass storage content for current run. Only counts the files related to the current run (see RunId) (V: XML) | GEN 0x64194 | XML: 090c from firmware 4.0.0 |
| VideoRecordingTimestamp | 0.5.14 | send | startTimestamp:u64; stopTimestamp:u64 | Video recording timestamp. 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 (V: XML) | GEN 0x642fc | XML gives no support value |
Common.OverHeat (class 6)
Section titled “Common.OverHeat (class 6)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| SwitchOff | 0.6.0 | receive | (none) | Switch off after an overheat. (V: XML) | REG 0x60ee4 cb 0x57274; msg 123 TEMPERATURE_SHUTDOWN (A) | XML: deprecated; XML support “none” lists no 090c |
Common.OverHeatState (class 7)
Section titled “Common.OverHeatState (class 7)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| OverHeatChanged | 0.7.0 | send | (none) | Overheat temperature reached. (V: XML) | GEN 0x5ebc0 | XML: deprecated; XML gives no support value |
Common.Controller (class 8)
Section titled “Common.Controller (class 8)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| IsPiloting | 0.8.0 | receive | piloting:u8 | 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. (V: XML) | REG 0x622b4 cb 0x61834; msg 5 PILOTING_STATUS (A) | XML support “drones” (generic) |
Common.WifiSettings (class 9)
Section titled “Common.WifiSettings (class 9)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| OutdoorSetting | 0.9.0 | receive | outdoor:u8 | Set wifi outdoor mode. Set wifi indoor/outdoor mode. Please note that you might be disconnected from the product after changing the indoor/outdoor setting as it changes Wifi parameters. (V: XML) | REG 0x6228c cb 0x61928; msg 97 SET_WIFI_SETTINGS_OUTDOOR (A) |
Common.WifiSettingsState (class 10)
Section titled “Common.WifiSettingsState (class 10)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| OutdoorSettingsChanged | 0.10.0 | send | outdoor:u8 | Wifi outdoor mode. (V: XML) | GEN 0x63294 |
Common.Mavlink (class 11)
Section titled “Common.Mavlink (class 11)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| Start | 0.11.0 | receive | filepath:string; type:enum{flightPlan="0,mapMyHouse=1"} | Start a FlightPlan based on a mavlink file existing on the drone. Requirements are: Product is calibrated Product should be in outdoor mode Product has fixed its GPS (V: XML) | REG 0x60f0c cb 0x58e20; msg 126 MAVLINK_FLIGHTPLANS_START, 126 MAVLINK_FLIGHTPLANS_START (A) | Callback body contains two posts of the same id. |
| Pause | 0.11.1 | receive | (none) | Pause a FlightPlan that was playing. To unpause a FlightPlan, see StartFlightPlan (V: XML) | REG 0x60f20 cb 0x571fc; msg 128 MAVLINK_FLIGHTPLANS_PAUSE (A) | |
| Stop | 0.11.2 | receive | (none) | Stop a FlightPlan that was playing. (V: XML) | REG 0x60f34 cb 0x57184; msg 127 MAVLINK_FLIGHTPLANS_STOP (A) |
Common.MavlinkState (class 12)
Section titled “Common.MavlinkState (class 12)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| MavlinkFilePlayingStateChanged | 0.12.0 | send | state:enum{playing="0,stopped=1,paused=2,loaded=3"}; filepath:string; type:enum{flightPlan="0,mapMyHouse=1"} | Playing state of a FlightPlan. (V: XML) | GEN 0x5f814 | |
| MissionItemExecuted | 0.12.2 | send | idx:u32 | Mission item executed. Mission item has been executed. (V: XML) | GEN 0x5f970 | XML: 090c from firmware 4.2.0 |
Common.Calibration (class 13)
Section titled “Common.Calibration (class 13)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| MagnetoCalibration | 0.13.0 | receive | calibrate:u8 | Start/Abort magnetometer calibration. Start or abort magnetometer calibration process. (V: XML) | REG 0x60ef8 cb 0x55804; msg 124 CALIBRATION_MAGNETO (A) |
Common.CalibrationState (class 14)
Section titled “Common.CalibrationState (class 14)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| MagnetoCalibrationStateChanged | 0.14.0 | send | xAxisCalibration:u8; yAxisCalibration:u8; zAxisCalibration:u8; calibrationFailed:u8 | Magneto calib process axis state. (V: XML) | GEN 0x5f554 | |
| MagnetoCalibrationRequiredState | 0.14.1 | send | required:u8 | Calibration required. (V: XML) | GEN 0x5f298 | |
| MagnetoCalibrationAxisToCalibrateChanged | 0.14.2 | send | axis:enum{xAxis="0,yAxis=1,zAxis=2,none=3"} | Axis to calibrate during calibration process. (V: XML) | GEN 0x5f6b4 | |
| MagnetoCalibrationStartedChanged | 0.14.3 | send | started:u8 | Calibration process state. (V: XML) | GEN 0x5f3ec |
Common.CameraSettingsState (class 15)
Section titled “Common.CameraSettingsState (class 15)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| CameraSettingsChanged | 0.15.0 | send | fov:float; panMax:float; panMin:float; tiltMax:float; tiltMin:float | Camera info. (V: XML) | GEN 0x5a1f4 |
Common.GPS (class 16)
Section titled “Common.GPS (class 16)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| ControllerPositionForRun | 0.16.0 | receive | latitude:double; longitude:double | Set the position of a run. This will let the product know the controller location for the flight/run. The location is typically used to geotag medias. Only used on products that have no gps. Watch out, this command is not used by BLE products. (V: XML) | REG 0x622c8 cb 0x6178c; msg 111 GPS_CONTROLLER_LATITUDE, 112 GPS_CONTROLLER_LONGITUDE (A) | XML support “0902;0905;0906” lists no 090c |
Common.FlightPlanState (class 17)
Section titled “Common.FlightPlanState (class 17)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| AvailabilityStateChanged | 0.17.0 | send | AvailabilityState:u8 | FlightPlan availability. Availability is linked to GPS fix, magnetometer calibration, sensor states… (V: XML) | GEN 0x5faa0 | |
| ComponentStateListChanged | 0.17.1 | send | component:enum{GPS="0,Calibration=1,Mavlink_File=2,TakeOff=3,WaypointsBeyondGeofence=4,CameraAvailable=5"}; State:u8 | FlightPlan components state list. (V: XML) | GEN 0x5fbbc | differs from firmware: arg component enum values XML [GPS,Calibration,Mavlink_File,TakeOff,WaypointsBeyondGeofence,CameraAvailable], firmware [GPS,CALIBRATION,MAVLINK_FILE,TAKEOFF,WAYPOINTSBEYONDGEOFENCE] |
Common.ARLibsVersionsState (class 18)
Section titled “Common.ARLibsVersionsState (class 18)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| DeviceLibARCommandsVersion | 0.18.2 | send | version:string | (no text in the XML) (V: XML) | GEN 0x6352c | XML gives no support value |
Common.FlightPlanEvent (class 19)
Section titled “Common.FlightPlanEvent (class 19)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| StartingErrorEvent | 0.19.0 | send | (none) | FlightPlan start error. This event is a notification, you can’t retrieve it in the cache of the device controller. (V: XML) | GEN 0x5fccc |
Common.Audio (class 20)
Section titled “Common.Audio (class 20)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| ControllerReadyForStreaming | 0.20.0 | receive | ready:u8 | Set audio stream direction. (V: XML) | REG 0x62334 cb 0x61570; msg 141 SET_CONTROLLER_READY_FOR_STREAMING (A) | XML support “0905;0906” lists no 090c |
Common.Headlights (class 22)
Section titled “Common.Headlights (class 22)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| Intensity | 0.22.0 | receive | left:u8; right:u8 | Set LEDs intensity. Set lighting LEDs intensity. (V: XML) | REG 0x622dc cb 0x616fc; msg 136 SET_HEADLIGHTS (A) | XML support “0905;0906;0907” lists no 090c |
Common.Animations (class 24)
Section titled “Common.Animations (class 24)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| StartAnimation | 0.24.0 | receive | anim:enum{HEADLIGHTS_FLASH="0,HEADLIGHTS_BLINK=1,HEADLIGHTS_OSCILLATION=2,SPIN=3,TAP=4,SLOW_SHAKE=5,METRONOME=6,ONDULATION=7,SPIN_JUMP=8,SPIN_TO_POSTURE=9,SPIRAL=10,SLALOM=11,BOOST=12,LOOPING=13,BARREL_ROLL_180_RIGHT=14,BARREL_ROLL_180_LEFT=15,BACKSWAP=16"} | Start an animation. Start a paramaterless animation. List of available animations can be retrieved from AnimationsStateList. (V: XML) | REG 0x622f0 cb 0x61678; msg 133 START_ANIM (A) | XML support “0902;0905;0906;0907;0909” lists no 090c |
| StopAnimation | 0.24.1 | receive | anim:enum{HEADLIGHTS_FLASH="0,HEADLIGHTS_BLINK=1,HEADLIGHTS_OSCILLATION=2,SPIN=3,TAP=4,SLOW_SHAKE=5,METRONOME=6,ONDULATION=7,SPIN_JUMP=8,SPIN_TO_POSTURE=9,SPIRAL=10,SLALOM=11,BOOST=12,LOOPING=13,BARREL_ROLL_180_RIGHT=14,BARREL_ROLL_180_LEFT=15,BACKSWAP=16"} | Stop an animation. Stop a paramaterless animation. List of running animations can be retrieved from AnimationsStateList. (V: XML) | REG 0x62304 cb 0x615f4; msg 134 STOP_ANIM (A) | XML support “0902;0905;0906;0907;0909” lists no 090c |
| StopAllAnimations | 0.24.2 | receive | (none) | Stop all animations. Stop all running paramaterless animations. List of running animations can be retrieved from AnimationsStateList. (V: XML) | REG 0x62320 cb 0x615f4; msg 134 STOP_ANIM (A) | XML support “0902;0905;0906;0907;0909” lists no 090c |
Common.RunState (class 30)
Section titled “Common.RunState (class 30)”| Command | Id | Dir | Arguments | What it does | Status in dragon-prog | Notes |
|---|---|---|---|---|---|---|
| RunIdChanged | 0.30.0 | send | runId:string | Current run id. A run id is uniquely identifying a run or a flight. For each run is generated on the drone a file which can be used by Academy to sum up the run. Also, each medias taken during a run has a filename containing the run id. (V: XML) | GEN 0x63d44 |
Comments
Spotted a mistake, or tried this on your own Bebop? Leave a note. Comments are kept on this site's own server.