mavsdk Namespace Reference

---

Namespace for all mavsdk types.

Data Structures

• mavsdk::Action
• mavsdk::ActionServer
• mavsdk::ArmAuthorizerServer
• mavsdk::Calibration
• mavsdk::Camera
• mavsdk::CameraServer
• mavsdk::ComponentMetadata
• mavsdk::ComponentMetadataServer
• mavsdk::Events
• mavsdk::Failure
• mavsdk::FakeHandle
• mavsdk::FollowMe
• mavsdk::Ftp
• mavsdk::FtpServer
• mavsdk::Geofence
• mavsdk::Gimbal
• mavsdk::Gripper
• mavsdk::Handle
• mavsdk::HandleFactory
• mavsdk::Info
• mavsdk::LogFiles
• mavsdk::LogStreaming
• mavsdk::ManualControl
• mavsdk::MavlinkPassthrough
• mavsdk::Mavsdk
• mavsdk::Mission
• mavsdk::MissionRaw
• mavsdk::MissionRawServer
• mavsdk::Mocap
• mavsdk::Offboard
• mavsdk::overloaded
• mavsdk::Param
• mavsdk::ParamServer
• mavsdk::PluginBase
• mavsdk::Rtk
• mavsdk::ServerComponent
• mavsdk::ServerPluginBase
• mavsdk::ServerUtility
• mavsdk::Shell
• mavsdk::System
• mavsdk::Telemetry
• mavsdk::TelemetryServer
• mavsdk::Transponder
• mavsdk::Tune
• mavsdk::Winch

Enumerations

Type	Description
enum Autopilot	Autopilot type.
enum ComponentType	ComponentType of configurations, used for automatic ID setting.
enum ConnectionResult	Result type returned when adding a connection.
enum ForwardingOption	ForwardingOption for Connection, used to set message forwarding option.

Functions

Type	Name	Description
std::string	base64_encode (std::vector< uint8_t > & raw)	Encode raw bytes to a base64 string.
std::vector< uint8_t >	base64_decode (const std::string & str)	Decode a base64 string into raw bytes.
std::ostream &	operator<< (std::ostream & str, const ConnectionResult & result)	Stream operator to print information about a ConnectionResult.
	overloaded (Ts...)-> overloaded< Ts... >	Template deduction helper for overloaded

Enumeration Type Documentation

enum Autopilot

#include: autopilot.h

Autopilot type.

Value	Description
Unknown
Px4
ArduPilot

enum ComponentType

#include: component_type.h

ComponentType of configurations, used for automatic ID setting.

Value	Description
Autopilot	SDK is used as an autopilot.
GroundStation	SDK is used as a ground station.
CompanionComputer	SDK is used as a companion computer on board the MAV.
Camera
Gimbal	SDK is used as a camera. <
RemoteId	SDK is used as a gimbal. <
Custom	SDK is used as a RemoteId system. <

the SDK is used in a custom configuration, no automatic ID will be provided

enum ConnectionResult

#include: connection_result.h

Result type returned when adding a connection.

Note: Mavsdk does not throw exceptions. Instead a result of this type will be returned.

Value	Description
Success	Connection succeeded.
Timeout	Connection timed out.
SocketError	Socket error.
BindError	Bind error.
SocketConnectionError	Socket connection error.
ConnectionError	Connection error.
NotImplemented	Connection type not implemented.
SystemNotConnected	No system is connected.
SystemBusy	System is busy.
CommandDenied	Command is denied.
DestinationIpUnknown	Connection IP is unknown.
ConnectionsExhausted	Connections exhausted.
ConnectionUrlInvalid	URL invalid.
BaudrateUnknown	Baudrate unknown.

enum ForwardingOption

#include: mavsdk.h

ForwardingOption for Connection, used to set message forwarding option.

Value	Description
ForwardingOff
ForwardingOn

Function Documentation

base64_encode()

#include: base64.h

std::string mavsdk::base64_encode(std::vector< uint8_t > &raw)

Encode raw bytes to a base64 string.

Parameters

• std::vector< uint8_t >& raw - Raw bytes

Returns

 std::string - Base64 string

base64_decode()

#include: base64.h

std::vector< uint8_t > mavsdk::base64_decode(const std::string &str)

Decode a base64 string into raw bytes.

Parameters

• const std::string& str - Base64 string

Returns

 std::vector< uint8_t > - Raw bytes

operator<<()

#include: connection_result.h

std::ostream & mavsdk::operator<<(std::ostream &str, const ConnectionResult &result)

Stream operator to print information about a ConnectionResult.

Parameters

• std::ostream& str -
• const ConnectionResult& result -

Returns

 std::ostream & - A reference to the stream.

overloaded()

#include: plugin_base.h

mavsdk::overloaded(Ts...) -> overloaded< Ts... >

Template deduction helper for overloaded

Parameters

• Ts... -