Skip to content

Commit f35ab99

Browse files
committed
docs: update README support matrix and implementation notes
1 parent 98e15f5 commit f35ab99

2 files changed

Lines changed: 46 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
66
[![Language: C99](https://img.shields.io/badge/language-C99-blue.svg)](#)
77
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](#)
8-
[![Platform](https://img.shields.io/badge/platform-ESP32%20%7C%20ESP32--S3%20%7C%20ESP32--C3-lightgrey.svg)](#)
9-
[![Status: v1.3.0](https://img.shields.io/badge/status-v1.3.0-brightgreen.svg)](#)
8+
[![Platform](https://img.shields.io/badge/platform-ESP32%20%7C%20S2%20%7C%20S3%20%7C%20C3%20%7C%20C6-lightgrey.svg)](#)
9+
[![Status: v1.4.0](https://img.shields.io/badge/status-v1.4.0-brightgreen.svg)](#)
1010

1111
---
1212

@@ -192,6 +192,19 @@ RX current: ~60 mA @ 3.3V
192192

193193
**No extra hardware.** Just ESP32 + power supply.
194194

195+
## Supported Hardware
196+
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
207+
195208
---
196209

197210
## Documentation
@@ -237,9 +250,10 @@ Other micro-toolkit libraries are optional and can be integrated if needed:
237250
+ Security layer (AES-128 CTR, HMAC-SHA256)
238251
+ Auto-mesh coordinator election
239252
+ Gradient routing mode for sensor networks
253+
+ Broad ESP32 capability detection (S2/S3/C3/C6)
240254
+ ESP32 port
241255
+ Examples
242-
+ Unit tests (12/12 passing)
256+
+ Unit tests (13/13 passing)
243257
```
244258

245259
---

‎docs/IMPLEMENTATION.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ umesh/
1111
|
1212
+-- include/
1313
| +-- umesh.h # single public header
14+
| +-- umesh_caps.h # target capability detection
1415
|
1516
+-- src/
1617
| +-- umesh.c # init, start, stop, API glue
@@ -41,8 +42,11 @@ umesh/
4142
+-- port/
4243
| +-- esp32/
4344
| | +-- phy_esp32.c # raw 802.11, promiscuous mode
45+
| | +-- power_esp32.c # power HAL
46+
| | +-- twt_esp32c6.c # C6 TWT stub
4447
| +-- posix/
4548
| +-- phy_posix.c # simulation for PC tests
49+
| +-- power_posix.c # power simulation
4650
|
4751
+-- tests/
4852
| +-- test_crc.c
@@ -374,12 +378,32 @@ ctest --test-dir build --output-on-failure
374378

375379
---
376380

381+
## Target Capability Detection
382+
383+
`include/umesh_caps.h` provides compile-time target descriptors:
384+
- `UMESH_TARGET`
385+
- `UMESH_HAS_WIFI`
386+
- `UMESH_HAS_BT`
387+
- `UMESH_WIFI_GEN`
388+
- `UMESH_RAM_KB`
389+
- `UMESH_TX_POWER_MAX`
390+
- `UMESH_HAS_TWT` (ESP32-C6)
391+
392+
Runtime wrappers are exposed by API:
393+
- `umesh_get_target()`
394+
- `umesh_get_wifi_gen()`
395+
- `umesh_target_supports(...)`
396+
397+
---
398+
377399
## CMakeLists.txt
378400

379401
```cmake
380402
cmake_minimum_required(VERSION 3.16)
381403
project(umesh C)
382404
set(CMAKE_C_STANDARD 99)
405+
option(UMESH_ENABLE_POWER_MANAGEMENT "Enable power management" ON)
406+
option(UMESH_LOW_MEMORY "Enable reduced-memory profile" OFF)
383407
384408
set(UMESH_SOURCES
385409
src/umesh.c
@@ -402,8 +426,13 @@ target_include_directories(umesh PRIVATE src)
402426
403427
if(UMESH_PORT STREQUAL "esp32")
404428
target_sources(umesh PRIVATE port/esp32/phy_esp32.c)
429+
target_sources(umesh PRIVATE port/esp32/power_esp32.c)
430+
if(DEFINED CONFIG_IDF_TARGET_ESP32C6 AND CONFIG_IDF_TARGET_ESP32C6)
431+
target_sources(umesh PRIVATE port/esp32/twt_esp32c6.c)
432+
endif()
405433
else()
406434
target_sources(umesh PRIVATE port/posix/phy_posix.c)
435+
target_sources(umesh PRIVATE port/posix/power_posix.c)
407436
message(STATUS "umesh: POSIX port (testing)")
408437
endif()
409438

0 commit comments

Comments
 (0)