Get the instruction set of the device

Last Updated on : 2024-06-28 23:17:31download

Get the instruction set of the device by the device ID.

API address

GET: /v1.0/iot-03/devices/{device_id}/functions

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	Device ID

Return parameter

Parameter name	Type	Description
result	FunctionRes

Description of result

Parameter name	Type	Description
category	String	Product category
functions	List	Instruction set

Description of functions

Parameter name	Type	Description
name	String	Instruction name
desc	String	Description
code	String	Instruction
type	String	Instruction type
values	String	The input parameter range of the instruction

Request example

GET: /v1.0/iot-03/devices/0123xxxxxx/functions

Return example

{
    "result": {
        "functions": [
            {
                "code": "switch_led",
                "values": "{}",
                "type": "Boolean",
                "name": "Switch",
                "desc": "Switch"
            }
        ],
        "category": "dj"
    },
    "t": 1591872112140,
    "success": true
}

Error code

For more information, see error code.

Prev DocSend Command

Next DocGet Device Specification and Attribute