Add a defmt feature to esp-hal-smartled (esp-rs#846)

* Add a `defmt` feature to `esp-hal-smartled` * Update `CHANGELOG.md`
MabezDev · Oct 20, 2023 · 684cc71 · 684cc71
1 parent 9747a8c
commit 684cc71
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -29,6 +29,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Support for ULP-RISCV including Delay and GPIO (#840, #845)
 - Add bare-bones SPI slave support, DMA only (#580, #843)
 - Embassy `#[main]` convenience macro (#841)
+- Add a `defmt` feature to the `esp-hal-smartled` package (#846)
 
 ### Changed
 

diff --git a/esp-hal-smartled/Cargo.toml b/esp-hal-smartled/Cargo.toml
@@ -11,6 +11,7 @@ license      = "MIT OR Apache-2.0"
 features = ["esp32c3"]
 
 [dependencies]
+defmt            = { version = "0.3.5",  optional = true }
 esp-hal-common   = { version = "0.12.0", path = "../esp-hal-common" }
 fugit            = "0.3.7"
 smart-leds-trait = "0.2.1"
@@ -25,3 +26,5 @@ esp32s3 = ["esp-hal-common/esp32s3"]
 
 xtal-26mhz = ["esp-hal-common/xtal-26mhz"]
 xtal-40mhz = ["esp-hal-common/xtal-40mhz"]
+
+defmt = ["dep:defmt", "esp-hal-common/defmt"]
diff --git a/esp-hal-smartled/src/lib.rs b/esp-hal-smartled/src/lib.rs
@@ -62,6 +62,7 @@ const SK68XX_T1L_CYCLES: u16 = ((SK68XX_T1L_NS * (SOURCE_CLK_FREQ / 1_000_000))
 /// All types of errors that can happen during the conversion and transmission
 /// of LED commands
 #[derive(Debug)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum LedAdapterError {
     /// Raised in the event that the provided data container is not large enough
     BufferSizeExceeded,