Skip to content

v0.1.0

Choose a tag to compare

@schlarpc schlarpc released this 06 Oct 05:56
· 2 commits to main since this release

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/ and devices/ 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.