dvcdbg 0.2.1

Lightweight logging and diagnostics toolkit for embedded (no_std, I2C scan, quick tests)
Documentation

šŸ› ļø Lightweight logging & debugging crate for embedded Rust (no_std friendly)

dvcdbg is a lightweight, no_std-friendly logging and debugging library for embedded Rust. It is designed to simplify the initial setup and bring-up of new hardware by providing a convenient set of diagnostic tools.

āœØ Key Features

  • āœ… Works in no_std environments
  • āœ… Lightweight and fast, formatless logging support
  • āœ… Includes useful embedded utilities:
    • I2C bus scanner (scan_i2c!)
    • Hex dump (write_hex!)
    • Execution cycle measurement (measure_cycles!)
  • āœ… Quick diagnostic workflow with quick_diag!
  • āœ… Serial logger abstraction for various HALs
  • āœ… Feature flags allow selective compilation:
    • logger ā†’ logging utilities
    • scanner ā†’ I2C scanning utilities
    • macros ā†’ helper macros (adapt_serial!, quick_diag!, etc.)

šŸ“¦ Quickstart

cargo add dvcdbg --no-default-features --features "logger,macros,ehal_0_2"

Detailed settings

Provided Macros

  • Logging & Formatting

    • write_hex!(dst, &buf)
      Write a byte slice in hexadecimal (12 AB FF ).
    • write_bin!(dst, &buf)
      Write a byte slice in binary (10101010 11110000 ).
    • assert_log!(cond, logger, "msg")
      Log an assertion failure without panicking.

  • Diagnostics

    • scan_i2c!(i2c, logger)
      Scan IĀ²C bus and log found devices.
    • quick_diag!(logger, i2c, timer [, { expr }])
      Run a quick diagnostic workflow: serial check, IĀ²C scan, optional cycle measurement.

  • Timing & Control

    • measure_cycles!(expr, timer)
      Measure execution cycles (or timestamps) for an expression.
    • loop_with_delay!(delay, ms, { body })
      Run a loop with a fixed delay between iterations.

  • Adapters

    • adapt_serial!(AdapterName)
      Wrap a custom serial-like type to implement:
      • [core::fmt::Write]
      • [embedded_io::Write]
      • [nb::serial::Write<u8>]

šŸ“š Documentation

šŸš€ Binary Size Optimisation

Since dvcdbg is designed for a no_std environment, it is important to minimise the final binary size.

Enabling LTO (link-time optimisation) and strip during release builds will remove unused code from dvcdbg and other dependent crates, significantly reducing the binary size.

Add the following settings to your application's Cargo.toml.

# Cargo.toml (application)
[profile.release]
lto = true
strip = true

šŸ› ļø Supported Environments

  • Rust no_std
  • AVR (Arduino Uno)
  • ESP-IDF / other HALs supported via serial abstraction

šŸ¤ Contributing

Bug reports, feature suggestions, and pull requests are welcome! See CONTRIBUTING.md for guidelines.

šŸ“„ License

MIT OR Apache-2.0