mirror of
https://github.com/esp-rs/esp-hal.git
synced 2025-09-29 05:10:55 +00:00
4eb4c89944
* folding esp-ieee802154 to `esp-radio` * remove the package Edit monorepo changelog to reflect the ieee-crate changes * edit readme * fix cargo.toml * changelog update fix changelog entry * address reviews * edit changelog * remove useless "fmt.rs" file * address reviews * fix HIL build sure oh fix hashmap inconsistency
67 lines
4.2 KiB
Markdown
67 lines
4.2 KiB
Markdown
# esp-radio
|
|
|
|
[](https://crates.io/crates/esp-radio)
|
|
[](https://docs.espressif.com/projects/rust/esp-radio/latest/)
|
|
|
|
|
|
[](https://matrix.to/#/#esp-rs:matrix.org)
|
|
|
|
A WiFi, BLE and ESP-NOW driver for Espressif microcontrollers.
|
|
|
|
This package also includes low-level [IEEE 802.15.4] driver for the ESP32-C6 and ESP32-H2
|
|
|
|
Note that this crate currently requires you to enable the `unstable` feature on `esp-hal`.
|
|
|
|
[IEEE 802.15.4]: https://en.wikipedia.org/wiki/IEEE_802.15.4
|
|
|
|
## Current support
|
|
|
|
If a cell contains an em dash (—) this means that the particular feature is not present for a chip. A check mark (✓) means that some driver implementation exists.
|
|
|
|
| | `Wi-Fi`| `BLE` | `Coex (Wi-Fi + BLE)` | `ESP-NOW` | `IEEE 802.15.4`
|
|
| :------: | :--------------------------------------------------: | :-------------------------------------------------: | :--------------------------------------------------: | :-----: | :-----: |
|
|
| ESP32 | ✓ | ✓ | ✓ | ✓ | — |
|
|
| ESP32-C2 | ✓ | ✓ | ✓ | ✓ | — |
|
|
| ESP32-C3 | ✓ | ✓ | ✓ | ✓ | — |
|
|
| ESP32-C6 | ✓ | ✓ | ✓ | ✓ | ✓ |
|
|
| ESP32-H2 | — | ✓ | — | — | ✓ |
|
|
| ESP32-S2 | ✓ | — | — | ✓ | — |
|
|
| ESP32-S3 | ✓ | ✓ | ✓ | ✓ | — |
|
|
|
|
## Missing / To be done
|
|
|
|
- Support for non-open SoftAP
|
|
|
|
## Bluetooth stack
|
|
We recommend using [`TrouBLE`] as the Bluetooth stack. You can find detailed examples [here].
|
|
|
|
[`TrouBLE`]: https://github.com/embassy-rs/trouble/tree/main
|
|
[here]: https://github.com/embassy-rs/trouble/tree/main/examples/esp32
|
|
|
|
## Driver version
|
|
|
|
This uses the WiFi drivers from https://github.com/esp-rs/esp-wireless-drivers-3rdparty
|
|
|
|
v5.1.2-602-gdb1e54a0c5-dirty commit db1e54a0c537d8b2cc2bd109ee88b50e1ca0ea80
|
|
|
|
https://github.com/esp-rs/esp-wireless-drivers-3rdparty/ (commit ca2809144cf6d2f89d413f1d415f1c4454ee6249)
|
|
|
|
## Minimum Supported Rust Version (MSRV)
|
|
|
|
This crate is guaranteed to compile when using the latest stable Rust version at the time of the crate's release. It _might_ compile with older versions, but that may change in any new release, including patches.
|
|
|
|
## License
|
|
|
|
Licensed under either of:
|
|
|
|
- Apache License, Version 2.0 ([LICENSE-APACHE](../LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
|
|
- MIT license ([LICENSE-MIT](../LICENSE-MIT) or http://opensource.org/licenses/MIT)
|
|
|
|
at your option.
|
|
|
|
### Contribution
|
|
|
|
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.
|