|
| 1 | +# ESP-Hosted Firmware |
| 2 | + |
| 3 | +Pre-built [ESP-Hosted-MCU](https://github.com/espressif/esp-hosted-mcu) co-processor firmware binaries |
| 4 | + |
| 5 | +## Overview |
| 6 | + |
| 7 | +The slave firmware enables host MCUs to utilize the Wi-Fi and Bluetooth capabilities of ESP32 series chips through **SDIO, SPI, or UART** interfaces. |
| 8 | + |
| 9 | +## Supported Co-processors and Transports |
| 10 | + |
| 11 | +The following table summarizes the supported co-processors and transport communication buses between the slave and host. |
| 12 | + |
| 13 | +| Transport Supported | SDIO | SPI Full-Duplex | SPI Half-Duplex | UART | |
| 14 | +|---|:---:|:---:|:---:|:---:| |
| 15 | +| **Co-Processors Supported** | | | | | |
| 16 | +| ESP32 | ✓ | ✓ | × | ✓ | |
| 17 | +| ESP32-C2 | × | ✓ | ✓ | ✓ | |
| 18 | +| ESP32-C3 | × | ✓ | ✓ | ✓ | |
| 19 | +| ESP32-C5 | ✓ | ✓ | ✓ | ✓ | |
| 20 | +| ESP32-C6/C61 | ✓ | ✓ | ✓ | ✓ | |
| 21 | +| ESP32-S2 | × | ✓ | ✓ | ✓ | |
| 22 | +| ESP32-S3 | × | ✓ | ✓ | ✓ | |
| 23 | + |
| 24 | +## Usage |
| 25 | + |
| 26 | +Download the appropriate firmware binary for your co-processor from the [Releases](https://github.com/pioarduino/esp-hosted-mcu-firmware/releases) page |
| 27 | + |
| 28 | +## Building Locally |
| 29 | + |
| 30 | +To build the firmware locally: |
| 31 | + |
| 32 | +```bash |
| 33 | +# Clone ESP-IDF |
| 34 | +git clone -b v5.5.1 --recursive https://github.com/espressif/esp-idf.git |
| 35 | +cd esp-idf |
| 36 | +./install.sh esp32c6 # or your target |
| 37 | +source export.sh |
| 38 | +cd .. |
| 39 | + |
| 40 | +# Create project from ESP-Hosted example |
| 41 | +idf.py create-project-from-example "espressif/esp_hosted==2.7.3:slave" |
| 42 | +cd slave/ |
| 43 | + |
| 44 | +# Build for your target |
| 45 | +idf.py set-target esp32c6 # or your target |
| 46 | +idf.py build |
| 47 | + |
| 48 | +# Output: build/network_adapter.bin |
| 49 | +``` |
| 50 | + |
| 51 | +## Versioning |
| 52 | + |
| 53 | +Releases are tagged with the ESP-Hosted-MCU version used (e.g., `v2.7.3`). |
| 54 | + |
| 55 | +## License |
| 56 | + |
| 57 | +The ESP-Hosted-MCU firmware is licensed under the Apache License 2.0. See the [ESP-Hosted-MCU repository](https://github.com/espressif/esp-hosted-mcu) for details. |
0 commit comments