ym88659208ym87991671
User device (device) | Documentation SmartMarket
Skip to main content

User device (device)

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

FieldTypeMandatory?Description
idstring✔︎Device ID in the vendor's system
parent_idstringID of parent device (e.g. hub)
namestring✔︎Device name given by the user
default_namestring✔︎Device name from the manufacturer
nicknameslist<string>Alternative device names
homestringName of the room group in which the device is located
roomstringName of the room in which the device is located
groupslist<string>Names of the groups the device belongs to. A group can only include devices of the same type
model_idstring✔︎*Device model ID (*only specified if model is not specified)
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_versionstringEquipment version
sw_versionstringFirmware 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
}