11 unstable releases

0.6.1 Dec 2, 2024
0.6.0 Nov 21, 2024
0.5.0 Jan 4, 2024
0.4.0 Mar 3, 2023
0.2.0 May 7, 2020

#25 in Embedded development

Download history 4196/week @ 2024-08-19 3972/week @ 2024-08-26 4539/week @ 2024-09-02 3724/week @ 2024-09-09 3866/week @ 2024-09-16 4650/week @ 2024-09-23 3640/week @ 2024-09-30 3404/week @ 2024-10-07 4185/week @ 2024-10-14 4425/week @ 2024-10-21 3999/week @ 2024-10-28 3605/week @ 2024-11-04 2670/week @ 2024-11-11 3460/week @ 2024-11-18 3181/week @ 2024-11-25 5225/week @ 2024-12-02

14,682 downloads per month
Used in 81 crates (63 directly)

MIT license

51KB
775 lines

rtt-target

crates.io documentation

Target side implementation of the RTT (Real-Time Transfer) I/O protocol. RTT implements input and output via a debug probe using in-memory ring buffers and polling. This enables debug logging from the microcontroller with minimal delays and no blocking, making it usable even in real-time applications where e.g. semihosting delays cannot be tolerated.

Documentation

Platform support

A platform-specific critical-section implementation is needed to use this library.

Output directly to a channel object with write! or the binary write method does not require locking and therefore does not need any platform-specific critical section.

Usage

With a platform-specific critical section in use, printing is as simple as:

use rtt_target::{rtt_init_print, rprintln};

fn main() {
    rtt_init_print!();
    loop {
        rprintln!("Hello, world!");
    }
}

rtt-target also supports initializing multiple RTT channels, and even has a logger implementations for log and defmt that can be used in conjunction with arbitrary channel setups.

The defmt integration requires setting features = ["defmt"]. Furthermore, you have to either invoke rtt_init_defmt! or set up your channel(s) manually and invoke set_defmt_channel before using defmt.

The log integration requires setting features = ["log"]. Furthermore, you have to either invoke rtt_init_log! or set up your channel(s) manually and invoke init_logger/init_logger_with_level before using log.

Note: For your platform, particularly if you're using a multi-core MCU, external logger implementations might be better suited than the one provided by this crate via the log/defmt feature.

For more information, please check out the documentation.

Development

The examples-cortex-m and panic-test crates come with build files for the venerable STM32F103C8xx by default, but can be easily adapted for any chip as they contain only minimal platform-specific runtime code to get fn main to run.

Dependencies

~1.5MB
~23K SLoC