Get Instruction Set Supported by Device

Last Updated on : 2024-01-11 05:59:58download

Query the functions supported by the specified device, and the obtained instructions can be sent to control the device.

API address

GET: /v1.0/devices/{deviceId}/functions

Request parameter

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

Return parameter

Parameter name	Type	Description
result	FunctionRes	The returned result.

Description of result

Parameter name	Type	Description
category	String	The product category.
functions	List	The instruction set.

Description of functions

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

Request example

GET: /v1.0/devices/0123******/functions

Return example

{
    "functions": [
        {
            "code": "switch_led",
            "values": "{}",
            "type": "Boolean",
            "name": "Switch",
            "desc": "LED Switch"
        }
    ],
    "category": "dj"
}

Error code

For more information, see error code.