Classes

The following classes are available globally.

  • Undocumented

    See more

    Declaration

    Swift

    public class Drone
  • Enable simple actions such as arming, taking off, and landing.

    See more

    Declaration

    Swift

    public class Action
  • Provide vehicle actions (as a server) such as arming, taking off, and landing.

    See more

    Declaration

    Swift

    public class ActionServer
  • Enable to calibrate sensors of a drone such as gyro, accelerometer, and magnetometer.

    See more

    Declaration

    Swift

    public class Calibration
  • Can be used to manage cameras that implement the MAVLink Camera Protocol: https://mavlink.io/en/protocol/camera.html.

    Currently only a single camera is supported. When multiple cameras are supported the plugin will need to be instantiated separately for every camera and the camera selected using select_camera.

    See more

    Declaration

    Swift

    public class Camera
  • Access component information such as parameters.

    See more

    Declaration

    Swift

    public class ComponentInformation
  • Provide component information such as parameters.

    See more

    Declaration

    Swift

    public class ComponentInformationServer
  • Access to the connection state and core configurations

    See more

    Declaration

    Swift

    public class Core
  • Inject failures into system to test failsafes.

    See more

    Declaration

    Swift

    public class Failure
  • Allow users to command the vehicle to follow a specific target. The target is provided as a GPS coordinate and altitude.

    See more

    Declaration

    Swift

    public class FollowMe
  • Ftp

    Implements file transfer functionality using MAVLink FTP.

    See more

    Declaration

    Swift

    public class Ftp
  • Enable setting a geofence.

    See more

    Declaration

    Swift

    public class Geofence
  • Provide control over a gimbal.

    See more

    Declaration

    Swift

    public class Gimbal
  • Provide information about the hardware and/or software of a system.

    See more

    Declaration

    Swift

    public class Info
  • Allow to download log files from the vehicle after a flight is complete. For log streaming during flight check the logging plugin.

    See more

    Declaration

    Swift

    public class LogFiles
  • Enable manual control using e.g. a joystick or gamepad.

    See more

    Declaration

    Swift

    public class ManualControl
  • Enable waypoint missions.

    See more

    Declaration

    Swift

    public class Mission
  • Enable raw missions as exposed by MAVLink.

    See more

    Declaration

    Swift

    public class MissionRaw
  • Acts as a vehicle and receives incoming missions from GCS (in raw MAVLINK format). Provides current mission item state, so the server can progress through missions.

    See more

    Declaration

    Swift

    public class MissionRawServer
  • * Allows interfacing a vehicle with a motion capture system in order to allow navigation without global positioning sources available (e.g. indoors, or when flying under a bridge. etc.).

    See more

    Declaration

    Swift

    public class Mocap
  • * Control a drone with position, velocity, attitude or motor commands.

    The module is called offboard because the commands can be sent from external sources as opposed to onboard control right inside the autopilot “board”.

    Client code must specify a setpoint before starting offboard mode. Mavsdk automatically sends setpoints at 20Hz (PX4 Offboard mode requires that setpoints are minimally sent at 2Hz).

    See more

    Declaration

    Swift

    public class Offboard
  • Provide raw access to get and set parameters.

    See more

    Declaration

    Swift

    public class Param
  • Rtk

    Service to send RTK corrections to the vehicle.

    See more

    Declaration

    Swift

    public class Rtk
  • Utility for onboard MAVSDK instances for common “server” tasks.

    See more

    Declaration

    Swift

    public class ServerUtility
  • * Allow to communicate with the vehicle’s system shell.

    See more

    Declaration

    Swift

    public class Shell
  • Allow users to get vehicle telemetry and state information (e.g. battery, GPS, RC connection, flight mode etc.) and set telemetry update rates.

    See more

    Declaration

    Swift

    public class Telemetry
  • Allow users to provide vehicle telemetry and state information (e.g. battery, GPS, RC connection, flight mode etc.) and set telemetry update rates.

    See more

    Declaration

    Swift

    public class TelemetryServer
  • Allow users to get ADS-B information and set ADS-B update rates.

    See more

    Declaration

    Swift

    public class Transponder
  • Enable creating and sending a tune to be played on the system.

    See more

    Declaration

    Swift

    public class Tune