dvcdbg 0.2.0

Lightweight logging and diagnostics toolkit for embedded (no_std, I2C scan, quick tests)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

<div align="center">
  <h1>dvcdbg</h1>
</div>

> šŸ› ļø 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 (`impl_fmt_write_for_serial!`, `quick_diag!`, etc.)

---

## šŸ“¦ Quickstart

```sh
cargo add dvcdbg --features "macros"
```

---

## šŸ“„ Usage Example (Arduino)

- [Detailed settings](docs/USAGE.md)

```rust
use arduino_hal::default_serial;
use dvcdbg::prelude::*;

fn main() {
    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);

    #[cfg(feature = "macros")]
    {
        // Initialization I2C instance and timer
        let i2c = arduino_hal::I2c::new(
            dp.TWI,
            pins.a4.into_pull_up_input(),
            pins.a5.into_pull_up_input(),
            100_000,
        );
        let timer = arduino_hal::hal::timer::Timer1::new(dp.TC1, arduino_hal::hal::clock::Clock::new());

        // Quick diagnostic: scans I2C bus and measures cycles for test code
        quick_diag!(logger, i2c, timer, {
            your_test_code();
        });
    }
}

fn your_test_code() {
    // 
}

```
---

## Architecture

![](docs/assets/architecture20250815.png)

---

## šŸ“š Macros Included

* `impl_fmt_write_for_serial!` ā†’ implement `core::fmt::Write` for any serial type
* `write_hex!` ā†’ print byte slices in hexadecimal format
* `measure_cycles!` ā†’ measure execution cycles or timestamps
* `loop_with_delay!` ā†’ loop with fixed delay for testing
* `assert_log!` ā†’ log assertions without panicking
* `scan_i2c!` ā†’ scan IĀ²C bus for connected devices
* `quick_diag!` ā†’ all-in-one diagnostic workflow

---

## šŸ“š Documentation

* [API Documentation (docs.rs)](https://docs.rs/dvcdbg)

---

## šŸš€ 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`.

```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](docs/CONTRIBUTING.md) for guidelines.

---

## šŸ“„ License

[MIT](docs/LICENSE-MIT) OR [Apache-2.0](docs/LICENSE-APACHE)