Repository navigation
Releases
v0.1.1
Fixes a connection that could hang forever without ever identifying.
Seen twice on real hardware, both after a Home Assistant restart: the sign completes the TCP handshake and then sends nothing. ss showed segs_in: 2 — the handshake and nothing else — with lastrcv past four minutes, while the sign believed it was connected and the server reported it absent (accepted=1, identified=0). Reloading the integration cleared it, which is not a fix.
The socket hung in the TLS sniff, not the read loop: _peek awaits six bytes that never arrive, so the connection never reached the loop and a guard there would never have run. Both paths are now bounded by identify_timeout (default 120 s; None disables).
Only applies before a device identifies — a sign that has introduced itself may legitimately hold its socket quiet between heartbeats, and closing that would be a regression. There is a test for each half.
Also: ServerStats.unidentified_timeouts counts it, and a test-only lz4 import was removed so the suite collects without the optional dependency.
1155 tests.
v0.1.0
First release.
A sans-io reimplementation of the wire protocol spoken by Visionect e-ink signs, derived from the vendor server's unstripped Go binaries and validated against packet captures from a real device.
The sign is a TCP client — it dials out and speaks first, with no handshake and no authentication — so this library is a listener that replaces the vendor server outright. It has driven a real 31.2" panel end to end: encode, dither, bit-pack, interleave, push, with the device echoing back the checksum we computed.
- Strictly sans-io:
wire/,packets/,session/anddevices/are pure, enforced by an AST test;io/holds the only sockets - Framing, the 235-entry TCLV parameter table, status decoding, the file protocol, and firmware metadata
- Imaging: 1/4 bpp packing, dithering including a blue-noise mode, the interlaced two-screen fold, and XXHash32 state checksums
- Optional screen-space partial updates — ~26-42x less data on the wire, verified on hardware
- A USB serial console client, and a Home Assistant integration at ha-visionect
- 1153 tests, including replay against real captured traffic
docs/carries a 4,000-line protocol reference, scrubbed of deployment specifics
Details that bite reimplementers are documented rather than buried: the frame checksum is direction-dependent, 4 bpp puts the even pixel in the low nibble, and help on the device is not a complete command index. OPEN-QUESTIONS.md is an honest ledger of what is still unresolved.