myaats / mavsdk Goto Github PK

MAVSDK is a set of libraries providing a high-level API to MAVLink. It aims to be:

• Easy to use with a simple API supporting both synchronous (blocking) API calls and asynchronous API calls using callbacks.
• Fast and lightweight.
• Cross-platform (Linux, macOS, Windows, iOS, Android).
• Extensible (using compile-time plugins).
• Fully compliant with the MAVLink common standard/definitions.

In order to support multiple programming languages, MAVSDK implements a gRPC server in C++ which allows clients in different programming languages to connect to. The API is defined by the proto IDL (proto files). This architecture allows the clients to be implemented in idiomatic patterns, so using the tooling and syntax expected by end users. For example, the Python library can be installed from PyPi using pip.

The MAVSDK C++ part consists of:

• The core library implementing the basic MAVLink communication.
• The plugin libraries implementing the MAVLink communication specific to a feature.
• The mavsdk_server implementing the gRPC server for the language clients.

• MAVSDK - this repo containing the source code for the C++ core.
• MAVSDK-Proto - Common interface definitions for API specified as proto files used by gRPC between language clients and mavsdk_server.
• MAVSDK-Python - MAVSDK client for Python (first released on Pypi 2019).
• MAVSDK-Swift - MAVSDK client for Swift (used in production, first released 2018).
• MAVSDK-Java - MAVSDK client for Java (first released on MavenCentral in 2019).
• MAVSDK-JavaScript - MAVSDK client in JavaScript (proof of concept, 2019).
• MAVSDK-Rust - MAVSDK client for Rust (proof of concept, 2019).
• MAVSDK-CSharp - MAVSDK client for CSharp (proof of concept, 2019).
• Docs - MAVSDK docs source.

Instructions for how to use the C++ library can be found in the MAVSDK docs (links to other programming languages can be found from the documentation sidebar).

Quick Links:

• Getting started
• C++ API Overview
• API Reference
• Installing the Library
• Building the Library
• Examples
• FAQ

This project is licensed under the permissive BSD 3-clause, see LICENSE.md.

This project is maintained by volunteers:

• Julian Oes (sponsoring, consulting).
• Jonas Vautherin

Maintenance is not sponsored by any company, however, hosting of the docs and the forum is provided by the Dronecode Foundation.

If you just have a question, consider asking in the forum.

If you have run into an issue, discovered a bug, or want to request a feature, create an issue. If it is important or urgent to you, consider sponsoring any of the maintainers to move the issue up on their todo list.

If you need private support, consider paid consulting:

• Julian Oes consulting

(Create a pull request if you wish to be listed here.)