|
1 | 1 | //! esp32-wroom-rp |
2 | 2 | //! |
3 | | -//! This crate is an Espressif ESP32-WROOM WiFi driver implementation for RP2040 series microcontroller implemented in Rust. |
4 | | -//! Supports the [ESP32-WROOM-32E](https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32e_esp32-wroom-32ue_datasheet_en.pdf), [ESP32-WROOM-32UE](https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32e_esp32-wroom-32ue_datasheet_en.pdf) modules. |
5 | | -//! Future implementations will support the [ESP32-WROOM-DA](https://www.espressif.com/sites/default/files/documentation/esp32-wroom-da_datasheet_en.pdf) module. |
| 3 | +//! This crate is an Espressif ESP32-WROOM WiFi module communications driver for RP2040 series microcontroller implemented in Rust. |
| 4 | +//! It currently supports the [ESP32-WROOM-32E](https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32e_esp32-wroom-32ue_datasheet_en.pdf) |
| 5 | +//! and [ESP32-WROOM-32UE](https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32e_esp32-wroom-32ue_datasheet_en.pdf) modules. |
| 6 | +//! Future implementations intend to add support for the [ESP32-WROOM-DA](https://www.espressif.com/sites/default/files/documentation/esp32-wroom-da_datasheet_en.pdf) module. |
6 | 7 | //! |
7 | 8 | //! It's intended to communicate with recent versions of most [Arduino-derived WiFiNINA firmwares](https://www.arduino.cc/reference/en/libraries/wifinina/) |
8 | | -//! that run on an ESP32-WROOM-XX WiFi module. For example, Adafruit makes such WiFi hardware referred to as the [Airlift](https://www.adafruit.com/product/4201) and maintains its [firmware](https://github.com/adafruit/nina-fw). |
| 9 | +//! that run on an ESP32-WROOM-XX WiFi module. For example, Adafruit makes such WiFi hardware, referred to as the [Airlift](https://www.adafruit.com/product/4201), and maintains its [firmware](https://github.com/adafruit/nina-fw). |
9 | 10 | //! |
10 | 11 | //! This driver is implemented on top of [embedded-hal](https://github.com/rust-embedded/embedded-hal/), which makes it platform-independent, but is currently only intended |
11 | 12 | //! to be used with [rp2040-hal](https://github.com/rp-rs/rp-hal/tree/main/rp2040-hal) for your application. |
12 | 13 | //! |
13 | | -//! Please see the README.md for details on where to obtain and how to connect your RP2040-based device (e.g. Pico) to your ESP32-WROOM-XX WiFI board. |
| 14 | +//! Please see the README.md for details on where to obtain and how to connect your RP2040-based device (e.g. Pico) to your ESP32-WROOM-XX WiFi board. |
14 | 15 | //! |
15 | | -//! Once connected, note that all communication with the WiFI board occurs via a SPI bus. As the example below (and all examples under the directory `cross/`) |
| 16 | +//! Once connected, note that all communication with the WiFi board occurs via a SPI bus. As the example below (and all examples under the directory `cross/`) |
16 | 17 | //! show, you first need to create an `embedded_hal::spi::Spi` instance. See the [rp2040-hal documentation](https://docs.rs/rp2040-hal/0.6.0/rp2040_hal/spi/index.html) along |
17 | 18 | //! with the datasheet for your device on what specific SPI ports are available to you. |
18 | 19 | //! |
|
137 | 138 | //! loop {} |
138 | 139 | //! } |
139 | 140 | //! ``` |
| 141 | +//! |
| 142 | +//! ## More examples |
| 143 | +//! |
| 144 | +//! Please refer to the `cross/` directory in this crate's source for examples that demonstrate how to use every part of its public API. |
| 145 | +//! |
140 | 146 |
|
141 | 147 | #![doc(html_root_url = "https://docs.rs/esp32-wroom-rp")] |
142 | 148 | #![doc(issue_tracker_base_url = "https://github.com/Jim-Hodapp-Coaching/esp32-wroom-rp/issues")] |
|
0 commit comments