dvcdbg 0.2.1

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

<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 (`adapt_serial!`, `quick_diag!`, etc.)

---

## šŸ“¦ Quickstart

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

---

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

---

## 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

* [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)