mirror of
https://github.com/licsber/micropython.git
synced 2024-09-20 09:00:23 +08:00
7fa322afb8
ESP-NOW is a proprietary wireless communication protocol which supports
connectionless communication between ESP32 and ESP8266 devices, using
vendor specific WiFi frames. This commit adds support for this protocol
through a new `espnow` module.
This commit builds on original work done by @nickzoic, @shawwwn and with
contributions from @zoland. Features include:
- Use of (extended) ring buffers in py/ringbuf.[ch] for robust IO.
- Signal strength (RSSI) monitoring.
- Core support in `_espnow` C module, extended by `espnow.py` module.
- Asyncio support via `aioespnow.py` module (separate to this commit).
- Docs provided at `docs/library/espnow.rst`.
Methods available in espnow.ESPNow class are:
- active(True/False)
- config(): set rx buffer size, read timeout and tx rate
- recv()/irecv()/recvinto() to read incoming messages from peers
- send() to send messages to peer devices
- any() to test if a message is ready to read
- irq() to set callback for received messages
- stats() returns transfer stats:
(tx_pkts, tx_pkt_responses, tx_failures, rx_pkts, lost_rx_pkts)
- add_peer(mac, ...) registers a peer before sending messages
- get_peer(mac) returns peer info: (mac, lmk, channel, ifidx, encrypt)
- mod_peer(mac, ...) changes peer info parameters
- get_peers() returns all peer info tuples
- peers_table supports RSSI signal monitoring for received messages:
{peer1: [rssi, time_ms], peer2: [rssi, time_ms], ...}
ESP8266 is a pared down version of the ESP32 ESPNow support due to code
size restrictions and differences in the low-level API. See docs for
details.
Also included is a test suite in tests/multi_espnow. This tests basic
espnow data transfer, multiple transfers, various message sizes, encrypted
messages (pmk and lmk), and asyncio support.
Initial work is from https://github.com/micropython/micropython/pull/4115.
Initial import of code is from:
https://github.com/nickzoic/micropython/tree/espnow-4115.
|
||
|---|---|---|
| .. | ||
| ESP32_S2_WROVER | ||
| GENERIC | ||
| GENERIC_C3 | ||
| GENERIC_C3_USB | ||
| GENERIC_D2WD | ||
| GENERIC_OTA | ||
| GENERIC_S2 | ||
| GENERIC_S3 | ||
| GENERIC_S3_SPIRAM | ||
| GENERIC_S3_SPIRAM_OCT | ||
| GENERIC_SPIRAM | ||
| GENERIC_UNICORE | ||
| LILYGO_TTGO_LORA32 | ||
| LOLIN_C3_MINI | ||
| LOLIN_S2_MINI | ||
| LOLIN_S2_PICO | ||
| M5STACK_ATOM | ||
| OLIMEX_ESP32_POE | ||
| SIL_WESP32 | ||
| UM_FEATHERS2 | ||
| UM_FEATHERS2NEO | ||
| UM_FEATHERS3 | ||
| UM_PROS3 | ||
| UM_TINYPICO | ||
| UM_TINYS2 | ||
| UM_TINYS3 | ||
| deploy_c3.md | ||
| deploy_s2.md | ||
| deploy_s3.md | ||
| deploy.md | ||
| manifest_test.py | ||
| manifest.py | ||
| sdkconfig.240mhz | ||
| sdkconfig.base | ||
| sdkconfig.ble | ||
| sdkconfig.nimble_core0 | ||
| sdkconfig.nimble_core1 | ||
| sdkconfig.spiram | ||
| sdkconfig.spiram_oct | ||
| sdkconfig.spiram_sx | ||
| sdkconfig.usb | ||