dvcdbg

dvcdbg is an efficient logging and debugging library tailored for embedded Rust development, fully compatible with no_std environments. Designed to cater to the unique requirements of embedded applications, this library facilitates log output through various interfaces, including UART and I2C.

Features

• No_std Support: Seamlessly integrates into environments where the standard library is unavailable.
• Lightweight and Fast: Optimized for speed and minimal footprint, ensuring quick performance without unnecessary overhead.
• Debug Utilities: Includes essential tools for embedded debugging, such as a comprehensive I2C scanner.
• User-Friendly: Simplifies logging with intuitive macros and straightforward usage patterns.
• Feature Flags: Customize functionalities based on project requirements, enabling features such as debug_log as needed.

Quick Start Example

Integrating dvcdbg into a Rust project is simple. Update the Cargo.toml with the following dependency:

# Cargo.toml
[dependencies]
dvcdbg = { git = "https://github.com/p14c31355/dvcdbg", features = ["debug_log"] }

Usage Example (Arduino)

Here’s a quick example of how to implement logging in an Arduino environment:

use arduino_hal::default_serial;
use dvcdbg::logger::SerialLogger;

let dp = arduino_hal::Peripherals::take().unwrap();
let pins = arduino_hal::pins!(dp);
let mut serial = default_serial!(dp, pins, 57600);

let mut logger = SerialLogger::new(&mut serial);
logger.log("Init I2C bus...");

// Use `log!` macro (requires debug_log feature)
log!(logger, "Formatted number: {}", 42);

Documentation

Comprehensive API documentation is available for further insights and examples:

• API Documentation on docs.rs (Available after publishing)
• API Documentation on GitHub Pages

Supported Environments

• Rust no_std: Fully compatible with embedded development without the standard library.
• AVR (Arduino Uno): Tailored for Arduino hardware.

Contributions

Contributions are encouraged! For those interested in contributing, please review the contribution guidelines for reporting bugs, suggesting features, or submitting pull requests.