Technical documentation

How this engineering documentation set is organised, why it is English-only, and how to read applicability, method and limits without assuming a parameter we have not published.

The minimal commissioning path for a local-first LoRa switching site, in order, with the preconditions and the failure modes to check before moving on.

A selection method for matching a load, an enclosure and an interface requirement to a model page, without publishing a parameter that has not been signed off.

The four layers of a local-first LoRa switching site, the role of each layer, and the failure mode each layer is designed to hold.

How to survey a site for LoRa link closure, why a single range figure is not published, and what changes a link after commissioning.

Preparing a private gateway or edge controller: local power, local interface, node registry and the order in which a site is brought up without depending on the uplink.

How endpoints are paired into the gateway registry, how identity is assigned and persisted, and the failure modes to check when a device is reachable but not registered.

Which behaviour must resolve on the edge, how a site is tested for local-first operation, and what degrades — and does not — when the uplink is lost.

The shape of the gateway's local API and event contract — resources, error model, idempotency and delivery — with the authoritative field list owned by a second team in contracts/openapi.yaml.

Which field protocols the edge controller exposes, the shape of each contract, and where the authoritative topic and register definitions live — without inventing a topic tree or a register table.

Preparing for, applying and verifying a firmware update on a local-first site, including the revision check that must happen before and after the update.

The access boundaries of a local-first site, why the local management path must not be exposed to the internet, and how roles, credentials and updates are handled.

An ordered fault-isolation procedure for a local-first site, from the load outward, so an intermittent link, a missing registry entry and a remote-resolved rule can be told apart.

How a market's radio authorisation and electrical approvals determine what may be offered, why they are per-market and per-model, and where a certificate identifier comes from.

What this documentation revision covers, what has changed since the previous revision, and why no firmware version identifier is listed until it has been released.