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.
38 lines
1.1 KiB
Python
38 lines
1.1 KiB
Python
# espnow module for MicroPython on ESP8266
|
|
# MIT license; Copyright (c) 2022 Glenn Moloney @glenn20
|
|
|
|
from _espnow import *
|
|
from uselect import poll, POLLIN
|
|
|
|
|
|
class ESPNow(ESPNowBase):
|
|
# Static buffers for alloc free receipt of messages with ESPNow.irecv().
|
|
_data = [bytearray(ADDR_LEN), bytearray(MAX_DATA_LEN)]
|
|
_none_tuple = (None, None)
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
self._poll = poll() # For any() method below...
|
|
self._poll.register(self, POLLIN)
|
|
|
|
def irecv(self, timeout_ms=None):
|
|
n = self.recvinto(self._data, timeout_ms)
|
|
return self._data if n else self._none_tuple
|
|
|
|
def recv(self, timeout_ms=None):
|
|
n = self.recvinto(self._data, timeout_ms)
|
|
return [bytes(x) for x in self._data] if n else self._none_tuple
|
|
|
|
def __iter__(self):
|
|
return self
|
|
|
|
def __next__(self):
|
|
return self.irecv() # Use alloc free irecv() method
|
|
|
|
def any(self): # For the ESP8266 which does not have ESPNow.any()
|
|
try:
|
|
next(self._poll.ipoll(0))
|
|
return True
|
|
except StopIteration:
|
|
return False
|