Type Alias SensorDeclaration

Declaration of a read-only reading. Declarative only, so a dashboard can place a widget before any telemetry has arrived; it takes no commands.

type SensorDeclaration = {
    key: string;
    metric: string;
    type: "sensor";
    unit?: string;
}

Properties

key: string

Capability key, unique per device; must survive an MQTT topic level unescaped.

metric: string

The metric name this sensor reports.

type: "sensor"

Discriminant for a read-only reading.

unit?: string

Display unit, e.g. "celsius".