CHANGELOG + Migration Guide

esp-rs · Feb 6, 2025 · 8d231d2 · 8d231d2
1 parent b92e717
commit 8d231d2
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
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
 
 - `set_power_saving` is now also available when the `coex` feature is activated (#3081)
 
+- Network interfaces and the controller are now more separated (#3027)
+
 ### Fixed
 
 - Fixed a problem using BLE on ESP32-C6 when connected via Serial-JTAG (#2981)

diff --git a/esp-wifi/MIGRATING-0.11.md b/esp-wifi/MIGRATING-0.11.md
@@ -27,3 +27,20 @@ As part of limiting public API changes due to config options, the `csi_enabled`
 -esp-wifi = { version = "0.12.0", features = ["wifi"] }
 +esp-wifi = { version = "0.12.0", features = ["wifi", "csi"] }
 ```
+
+## Changed the way to get the WiFi controller and interfaces
+
+The network interfaces and the controller are now more separated. This way you can change between STA, AP and AP_STA mode easily without reconstructing the networking stacks.
+
+Use `device.interface()` to get the `smoltcp` interface needed by blocking networking stacks.
+
+Please note that networking stacks _might_ need to be reset when connecting to a different network interface (i.e. get a new IP address and routings) - `embassy-net` should manage to do that automatically.
+
+```diff
+-    let (iface, device, mut controller) =
+-        create_network_interface(&init, peripherals.WIFI, WifiStaDevice).unwrap();
++    let (mut controller, interfaces) =
++        esp_wifi::wifi::new(&init, peripherals.WIFI).unwrap();
++    let mut device = interfaces.sta;
++    let iface = device.interface();
+```