dvcdbg 0.1.1

I2C scanner and logger for embedded, no_std use.
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

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

> 🛠️ Lightweight i2c scan & logger crate for embedded Rust (no_std friendly)

`dvcdbg` is a lightweight logging and debugging output library for embedded Rust development.  
It can be used in a `no_std` environment and supports log output via I2C

---

## ✨ Features

- ✅ `no_std` support
- ✅ Formatless, fast and lightweight
- ✅ It also includes utilities for embedded debugging, such as an I2C scanner.
- ✅ Easy to use with simple logging and macros
- ✅ Comes with handy built-in utilities such as an I2C bus scanner
- ✅ Features can be selected with feature flags (e.g., `debug_log`)

## 📈 Firmware Size History
![Firmware Size](.github/size-history.svg)

---

## 📦 Quickstart

```toml
# Cargo.toml
[dependencies]
dvcdbg = { version = "0.1.1", features = ["debug_log"] }
```

## 📄 Usage example (Arduino)

```rust
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

* [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 side)
[profile.release]
lto = true
strip = true
```

---

## 🛠️ Supported environments

* Rust `no_std`
* AVR ( Arduino Uno )

## 🤝 Contributions welcome!

Bug reports, feature suggestions, and pull requests are welcome! Please see our [contribution guidelines](CONTRIBUTING.md).

## 📄 Licenses

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