blackbox-log

CI codecov dependency status crates.io docs.rs MSRV license

This is a Rust port of Betaflight's & INAV's blackbox tools. Check the GitHub organization for related projects. Or, read the [docs] to get started.

Note: blackbox-log is not quite ready for production use yet -- consider it early-mid beta quality.

Why?

There are two official parser implementations, each with a copy maintained by Betaflight and one by INAV, so why another?

Neither is all that great for building other software with: - blackbox_decode (BF, INAV) has missed some of the changes in the format in the last few years, so its output is no longer entirely correct. Additionally, it decodes and writes everything to disk, so you pay for data your application may not need. - The log viewer's parser (BF, INAV) isn't meant to be used by anything else and is tightly coupled with its GUI. It's written in JavaScript, which limits the places it can reasonably be embedded.

This project aims to fill that niche. An ergonomic, up-to-date API usable anywhere that supports Rust or WebAssembly.

Contributing

At the moment, blackbox-log is still in heavy development and probably isn't quite ready for code contributions. However, bug reports are welcomed. If at all possible, please include a log file exhibiting the bug. If you've got any other questions or ideas, feel free to start a discussion.

References/Prior Art

License

In accordance with the GNU FAQ's guidance that ports are derivative works, all code is licensed under the GPLv3 to match the Betaflight and INAV projects.