Skip to content

Efficient, deferred formatting for logging on embedded systems

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

knurling-rs/defmt

Folders and files

NameName
Last commit message
Last commit date
Feb 11, 2021
Jan 24, 2025
Oct 27, 2021
Mar 5, 2025
Jan 20, 2025
Jan 10, 2025
Mar 5, 2025
Feb 17, 2025
Jan 20, 2025
Feb 25, 2025
Nov 26, 2024
Nov 26, 2024
Jul 28, 2020
Mar 5, 2025
Mar 25, 2024
Aug 21, 2020
Nov 27, 2024
Feb 3, 2025
Nov 20, 2024
Jan 8, 2025
Jun 10, 2024

defmt

defmt ("de format", short for "deferred formatting") is a highly efficient logging framework that targets resource-constrained devices, like microcontrollers.

For more details about the framework check the book at https://defmt.ferrous-systems.com.

Components

This repository contains the following packages:

Name Path Description
defmt ./defmt On-target code for highly efficient logging
defmt-macros ./macros Proc Macros for defmt
defmt-print ./print CLI utility for decoding and printing defmt encoded logs to standard out
defmt-decoder ./decoder Host Library for decoding defmt log frames
defmt-parser ./parser Host Library for parsing defmt log frames
defmt-rtt ./firmware/defmt-rtt On-target library for sending defmt logs over RTT
defmt-itm ./firmware/defmt-itm On-target library for sending defmt logs over ITM
defmt-semihosting ./firmware/defmt-semihosting On-target library for sending defmt logs over semihosting
panic-probe ./firmware/panic-probe On-target library for sending panic! over defmt
defmt-test ./firmware/defmt-test Framework for running tests on-target
defmt-test-macros ./firmware/defmt-test/macros Proc Macros for defmt-test
defmt-json-schema ./decoder/defmt-json-schema Describes the JSON emitted by defmt-decoder

MSRV

The minimum supported Rust version is 1.76 (or Ferrocene 24.05). defmt is tested against the latest stable Rust version and the MSRV.

Developer Information

Running Tests

Tests are run using cargo xtask -- although this is simply an alias (defined in .cargo/config.toml) for cargo run --package xtask --.

To see a list of options, see xtask/src/main.rs, or run:

cargo xtask help

For example, to run all the tests, run:

cargo xtask test-all

You will need qemu-system-arm installed and in your $PATH for some of the tests (e.g. test-snapshot).

Support

defmt is part of the Knurling project, Ferrous Systems' effort at improving tooling used to develop for embedded systems.

If you think that our work is useful, consider sponsoring it via GitHub Sponsors.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions.