Get Device Specification

Last Updated on : 2023-06-20 15:21:53download

Get the specifications and properties of a specified device by device ID, including the instruction set and status set.

API address

GET: /v1.2/iot-03/devices/{device_id}/specification

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	The device ID.

Return parameter

Parameter name	Type	Description
result	FunctionStatusToLangRes	The returned result.

Description of result

Parameter name	Type	Description
category	String	The category of a specified product.
status	List	The standard status set.
functions	List	The standard instruction set.

Description of functions

Parameter name	Type	Description
code	String	The code of a specified device instruction.
type	String	The type of a specified device instruction.
name	String	The name of a specified device instruction.
values	String	The value description of a specified device instruction.
lang_config	Map<String,String>	The multilingual description.

Description of status

Parameter name	Type	Description
code	String	The code of specified device status.
type	String	The type of specified device status.
name	String	The name of specified device status.
values	String	The value description of specified device status.
lang_config	Map<String,String>	The multilingual description.

Request example

GET: /v1.2/iot-03/devices/****id/specification

Return example

{
    "result": {
        "functions": [
            {
                "code": "switch",
                "values": "{}",
                "lang_config": {
                    "false": "Off",
                    "true": "On"
                },
                "type": "Boolean",
                "name": "Switch"
            },
            {
                "code": "temp_set",
                "values": "{\"unit\":\"℃\",\"min\":0,\"max\":37,\"scale\":0,\"step\":1}",
                "lang_config": {
                    "unit": "°C"
                },
                "type": "Integer",
                "name": "Target Temperature"
            }
        ],
        "category": "qn",
        "status": [
            {
                "code": "switch",
                "values": "{}",
                "lang_config": {
                    "false": "Off",
                    "true": "On"
                },
                "type": "Boolean",
                "name": "Switch"
            },
            {
                "code": "temp_set",
                "values": "{\"unit\":\"℃\",\"min\":0,\"max\":37,\"scale\":0,\"step\":1}",
                "lang_config": {
                    "unit": "°C"
                },
                "type": "Integer",
                "name": "Target Temperature"
            },
            {
                "code": "temp_current",
                "values": "{\"unit\":\"℃\",\"min\":-20,\"max\":50,\"scale\":0,\"step\":1}",
                "lang_config": {
                    "unit": "°C"
                },
                "type": "Integer",
                "name": "Current Temperature"
            }
        ]
    },
    "t": 1639022337569,
    "success": true
}

Error code

For more information, see error code.

Prev DocGet Device Information

Next DocGet Extended Properties in Bulk