Erase i2c peripheral instances (#2361)

* Clean up * Erase I2C instance type * Clean up * Implement Peripheral * Changelog * Remove with_timeout constructors
esp-rs · Oct 23, 2024 · e367c83 · e367c83
1 parent 1afc9ee
commit e367c83
Show file tree

Hide file tree

Showing 5 changed files with 295 additions and 315 deletions.
diff --git a/esp-hal/CHANGELOG.md b/esp-hal/CHANGELOG.md
@@ -16,11 +16,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added `AnySpi` and `AnySpiDmaChannel`. (#2334)
 - Added `AnyI2s` and `AnyI2sDmaChannel`. (#2367)
 - `Pins::steal()` to unsafely obtain GPIO. (#2335)
+- `I2c::with_timeout` (#2361)
 
 ### Changed
 
 - Peripheral type erasure for SPI (#2334)
 - Peripheral type erasure for I2S (#2367)
+- Peripheral type erasure for I2C (#2361)
 
 ### Fixed
 
@@ -31,6 +33,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - The `i2s::{I2sWrite, I2sWriteDma, I2sRead, I2sReadDma, I2sWriteDmaAsync, I2sReadDmaAsync}` traits have been removed. (#2316)
 - The `ledc::ChannelHW` trait is no longer generic. (#2387)
+- The `I2c::new_with_timeout` constructors have been removed (#2361)
 
 ## [0.21.1]
 

diff --git a/esp-hal/MIGRATING-0.21.md b/esp-hal/MIGRATING-0.21.md
@@ -30,6 +30,7 @@ peripherals:
 
 - SPI (both master and slave)
 - I2S
+- I2C
 
 ```diff
 -Spi<'static, SPI2, FullDuplexMode>
@@ -49,3 +50,12 @@ the peripheral instance has been moved to the last generic parameter position.
 ```rust
 let spi: Spi<'static, FullDuplexMode, SPI2> = Spi::new_typed(peripherals.SPI2, 1.MHz(), SpiMode::Mode0);
 ```
+
+## I2C constructor changes
+
+The `with_timeout` constructors have been removed in favour of `set_timeout` or `with_timeout`.
+
+```diff
+-let i2c = I2c::new_with_timeout(peripherals.I2C0, io.pins.gpio4, io.pins.gpio5, 100.kHz(), timeout);
++let i2c = I2c::new(peripherals.I2C0, io.pins.gpio4, io.pins.gpio5, 100.kHz()).with_timeout(timeout);
+```