ym88659208ym87991671
Device model (model) | Documentation for developers
Skip to main content

Device model (model)

Last updated on August 26, 2022

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

FieldTypeMandatory?Description
idstring✔︎Model ID (often product_id)
manufacturerstring✔︎Manufacturer
modelstring✔︎Full model name
hw_versionstringEquipment version
sw_versionstringFirmware version
descriptionstringDescription
categorystring✔︎Device category (see Devices)
featureslist<string>✔︎List of functions (see Device functions)
dependenciesmap<string, object>Function dependencies (see Function dependencies (dependencies)
allowed_valuesmap<string, object>Allowed values of functions (see Allowed values of functions (allowed_values))
{
"id": string,
"manufacturer": string,
"model": string,
"hw_version": string,
"sw_version": string,
"description": string,
"category": string,
"features": [
string,
string,
// ...
],
"dependencies": {
"func_name": {
"key": string,
"value": [
{
"type": string,
"type_value": object
},
{
// ...
}
]
}
},
"allowed_values": {
"func_name": {
"type": string,
"type_values": {
"min": object,
"max": object,
"step": object
},
},
{
// ...
}
}
}