Skip to content

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

FieldTypeRequiredDescription
relaysarray<RelayState>NoRelay output list. See Relay Outputs
digitalInputsarray<DigitalInputState>NoDigital input list. See Digital Inputs
sensorsarray<SensorState>NoSensor reading list. See Sensor Readings
analogInputsarray<AnalogInputState>NoAnalog 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 peripherals as one complete peripheral-state object.
  • A single sensor interface may return multiple readings at the same index.
  • Use index + type to identify one sensor reading.
  • Use index as the primary key for relay outputs, digital inputs, and analog inputs.
Docs buildVersion v1.2.19-20260602-174859-60
Copyright © 2026 WLTE