Peripheral State Reference
In Get Device, List Devices, and WebSocket device-state messages, peripherals contains the current peripheral state returned for a device.
peripherals is a peripheral-state container. It groups relay outputs, digital inputs, sensor readings, analog input readings, and other peripheral data under one object so clients can render device state by capability.
peripherals Field
| Field | Type | Required | Description |
|---|---|---|---|
relays | array<RelayState> | No | Relay output list. See Relay Outputs |
digitalInputs | array<DigitalInputState> | No | Digital input list. See Digital Inputs |
sensors | array<SensorState> | No | Sensor reading list. See Sensor Readings |
analogInputs | array<AnalogInputState> | No | Analog input reading list. See Analog Input Readings |
Reading Rules
- A field may be omitted when the device does not support that capability.
- Unless an endpoint says otherwise, treat
peripheralsas one complete peripheral-state object. - A single sensor interface may return multiple readings at the same
index. - Use
index + typeto identify one sensor reading. - Use
indexas the primary key for relay outputs, digital inputs, and analog inputs.
