Get the instructions set by category

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

Query the instruction set by category. This instruction set is the most comprehensive instruction set under the Tuya public version category and can be used as a reference for developers. If you are a platform developer, it is recommended to follow this category for development and docking.

API address

GET: /v1.0/functions/{category}

Request parameter

Parameter name	Type	IN	Required	Description
category	String	uri	true	Product Category

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	Command name
desc	String	Description
code	String	Command
type	String	Command Type
values	String	Command into the parameter range

Request example

GET: /v1.0/fucntions/kg

Return example

{
    "result": {
        "functions": [
            {
                "code": "switch",
                "values": "{}",
                "type": "Boolean",
                "name": "switch",
                "desc": "Global switch equals true, open all. Global switch equals false, close all."
            }
        ],
        "category": "kg"
    },
    "t": 1571293457435,
    "success": true
}

Error code

For more information, see error code.