# `blackbox-log`
[](https://github.com/blackbox-log/blackbox-log/actions/workflows/ci.yaml)
[](https://codecov.io/gh/blackbox-log/blackbox-log)
[](https://deps.rs/repo/github/blackbox-log/blackbox-log)
[](https://crates.io/blackbox-log)
[](https://docs.rs/blackbox-log)
[](https://github.com/rust-lang/rust/blob/master/RELEASES.md)
This is a Rust port of Betaflight's & INAV's blackbox tools. Check the [GitHub
organization][org] 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][bf-tools], [INAV][inav-tools]) 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][bf-viewer], [INAV][inav-viewer]) 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
All contributions are welcome. Testing and [bug reports] are greatly
appreciated. 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].
If you're looking to contribute code or log files, see the
[help wanted](https://github.com/blackbox-log/blackbox-log/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
and
[needs logs](https://github.com/blackbox-log/blackbox-log/issues?q=is%3Aopen+is%3Aissue+label%3A%22needs+logs)
tags.
Most development tasks are run using [`just`](https://github.com/casey/just).
Run `just` in the project root to get a list of available tasks. If modifying
the yaml files in `types/`, make sure to commit the result of `just codegen`.
There are 2 devcontainers set up with all necessary development tools. `Default`
will build the container from scratch, while `Default (prebuilt)` will download
a prebuilt container and will likely be faster to start.
[](https://devpod.sh/open#https://github.com/blackbox-log/blackbox-log)
[](https://codespaces.new/blackbox-log/blackbox-log?devcontainer_path=.devcontainer%2Fdefault-prebuilt%2Fdevcontainer.json)
> **Note**: At least 4 cores and 4GiB of RAM is recommended.
## References/Prior Art
- `blackbox_decode` ([Betaflight][bf-tools], [INAV][inav-tools])
- Blackbox log viewer ([Betaflight][bf-viewer], [INAV][inav-viewer])
- [Betaflight][betaflight] and [INAV][inav] source code; mainly in `src/main/blackbox/`
- The Blackbox Internals development documentation ([Betaflight](https://betaflight.com/docs/development/Blackbox-Internals), [INAV](https://github.com/iNavFlight/inav/blob/master/docs/development/Blackbox%20Internals.md))
- [`fc-blackbox`](https://lib.rs/crates/fc-blackbox) written by [Ilya Epifanov](https://github.com/ilya-epifanov)
Many thanks to [Nicholas Sherlock](https://github.com/thenickdude) for his
[original logging implementation](https://github.com/thenickdude/blackbox) and
to [the Cleanflight project](https://github.com/cleanflight) (which Betaflight &
INAV are forked from) for integrating it
(https://github.com/cleanflight/cleanflight/pull/227).
## License
Licensed under either of
- Apache License, Version 2.0 ([LICENSE-APACHE] or <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT license ([LICENSE-MIT] or <http://opensource.org/licenses/MIT>)
at your option.
[org]: https://github.com/blackbox-log/
[docs]: https://docs.rs/blackbox-log
[bf-tools]: https://github.com/betaflight/blackbox-tools
[bf-viewer]: https://github.com/betaflight/blackbox-log-viewer
[inav-tools]: https://github.com/iNavFlight/blackbox-tools
[inav-viewer]: https://github.com/iNavFlight/blackbox-log-viewer
[betaflight]: https://github.com/betaflight/betaflight
[inav]: https://github.com/iNavFlight/inav
[bug reports]: https://github.com/blackbox-log/blackbox-log/issues
[discussion]: https://github.com/blackbox-log/blackbox-log/discussions
[LICENSE-APACHE]: https://github.com/blackbox-log/blackbox-log/blob/main/LICENSE-APACHE
[LICENSE-MIT]: https://github.com/blackbox-log/blackbox-log/blob/main/LICENSE-MIT