User device (device)

The structure describes specifications and functions of the model of a device, such as a lamp or a socket.

Field Type Mandatory? Description
id string ✔︎ Device ID in the vendor's system
parent_id string ID of parent device (e.g. hub)
name string ✔︎ Device name given by the user
default_name string ✔︎ Device name from the manufacturer
nicknames list<string> Alternative device names
home string Name of the room group in which the device is located
room string Name of the room in which the device is located
groups list<string> Names of the groups the device belongs to. A group can only include devices of the same type
model_id string ✔︎ Device model ID
model <object> ✔︎ Device model description (only specified if model_id is not specified). For the structure of the model description, see Device model (model)
hw_version string Equipment version
sw_version string Firmware version
{
  "id": string,
  "parent_id": string,
  "name": string,
  "default_name": string,
  "nicknames": [
    string,
    string,
    // ...
  ],
  "home": string,
  "room": string,
  "groups": [
    string,
    string,
    // ...
  ],
    "model_id": string,
    "hw_version": string,
    "sw_version": string
}