Skip to content

Commit 4c3203f

Browse files
committed
docs: add complete ESP family support matrix to README
1 parent ecf492a commit 4c3203f

1 file changed

Lines changed: 25 additions & 10 deletions

File tree

README.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](#)
88
[![Platform](https://img.shields.io/badge/platform-ESP32%20%7C%20S2%20%7C%20S3%20%7C%20C3%20%7C%20C6-lightgrey.svg)](#)
99
[![Status: v1.4.0](https://img.shields.io/badge/status-v1.4.0-brightgreen.svg)](#)
10+
[![Actions](https://github.com/Vanderhell/uMesh/actions/workflows/ci.yml/badge.svg)](https://github.com/Vanderhell/uMesh/actions/workflows/ci.yml)
1011

1112
---
1213

@@ -194,16 +195,30 @@ RX current: ~60 mA @ 3.3V
194195

195196
## Supported Hardware
196197

197-
| Chip | WiFi | Tested | Notes |
198-
|------|------|--------|-------|
199-
| ESP32 | 802.11n || Classic |
200-
| ESP32-S2 | 802.11n || No BT |
201-
| ESP32-S3 | 802.11n || Recommended |
202-
| ESP32-C3 | 802.11n || Budget option |
203-
| ESP32-C6 | 802.11ax || WiFi 6, TWT-ready |
204-
| ESP32-H2 ||| No WiFi |
205-
206-
✓ = hardware tested ○ = compile-tested ✗ = not supported
198+
| Chip | Support | Reason |
199+
|------|---------|--------|
200+
| ESP32 | ✓ Full | Classic, fully tested |
201+
| ESP32-S2 | ✓ Full | No BT, otherwise identical |
202+
| ESP32-S3 | ✓ Full | Recommended, dual-core |
203+
| ESP32-C3 | ✓ Full | Budget option, RISC-V |
204+
| ESP32-C6 | ✓ Full | WiFi 6, best power mgmt |
205+
| ESP32-H2 | ✗ Not supported | No WiFi (802.15.4 only) |
206+
| ESP32-C2 | ✗ Not supported | Insufficient RAM |
207+
| ESP8266 | ✗ Not supported | No raw 802.11 TX API |
208+
| ESP8285 | ✗ Not supported | Same as ESP8266 |
209+
210+
> **Why ESP8266 is not supported:**
211+
> ESP8266 lacks `esp_wifi_80211_tx()` - the API required
212+
> to send raw 802.11 frames. Only promiscuous RX is
213+
> available, making it impossible to be an active mesh node.
214+
>
215+
> **Why ESP32-H2 is not supported:**
216+
> ESP32-H2 uses 802.15.4 radio (Zigbee/Thread) instead
217+
> of WiFi. µMesh requires WiFi hardware.
218+
>
219+
> **Why ESP32-C2 is not supported:**
220+
> ESP32-C2 has insufficient RAM (272KB) for the full
221+
> µMesh stack.
207222
208223
---
209224

0 commit comments

Comments
 (0)