ADR-110: ESP32-C6 firmware extension (#764)

Closes the firmware-side ADR-110 design at v0.7.0-esp32 after a 38-iter /loop SOTA sprint.

Headline (bench, COM9+COM12 ESP32-C6):
- 99.56% cross-board RX, 104.1 µs smoothed offset stdev (≤100 µs §2.4 target met)
- 3.95× EMA suppression, 1.4 ppm crystal skew preserved

4 firmware releases: v0.6.7 / v0.6.8 / v0.6.9 / v0.7.0-esp32.
42 ADR-110 unit tests, 1761 v2 workspace tests, full Firmware CI + QEMU green.
This commit is contained in:
rUv
2026-05-23 15:34:48 -04:00
committed by GitHub
parent 5d544126ee
commit 00a234eda8
63 changed files with 5864 additions and 63 deletions
+144 -4
View File
@@ -143,13 +143,35 @@ class ESP32BinaryParser:
12 4 Sequence number (LE u32)
16 1 RSSI (i8)
17 1 Noise floor (i8)
18 2 Reserved
18 1 PPDU type (ADR-110): 0=HT/legacy, 1=HE-SU, 2=HE-MU,
3=HE-TB, 0xFF=unknown. Pre-ADR-110 firmware sends 0.
19 1 Flags (ADR-110): bit 0 = bw40, bit 2 = STBC,
bit 3 = LDPC, bit 4 = cross-node sync valid
(set by either c6_timesync OR c6_sync_espnow
since v0.7.0 — ADR-110 §A0.13).
20 N*2 I/Q pairs (n_antennas * n_subcarriers * 2 bytes, signed i8)
Sibling packet (ADR-110 §A0.12, firmware v0.6.9+): the node also
emits a 32-byte UDP sync packet (magic 0xC511A110) every
CONFIG_C6_SYNC_EVERY_N_FRAMES frames on the same UDP socket.
See parse_sync_packet() / SyncPacket below.
"""
MAGIC = 0xC5110001
HEADER_SIZE = 20
HEADER_FMT = '<IBBHIIBB2x' # magic, node_id, n_ant, n_sc, freq, seq, rssi, noise
# ADR-110: previously '<IBBHIIBB2x' (last 2 bytes skipped as reserved).
# Now read those 2 bytes as PPDU type + flags. Pre-ADR-110 firmware
# sends zeros, which decode as 'HT/legacy' + 'no flags' — fully
# backwards compatible.
HEADER_FMT = '<IBBHIIBBBB' # +2 bytes: ppdu_type, flags
# ADR-110 PPDU type byte values
PPDU_HT_LEGACY = 0
PPDU_HE_SU = 1
PPDU_HE_MU = 2
PPDU_HE_TB = 3
PPDU_UNKNOWN = 0xFF
_PPDU_NAMES = {0: 'ht_legacy', 1: 'he_su', 2: 'he_mu', 3: 'he_tb', 0xFF: 'unknown'}
def parse(self, raw_data: bytes) -> CSIData:
"""Parse an ADR-018 binary frame into CSIData.
@@ -168,8 +190,8 @@ class ESP32BinaryParser:
f"Frame too short: need {self.HEADER_SIZE} bytes, got {len(raw_data)}"
)
magic, node_id, n_antennas, n_subcarriers, freq_mhz, sequence, rssi_u8, noise_u8 = \
struct.unpack_from(self.HEADER_FMT, raw_data, 0)
magic, node_id, n_antennas, n_subcarriers, freq_mhz, sequence, rssi_u8, noise_u8, \
ppdu_byte, flags_byte = struct.unpack_from(self.HEADER_FMT, raw_data, 0)
if magic != self.MAGIC:
raise CSIParseError(
@@ -226,10 +248,128 @@ class ESP32BinaryParser:
'rssi_dbm': rssi,
'noise_floor_dbm': noise_floor,
'channel_freq_mhz': freq_mhz,
# ADR-110 extension — zeros from pre-ADR-110 firmware land here as
# 'ht_legacy' + all-flags-false. New consumers can branch on
# ppdu_type / he_capable for HE-LTF-aware DSP.
'ppdu_type': self._PPDU_NAMES.get(ppdu_byte, 'unknown'),
'ppdu_type_raw': ppdu_byte,
'he_capable': ppdu_byte in (1, 2, 3),
'bw40': bool(flags_byte & 0x01),
'stbc': bool(flags_byte & 0x04),
'ldpc': bool(flags_byte & 0x08),
'ieee802154_sync_valid': bool(flags_byte & 0x10),
'adr018_flags_raw': flags_byte,
}
)
@dataclass
class SyncPacket:
"""ADR-110 §A0.12 sync packet (firmware v0.6.9+, magic 0xC511A110).
Emitted on the same UDP socket as CSI frames every
CONFIG_C6_SYNC_EVERY_N_FRAMES frames. Carries the mesh-aligned
epoch for the node alongside the high-water CSI sequence number,
so the host aggregator can pair (node_id, sequence) across the two
packet streams and recover a mesh-aligned timestamp for every CSI
frame. See WITNESS-LOG-110 §A0.12 for the live verification.
"""
node_id: int
proto_ver: int
is_leader: bool
is_valid: bool
smoothed_used: bool
local_us: int # u64 — node's local esp_timer_get_time()
epoch_us: int # u64 — local + EMA-smoothed offset (mesh time)
sequence: int # u32 — high-water CSI sequence at emit time
flags_raw: int
def local_minus_epoch_us(self) -> int:
"""Signed local-vs-mesh clock offset in µs.
Negative when this node's clock is behind the leader's (typical
for followers). Equal to ≈0 on the leader (modulo call-stack µs).
Matches Rust's `SyncPacket::local_minus_epoch_us` byte-for-byte.
"""
return self.local_us - self.epoch_us
def apply_to_local(self, local_at_frame_us: int) -> int:
"""Recover a mesh-aligned timestamp for any node-local µs snapshot.
Math (see WITNESS-LOG-110 §A0.10 / §A0.12):
offset = epoch_us - local_us (signed; this packet)
mesh = local_at_frame_us + offset
Identical contract to Rust's `SyncPacket::apply_to_local`.
Identity at `local_at_frame_us == self.local_us` returns `epoch_us`.
"""
offset = self.epoch_us - self.local_us
return local_at_frame_us + offset
def mesh_aligned_us_for_sequence(self, frame_seq: int, fps_hz: float) -> int:
"""ADR-110 §A0.12 — recover the mesh-aligned timestamp for an
in-flight CSI frame by its sequence number.
Pairs the frame's sequence number against this sync packet's
sequence high-water + an assumed/measured CSI rate. Matches the
Rust implementation byte-for-byte at the integer level (Python
rounds via `int()` truncation; for the canonical bench values
this is exact).
"""
if fps_hz <= 0:
raise ValueError(f"fps_hz must be positive, got {fps_hz}")
# Wrap to handle u32 sequence overflow the same way Rust does.
dframes = (frame_seq - self.sequence) & 0xFFFFFFFF
if dframes >= 0x80000000:
dframes -= 0x1_0000_0000
dus = int(dframes * 1_000_000 / fps_hz)
local_at = self.local_us + dus
return self.apply_to_local(local_at)
class SyncPacketParser:
"""Parser for ADR-110 §A0.12 32-byte sync packets.
Distinguished from CSI frames by the leading magic. Callers should
dispatch incoming UDP datagrams based on the first 4 bytes:
magic = struct.unpack_from('<I', data, 0)[0]
if magic == ESP32BinaryParser.MAGIC: # 0xC5110001 — CSI frame
...
elif magic == SyncPacketParser.MAGIC: # 0xC511A110 — sync packet
...
"""
MAGIC = 0xC511A110
SIZE = 32
# <IBBBB QQ IB3x>
# I=magic, B=node_id, B=proto_ver, B=flags, B=reserved,
# Q=local_us, Q=epoch_us, I=sequence, B+3x=reserved
HEADER_FMT = '<IBBBBQQI4x'
@classmethod
def parse(cls, raw_data: bytes) -> SyncPacket:
if len(raw_data) < cls.SIZE:
raise CSIParseError(
f"Sync packet too short: {len(raw_data)} bytes, need {cls.SIZE}"
)
magic, node_id, proto_ver, flags_byte, _, local_us, epoch_us, seq = \
struct.unpack_from(cls.HEADER_FMT, raw_data, 0)
if magic != cls.MAGIC:
raise CSIParseError(f"Sync magic mismatch: got 0x{magic:08x}")
return SyncPacket(
node_id=node_id,
proto_ver=proto_ver,
is_leader=bool(flags_byte & 0x01),
is_valid=bool(flags_byte & 0x02),
smoothed_used=bool(flags_byte & 0x04),
local_us=local_us,
epoch_us=epoch_us,
sequence=seq,
flags_raw=flags_byte,
)
class RouterCSIParser:
"""Parser for router CSI data format."""
@@ -19,11 +19,16 @@ from hardware.csi_extractor import (
CSIExtractor,
CSIParseError,
CSIExtractionError,
SyncPacket,
SyncPacketParser,
)
# ADR-018 constants
MAGIC = 0xC5110001
HEADER_FMT = '<IBBHIIBB2x'
# ADR-110: bytes 18-19 are now PPDU type + flags (used to be `2x` reserved).
# Pre-ADR-110 firmware sends zeros for both, which round-trip as
# ('ht_legacy', flags=all-false) — fully backwards compatible.
HEADER_FMT = '<IBBHIIBBBB'
HEADER_SIZE = 20
@@ -36,6 +41,8 @@ def build_binary_frame(
rssi: int = -50,
noise_floor: int = -90,
iq_pairs: list = None,
ppdu_byte: int = 0, # ADR-110: default 0 = HT/legacy (pre-ADR-110 behavior)
flags_byte: int = 0, # ADR-110: default 0 = no flags set
) -> bytes:
"""Build an ADR-018 binary frame for testing."""
if iq_pairs is None:
@@ -54,6 +61,8 @@ def build_binary_frame(
sequence,
rssi_u8,
noise_u8,
ppdu_byte,
flags_byte,
)
iq_data = b''
@@ -63,6 +72,52 @@ def build_binary_frame(
return header + iq_data
class TestAdr110ByteEncoding:
"""ADR-110: byte 18 = PPDU type, byte 19 = flags."""
def setup_method(self):
self.parser = ESP32BinaryParser()
def test_pre_adr110_zeros_decode_as_ht_legacy(self):
"""Pre-ADR-110 firmware sends zeros → must surface as HT/legacy + no flags."""
frame = build_binary_frame() # ppdu_byte=0, flags_byte=0 default
csi = self.parser.parse(frame)
assert csi.metadata['ppdu_type'] == 'ht_legacy'
assert csi.metadata['ppdu_type_raw'] == 0
assert csi.metadata['he_capable'] is False
assert csi.metadata['bw40'] is False
assert csi.metadata['stbc'] is False
assert csi.metadata['ldpc'] is False
assert csi.metadata['ieee802154_sync_valid'] is False
def test_he_su_decodes(self):
frame = build_binary_frame(ppdu_byte=1)
csi = self.parser.parse(frame)
assert csi.metadata['ppdu_type'] == 'he_su'
assert csi.metadata['he_capable'] is True
def test_he_mu_and_he_tb_decode(self):
for byte, expected in [(2, 'he_mu'), (3, 'he_tb')]:
csi = self.parser.parse(build_binary_frame(ppdu_byte=byte))
assert csi.metadata['ppdu_type'] == expected
assert csi.metadata['he_capable'] is True
def test_unknown_ppdu_byte(self):
csi = self.parser.parse(build_binary_frame(ppdu_byte=0xFF))
assert csi.metadata['ppdu_type'] == 'unknown'
assert csi.metadata['ppdu_type_raw'] == 0xFF
assert csi.metadata['he_capable'] is False
def test_all_flags_set_round_trip(self):
# bw40 (0x01) + STBC (0x04) + LDPC (0x08) + 15.4-sync (0x10) = 0x1D
csi = self.parser.parse(build_binary_frame(ppdu_byte=1, flags_byte=0x1D))
assert csi.metadata['bw40'] is True
assert csi.metadata['stbc'] is True
assert csi.metadata['ldpc'] is True
assert csi.metadata['ieee802154_sync_valid'] is True
assert csi.metadata['adr018_flags_raw'] == 0x1D
class TestESP32BinaryParser:
"""Tests for ESP32BinaryParser."""
@@ -204,3 +259,172 @@ class TestESP32BinaryParser:
await extractor.disconnect()
asyncio.run(run_test())
# ============================================================================
# ADR-110 §A0.12 — SyncPacket / SyncPacketParser tests (firmware v0.6.9+)
# ============================================================================
SYNC_MAGIC = 0xC511A110
SYNC_SIZE = 32
SYNC_FMT = '<IBBBBQQI4x'
def build_sync_packet(
node_id: int = 9,
proto_ver: int = 1,
is_leader: bool = False,
is_valid: bool = True,
smoothed_used: bool = True,
local_us: int = 28798450,
epoch_us: int = 27634885,
sequence: int = 20,
) -> bytes:
flags = 0
if is_leader: flags |= 0x01
if is_valid: flags |= 0x02
if smoothed_used: flags |= 0x04
return struct.pack(
SYNC_FMT,
SYNC_MAGIC,
node_id, proto_ver, flags, 0,
local_us, epoch_us, sequence,
)
class TestSyncPacketParser:
"""ADR-110 §A0.12: 32-byte UDP sync packet (magic 0xC511A110)."""
def test_follower_typical_packet_roundtrips(self):
"""Match the COM9-witnessed sync-pkt #1 byte-for-byte."""
raw = build_sync_packet(
node_id=9, is_leader=False, is_valid=True, smoothed_used=True,
local_us=28798450, epoch_us=27634885, sequence=20,
)
assert len(raw) == SYNC_SIZE
pkt = SyncPacketParser.parse(raw)
assert isinstance(pkt, SyncPacket)
assert pkt.node_id == 9
assert pkt.proto_ver == 1
assert pkt.is_leader is False
assert pkt.is_valid is True
assert pkt.smoothed_used is True
assert pkt.local_us == 28798450
assert pkt.epoch_us == 27634885
assert pkt.sequence == 20
# The 1.16-second boot delta from §A0.10 should be recoverable
assert pkt.local_us - pkt.epoch_us == 1163565
def test_leader_packet_has_local_close_to_epoch(self):
"""COM12 (leader) had flags=0x03 and epoch ≈ local."""
raw = build_sync_packet(
node_id=12, is_leader=True, is_valid=True, smoothed_used=False,
local_us=28864932, epoch_us=28864939, sequence=20,
)
pkt = SyncPacketParser.parse(raw)
assert pkt.node_id == 12
assert pkt.is_leader is True
assert pkt.is_valid is True
assert pkt.smoothed_used is False
assert pkt.flags_raw == 0x03
assert pkt.local_us - pkt.epoch_us == -7 # leader has zero offset
def test_magic_mismatch_raises(self):
"""A non-sync datagram must not silently decode."""
raw = bytearray(build_sync_packet())
raw[0] = 0x01 # corrupt magic low byte
with pytest.raises(CSIParseError, match="magic mismatch"):
SyncPacketParser.parse(bytes(raw))
def test_short_packet_raises(self):
"""Below 32 bytes must error early, not silently truncate."""
raw = build_sync_packet()[:16]
with pytest.raises(CSIParseError, match="too short"):
SyncPacketParser.parse(raw)
def test_all_flag_combinations(self):
"""Each flag bit decodes independently."""
for is_leader in (False, True):
for is_valid in (False, True):
for smoothed_used in (False, True):
raw = build_sync_packet(
is_leader=is_leader,
is_valid=is_valid,
smoothed_used=smoothed_used,
)
pkt = SyncPacketParser.parse(raw)
assert pkt.is_leader == is_leader
assert pkt.is_valid == is_valid
assert pkt.smoothed_used == smoothed_used
def test_dispatch_distinguishes_csi_from_sync(self):
"""A host can pick CSI vs sync by leading magic."""
csi_magic = struct.unpack_from('<I', build_binary_frame(), 0)[0]
sync_magic = struct.unpack_from('<I', build_sync_packet(), 0)[0]
assert csi_magic == ESP32BinaryParser.MAGIC
assert sync_magic == SyncPacketParser.MAGIC
assert csi_magic != sync_magic
def test_apply_to_local_recovers_epoch_at_sync_point(self):
"""ADR-110 iter 26 — Python parity with Rust's `apply_to_local`.
At local_at_frame == sync.local_us, the recovered mesh time must
equal sync.epoch_us exactly."""
pkt = SyncPacketParser.parse(build_sync_packet(
local_us=28_798_450, epoch_us=27_634_885, sequence=20,
))
assert pkt.apply_to_local(pkt.local_us) == pkt.epoch_us
assert pkt.local_minus_epoch_us() == 1_163_565 # §A0.10's bench number
def test_apply_to_local_preserves_inter_frame_delta(self):
"""A frame arriving 5 s after the sync packet on the follower's
local clock must produce a mesh time exactly 5 s after sync.epoch_us."""
pkt = SyncPacketParser.parse(build_sync_packet(
local_us=28_798_450, epoch_us=27_634_885, sequence=20,
))
local_at_frame = pkt.local_us + 5_000_000
assert pkt.apply_to_local(local_at_frame) == pkt.epoch_us + 5_000_000
def test_mesh_aligned_us_for_sequence_matches_rust(self):
"""Cross-language parity with Rust's
`end_to_end_sync_decode_then_frame_mesh_recovery` test —
100 frames after sync.sequence at 20 fps = sync.epoch_us + 5 s."""
pkt = SyncPacketParser.parse(build_sync_packet(
local_us=28_798_450, epoch_us=27_634_885, sequence=20,
))
mesh = pkt.mesh_aligned_us_for_sequence(120, 20.0)
assert mesh == pkt.epoch_us + 5_000_000
# Both paths (apply_to_local + interpolation) must agree
local_at = pkt.local_us + 5_000_000
assert pkt.apply_to_local(local_at) == mesh
def test_canonical_wire_bytes_match_rust_decoder(self):
"""ADR-110 iter 21 — cross-language wire-format conformance gate.
These exact bytes also appear pinned in the Rust hardware crate's
`canonical_wire_bytes_match_python_decoder` test (same field
values, encoded by Rust's `SyncPacket::to_bytes`). If Python's
hardcoded hex stops matching what Rust produces from the equivalent
SyncPacket struct, ONE of the decoders has drifted from the wire.
Canonical packet: COM9 sync-pkt #1 from §A0.12 live capture.
"""
canonical = bytes.fromhex(
"10a111c509010600" # magic LE + node=9 + ver=1 + flags=0x06 + reserved
"f26db70100000000" # local_us = 28_798_450 (LE u64)
"c5aca50100000000" # epoch_us = 27_634_885 (LE u64)
"1400000000000000" # sequence = 20 (LE u32) + 4 reserved bytes
)
assert len(canonical) == SyncPacketParser.SIZE == 32
pkt = SyncPacketParser.parse(canonical)
assert pkt.node_id == 9
assert pkt.proto_ver == 1
assert pkt.flags_raw == 0x06
assert pkt.is_leader is False
assert pkt.is_valid is True
assert pkt.smoothed_used is True
assert pkt.local_us == 28_798_450
assert pkt.epoch_us == 27_634_885
assert pkt.sequence == 20
# Recovered offset matches §A0.10's measured 1.16-second boot delta.
assert pkt.local_us - pkt.epoch_us == 1_163_565