Get Instruction Sets in Bulk

Last Updated on : 2023-12-07 03:33:53download

Get the instruction sets of up to 20 devices.

API address

GET: /v1.0/devices/functions

Request parameter

Parameter name	Type	IN	Required	Description
device_ids	String	query	false	The list of up to 20 device IDs, separated with commas (,).

Return parameter

Parameter name	Type	Description
result	List	The collection of devices, instructions, and categories.

Description of result

Parameter name	Type	Description
category	String	The product category.
functions	List	The instruction set.
devices	List	The list of device IDs.

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.

Description of devices

Parameter name	Type	Description
devices	String	The device ID.

Request example

GET: /v1.0/devices/functions?device_ids=vdevo168****14179625,vdevo16****2860414179

Return example

{
    "functions": [
        {
            "code": "switch_1",
            "values": "{}",
            "type": "Boolean",
            "name": "Switch 1",
            "desc": "Switch 1"
        },
        {
            "code": "countdown_1",
            "values": "{\"unit\":\"s\",\"min\":0,\"max\":86400,\"scale\":0,\"step\":1}",
            "type": "Integer",
            "name": "Switch 1 Countdown",
            "desc": "The countdown of Switch 1"
        },
        {
            "code": "switch_led",
            "values": "{}",
            "type": "Boolean",
            "name": "Switch",
            "desc": "Switch"
        },
        {
            "code": "remote_id",
            "values": "{}",
            "type": "string",
            "name": "Remote Control ID",
            "desc": "The ID of the specified remote control"
        },
        {
            "code": "mode",
            "values": "{\"range\":[\"cold\",\"warm\",\"auto\",\"air\",\"dehumid\"]}",
            "type": "Enum",
            "name": "Mode",
            "desc": "The mode"
        },
        {
            "code": "target_temp",
            "values": "{\"min\":0,\"max\":100,\"scale\":1,\"step\":1}",
            "type": "Integer",
            "name": "Target Temperature",
            "desc": "The target temperature"
        },
        {
            "code": "fan_level",
            "values": "{\"range\":[\"auto\",\"low\",\"middle\",\"high\"]}",
            "type": "Enum",
            "name": "Wind speed",
            "desc": "The wind speed"
        },
        {
            "code": "control",
            "values": "{\"range\":[\"send_ir\",\"study\",\"study_exit\",\"study_key\"]}",
            "type": "Enum",
            "name": "Device Control",
            "desc": "The device control"
        }
    ],
    "devices": [
        "vdevo16****414179",
        "vdevo168****4179625"
    ],
    "category": "zigbeekt"
}

Error code

For more information, see error code.