Namespaces | |
MOP | |
This namespace encapsulates all available telemetry topics through either Broadcast or Subscribe. | |
Telemetry | |
This namespace encapsulates all available telemetry topics through either Broadcast or Subscribe. | |
VehicleStatus | |
info about vehicle | |
Classes | |
class | ACK |
Class for handling acknowledgements from the aircraft. More... | |
class | AdvancedSensing |
struct | BatteryWholeInfo |
struct | BatteryWholeInfoImpl |
class | Camera |
Camera class for controlling camera-related functions available through open protocol. More... | |
class | CameraManager |
The manager of camera module. More... | |
class | CameraModule |
CameraModule of PayloadNode. More... | |
struct | CGPoint |
struct | CMD_SETSupportMatrix |
Define CMD_SET support matrix. More... | |
struct | CommonCallBackHandler |
The CallBackHandler struct allows users to encapsulate callbacks and data in one struct. This is a more common method. More... | |
class | Control |
Flight control API: high-level actions and low-level control modes. More... | |
class | DataBroadcast |
Telemetry API through asynchronous "Broadcast"-style messages. More... | |
class | DataSubscription |
Telemetry API through asynchronous "Subscribe"-style messages. More... | |
struct | DispatchInfo |
Dispatch info. More... | |
struct | DJIGimbalRotation |
class | DJIHMS |
DJI health manager system of drone. More... | |
struct | DJIWaypointV2Action |
struct | DJIWaypointV2Actuator |
struct | DJIWaypointV2AircraftControlFlyingParam |
struct | DJIWaypointV2AircraftControlParam |
struct | DJIWaypointV2AircraftControlRotateHeadingParam |
struct | DJIWaypointV2AssociateTriggerParam |
struct | DJIWaypointV2CameraActuatorParam |
struct | DJIWaypointV2CameraFocalLengthParam |
struct | DJIWaypointV2CameraFocusParam |
struct | DJIWaypointV2GimbalActuatorParam |
struct | DJIWaypointV2IntervalTriggerParam |
struct | DJIWaypointV2TrajectoryTriggerParam |
struct | DJIWholeBatteryState |
struct | DJIWholeBatteryStateImpl |
struct | DownloadMissionAck |
struct | DownloadMissionRsp |
struct | ErrList |
class | ErrorCode |
union | Eventdata |
class | FlightController |
Flight controller API: set or get parameter, execute flight actions. More... | |
struct | GetGlobalCruiseVelAck |
struct | GetRemainRamAck |
struct | GetWaypontStartEndIndexAck |
class | Gimbal |
The Gimbal class for controlling gimbal-related functions. More... | |
class | GimbalManager |
The manager of gimbal module. More... | |
class | GimbalModule |
gimbal module More... | |
class | HardwareSync |
APIs for controlling Hardware Sync. More... | |
struct | HMSErrCodeInfo |
struct | HMSPushData |
struct | HMSPushPacket |
class | HotpointMission |
APIs for Hotpoint (Point of Interest) Missions. More... | |
struct | HotPointSettings |
HotPoint Mission Initialization settings. More... | |
class | MFIO |
APIs for Multi-Function Input-Output functionality. More... | |
class | MissionBase |
Mission Base class for commonality between SDK Missions. More... | |
struct | MissionEventPushAck |
class | MissionManager |
MissionManager class for chaining/managing missions. More... | |
struct | MissionStateCommanData |
struct | MissionStatePushAck |
class | MobileDevice |
APIs for Mobile-Onboard SDK Communication. More... | |
class | MopClient |
Class providing APIs & data structures for acting as a MOP client. More... | |
class | MopPipeline |
Class providing APIs & data structures MOP pipeline operations. More... | |
class | MopServer |
Class providing APIs & data structures for acting as a MOP server. More... | |
struct | OpenHeader |
The Header struct is meant to handle the open protocol header. More... | |
class | PayloadBase |
PayloadBase. More... | |
class | PayloadDevice |
APIs for Payload-Onboard SDK Communication. More... | |
class | PSDKManager |
The manager of psdk module. More... | |
class | PSDKModule |
PSDK module. More... | |
struct | RecvContainer |
Received info. More... | |
struct | RelativePosition |
class | SubscriptionPackage |
Package class to support Subscribe-style telemetry. More... | |
struct | UploadActionsRawAck |
struct | UploadMissionRawAck |
struct | VehicleCallBackHandler |
The CallBackHandler struct allows users to encapsulate callbacks and data in one struct. More... | |
struct | VirtualRCData |
Virtual RC data (supported only on Matrice 100) More... | |
struct | VirtualRCSetting |
Virtual RC Settings (supported only on Matrice 100) More... | |
struct | WayPointFinishData |
Waypoint Mission Finish Event Push Data. More... | |
struct | WayPointInitSettings |
Waypoint Mission Initialization settings. More... | |
class | WaypointMission |
APIs for GPS Waypoint Missions. More... | |
struct | WayPointSettings |
Waypoint settings for individual waypoints being added to the mission. More... | |
struct | WaypointV2 |
struct | WaypointV2Config |
struct | WayPointV2InitSettings |
Waypoint V2 Mission Initialization settings. More... | |
struct | WayPointV2InitSettingsInternal |
Waypoint V2 Mission Initialization Settings Internal User have no need to use it. More... | |
struct | WaypointV2Internal |
class | WaypointV2MissionOperator |
Typedefs | |
typedef struct DJI::OSDK::RequestBatteryDynamicInfoCmd | RequestBatteryDynamicInfoCmd |
typedef struct DJI::OSDK::DJIWholeBatteryState | DJIWholeBatteryState |
typedef struct DJI::OSDK::BatteryWholeInfo | BatteryWholeInfo |
typedef enum DJI::OSDK::DJISmartBatterySelfCheck | DJISmartBatterySelfCheck |
typedef enum DJI::OSDK::DJIBatteryClosedReasonImpl | DJIBatteryClosedReasonImpl |
typedef enum DJI::OSDK::DJISmartBatteryHeatState | DJISmartBatteryHeatState |
typedef enum DJI::OSDK::DJISmartBatterySocWarning | DJISmartBatterySocWarning |
typedef struct DJI::OSDK::DJISmartBatteryState | DJISmartBatteryState |
typedef struct DJI::OSDK::SmartBatteryDynamicInfo | SmartBatteryDynamicInfo |
typedef struct DJI::OSDK::DJIWholeBatteryStateImpl | DJIWholeBatteryStateImpl |
typedef struct DJI::OSDK::BatteryWholeInfoImpl | BatteryWholeInfoImpl |
typedef enum DJI::OSDK::DJIBatteryFirmwareAbnormalImpl | DJIBatteryFirmwareAbnormalImpl |
typedef struct DJI::OSDK::DJISmartBatteryStateImpl | DJISmartBatteryStateImpl |
typedef struct DJI::OSDK::SmartBatteryDynamicInfoImpl | SmartBatteryDynamicInfoImpl |
typedef struct DJI::OSDK::ErrList | ErrList |
typedef struct DJI::OSDK::HMSPushData | HMSPushData |
typedef struct DJI::OSDK::HMSPushPacket | HMSPushPacket |
typedef struct DJI::OSDK::HMSErrCodeInfo | HMSErrCodeInfo |
typedef enum DJI::OSDK::MissionType | MissionType |
typedef struct DJI::OSDK::HotPointSettings | HotPointSettings |
HotPoint Mission Initialization settings. More... | |
typedef struct DJI::OSDK::WayPointInitSettings | WayPointInitSettings |
Waypoint Mission Initialization settings. More... | |
typedef struct DJI::OSDK::WayPointSettings | WayPointSettings |
Waypoint settings for individual waypoints being added to the mission. More... | |
typedef enum DJI::OSDK::WaypointActionTypeFormat | WaypointActionTypeFormat |
typedef enum DJI::OSDK::WayPointIncidentType | WayPointIncidentType |
WayPoint Reached Data Incident Type enumerator. More... | |
typedef enum DJI::OSDK::WayPointPushDataIncidentType | WayPointPushDataIncidentType |
WayPoint Push Data Incident Type enumerator. | |
typedef struct DJI::OSDK::WayPointFinishData | WayPointFinishData |
Waypoint Mission Finish Event Push Data. | |
typedef enum DJI::OSDK::DJIWaypointV2FlightPathMode | DJIWaypointV2FlightPathMode |
typedef enum DJI::OSDK::DJIWaypointV2HeadingMode | DJIWaypointV2HeadingMode |
typedef enum DJI::OSDK::DJIWaypointV2TurnMode | DJIWaypointV2TurnMode |
typedef uint8_t | RetCodeType |
typedef uint32_t | WaypointV2CommonAck |
typedef float32_t | GlobalCruiseSpeed |
typedef struct DJI::OSDK::UploadMissionRawAck | UploadMissionRawAck |
typedef struct DJI::OSDK::UploadActionsRawAck | UploadActionsRawAck |
typedef struct DJI::OSDK::DownloadMissionRsp | DownloadMissionRsp |
typedef struct DJI::OSDK::DownloadMissionAck | DownloadMissionAck |
typedef struct DJI::OSDK::GetGlobalCruiseVelAck | GetGlobalCruiseVelAck |
typedef struct DJI::OSDK::GetRemainRamAck | getRemainRamAck |
typedef struct DJI::OSDK::GetWaypontStartEndIndexAck | GetWaypontStartEndIndexAck |
typedef struct DJI::OSDK::MissionStateCommanData | MissionStateCommanData |
typedef struct DJI::OSDK::MissionStatePushAck | MissionStatePushAck |
typedef union DJI::OSDK::Eventdata | Eventdata |
typedef struct DJI::OSDK::MissionEventPushAck | MissionEventPushAck |
typedef struct DJI::OSDK::WayPointV2InitSettingsInternal | WayPointV2InitSettingsInternal |
Waypoint V2 Mission Initialization Settings Internal User have no need to use it. | |
typedef struct DJI::OSDK::DownloadInitSettingRawAck | DownloadInitSettingRawAck |
typedef struct DJI::OSDK::RelativePosition | RelativePosition |
typedef struct DJI::OSDK::WaypointV2Config | WaypointV2Config |
typedef struct DJI::OSDK::WaypointV2Internal | WaypointV2Internal |
typedef struct DJI::OSDK::WaypointV2 | WaypointV2 |
typedef struct DJI::OSDK::WayPointV2InitSettings | WayPointV2InitSettings |
Waypoint V2 Mission Initialization settings. More... | |
typedef struct DJI::OSDK::FCGroundStationDataPush | FCGroundStationDataPush |
typedef void * | UserData |
This is used as the datatype for all data arguments in callbacks. | |
typedef uint64_t | time_ms |
typedef uint64_t | time_us |
typedef float | float32_t |
typedef double | float64_t |
typedef struct DJI::OSDK::OpenHeader | OpenHeader |
The Header struct is meant to handle the open protocol header. | |
typedef struct DJI::OSDK::Command | Command |
typedef struct DJI::OSDK::MMU_Tab | MMU_Tab |
typedef struct DJI::OSDK::CMDSession | CMDSession |
typedef struct DJI::OSDK::ACKSession | ACKSession |
typedef struct DJI::OSDK::DataBuryPack | DataBuryPack |
typedef struct DJI::OSDK::HeartBeatPack | HeartBeatPack |
typedef struct DJI::OSDK::VirtualRCSetting | VirtualRCSetting |
Virtual RC Settings (supported only on Matrice 100) | |
typedef struct DJI::OSDK::VirtualRCData | VirtualRCData |
Virtual RC data (supported only on Matrice 100) | |
typedef struct DJI::OSDK::DispatchInfo | DispatchInfo |
Dispatch info. More... | |
typedef struct DJI::OSDK::RecvContainer | RecvContainer |
Received info. More... | |
typedef void(* | VehicleCallBack) (Vehicle *vehicle, RecvContainer recvFrame, UserData userData) |
Function prototype for all callback functions used in the OSDK. More... | |
typedef struct DJI::OSDK::VehicleCallBackHandler | VehicleCallBackHandler |
The CallBackHandler struct allows users to encapsulate callbacks and data in one struct. More... | |
typedef struct DJI::OSDK::CommonCallBackHandler | CommonCallBackHandler |
The CallBackHandler struct allows users to encapsulate callbacks and data in one struct. This is a more common method. More... | |
typedef struct DJI::OSDK::CMD_SETSupportMatrix | CMD_SETSupportMatrix |
Define CMD_SET support matrix. | |
typedef E_OsdkStat(* | PushCallback) (struct _CommandHandle *cmdHandle, const T_CmdInfo *cmdInfo, const uint8_t *cmdData, void *userData) |
callback type to get the pushing data from waypoint 2.0 More... | |
typedef struct DJI::OSDK::CGPoint | CGPoint |
typedef struct DJI::OSDK::DJIGimbalRotation | DJIGimbalRotation |
typedef struct DJI::OSDK::DJIWaypointV2SampleReachPointTriggerParam | DJIWaypointV2SampleReachPointTriggerParam |
typedef struct DJI::OSDK::DJIWaypointV2AssociateTriggerParam | DJIWaypointV2AssociateTriggerParam |
typedef struct DJI::OSDK::DJIWaypointV2TrajectoryTriggerParam | DJIWaypointV2TrajectoryTriggerParam |
typedef struct DJI::OSDK::DJIWaypointV2IntervalTriggerParam | DJIWaypointV2IntervalTriggerParam |
typedef struct DJI::OSDK::DJIWaypointV2CameraFocusParam | DJIWaypointV2CameraFocusParam |
typedef struct DJI::OSDK::DJIWaypointV2CameraFocalLengthParam | DJIWaypointV2CameraFocalLengthParam |
typedef struct DJI::OSDK::DJIWaypointV2AircraftControlRotateHeadingParam | DJIWaypointV2AircraftControlRotateHeadingParam |
typedef struct DJI::OSDK::DJIWaypointV2AircraftControlFlyingParam | DJIWaypointV2AircraftControlFlyingParam |
typedef struct DJI::OSDK::DJIWaypointV2Trigger | DJIWaypointV2Trigger |
typedef struct DJI::OSDK::DJIWaypointV2CameraActuatorParam | DJIWaypointV2CameraActuatorParam |
typedef struct DJI::OSDK::DJIWaypointV2GimbalActuatorParam | DJIWaypointV2GimbalActuatorParam |
typedef struct DJI::OSDK::DJIWaypointV2AircraftControlParam | DJIWaypointV2AircraftControlParam |
typedef struct DJI::OSDK::DJIWaypointV2Actuator | DJIWaypointV2Actuator |
typedef struct DJI::OSDK::DJIWaypointV2Action | DJIWaypointV2Action |
typedef struct DJI::OSDK::DataConfig | DataConfig |
typedef struct DJI::OSDK::ImgConfig | ImgConfig |
typedef struct DJI::OSDK::VGAConfig | VGAConfig |
typedef struct DJI::OSDK::AdvancedSensingConfig | AdvancedSensingConfig |
Functions | |
bool | replaceStr (string &str, const string oldReplaceStr, const string newReplaceStr) |
void | encodeSender (const uint8_t sender, uint8_t &deviceType, uint8_t &deviceIndex) |
Variables | |
const std::pair< const uint32_t, const char * > | commonData [] |
const std::pair< const uint32_t, const char * > | activateData [] |
const std::pair< const uint32_t, const char * > | subscribeData [] |
const std::pair< const uint32_t, const char * > | setControlData [] |
const std::pair< const uint32_t, const char * > | setArmData [] |
const std::pair< const uint32_t, const char * > | taskData [] |
const std::pair< const uint32_t, const char * > | LegacyTaskData [] |
const std::pair< const uint32_t, const char * > | missionData [] |
const std::pair< const uint32_t, const char * > | mfioData [] |
HMSErrCodeInfo | hmsErrCodeInfoTbl [dbHMSErrNum] |
const uint8_t | MaxSmartBatteryNum = 2 |
const uint32_t | dbHMSErrNum = 700 |
const float32_t | EARTH_RADIUS = 6378137.0 |
char | buffer [] |
const size_t | SESSION_TABLE_NUM = 32 |
const size_t | CALLBACK_LIST_NUM = 10 |
const size_t | MAX_INCOMING_DATA_SIZE = 300 |
const size_t | MAX_ACK_SIZE = 107 |
static const uint8_t | CAMERA_PAIR_NUM = 5 |
static const uint8_t | IMAGE_TYPE_NUM = 10 |
const uint8_t | MAX_OSDK_VERSION_SIZE = 16 |
const uint8_t | MAX_SEND_DATA_BURY_PKG_COUNT = 5 |
const Version::FirmWare | mandatoryVersionBase = (Version::FW(3, 1, 10, 0)) |
Define FW version that supports "mandatory" CMD_SET. More... | |
const Version::FirmWare | extendedVersionBase = (Version::FW(3, 2, 36, 6)) |
Define FW version that supports "extended" CMD_SET. More... | |
const Version::FirmWare | versionBase33 = (Version::FW(3,3,0,0)) |
Define FW version constant for 3.3.x firmware branch. More... | |
Detailed Description
Onboard SDK related commands
Typedef Documentation
◆ BatteryWholeInfo
typedef struct DJI::OSDK::BatteryWholeInfo DJI::OSDK::BatteryWholeInfo |
The whole battery information push,include: 1.some raw battery data; 2.calculated data; 3.battery state
◆ BatteryWholeInfoImpl
typedef struct DJI::OSDK::BatteryWholeInfoImpl DJI::OSDK::BatteryWholeInfoImpl |
The whole battery information push,include: 1.some raw battery data; 2.calculated data; 3.battery state
◆ CGPoint
typedef struct DJI::OSDK::CGPoint DJI::OSDK::CGPoint |
Focus point parameter
◆ CommonCallBackHandler
typedef struct DJI::OSDK::CommonCallBackHandler DJI::OSDK::CommonCallBackHandler |
The CallBackHandler struct allows users to encapsulate callbacks and data in one struct. This is a more common method.
◆ DispatchInfo
typedef struct DJI::OSDK::DispatchInfo DJI::OSDK::DispatchInfo |
Dispatch info.
This struct has booleans that get populated in the protocol layer and help the dispatcher in the Vehicle layer decide what to do with the received packet.
◆ DJIBatteryClosedReasonImpl
Smart battery closed reason
◆ DJIBatteryFirmwareAbnormalImpl
Abnormal battery firmware status
◆ DJIGimbalRotation
typedef struct DJI::OSDK::DJIGimbalRotation DJI::OSDK::DJIGimbalRotation |
Gimbal rotation parameter
◆ DJISmartBatteryHeatState
Smart battery heating status
◆ DJISmartBatterySelfCheck
Smart battery self-checkout error flag
◆ DJISmartBatterySocWarning
Smart battery abnormal warning
◆ DJIWaypointV2Action
typedef struct DJI::OSDK::DJIWaypointV2Action DJI::OSDK::DJIWaypointV2Action |
This class represents an action for DJIWaypointV2Mission
. It determines how action is performed when a waypoint mission is executed.
◆ DJIWaypointV2Actuator
typedef struct DJI::OSDK::DJIWaypointV2Actuator DJI::OSDK::DJIWaypointV2Actuator |
This class defines an actuator for DJIWaypointV2Action
. It determines how the action is performed when a waypoint mission is executed.
◆ DJIWaypointV2AircraftControlFlyingParam
typedef struct DJI::OSDK::DJIWaypointV2AircraftControlFlyingParam DJI::OSDK::DJIWaypointV2AircraftControlFlyingParam |
This class defines if the aircraft starts or stops the flight.
◆ DJIWaypointV2AircraftControlParam
typedef struct DJI::OSDK::DJIWaypointV2AircraftControlParam DJI::OSDK::DJIWaypointV2AircraftControlParam |
This class defines the parameters for DJIWaypointV2Action_DJIWaypointV2Actuator
. It determines how the aircraft control actuator will be performed when a waypoint mission is executed.
◆ DJIWaypointV2AircraftControlRotateHeadingParam
typedef struct DJI::OSDK::DJIWaypointV2AircraftControlRotateHeadingParam DJI::OSDK::DJIWaypointV2AircraftControlRotateHeadingParam |
This class defines how the aircraft rotates on the yaw axis.
◆ DJIWaypointV2AssociateTriggerParam
typedef struct DJI::OSDK::DJIWaypointV2AssociateTriggerParam DJI::OSDK::DJIWaypointV2AssociateTriggerParam |
This class defines DJIWaypointV2MissionV2_DJIWaypointV2ActionTriggerType_ActionAssociated
.
◆ DJIWaypointV2CameraActuatorParam
typedef struct DJI::OSDK::DJIWaypointV2CameraActuatorParam DJI::OSDK::DJIWaypointV2CameraActuatorParam |
This class defines the parameters for DJIWaypointV2Action_DJIWaypointV2Actuator
. This determines how the camera will be performed when a waypoint mission is executing.
◆ DJIWaypointV2CameraFocalLengthParam
typedef struct DJI::OSDK::DJIWaypointV2CameraFocalLengthParam DJI::OSDK::DJIWaypointV2CameraFocalLengthParam |
This class defines a camera focal length operation for DJIWaypointV2Action_DJIWaypointV2CameraActuatorParam
.
◆ DJIWaypointV2CameraFocusParam
This class defines a camera focus operation for DJIWaypointV2Action_DJIWaypointV2CameraActuatorParam
.
◆ DJIWaypointV2FlightPathMode
Waypoint flight path mode.
◆ DJIWaypointV2GimbalActuatorParam
typedef struct DJI::OSDK::DJIWaypointV2GimbalActuatorParam DJI::OSDK::DJIWaypointV2GimbalActuatorParam |
This class defines the parameters for DJIWaypointV2Action_DJIWaypointV2Actuator
. It determines how the gimbal actuator will be performed when a waypoint mission is executed.
◆ DJIWaypointV2HeadingMode
Represents current aircraft's heading mode on current waypoint.
◆ DJIWaypointV2IntervalTriggerParam
typedef struct DJI::OSDK::DJIWaypointV2IntervalTriggerParam DJI::OSDK::DJIWaypointV2IntervalTriggerParam |
This class defines DJIWaypointV2MissionV2_DJIWaypointV2ActionTriggerType_Trajectory
.
◆ DJIWaypointV2TrajectoryTriggerParam
typedef struct DJI::OSDK::DJIWaypointV2TrajectoryTriggerParam DJI::OSDK::DJIWaypointV2TrajectoryTriggerParam |
This class represents a trajectory trigger action when should be trigger.
◆ DJIWaypointV2TurnMode
The direction when the aircraft changes its heading to adapt to the heading at the waypoint.
◆ DJIWholeBatteryState
typedef struct DJI::OSDK::DJIWholeBatteryState DJI::OSDK::DJIWholeBatteryState |
The whole battery state
◆ DJIWholeBatteryStateImpl
The whole battery state
◆ DownloadMissionAck
typedef struct DJI::OSDK::DownloadMissionAck DJI::OSDK::DownloadMissionAck |
Download mission raw ack data
◆ DownloadMissionRsp
typedef struct DJI::OSDK::DownloadMissionRsp DJI::OSDK::DownloadMissionRsp |
Download mission raw request data
◆ ErrList
typedef struct DJI::OSDK::ErrList DJI::OSDK::ErrList |
the type of error code list in HMS's raw pushing data
◆ Eventdata
typedef union DJI::OSDK::Eventdata DJI::OSDK::Eventdata |
Mission's event data
◆ GetGlobalCruiseVelAck
typedef struct DJI::OSDK::GetGlobalCruiseVelAck DJI::OSDK::GetGlobalCruiseVelAck |
Get the mission global cruise speed raw ack data
◆ getRemainRamAck
typedef struct DJI::OSDK::GetRemainRamAck DJI::OSDK::getRemainRamAck |
Get the remain memory ack data
◆ GetWaypontStartEndIndexAck
Get the mission's start and stop index ack data
◆ GlobalCruiseSpeed
typedef float32_t DJI::OSDK::GlobalCruiseSpeed |
Global cruise speed of mission unit: m/s range:[0,WayPointV2InitSettings::maxFlightSpeed]
◆ HMSErrCodeInfo
typedef struct DJI::OSDK::HMSErrCodeInfo DJI::OSDK::HMSErrCodeInfo |
the type of HMS's error code information
◆ HMSPushData
typedef struct DJI::OSDK::HMSPushData DJI::OSDK::HMSPushData |
the type of HMS's raw pushing data
◆ HMSPushPacket
typedef struct DJI::OSDK::HMSPushPacket DJI::OSDK::HMSPushPacket |
the type of HMS's pushing data with a time stamp
◆ HotPointSettings
typedef struct DJI::OSDK::HotPointSettings DJI::OSDK::HotPointSettings |
HotPoint Mission Initialization settings.
This is one of the few structs in the OSDK codebase that is used in both a sending and a receiving API.
◆ MissionEventPushAck
typedef struct DJI::OSDK::MissionEventPushAck DJI::OSDK::MissionEventPushAck |
Mission's event push ack data
◆ MissionStateCommanData
Mission's state data
◆ MissionStatePushAck
typedef struct DJI::OSDK::MissionStatePushAck DJI::OSDK::MissionStatePushAck |
Mission's state push ack data
◆ PushCallback
typedef E_OsdkStat(* DJI::OSDK::PushCallback) (struct _CommandHandle *cmdHandle, const T_CmdInfo *cmdInfo, const uint8_t *cmdData, void *userData) |
callback type to get the pushing data from waypoint 2.0
- Supported Platforms : M300
◆ RecvContainer
typedef struct DJI::OSDK::RecvContainer DJI::OSDK::RecvContainer |
Received info.
This struct contains the ack or data struct return from the vehicle with sending info
◆ RelativePosition
typedef struct DJI::OSDK::RelativePosition DJI::OSDK::RelativePosition |
waypoint position relative to WayPointV2InitSettings's reference point unit: m
◆ UploadActionsRawAck
typedef struct DJI::OSDK::UploadActionsRawAck DJI::OSDK::UploadActionsRawAck |
Upload actions raw ack data
◆ UploadMissionRawAck
typedef struct DJI::OSDK::UploadMissionRawAck DJI::OSDK::UploadMissionRawAck |
Upload mission raw ack data
◆ VehicleCallBack
typedef void(* DJI::OSDK::VehicleCallBack) (Vehicle *vehicle, RecvContainer recvFrame, UserData userData) |
Function prototype for all callback functions used in the OSDK.
If you want to register a function as a callback funtion, make sure it matches this prototype.
◆ VehicleCallBackHandler
The CallBackHandler struct allows users to encapsulate callbacks and data in one struct.
◆ WayPointIncidentType
WayPoint Reached Data Incident Type enumerator.
- Note
- can be separated by the first bytes of data
◆ WayPointInitSettings
typedef struct DJI::OSDK::WayPointInitSettings DJI::OSDK::WayPointInitSettings |
Waypoint Mission Initialization settings.
This is one of the few structs in the OSDK codebase that is used in both a sending and a receiving API.
◆ WayPointSettings
typedef struct DJI::OSDK::WayPointSettings DJI::OSDK::WayPointSettings |
Waypoint settings for individual waypoints being added to the mission.
This is one of the few structs in the OSDK codebase that is used in both a sending and a receiving API.
◆ WaypointV2
typedef struct DJI::OSDK::WaypointV2 DJI::OSDK::WaypointV2 |
The struct represents a target point in the waypoint mission. For a waypoint mission, a flight route consists of multiple WaypointV2
objects.
◆ WaypointV2Config
typedef struct DJI::OSDK::WaypointV2Config DJI::OSDK::WaypointV2Config |
Represents current waypoint's speed config.
◆ WayPointV2InitSettings
Waypoint V2 Mission Initialization settings.
This is one of the few structs in the OSDK codebase that is used in both a sending and a receiving API.
◆ WaypointV2Internal
typedef struct DJI::OSDK::WaypointV2Internal DJI::OSDK::WaypointV2Internal |
The struct represents a target point in the waypoint mission. For a waypoint mission, a flight route consists of multiple WaypointV2
objects.
Enumeration Type Documentation
◆ DJI_CAMERA_ISO_PARAMETER
◆ DJIBatteryClosedReasonImpl
Smart battery closed reason
◆ DJIBatteryFirmwareAbnormalImpl
Abnormal battery firmware status
◆ DJISmartBatteryHeatState
Smart battery heating status
◆ DJISmartBatterySelfCheck
Smart battery self-checkout error flag
◆ DJISmartBatterySocWarning
Smart battery abnormal warning
◆ DJISmartBatterySohState
Smart battery cycle count status
◆ DJIWaypointV2ActionActuatorAircraftControlOperationType
Possible types of aircraft control actuator operation.
◆ DJIWaypointV2ActionActuatorCameraOperationType
enum DJI::OSDK::DJIWaypointV2ActionActuatorCameraOperationType : uint16_t |
Possible types of camera actuator operation.
◆ DJIWaypointV2ActionActuatorGimbalOperationType
enum DJI::OSDK::DJIWaypointV2ActionActuatorGimbalOperationType : uint16_t |
The type of gimbal actuator operation.
◆ DJIWaypointV2ActionActuatorType
enum DJI::OSDK::DJIWaypointV2ActionActuatorType : uint8_t |
Possible types of action actuator.
◆ DJIWaypointV2ActionExecutionEvent
enum DJI::OSDK::DJIWaypointV2ActionExecutionEvent : uint8_t |
◆ DJIWaypointV2ActionIntervalType
enum DJI::OSDK::DJIWaypointV2ActionIntervalType : uint8_t |
The type of DJIWaypointV2Action_DJIWaypointV2IntervalTriggerParam
, Determines the interval type of how action repeats.
◆ DJIWaypointV2ActionTriggerType
enum DJI::OSDK::DJIWaypointV2ActionTriggerType : uint8_t |
Possible types of action trigger.
◆ DJIWaypointV2FlightPathMode
enum DJI::OSDK::DJIWaypointV2FlightPathMode : uint8_t |
Waypoint flight path mode.
◆ DJIWaypointV2HeadingMode
enum DJI::OSDK::DJIWaypointV2HeadingMode : uint8_t |
Represents current aircraft's heading mode on current waypoint.
◆ DJIWaypointV2MissionExecutionState
enum DJI::OSDK::DJIWaypointV2MissionExecutionState : uint8_t |
Current waypoint mission executing state.
◆ DJIWaypointV2MissionFinishedAction
enum DJI::OSDK::DJIWaypointV2MissionFinishedAction : uint8_t |
Actions will be taken when the waypoint mission is finished.
◆ DJIWaypointV2MissionGotoFirstWaypointMode
enum DJI::OSDK::DJIWaypointV2MissionGotoFirstWaypointMode : uint8_t |
Possible flight mode to executes the mission.
◆ DJIWaypointV2MissionState
All the possible state of WaypointV2MissionOperator
.
Enumerator | |
---|---|
DJIWaypointV2MissionStateUnWaypointActionActuatorknown | The state of the operator is unknown. It is the initial state when the operator is just created. |
DJIWaypointV2MissionStateDisconnected | The connection OSDK device, remote controller and aircraft is broken. |
DJIWaypointV2MissionStateReadyToExecute | Raed to execute the mission. |
DJIWaypointV2MissionStateExecuting | The execution is started successfully. |
DJIWaypointV2MissionStateInterrupted | Waypoint mission is paused successfully. |
DJIWaypointV2MissionStateResumeAfterInterrupted | Waypoint mission is restarted after interrupted. |
DJIWaypointV2MissionStateExitMission | Waypoint mission is exited. |
DJIWaypointV2MissionStateFinishedMission | Waypoint mission is finished. |
◆ DJIWaypointV2MissionV2RCLostAction
enum DJI::OSDK::DJIWaypointV2MissionV2RCLostAction : uint8_t |
The action of waypoint mission that will be executed when the remote controller signal lost.
◆ DJIWaypointV2TriggerAssociatedTimingType
enum DJI::OSDK::DJIWaypointV2TriggerAssociatedTimingType : uint8_t |
The type of DJIWaypointV2Action_DJIWaypointV2AssociateTriggerParam
, Determines the time to execute the trigger associated with another one.
◆ DJIWaypointV2TurnMode
enum DJI::OSDK::DJIWaypointV2TurnMode : uint8_t |
The direction when the aircraft changes its heading to adapt to the heading at the waypoint.
◆ WaypointActionTypeFormat
◆ WayPointIncidentType
WayPoint Reached Data Incident Type enumerator.
- Note
- can be separated by the first bytes of data
Variable Documentation
◆ activateData
const std::pair<const uint32_t, const char*> DJI::OSDK::activateData[] |
◆ CAMERA_PAIR_NUM
|
static |
- Note
- some constants for stereo camera
◆ dbHMSErrNum
const uint32_t DJI::OSDK::dbHMSErrNum = 700 |
the length of HMS's error code table
◆ extendedVersionBase
const Version::FirmWare DJI::OSDK::extendedVersionBase = (Version::FW(3, 2, 36, 6)) |
Define FW version that supports "extended" CMD_SET.
Limited products support predefined CMD_SET list
Supported products: M210, A3, N3
◆ hmsErrCodeInfoTbl
HMSErrCodeInfo DJI::OSDK::hmsErrCodeInfoTbl |
HMS's error code table
◆ LegacyTaskData
const std::pair<const uint32_t, const char*> DJI::OSDK::LegacyTaskData[] |
◆ mandatoryVersionBase
const Version::FirmWare DJI::OSDK::mandatoryVersionBase = (Version::FW(3, 1, 10, 0)) |
Define FW version that supports "mandatory" CMD_SET.
All supported products implement predefined CMD_SET list
Supported products: M100, M210, M600, A3, N3
◆ MAX_INCOMING_DATA_SIZE
const size_t DJI::OSDK::MAX_INCOMING_DATA_SIZE = 300 |
- Note
- size is in Bytes
◆ mfioData
const std::pair<const uint32_t, const char*> DJI::OSDK::mfioData[] |
◆ setArmData
const std::pair<const uint32_t, const char*> DJI::OSDK::setArmData[] |
◆ setControlData
const std::pair<const uint32_t, const char*> DJI::OSDK::setControlData[] |
◆ versionBase33
const Version::FirmWare DJI::OSDK::versionBase33 = (Version::FW(3,3,0,0)) |
Define FW version constant for 3.3.x firmware branch.
Only the A3 and the N3 support the 3.3.x firmware branch.
- Note
- Not to be confused with the OSDK version 3.3.x; firmware versions follow a different numbering and cadence.