8 breaking releases

0.10.0 Jun 7, 2024
0.8.0 Feb 9, 2024
0.7.0 Oct 11, 2023
0.6.0 Sep 13, 2022
0.4.0 Jul 15, 2022

#457 in Hardware support

Download history 39/week @ 2024-07-29 1/week @ 2024-08-26 47/week @ 2024-09-02 60/week @ 2024-09-09 30/week @ 2024-09-16 70/week @ 2024-09-23 33/week @ 2024-09-30 4/week @ 2024-10-07 77/week @ 2024-10-14 8/week @ 2024-10-28

91 downloads per month

MIT license

150KB
78 lines

Crates.io Documentation tests

defmt-serial

A defmt target for logging over a serial port. Have a look at examples to see how to use library example-artemis or example-pi-pico. You can also try it out in a hosted environment: example-std. To parse the logs have a look at parsing logs.

static SERIAL: StaticCell<hal::uart::Uart0> = StaticCell::new();

#[entry]
fn main() -> ! {
    let mut dp = hal::pac::Peripherals::take().unwrap();
    let pins = hal::gpio::Pins::new(dp.GPIO);

    // set up serial
    let serial = hal::uart::Uart0::new(dp.UART0, pins.tx0, pins.rx0);
    defmt_serial::defmt_serial(SERIAL.init(serial));

    defmt::info!("Hello from defmt!");

    loop {
        asm::wfi();
    }
}

Remember to set the DEFMT_LOG variable when testing, e.g.:

$ cd example-std/
$ DEFMT_LOG=debug cargo run

Parsing logs

The easiest way to parse the logs is to use socat and defmt-print together. For example:

$ socat ${PORT},rawer,b${BAUDRATE} STDOUT | defmt-print -e ${ELF}

Just replace ${PORT}, ${BAUDRATE} and ${ELF} with correct values.

To install the tools on Ubuntu 22.04 run these commands:

$ apt install socat
$ cargo install defmt-print

Note that on Mac OS it seems that socat is broken for this purpose. Use stty and cat in stead:

$ (stty speed 115200 >/dev/null && cat) </dev/cu.usbserial-10 | defmt-print -e $(ELF)

Dependencies

~0.5–1MB
~23K SLoC