Make embedded svc really optional (#429)

* Make embedded-svc really optional * Update README.md * CHANGELOG.md entry
esp-rs · Feb 5, 2024 · e8042d5 · e8042d5
1 parent 31ce512
commit e8042d5
Show file tree

Hide file tree

Showing 28 changed files with 1,128 additions and 144 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 
 ### Changed
+- Users don't need embedded-svc to control wifi anymore. The wifi trait is optionally implemented now. (#429)
 
 ### Removed
 

diff --git a/Cargo.toml b/Cargo.toml
@@ -25,6 +25,7 @@ portable-atomic = { version = "1.5", default-features = false }
 portable_atomic_enum = { version = "0.3.0", features = ["portable-atomic"] }
 log = "0.4.20"
 embedded-svc = { version = "0.27.0", default-features = false, features = [] }
+no-std-net = "0.6.0"
 enumset = { version = "1.1.3", default-features = false }
 linked_list_allocator = { version = "0.10.5", default-features = false, features = [
     "const_mut_refs",
@@ -51,7 +52,7 @@ embassy-net = { version = "0.4.0", features = [
     "dhcpv4",
     "medium-ethernet",
 ] }
-bleps = { git = "https://github.com/bjoernQ/bleps", package = "bleps", rev = "0db8fcb", features = [
+bleps = { git = "https://github.com/bjoernQ/bleps", package = "bleps", rev = "be90de7", features = [
     "macros",
 ] }
 embassy-executor = { version = "0.5.0", package = "embassy-executor", features = [

diff --git a/esp-wifi/Cargo.toml b/esp-wifi/Cargo.toml
@@ -42,6 +42,7 @@ fugit.workspace = true
 heapless = { workspace = true, default-features = false }
 num-derive = { workspace = true }
 num-traits = { workspace = true, default-features = false }
+no-std-net = { workspace = true, optional = true }
 esp-wifi-sys = { version = "0.3.0", path = "../esp-wifi-sys" }
 embassy-sync = { workspace = true, optional = true }
 embassy-futures = { workspace = true, optional = true }
@@ -115,7 +116,8 @@ dump-packets = []
 smoltcp = [ "dep:smoltcp" ]
 utils = [ "smoltcp" ]
 enumset = []
-wifi = [ "dep:enumset", "dep:embedded-svc" ]
+wifi = [ "dep:enumset", "dep:no-std-net" ]
+embedded-svc = [ "dep:embedded-svc" ]
 ble = [ "esp32-hal?/bluetooth" ]
 phy-enable-usb = []
 ps-min-modem = []

diff --git a/esp-wifi/README.md b/esp-wifi/README.md
@@ -90,6 +90,7 @@ Don't use this feature if you are _not_ using USB-SERIAL-JTAG as it might reduce
 | ps-max-modem   | Enable maximum modem sleep. Only affects STA mode                                                    |
 | log            | Route log output to the `log` crate                                                                  |
 | defmt          | Add `defmt::Format` implementation and output logs via `defmt`                                       |
+| embedded-svc   | Implement the embedded-svc Wifi trait                                                                |
 
 Note that not all features are available on every MCU. For example, `ble` (and thus, `coex`) is not available on ESP32-S2.
 

diff --git a/esp-wifi/automated-tests/open_access_point.rs b/esp-wifi/automated-tests/open_access_point.rs
@@ -6,8 +6,7 @@ mod examples_util;
 use examples_util::hal;
 
 use embedded_io::*;
-use embedded_svc::ipv4::Interface;
-use embedded_svc::wifi::{AccessPointConfiguration, Configuration, Wifi};
+use esp_wifi::wifi::{AccessPointConfiguration, Configuration};
 
 use esp_backtrace as _;
 use esp_println::println;
@@ -64,16 +63,18 @@ fn main() -> ! {
     println!("{:?}", controller.get_capabilities());
 
     wifi_stack
-        .set_iface_configuration(&embedded_svc::ipv4::Configuration::Client(
-            embedded_svc::ipv4::ClientConfiguration::Fixed(embedded_svc::ipv4::ClientSettings {
-                ip: embedded_svc::ipv4::Ipv4Addr::from(parse_ip("192.168.2.1")),
-                subnet: embedded_svc::ipv4::Subnet {
-                    gateway: embedded_svc::ipv4::Ipv4Addr::from(parse_ip("192.168.2.1")),
-                    mask: embedded_svc::ipv4::Mask(24),
+        .set_iface_configuration(&esp_wifi::wifi::ipv4::Configuration::Client(
+            esp_wifi::wifi::ipv4::ClientConfiguration::Fixed(
+                esp_wifi::wifi::ipv4::ClientSettings {
+                    ip: esp_wifi::wifi::ipv4::Ipv4Addr::from(parse_ip("192.168.2.1")),
+                    subnet: esp_wifi::wifi::ipv4::Subnet {
+                        gateway: esp_wifi::wifi::ipv4::Ipv4Addr::from(parse_ip("192.168.2.1")),
+                        mask: esp_wifi::wifi::ipv4::Mask(24),
+                    },
+                    dns: None,
+                    secondary_dns: None,
                 },
-                dns: None,
-                secondary_dns: None,
-            }),
+            ),
         ))
         .unwrap();
 

diff --git a/esp-wifi/automated-tests/test_ble.rs b/esp-wifi/automated-tests/test_ble.rs
@@ -85,7 +85,8 @@ fn main() -> ! {
             },],
         },]);
 
-        let mut srv = AttributeServer::new(&mut ble, &mut gatt_attributes);
+        let mut rng = bleps::no_rng::NoRng;
+        let mut srv = AttributeServer::new(&mut ble, &mut gatt_attributes, &mut rng);
 
         loop {
             match srv.do_work_with_notification(None) {

diff --git a/esp-wifi/automated-tests/test_connect.rs b/esp-wifi/automated-tests/test_connect.rs
@@ -6,8 +6,7 @@ mod examples_util;
 use examples_util::hal;
 
 use embedded_io::*;
-use embedded_svc::ipv4::Interface;
-use embedded_svc::wifi::{AccessPointInfo, AuthMethod, ClientConfiguration, Configuration, Wifi};
+use esp_wifi::wifi::{AccessPointInfo, AuthMethod, ClientConfiguration, Configuration};
 
 use esp_backtrace as _;
 use esp_println::println;
@@ -136,16 +135,18 @@ fn main() -> ! {
     println!("Setting static IP {}", STATIC_IP);
 
     wifi_stack
-        .set_iface_configuration(&embedded_svc::ipv4::Configuration::Client(
-            embedded_svc::ipv4::ClientConfiguration::Fixed(embedded_svc::ipv4::ClientSettings {
-                ip: embedded_svc::ipv4::Ipv4Addr::from(parse_ip(STATIC_IP)),
-                subnet: embedded_svc::ipv4::Subnet {
-                    gateway: embedded_svc::ipv4::Ipv4Addr::from(parse_ip(GATEWAY_IP)),
-                    mask: embedded_svc::ipv4::Mask(24),
+        .set_iface_configuration(&esp_wifi::wifi::ipv4::Configuration::Client(
+            esp_wifi::wifi::ipv4::ClientConfiguration::Fixed(
+                esp_wifi::wifi::ipv4::ClientSettings {
+                    ip: esp_wifi::wifi::ipv4::Ipv4Addr::from(parse_ip(STATIC_IP)),
+                    subnet: esp_wifi::wifi::ipv4::Subnet {
+                        gateway: esp_wifi::wifi::ipv4::Ipv4Addr::from(parse_ip(GATEWAY_IP)),
+                        mask: esp_wifi::wifi::ipv4::Mask(24),
+                    },
+                    dns: None,
+                    secondary_dns: None,
                 },
-                dns: None,
-                secondary_dns: None,
-            }),
+            ),
         ))
         .unwrap();
 

diff --git a/esp-wifi/examples/access_point.rs b/esp-wifi/examples/access_point.rs
@@ -6,8 +6,7 @@ mod examples_util;
 use examples_util::hal;
 
 use embedded_io::*;
-use embedded_svc::ipv4::Interface;
-use embedded_svc::wifi::{AccessPointConfiguration, Configuration, Wifi};
+use esp_wifi::wifi::{AccessPointConfiguration, Configuration};
 
 use esp_backtrace as _;
 use esp_println::{print, println};
@@ -64,16 +63,18 @@ fn main() -> ! {
     println!("{:?}", controller.get_capabilities());
 
     wifi_stack
-        .set_iface_configuration(&embedded_svc::ipv4::Configuration::Client(
-            embedded_svc::ipv4::ClientConfiguration::Fixed(embedded_svc::ipv4::ClientSettings {
-                ip: embedded_svc::ipv4::Ipv4Addr::from(parse_ip("192.168.2.1")),
-                subnet: embedded_svc::ipv4::Subnet {
-                    gateway: embedded_svc::ipv4::Ipv4Addr::from(parse_ip("192.168.2.1")),
-                    mask: embedded_svc::ipv4::Mask(24),
+        .set_iface_configuration(&esp_wifi::wifi::ipv4::Configuration::Client(
+            esp_wifi::wifi::ipv4::ClientConfiguration::Fixed(
+                esp_wifi::wifi::ipv4::ClientSettings {
+                    ip: esp_wifi::wifi::ipv4::Ipv4Addr::from(parse_ip("192.168.2.1")),
+                    subnet: esp_wifi::wifi::ipv4::Subnet {
+                        gateway: esp_wifi::wifi::ipv4::Ipv4Addr::from(parse_ip("192.168.2.1")),
+                        mask: esp_wifi::wifi::ipv4::Mask(24),
+                    },
+                    dns: None,
+                    secondary_dns: None,
                 },
-                dns: None,
-                secondary_dns: None,
-            }),
+            ),
         ))
         .unwrap();
 

diff --git a/esp-wifi/examples/access_point_with_sta.rs b/esp-wifi/examples/access_point_with_sta.rs
@@ -6,8 +6,7 @@ mod examples_util;
 use examples_util::hal;
 
 use embedded_io::*;
-use embedded_svc::ipv4::Interface;
-use embedded_svc::wifi::{AccessPointConfiguration, ClientConfiguration, Configuration, Wifi};
+use esp_wifi::wifi::{AccessPointConfiguration, ClientConfiguration, Configuration};
 
 use esp_backtrace as _;
 use esp_println::{print, println};
@@ -93,16 +92,18 @@ fn main() -> ! {
     println!("{:?}", controller.get_capabilities());
 
     wifi_ap_stack
-        .set_iface_configuration(&embedded_svc::ipv4::Configuration::Client(
-            embedded_svc::ipv4::ClientConfiguration::Fixed(embedded_svc::ipv4::ClientSettings {
-                ip: embedded_svc::ipv4::Ipv4Addr::from(parse_ip("192.168.2.1")),
-                subnet: embedded_svc::ipv4::Subnet {
-                    gateway: embedded_svc::ipv4::Ipv4Addr::from(parse_ip("192.168.2.1")),
-                    mask: embedded_svc::ipv4::Mask(24),
+        .set_iface_configuration(&esp_wifi::wifi::ipv4::Configuration::Client(
+            esp_wifi::wifi::ipv4::ClientConfiguration::Fixed(
+                esp_wifi::wifi::ipv4::ClientSettings {
+                    ip: esp_wifi::wifi::ipv4::Ipv4Addr::from(parse_ip("192.168.2.1")),
+                    subnet: esp_wifi::wifi::ipv4::Subnet {
+                        gateway: esp_wifi::wifi::ipv4::Ipv4Addr::from(parse_ip("192.168.2.1")),
+                        mask: esp_wifi::wifi::ipv4::Mask(24),
+                    },
+                    dns: None,
+                    secondary_dns: None,
                 },
-                dns: None,
-                secondary_dns: None,
-            }),
+            ),
         ))
         .unwrap();
 

diff --git a/esp-wifi/examples/bench.rs b/esp-wifi/examples/bench.rs
@@ -6,8 +6,7 @@ mod examples_util;
 use examples_util::hal;
 
 use embedded_io::*;
-use embedded_svc::ipv4::Interface;
-use embedded_svc::wifi::{AccessPointInfo, ClientConfiguration, Configuration, Wifi};
+use esp_wifi::wifi::{AccessPointInfo, ClientConfiguration, Configuration};
 
 use esp_backtrace as _;
 use esp_println::println;

diff --git a/esp-wifi/examples/ble.rs b/esp-wifi/examples/ble.rs
@@ -118,7 +118,8 @@ fn main() -> ! {
             ],
         },]);
 
-        let mut srv = AttributeServer::new(&mut ble, &mut gatt_attributes);
+        let mut rng = bleps::no_rng::NoRng;
+        let mut srv = AttributeServer::new(&mut ble, &mut gatt_attributes, &mut rng);
 
         loop {
             let mut notification = None;

diff --git a/esp-wifi/examples/coex.rs b/esp-wifi/examples/coex.rs
@@ -19,8 +19,7 @@ use esp_wifi::{
 };
 
 use embedded_io::*;
-use embedded_svc::ipv4::Interface;
-use embedded_svc::wifi::{ClientConfiguration, Configuration, Wifi};
+use esp_wifi::wifi::{ClientConfiguration, Configuration};
 
 use esp_backtrace as _;
 use esp_println::{print, println};

diff --git a/esp-wifi/examples/dhcp.rs b/esp-wifi/examples/dhcp.rs
@@ -6,8 +6,7 @@ mod examples_util;
 use examples_util::hal;
 
 use embedded_io::*;
-use embedded_svc::ipv4::Interface;
-use embedded_svc::wifi::{AccessPointInfo, ClientConfiguration, Configuration, Wifi};
+use esp_wifi::wifi::{AccessPointInfo, ClientConfiguration, Configuration};
 
 use esp_backtrace as _;
 use esp_println::{print, println};

diff --git a/esp-wifi/examples/embassy_access_point.rs b/esp-wifi/examples/embassy_access_point.rs
@@ -12,9 +12,9 @@ use examples_util::hal;
 
 use embassy_executor::Spawner;
 use embassy_time::{Duration, Timer};
-use embedded_svc::wifi::{AccessPointConfiguration, Configuration, Wifi};
 use esp_backtrace as _;
 use esp_println::{print, println};
+use esp_wifi::wifi::{AccessPointConfiguration, Configuration};
 use esp_wifi::wifi::{WifiApDevice, WifiController, WifiDevice, WifiEvent, WifiState};
 use esp_wifi::{initialize, EspWifiInitFor};
 use hal::clock::ClockControl;

diff --git a/esp-wifi/examples/embassy_access_point_with_sta.rs b/esp-wifi/examples/embassy_access_point_with_sta.rs
@@ -12,9 +12,9 @@ use examples_util::hal;
 
 use embassy_executor::Spawner;
 use embassy_time::{Duration, Timer};
-use embedded_svc::wifi::{AccessPointConfiguration, ClientConfiguration, Configuration, Wifi};
 use esp_backtrace as _;
 use esp_println::{print, println};
+use esp_wifi::wifi::{AccessPointConfiguration, ClientConfiguration, Configuration};
 use esp_wifi::wifi::{
     WifiApDevice, WifiController, WifiDevice, WifiEvent, WifiStaDevice, WifiState,
 };

diff --git a/esp-wifi/examples/embassy_bench.rs b/esp-wifi/examples/embassy_bench.rs
@@ -11,9 +11,9 @@ mod examples_util;
 use examples_util::hal;
 
 use embassy_time::{with_timeout, Duration, Timer};
-use embedded_svc::wifi::{ClientConfiguration, Configuration, Wifi};
 use esp_backtrace as _;
 use esp_println::println;
+use esp_wifi::wifi::{ClientConfiguration, Configuration};
 use esp_wifi::wifi::{WifiApDevice, WifiController, WifiDevice, WifiEvent, WifiState};
 use esp_wifi::{initialize, EspWifiInitFor};
 use hal::clock::ClockControl;

diff --git a/esp-wifi/examples/embassy_ble.rs b/esp-wifi/examples/embassy_ble.rs
@@ -75,6 +75,7 @@ async fn main(_spawner: Spawner) -> ! {
     println!("Connector created");
 
     let pin_ref = RefCell::new(button);
+    let pin_ref = &pin_ref;
 
     loop {
         println!("{:?}", ble.init().await);
@@ -137,9 +138,12 @@ async fn main(_spawner: Spawner) -> ! {
             ],
         },]);
 
-        let mut srv = AttributeServer::new(&mut ble, &mut gatt_attributes);
+        let mut rng = bleps::no_rng::NoRng;
+        let mut srv = AttributeServer::new(&mut ble, &mut gatt_attributes, &mut rng);
 
         let counter = RefCell::new(0u8);
+        let counter = &counter;
+
         let mut notifier = async || {
             // TODO how to check if notifications are enabled for the characteristic?
             // maybe pass something into the closure which just can query the characterisic value

diff --git a/esp-wifi/examples/embassy_dhcp.rs b/esp-wifi/examples/embassy_dhcp.rs
@@ -10,9 +10,9 @@ mod examples_util;
 use examples_util::hal;
 
 use embassy_time::{Duration, Timer};
-use embedded_svc::wifi::{ClientConfiguration, Configuration, Wifi};
 use esp_backtrace as _;
 use esp_println::println;
+use esp_wifi::wifi::{ClientConfiguration, Configuration};
 use esp_wifi::wifi::{WifiController, WifiDevice, WifiEvent, WifiStaDevice, WifiState};
 use esp_wifi::{initialize, EspWifiInitFor};
 use hal::clock::ClockControl;

diff --git a/esp-wifi/examples/static_ip.rs b/esp-wifi/examples/static_ip.rs
@@ -6,8 +6,7 @@ mod examples_util;
 use examples_util::hal;
 
 use embedded_io::*;
-use embedded_svc::ipv4::Interface;
-use embedded_svc::wifi::{AccessPointInfo, ClientConfiguration, Configuration, Wifi};
+use esp_wifi::wifi::{AccessPointInfo, ClientConfiguration, Configuration};
 
 use esp_backtrace as _;
 use esp_println::{print, println};
@@ -99,16 +98,18 @@ fn main() -> ! {
     println!("Setting static IP {}", STATIC_IP);
 
     wifi_stack
-        .set_iface_configuration(&embedded_svc::ipv4::Configuration::Client(
-            embedded_svc::ipv4::ClientConfiguration::Fixed(embedded_svc::ipv4::ClientSettings {
-                ip: embedded_svc::ipv4::Ipv4Addr::from(parse_ip(STATIC_IP)),
-                subnet: embedded_svc::ipv4::Subnet {
-                    gateway: embedded_svc::ipv4::Ipv4Addr::from(parse_ip(GATEWAY_IP)),
-                    mask: embedded_svc::ipv4::Mask(24),
+        .set_iface_configuration(&esp_wifi::wifi::ipv4::Configuration::Client(
+            esp_wifi::wifi::ipv4::ClientConfiguration::Fixed(
+                esp_wifi::wifi::ipv4::ClientSettings {
+                    ip: esp_wifi::wifi::ipv4::Ipv4Addr::from(parse_ip(STATIC_IP)),
+                    subnet: esp_wifi::wifi::ipv4::Subnet {
+                        gateway: esp_wifi::wifi::ipv4::Ipv4Addr::from(parse_ip(GATEWAY_IP)),
+                        mask: esp_wifi::wifi::ipv4::Mask(24),
+                    },
+                    dns: None,
+                    secondary_dns: None,
                 },
-                dns: None,
-                secondary_dns: None,
-            }),
+            ),
         ))
         .unwrap();