feat(transport): add WiFi/LAN (TCP + TLS-PSK) transport - #147
Merged
Conversation
Add an IP transport alongside BLE so displays can be driven over WiFi/LAN. - transport/ip.py: TCP + TLS-PSK connection, framing per the wire protocol - transport/base.py, connection.py: transport abstraction and selection - discovery_ip.py: zeroconf-based IP discovery (new optional `wifi` extra) - device.py/cli.py: host/port/tls/psk addressing and transport selection - DATA-ack timeout handling on the compressed path; TLS-PSK derived from the device master key Requires Python >= 3.13 (TLS-PSK needs ssl.set_psk_client_callback). CI matrix updated to 3.13 (floor) + 3.14 (non-blocking).
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
Patch coverage on OpenDisplay#147 was 59.58% against a 79.05% target, failing codecov/patch. Brings transport/ip.py and discovery_ip.py to 100%. - test_transport_ip.py: _build_ssl_context() verified against a real loopback TLS-PSK server (handshake, framed round-trip, wrong-PSK rejection), asserting the "opendisplay" identity reaches the wire; skipped on OpenSSL builds without PSK ciphersuites. Adds the connect/disconnect/write/read error branches. - test_discovery_ip.py (new): zeroconf stubbed at the lazily-imported module attributes. Covers resolution skips, the name-suffix fallback, teardown on error, and the TXT decode helpers. cli.py's new lines stay uncovered: it is 0% repo-wide on main and needs CLI test scaffolding that does not exist yet.
Member
|
|
…hes with
`_on_change` declared its first two parameters as `_zeroconf` / `_service_type`,
but zeroconf's Signal.fire() invokes handlers with KEYWORD arguments
(zeroconf=, service_type=, name=, state_change=). Every service-state-change
event therefore raised
TypeError: _on_change() got an unexpected keyword argument 'zeroconf'
which the browser swallows, so `scan --lan` reported "No WiFi OpenDisplay
devices found" while the device was on the network advertising itself.
Reproduced 100% of the time with zeroconf 0.150.0.
The underscore prefix reads as the usual unused-argument convention, but these
names are part of the callback contract; only positional-only parameters are
safe to rename.
_FakeBrowser called the handler positionally, so the fake and the callback
shared the same wrong assumption and agreed with each other all the way to
green. Dispatch by keyword in the fake so it matches real zeroconf: reverting
the discovery_ip.py half now fails 9 tests instead of 0.
Verified on hardware (reTerminal E1003, ESP32-S3): `scan --lan` finds the
device first try.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds an IP transport alongside BLE so OpenDisplay displays can be driven over WiFi/LAN.
transport/ip.py— TCP + TLS-PSK connection, framing per the wire protocoltransport/base.py/connection.py— transport abstraction and selectiondiscovery_ip.py— zeroconf-based IP discovery (new optionalwifiextra)device.py/cli.py— host/port/tls/psk addressing and transport selectionTLS-PSK requires
ssl.set_psk_client_callback, added in Python 3.13. This bumpsrequires-pythonfrom>=3.11to>=3.13, dropping 3.11 and 3.12 support. CI matrix updated accordingly (3.13 floor + 3.14 non-blocking); ruff/mypy targets moved to 3.13; AGENTS.md updated. Flagging for maintainer sign-off since it narrows the advertised support range.Notes
feat:commit drives the bump).uv.lockregenerated: addszeroconf+ifaddr; dropstomli(was apython_version < "3.11"marker dep, now unreachable).Testing
uv run pytest— 886 passed, on both 3.13 and 3.14uv run prek run --all-files— ruff, ruff-format, mypy (strict), pylint all pass