Glossary

The platform is built from a small set of generic concepts. Learn these and the rest of the docs falls into place.

Tenancy & access

Organization — the tenant root; everything is scoped to one organization and isolated by row-level security.
OrganizationMember / Invitation — human access to an organization, with roles (owner, admin, member).
ApiKey — a machine credential (sk_-prefixed) for calling the API.

Site — a location grouping of devices.
DeviceGroup — a tag-based grouping of devices.
Device — a physical or virtual unit that reports data.
Component — an addressable sub-unit of a device, bound to a SensorProfile.
Sensor — a typed data channel on a device or component.
Reading — a timestamped value, stored in a time-series hypertable with typed value columns.
DeviceHealth — an uptime, memory, signal-strength, and connection snapshot.

DeviceRegistrationToken — a one-time token a device exchanges for a certificate identity.
Firmware / FirmwareDownloadToken — a versioned firmware artifact and a short-lived download grant.
Command — an instruction to a device with an acknowledgement lifecycle: pending → sent → acknowledged → success (or failed / timeout).

DeviceProfile — a declarative device type: its components and writable fields.
SensorProfile — a versioned, typed schema (units, ranges) for a sensor channel.
Schema — the versioned-schema concept, realized by profiles and exported as DTDL JSON-LD.
ConfigArtefact — an immutable, versioned config blob validated against a profile schema.
DesiredStateBinding — an assignment of a ConfigArtefact to a target, with reported state tracked back.

AlertRule — a condition on a sensor; firings are recorded as events.
Event / EventLifecycle — the generic event log; the lifecycle adds an active → acknowledged → resolved workflow.
NotificationChannel — an email or webhook delivery target.

AnnotationClass — a schema defining a labelable category and its scope.
Annotation — an applied label on a scope, at a point or over a range, from a person or the system.
JobDefinition — a declarative, scheduled analytics computation, installed as data.
ReferencePair — a primary/reference component pairing consumed by analytics jobs.

Dashboard / Widget — a visualization layout and its registered panels.
Camera / MediaCapture / MediaCaptureRule / DvrClipRequest — the media-capture stack.
LiveSession — an operator-brokered live stream of a camera.
ExportJob — an asynchronous bulk export of readings and annotations.
PayloadQuarantine — rejected ingest payloads, parked for review.

Pack — a per-organization bundle of profiles, schemas, jobs, alerts, and dashboards that installs a use case. An installed pack is recorded as an InstalledPack.