Wi-Fi/BTLE coexistence is implemented but currently only works (to some extent) on ESP32-C3 and ESP32-S3. In general COEX shouldn't be used currently.
Minimum supported Rust compiler version: 1.65.0.0
This uses the WiFi drivers from https://github.com/esp-rs/esp-wireless-drivers-3rdparty
v5.1-dev-2658-g0025915dc4 commit 0025915dc489a9d45f99aed74920346f8ac4ec09
https://github.com/esp-rs/esp-wireless-drivers-3rdparty/ (commit f4caebff200e8f6f51b0a11d2b69ca56c76bb1c9)
If a cell contains am em dash (—) this means that the particular feature is not present for a chip. A check mark (✓) means that some driver implementation exists. An empty cell means that the feature is present in the chip but not implemented yet.
| Wifi | BLE | Coex | ESP-NOW | |
|---|---|---|---|---|
| ESP32 | ✓ | ✓ | ✓ | |
| ESP32-S2 | ✓ | — | — | ✓ |
| ESP32-S3 | ✓ | ✓ | ✓ | ✓ |
| ESP32-C3 | ✓ | ✓ | ✓ | ✓ |
| ESP32-C2 | ✓ | ✓ | ✓ | |
| ESP32-C6 | ✓ | ✓ |
To build these ensure you are in the examples-esp32XXX directory matching your target as othewise the config.toml will not apply
- set SSID and PASSWORD env variable
- gets an ip address via DHCP
- performs an HTTP get request to some "random" server
cargo run --example dhcp --release --features "embedded-svc,wifi"
- set SSID and PASSWORD env variable
- set STATIC_IP and GATEWAY_IP env variable (e.g. "192.168.2.191" / "192.168.2.1")
- might be necessary to configure your WiFi access point accordingly
- uses the given static IP
- responds with some HTML content when connecting to port 8080
cargo run --example static_ip --release --features "embedded-svc,wifi"
- starts Bluetooth advertising
- offers one service with three characteristics (one is read/write, one is write only, one is read/write/notify)
- pressing the boot-button on a dev-board will send a notification if it is subscribed
- this uses a toy level BLE stack - might not work with every BLE central device (tested with Android and Windows Bluetooth LE Explorer)
cargo run --example ble --release --features "ble"
NOTE: ESP32-S2 doesn't support bluetooth, for ESP32-C6 bluetooth support isn't implemented yet
- set SSID and PASSWORD env variable
- gets an ip address via DHCP
- performs an HTTP get request to some "random" server
- does BLE advertising
- coex support is still somewhat flaky
cargo run --example coex --release --features "embedded-svc,wifi,ble"
NOTE: Not currently available for the ESP32, ESP32-C2, ESP32-C6 or ESP32-S2
- broadcasts, receives and sends messages via esp-now
cargo run --example esp_now --release --features "esp-now"
- broadcasts, receives and sends messages via esp-now in an async way
cargo run --example embassy_esp_now --release --features "async,esp-now"
- Read and Write to sockets over WiFi asyncronously using embassy-executor.
cargo run --example embassy_dhcp --release --features "async,embedded-svc,wifi,embassy-net"
- creates an open access-point with SSID
esp-wifi - you can connect to it using a static IP in range 192.168.2.2 .. 192.168.2.255, gateway 192.168.2.1
- open http://192.168.2.1:8080/ in your browser
- on Android you might need to choose Keep Accesspoint when it tells you the WiFi has no internet connection, Chrome might not want to load the URL - you can use a shell and try
curlandping
cargo run --example access_point --release --features "embedded-svc,wifi"
- creates an open access-point with SSID
esp-wifi - you can connect to it using a static IP in range 192.168.2.2 .. 192.168.2.255, gateway 192.168.2.1
- open http://192.168.2.1:8080/ in your browser
- on Android you might need to choose Keep Accesspoint when it tells you the WiFi has no internet connection, Chrome might not want to load the URL - you can use a shell and try
curlandping
cargorun --example embassy_access_point --release --features "async,embedded-svc,wifi,embassy-net"
| Feature | Meaning |
|---|---|
| wifi-logs | logs the WiFi logs from the driver at log level info |
| dump-packets | dumps some packet info at log level info |
| utils | Provide utilities for smoltcp initialization, this is a default feature |
| embedded-svc | Provides a (very limited) implementation of the embedded-svc WiFi trait, includes utils feature |
| ble | Enable BLE support |
| wifi | Enable WiFi support |
| esp-now | Enable esp-now support |
It is necessary to build with optimization level 2 or 3 since otherwise it might not even be able to connect or advertise.
To make it work also for your debug builds add this to your Cargo.toml
[profile.dev.package.esp-wifi]
opt-level = 3Link time optimization is not yet recommended for use, please ensure lto = "off" is in your Cargo.toml for both release and debug profiles.
On ESP32-C3 / ESP32-S3 when using Serial-JTAG you have to activate the feature phy-enable-usb.
Don't use this feature if your are not using Serial-JTAG since it might reduce WiFi performance.
- scanning for WiFi access points
- connect to WiFi access point
- providing an HCI interface
- create an open access point
- uses SYSTIMER as the main timer
- doesn't work in direct-boot mode
- The WiFi logs only print the format string - not the actual values.
- The code runs on a single core and might currently not be multi-core safe!
On ESP32 / ESP32-S2 / ESP32-S3 currently TIMG1/TIMER0 is used as the main timer so you can't use it for anything else. Additionally it uses CCOMPARE0 - so don't touch that, too.
Currently your mileage might vary a lot for different opt-levels on Xtensa targets! If something doesn't work as expected try a different opt-level.
src/timer-espXXX.rs: systimer code used for timing and task switchingsrc/preemt/: a bare minimum RISCV and Xtensa round-robin task schedulersrc/compat/: code needed to emulate enough of an (RT)OS to use the drivercommon.rs: basics like semaphores and recursive mutexestimer_compat.rs: code to emulate timer related functionality
examples/*.rs: examples
- lots of refactoring
- make CoEx work on ESP32 (it kind of works when commenting out setting the country in wifi_start, probably some mis-compilation since it then crashes in a totally different code path)
- combined SoftAP/STA mode
- support for non-open SoftAP
For now this is not available on crates.io. Until then you need to specify a git dependency. You might want to pin the dependency to a specific commit since this things might change a lot during development.
Make sure to include the rom functions for your target like this
rustflags = [
"-C", "link-arg=-Tlinkall.x",
"-C", "link-arg=-Trom_functions.x",
]in your .cargo/config.toml - otherwise you will get linker errors complaining about missing symbols.
Licensed under either of:
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.