SDK Introduction
The Foxglove SDK allows you to quickly and easily:
- Stream and visualize your robot data live in Foxglove
- Log your data to MCAP files
The SDK is available for C++, Python, and Rust under the MIT license.
This documentation provides an overview of the SDK to help you get started. For more detailed information, see the additional resources for each language below.
Installation
- Rust
- Python
- C++
Install foxglove from crates.io: https://crates.io/crates/foxglove
cargo add foxglove
Install foxglove-sdk from PyPI: https://pypi.org/project/foxglove-sdk
pip install foxglove-sdk
The C++ SDK is a wrapper around a C library. To build it, you will need to link that library and compile the SDK source as part of your build process. The SDK assumes C++17 or newer.
Download the library, source, and header files for your platform from the SDK release assets.
Quickstart
Logging to an MCAP file and visualizing in Foxglove
In this guide, you'll use the Rust, Python, or C++ SDK to log a scene update with an animated cube to an MCAP file and visualize it live in the Foxglove app. Click here to get started.
Reference
Reference API documentation, additional examples, and other resources for each SDK language.
- Rust
- Python
- C++