设备管理

设备模块

获取设备详情

请求地址
action: industry.device.info

params请求参数

参数名	类型	说明	是否必填
device_id	String	设备 ID	是

请求示例

{
    "action":"industry.device.info",
    "access_token": "xxxxxx",
    "params":{
        "device_id":"101120xxxxf3eb7da61f"
    }
}

响应参数

参数名	类型	说明
code	Integer	响应码，成功为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
t	String	响应时间戳
result	Object	返回结果，失败为空

result说明

参数名	类型	说明
id	String	设备 ID
uuid	String	设备 UUID
category	String	产品品类
name	Integer	设备名称
product_id	Integer	产品 ID
product_name	String	产品名称
local_key	String	密钥
sub	Boolean	是否为子设备
asset_id	String	资产 ID
ip	String	设备 IP
lon	String	经度
lat	String	纬度
model	String	产品型号
time_zone	String	时区
active_time	Long	激活时间
update_time	Long	更新时间
create_time	Long	初次配网时间
online	Boolean	在线状态
icon	String	设备图标

修改设备信息

请求地址
action: industry.device.update

params请求参数

参数名	类型	说明	是否必填
device_id	String	设备 ID	是
name	String	设备名称	是

请求示例

{
    "action":"industry.device.update",
    "access_token": "xxxxxx",
    "params":{
        "device_id":"101120xxxxf3eb7da61f",
        "name":"香薰机"
    }
}

响应参数

参数名	类型	说明
code	Integer	响应码，成功为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
t	String	响应时间戳
result	Boolean	返回结果，失败为空

删除设备

请求地址
action: industry.device.delete

params请求参数

参数名	类型	说明	是否必填
device_id	String	设备 ID	是

请求示例

{
    "action":"industry.device.delete",
    "access_token": "xxxxxx",
    "params":{
        "device_id":"101120xxxxf3eb7da61"
    }
}

响应参数

参数名	类型	说明
code	Integer	响应码，成功为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
t	String	响应时间戳
result	Boolean	返回结果，失败为空

批量移除设备

请求地址
action: industry.device.batch.delete

params请求参数

参数名	类型	说明	是否必填
device_ids	String	设备 ID 列表，以半角逗号（,）隔开	是

请求示例

{
    "action":"industry.device.batch.delete",
    "access_token": "xxxxxx",
    "params":{
        "device_ids":"101120xxxxf3eb7da61f"
    }
}

响应参数

参数名	类型	说明
code	Integer	响应码，成功为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
t	String	响应时间戳
result	Boolean	返回结果，失败为空

设备恢复出厂设置

请求地址
action: industry.device.restore.setting

params请求参数

参数名	类型	说明	是否必填
device_id	String	设备 ID	是

请求示例

{
    "action":"industry.device.restore.setting",
    "access_token": "xxxxxx",
    "params":{
        "device_id":"101120xxxxf3eb7da61f"
    }
}

响应参数

参数名	类型	说明
code	Integer	响应码，成功为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
t	String	响应时间戳
result	Boolean	返回结果，失败为空

获取设备标准状态

请求地址
action: industry.device.status

params请求参数

参数名	类型	说明	是否必填
device_id	String	设备 ID	是

请求示例

{
    "action":"industry.device.status",
    "access_token": "xxxxxx",
    "params":{
        "device_id":"101120xxxxf3eb7da61f"
    }
}

响应参数

参数名	类型	说明
code	Integer	响应码，成功为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
t	String	响应时间戳
result	List	返回结果，失败为空

result说明

参数名	类型	说明
code	Integer	状态码
value	Object	状态值

批量获取设备标准状态

请求地址
action: industry.device.batch.status

params请求参数

参数名	类型	说明	是否必填
device_ids	String	设备 ID 列表，以半角逗号（,）隔开	是

请求示例

{
    "action":"industry.device.batch.status",
    "access_token": "xxxxxx",
    "params":{
        "device_ids":"101120xxxxf3eb7da61f"
    }
}

响应参数

参数名	类型	说明
code	Integer	响应码，成功为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
t	String	响应时间戳
result	Object	返回结果，失败为空

result说明

参数名	类型	说明
id	String	设备 ID
status	List	设备状态列表

status说明

参数名	类型	说明
code	String	状态码
value	Object	状态值

获取设备支持的指令集

请求地址
action: industry.device.functions

params请求参数

参数名	类型	说明	是否必填
device_id	String	设备 ID	是

请求示例

{
    "action":"industry.device.functions",
    "access_token": "xxxxxx",
    "params":{
        "device_id":"101120xxxxf3eb7da61f"
    }
}

响应参数

参数名	类型	说明
code	Integer	响应码，成功为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
t	String	响应时间戳
result	Object	返回结果，失败为空

result说明

参数名	类型	说明
category	String	产品品类
functions	List	指令集

functions说明

参数名	类型	说明
name	String	指令名称
desc	String	描述
code	String	指令
type	String	指令类型
values	String	指令入参范围

获取品类支持的指令集

请求地址
action: industry.device.category.functions

params请求参数

参数名	类型	说明	是否必填
category	String	产品类别	是

请求示例

{
    "action":"industry.device.category.functions",
    "access_token": "xxxxxx",
    "params":{
        "category":"xx"
    }
}

响应参数

参数名	类型	说明
code	Integer	响应码，成功为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
t	String	响应时间戳
result	Object	返回结果，失败为空

result说明

参数名	类型	说明
category	String	产品品类
functions	List	指令集

functions说明

参数名	类型	说明
name	String	指令名称
desc	String	描述
code	String	指令
type	String	指令类型
values	String	指令入参范围

获取设备规格属性（包含指令集、状态集）

请求地址
action: industry.device.functions.status

params请求参数

参数名	类型	说明	是否必填
device_id	String	设备 ID	是

请求示例

{
    "action":"industry.device.functions.status",
    "access_token": "xxxxxx",
    "params":{
        "device_id":"101120xxxxf3eb7da61f"
    }
}

响应参数

参数名	类型	说明
code	Integer	响应码，成功为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
t	String	响应时间戳
result	Object	返回结果，失败为空

result说明

参数名	类型	说明
category	String	产品品类
functions	List	指令集
status	List	状态集

functions说明

参数名	类型	说明
name	String	指令名称
desc	String	描述
code	String	指令
type	String	指令类型
values	String	指令入参范围

status说明

参数名	类型	说明
name	String	状态名称
code	String	状态码
type	String	类型
values	String	入参范围

设备指令下发

请求地址
action: industry.device.execute.commands

params请求参数

参数名	类型	说明	是否必填
device_id	String	设备 ID	是
commands	List	下发指令	是
validity	Long	DP 缓存时间	否

commands说明

参数名	类型	说明	是否必填
code	String	下发的标准指令码	是
value	Object	下发的指令值	是

请求示例

{
    "action":"industry.device.execute.commands",
    "access_token": "xxxxxx",
    "params":{
        "device_id":"101120xxxxf3eb7da61f",
        "commands":[
            {
                "code":"switch",
                "value":true
            }
        ],
        "validity":xx
    }
}

响应参数

参数名	类型	说明
code	Integer	响应码，成功为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功为空
t	String	响应时间戳
result	Boolean	返回结果，失败为空