feat: serve the BYOS device API
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
This commit is contained in:
@@ -0,0 +1,45 @@
|
||||
/**
|
||||
* Environment access, in one place so nothing else has to guess.
|
||||
*/
|
||||
|
||||
/**
|
||||
* The origin the device and the browser reach us on.
|
||||
*
|
||||
* Prefers what the request actually arrived as, because the panel has to be
|
||||
* handed a URL it can fetch — a mismatch here shows up as a blank screen in a
|
||||
* shop window, which is the most expensive place to debug. Falls back to the
|
||||
* configured domain for calls that have no request, such as background jobs.
|
||||
*/
|
||||
export function publicBaseUrl(request?: Request): string {
|
||||
if (request) {
|
||||
const host = request.headers.get('x-forwarded-host') ?? request.headers.get('host');
|
||||
if (host) {
|
||||
const proto = request.headers.get('x-forwarded-proto') ?? new URL(request.url).protocol.replace(':', '');
|
||||
return `${proto}://${host}`;
|
||||
}
|
||||
}
|
||||
|
||||
const configured = process.env.NEXTAUTH_URL;
|
||||
if (configured) {
|
||||
return configured.replace(/\/$/, '');
|
||||
}
|
||||
|
||||
const domain = process.env.APP_DOMAIN;
|
||||
if (domain) {
|
||||
return domain.startsWith('http') ? domain.replace(/\/$/, '') : `https://${domain}`;
|
||||
}
|
||||
|
||||
return 'http://localhost:3000';
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether the panel may talk to us over plain HTTP.
|
||||
*
|
||||
* Off by default. It exists because these ESP32 firmwares sometimes fail on a
|
||||
* certificate chain, and a shop with a blank window needs a way out that does
|
||||
* not involve reflashing. The device token is separate and revocable precisely
|
||||
* so this switch stays survivable.
|
||||
*/
|
||||
export function deviceAllowsHttp(): boolean {
|
||||
return process.env.DEVICE_ALLOW_HTTP === 'true';
|
||||
}
|
||||
Reference in New Issue
Block a user