defmt (#68)

Author: ivmarkov

.github/workflows/ci.yml

@@ -36,11 +36,15 @@ jobs:
         run: cargo fmt -- --check
       - name: Build | Clippy
         run: cargo clippy --features std,embedded-svc,edge-nal-embassy --examples --no-deps -- -Dwarnings
+      - name: Build | Clippy - defmt
+        run: cargo clippy --features std,embedded-svc,edge-nal-embassy,defmt --no-deps -- -Dwarnings
+      - name: Build | Clippy - log
+        run: cargo clippy --features std,embedded-svc,edge-nal-embassy,log --examples --no-deps -- -Dwarnings
       - name: Build | Default
-        run: cargo build
+        run: cargo build --features log
       - name: Build | Non-default
         run: cargo build --no-default-features
       - name: Build | Embassy
-        run: cargo build --no-default-features --features embassy
+        run: cargo build --no-default-features --features embassy,defmt
       - name: Build | Examples
-        run: cargo build --examples
+        run: cargo build --examples --features log

Cargo.toml

@@ -17,6 +17,8 @@ async-io-mini = ["std", "edge-nal-std/async-io-mini"]
 std = ["io", "edge-captive/std", "edge-dhcp/std", "edge-http/std", "edge-mdns/std", "edge-raw/std", "edge-mqtt", "edge-ws/std", "edge-nal-std"]
 embassy = ["io", "edge-nal-embassy"]
 io = ["edge-captive/io", "edge-dhcp/io", "edge-http/io", "edge-mdns/io", "edge-raw/io", "edge-ws/io", "edge-nal"]
+log = ["edge-captive/log", "edge-dhcp/log", "edge-http/log", "edge-mdns/log", "edge-raw/log", "edge-ws/log", "edge-nal-embassy?/log"]
+defmt = ["edge-captive/defmt", "edge-dhcp/defmt", "edge-http/defmt", "edge-mdns/defmt", "edge-raw/defmt", "edge-ws/defmt", "edge-nal-embassy?/defmt"]
 embedded-svc = ["edge-http/embedded-svc", "edge-mqtt/embedded-svc", "edge-ws/embedded-svc"]
 nightly = []
 
@@ -48,47 +50,47 @@ async-compat = "0.2" # For the `mqtt_client` example
 
 [[example]]
 name = "captive_portal"
-required-features = ["std"]
+required-features = ["std", "log"]
 
 [[example]]
 name = "dhcp_client"
-required-features = ["std"]
+required-features = ["std", "log"]
 
 [[example]]
 name = "dhcp_server"
-required-features = ["std"]
+required-features = ["std", "log"]
 
 [[example]]
 name = "http_client"
-required-features = ["std"]
+required-features = ["std", "log"]
 
 [[example]]
 name = "http_server"
-required-features = ["std"]
+required-features = ["std", "log"]
 
 [[example]]
 name = "mdns_responder"
-required-features = ["std"]
+required-features = ["std", "log"]
 
 [[example]]
 name = "mdns_service_responder"
-required-features = ["std"]
+required-features = ["std", "log"]
 
 [[example]]
 name = "ws_client"
-required-features = ["std"]
+required-features = ["std", "log"]
 
 [[example]]
 name = "ws_server"
-required-features = ["std"]
+required-features = ["std", "log"]
 
 [[example]]
 name = "nal_std"
-required-features = ["std"]
+required-features = ["std", "log"]
 
 [[example]]
 name = "mqtt_client"
-required-features = ["std", "embedded-svc"]
+required-features = ["std", "embedded-svc", "log"]
 
 [workspace]
 members = [
@@ -111,7 +113,6 @@ embassy-sync = { version = "0.6", default-features = false }
 embassy-time = { version = "0.4", default-features = false }
 embedded-io-async = { version = "0.6", default-features = false }
 embedded-svc = { version = "0.28", default-features = false }
-log = { version = "0.4", default-features = false }
 heapless = { version = "0.8", default-features = false }
 domain = { version = "0.10", default-features = false, features = ["heapless"] }
 

edge-captive/CHANGELOG.md

@@ -6,6 +6,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+* Optional `defmt` support via two new features (one has to specify one, or the other, or neither, but not both):
+  * `log` - uses the `log` crate for all logging
+  * `defmt` - uses the `defmt` crate for all logging, and implements `defmt::Format` for all library types that otherwise implement `Debug` and/or `Display`
 
 ## [0.5.0] - 2025-01-15
 * Updated dependencies for compatibility with `embassy-time-driver` v0.2

edge-captive/Cargo.toml

@@ -20,6 +20,7 @@ std = ["io"]
 io = ["edge-nal"]
 
 [dependencies]
-log = { workspace = true }
+log = { version = "0.4", default-features = false, optional = true }
+defmt = { version = "0.3", optional = true }
 domain = { workspace = true }
 edge-nal = { workspace = true, optional = true }