Linkage conditions for obtaining family support

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

Acquire linkage conditions or standard function points for performing actions based on the family ID.

API address

GET: /v1.0/homes/{home_id}/enable-linkage/codes

Request parameter

Parameter name	Type	IN	Required	Description
home_id	String	uri	true	Family ID

Return parameter

Parameter name	Type	Description
result	List	Return parameter description

Description of result

Parameter name	Type	Description
device_id	String	Device ID
functions	List	Action performed
status	List	Operation trigger conditions

Description of functions

Parameter name	Type	Description
code	String	Standard issued instruction Code
name	String	Code Name
type	String	Data type issued
values	Map	The value range corresponding to Code

Description of status

Parameter name	Type	Description
code	String	Standard issued instruction Code
name	String	Code Name
type	String	Data type issued
values	Map	The value range corresponding to Code

Description of values

Parameter name	Type	Description
values	String

Request example

GET: /v1.0/homes/52323****/enable-linkage/codes

Return example

[
    {
        "device_id": "0120090568c63a89****",
        "functions": [
            {
                "code": "bright_value",
                "values": {
                    "max": 255,
                    "scale": 0,
                    "type": "value",
                    "unit": "",
                    "min": 25,
                    "step": 1
                },
                "type": "Integer",
                "name": "Brightness"
            }
        ],
        "status": [
            {
                "code": "work_mode",
                "values": {
                    "range": [
                        "white",
                        "colour",
                        "scene",
                        "scene_1",
                        "scene_2",
                        "scene_3",
                        "scene_4"
                    ],
                    "type": "Enum"
                },
                "type": "Enum",
                "name": "Mode"
            }
        ]
    }
]

Error code

For more information, see error code.