Skip to content

Document what testing on real devices turned up - #1198

Merged
frenck merged 1 commit into
mainfrom
frenck/document-device-limits
Oct 3, 2026
Merged

frenck merged 1 commit into
mainfrom
frenck/document-device-limits

Conversation

@frenck

@frenck frenck commented Oct 3, 2026

Copy link
Copy Markdown
Owner

Proposed Changes

(Describe the changes and rationale behind them)

Everything since v1.4.1 was run end to end against two real devices, an LM 37X8 TIME on firmware 2.3.9 and an sa8 TIME on firmware 3.2.6. All of it works, and both devices were left exactly as they were. Two things it turned up are worth documenting:

  • screen_off on a TIME is a trap. The device accepts the mode and answers with success, but it only switches its other modes off (here when_dark) and enables nothing. The screensaver is then left without any mode, without any error. The display() docstring now says to only pick a mode the device reports in screensaver.modes.
  • Streaming needs more than API 2.3.0. The stream() docstring claimed API 2.3.0 was enough, but the LM 37X8 reports exactly API 2.3.0, lists no stream endpoints, and answers them with a 404. The sa8 (API 2.4.0) streams fine. The docstring and README now say so, and the stream example checks whether the device lists the stream endpoints before trying. Verified against both devices.

Related Issues

(Github link to related issues or pull requests)

None.

A TIME accepts the screen_off screensaver mode, answering with success,
but only switches its other modes off. The screensaver is then left
without any mode at all. Only pick a mode the device reports.

Streaming is not available on an LM 37X8 TIME on firmware 2.3.9, which
reports API 2.3.0 and answers the stream endpoints with a 404. The
docstring claimed API 2.3.0 was enough. The stream example now checks
whether the device lists the stream endpoints first.
@frenck frenck added the documentation Solely about the documentation of the project. label Oct 3, 2026
@frenck
frenck merged commit 3f3033f into main Oct 3, 2026
32 checks passed
@frenck
frenck deleted the frenck/document-device-limits branch October 3, 2026 12:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Solely about the documentation of the project.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant