The panel now pairs, fetches its image and files its logs against this application rather than against the TRMNL cloud. Four endpoints: /api/setup issues a token on first contact, /api/display hands back an image and a wake interval, /api/log stores firmware diagnostics, and /api/device/image/<hash> serves the bytes. The wake interval is where freshness and battery are traded off. In BYOS nothing can be pushed: the device sleeps, wakes, asks and sleeps again. So the interval is short while the shop trades and long overnight, and it is shortened further whenever a change of state falls inside it — the door opening in twenty minutes means waking in twenty-one, whatever the base interval says. The image filename is the hash of its own bytes. The firmware skips the redraw when the name is unchanged, which is the whole battery strategy, and the URL is immutable, unguessable and safe to cache forever. Two integration tests pin this: unchanged data must yield the same filename and store one row, changed hours must yield a different one. MAC addresses are normalised before use. They are a primary key here, and firmwares are inconsistent about case and separators; without this a panel could register twice by capitalising itself differently. Header names are read in both the hyphen and underscore spellings for the same reason — the TRMNL docs and the Seeed sources disagree, and being liberal costs nothing while being wrong costs a blank shop window. Pairing is deliberately made to survive a rendering failure. The token is issued once and only its digest is kept, so a device stranded by a failed response would be registered yet hold no credential, and unable to register again. The welcome image is worth far less than that. This was found by running the flow, not by reading it. satori, yoga and harfbuzz are marked external: bundling rewrites the relative path satori uses to load its WebAssembly, and the renderer dies on a missing hb.wasm. The integration tests run against a real Postgres, in CI too. Mocking Prisma here would only prove the mock works. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012cSY9pVhZmJUKNN7wf1Myd
77 lines
2.5 KiB
TypeScript
77 lines
2.5 KiB
TypeScript
/**
|
|
* How long to let the panel sleep.
|
|
*
|
|
* In BYOS there is no way to push: the device sleeps, wakes, asks, and sleeps
|
|
* again. The only lever is how long it sleeps for, so this is the entire
|
|
* freshness-versus-battery trade-off of the product, in one function.
|
|
*
|
|
* Two rules:
|
|
* - sleep briefly while the shop is trading, and at length overnight;
|
|
* - never sleep through a change of state. If the door opens in twenty
|
|
* minutes, wake in twenty-one, whatever the base interval says.
|
|
*/
|
|
|
|
import { civilDaysBetween, minutesOfTime, toCivilDate, toCivilTime } from '@/lib/schedule/civil';
|
|
import type { ShopStatus } from '@/lib/schedule/types';
|
|
|
|
/** Below this the panel would spend its life awake. */
|
|
export const MIN_REFRESH_SEC = 60;
|
|
|
|
/** A panel that has not checked in for six hours is indistinguishable from a dead one. */
|
|
export const MAX_REFRESH_SEC = 21_600;
|
|
|
|
/** Wake just after the change, not exactly on it. */
|
|
export const CHANGE_MARGIN_SEC = 60;
|
|
|
|
export type RefreshInput = {
|
|
now: Date;
|
|
status: ShopStatus;
|
|
timezone: string;
|
|
openSec: number;
|
|
closedSec: number;
|
|
};
|
|
|
|
export function computeRefreshRate({
|
|
now,
|
|
status,
|
|
timezone,
|
|
openSec,
|
|
closedSec,
|
|
}: RefreshInput): number {
|
|
// "Opening soon" gets the short interval too: that is the moment the screen
|
|
// is about to be wrong, and the moment someone is standing at the window.
|
|
const busy =
|
|
status.status === 'OPEN' || status.status === 'CLOSING_SOON' || status.status === 'OPENING_SOON';
|
|
|
|
let seconds = busy ? openSec : closedSec;
|
|
|
|
if (status.nextChangeAt) {
|
|
const untilChange = secondsUntil(now, status.nextChangeAt, timezone);
|
|
if (untilChange > 0) {
|
|
seconds = Math.min(seconds, untilChange + CHANGE_MARGIN_SEC);
|
|
}
|
|
}
|
|
|
|
return clamp(Math.round(seconds));
|
|
}
|
|
|
|
function clamp(seconds: number): number {
|
|
return Math.min(MAX_REFRESH_SEC, Math.max(MIN_REFRESH_SEC, seconds));
|
|
}
|
|
|
|
/**
|
|
* Seconds from now until a wall-clock moment.
|
|
*
|
|
* Measured on the wall clock, which is off by an hour on the two nights a year
|
|
* the clocks change. That only shifts one wake-up, and the alternative — a
|
|
* real timezone conversion back to an instant — buys nothing the panel can
|
|
* perceive.
|
|
*/
|
|
function secondsUntil(now: Date, target: { date: string; time: string }, timezone: string): number {
|
|
const today = toCivilDate(now, timezone);
|
|
const nowMinutes = minutesOfTime(toCivilTime(now, timezone));
|
|
const days = civilDaysBetween(today, target.date);
|
|
const minutes = days * 1440 + minutesOfTime(target.time) - nowMinutes;
|
|
return minutes * 60 - now.getUTCSeconds();
|
|
}
|