skybrush 0.1.1

Parsing and playback of Skybrush drone show files
Documentation
  • Coverage
  • 100%
    517 out of 517 items documented15 out of 302 items with examples
  • Size
  • Source code size: 390.6 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 10.6 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 6s Average build duration of successful builds.
  • all releases: 6s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Homepage
  • Repository
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • ntamas

libskybrush-rs

Parsing and playback of Skybrush drone show files in Rust.

This is a rewrite of the C library libskybrush, with feature parity to version 6.0.4 of the C library where possible. The API is idiomatic Rust and does not follow the conventions of the C library.

The crate is no_std and requires a global allocator only, so it can be used in firmware, e.g., in loadable ArduPilot modules. Playback does not allocate, and malformed show files are reported as errors, never as panics.

Usage

[dependencies]
skybrush = "0.1"
use skybrush::control::ShowController;
use skybrush::formats::binary::BinaryFile;
use skybrush::screenplay::Screenplay;

let file = BinaryFile::new(&bytes)?;
let screenplay = Screenplay::from_binary_file(&file)?;
let mut controller = ShowController::new(screenplay);

// What the drone should do 2.5 s into the show
controller.update_time_msec(2500);
let position = controller.current_output().position();

See the documentation for the components of a show and their players.

The minimum supported Rust version is 1.98.1.

Testing

The behaviour of the crate is checked against test data generated by the C library, vendored in tests/oracle (see scripts/vendor-oracle.sh). cargo test runs these tests; fuzz/ has the fuzz targets.

License

Copyright 2026 CollMot Robotics Ltd.

libskybrush-rs is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

libskybrush-rs is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.