Update changelog

esp-rs · Sep 2, 2024 · f96e336 · f96e336
1 parent 1a5f654
commit f96e336
Show file tree

Hide file tree

Showing 6 changed files with 80 additions and 2 deletions.
diff --git a/esp-hal-embassy/CHANGELOG.md b/esp-hal-embassy/CHANGELOG.md
@@ -15,6 +15,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+- Removed the `clocks` parameter from `esp_hal_embassy::init`. (#1999)
+
 ## 0.3.0 - 2024-08-29
 
 ### Added

diff --git a/esp-hal-embassy/MIGRATING-0.3.md b/esp-hal-embassy/MIGRATING-0.3.md
@@ -0,0 +1,30 @@
+Migration Guide from 0.3.x to vNext
+====================================
+
+Initialsation
+-------------
+
+You no longer have to set up clocks and pass them to `esp_hal_embassy::init`.
+
+```diff
+ use esp_hal::{
+-    clock::ClockControl,
+-    peripherals::Peripherals,
+     prelude::*,
+-    system::SystemControl,
+ };
+
+ #[esp_hal_embassy::main]
+ async fn main(_spawner: Spawner) -> ! {
+-    let peripherals = Peripherals::take();
+-    let system = SystemControl::new(peripherals.SYSTEM);
+-    let clocks = ClockControl::boot_defaults(system.clock_control).freeze();
++    let peripherals = esp_hal::init(esp_hal::Config::default());
+
+     let timg0 = TimerGroup::new(peripherals.TIMG0);
+-    esp_hal_embassy::init(&clocks, timg0);
++    esp_hal_embassy::init(timg0);
+
+     // ...
+ }
+```
diff --git a/esp-hal-smartled/CHANGELOG.md b/esp-hal-smartled/CHANGELOG.md
@@ -15,6 +15,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+- Removed the `clocks` parameter from `SmartLedsAdapter::new` (#1999)
+
 ## 0.13.0 - 2024-08-29
 
 ## 0.12.0 - 2024-07-15

diff --git a/esp-hal/CHANGELOG.md b/esp-hal/CHANGELOG.md
@@ -9,14 +9,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Added `esp_hal::init` to simplify HAL initialisation (#1970)
+- Added `esp_hal::init` to simplify HAL initialisation (#1970, #1999)
 
 ### Changed
 
 ### Fixed
 
 ### Removed
 
+- `Peripherals::take` (#1999)
+
 ## [0.20.1] - 2024-08-30
 
 ### Fixed
@@ -73,7 +75,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Removed `FlashSafeDma` (#1856)
 - Remove redundant WithDmaSpi traits (#1975)
 - `IsFullDuplex` and `IsHalfDuplex` traits (#1985)
-- `Peripherals::take` (#1999)
 
 ## [0.19.0] - 2024-07-15
 

diff --git a/esp-wifi/CHANGELOG.md b/esp-wifi/CHANGELOG.md
@@ -15,6 +15,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+- Removed the `clocks` parameter from `esp_wifi::initialize` (#1999)
+
 ## 0.8.0 - 2024-08-29
 
 ### Added

diff --git a/esp-wifi/MIGRATING-0.8.md b/esp-wifi/MIGRATING-0.8.md
@@ -0,0 +1,41 @@
+Migration Guide from 0.3.x to vNext
+====================================
+
+Initialsation
+-------------
+
+You no longer have to set up clocks and pass them to `esp_wifi::initialize`.
+
+```diff
+ use esp_hal::{
+-    clock::ClockControl,
+-    peripherals::Peripherals,
+     prelude::*,
+-    system::SystemControl,
+ };
+ use esp_wifi::{
+     initialize,
+     // ...
+ };
+
+ #[entry]
+ fn main() -> ! {
+-    let peripherals = Peripherals::take();
+-    let system = SystemControl::new(peripherals.SYSTEM);
+-    let clocks = ClockControl::boot_defaults(system.clock_control).freeze();
++    let peripherals = esp_hal::init(esp_hal::Config::default());
+
+     let timg0 = TimerGroup::new(peripherals.TIMG0);
+
+     let init = initialize(
+         EspWifiInitFor::Wifi,
+         timg0.timer0,
+         Rng::new(peripherals.RNG),
+         peripherals.RADIO_CLK,
+-        &clocks,
+     )
+     .unwrap();
+
+     // ...
+ }
+```