设备控制

您可以使用以下 API 来控制您的设备。

API 列表

请求方式	API	说明
POST	/v1.0/illumination/devices/{deviceId}/dps	设备单控
POST	/v1.0/illumination/devices/dps/multidev	设备多控
POST	/v1.0/illumination/devices/dps/group	设备群组控制
POST	/v1.0/cloud/illume/device/send/query-state-cmd	上报 DP 状态

设备单控

功能说明

根据设备 ID，控制指定的单个设备。

接口地址

POST /v1.0/illumination/devices/{deviceId}/dps

请求参数

参数名	类型	参数类型	说明	是否必填
projectId	String	body	所属项目 ID	是
deviceId	String	url	设备 ID	是
dpCode	String	body	控制 DP 指令 Code	是
dpValue	String	body	控制 DP 指令	是

返回参数

参数名	类型	说明
code	Integer	响应码，详情请参考 错误码 章节，成功时为空
success	Boolean	是否成功 true：成功 false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回的 13 位时间戳
result	Object	返回结果

result 参数说明

{
  "message": "是否成功",
  "action": "行为"
}

请求示例

{
  "dpValue": "控制 DP 指令",
  "dpCode": "控制 DP 指令 Code",
  "projectId": "所属项目 ID",
  "deviceId": "设备 ID"
}

响应示例

{
  "message": "SUCCESS",
  "action": "设备单控"
}

设备多控

功能说明

根据设备 ID 列表，一次控制多个设备。

接口地址

POST /v1.0/illumination/devices/dps/multidev

请求参数

参数名	类型	参数类型	说明	是否必填
projectId	String	body	项目 ID	是
deviceIds	String[]	body	设备 ID 列表	是
dpCode	String	body	控制 DP 指令 Code	是
dpValue	String	body	控制 DP 指令	是

返回参数

参数名	类型	说明
code	Integer	响应码，详情请参考 错误码 章节，成功时为空
success	Boolean	是否成功 true：成功 false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回的 13 位时间戳
result	Object	返回结果

result 参数说明

{
  "message": "是否成功",
  "action": "行为"
}

请求示例

{
  "dpValue": "",
  "workMode": "",
  "dpCode": "",
  "projectId": ""
}

响应示例

{
  "message": "SUCCESS",
  "action": "设备多控"
}

设备群组控制

功能说明

控制设备群组。

接口地址

POST /v1.0/illumination/devices/dps/group

请求参数

参数名	类型	参数类型	说明	是否必填
projectId	String	body	所属项目 ID	是
roomId	String	body	所属房间 ID	是
dpCode	String	body	控制 DP 指令 Code	是
dpValue	String	body	控制 DP 指令	是

返回参数

参数名	类型	说明
code	Integer	响应码，详情请参考 错误码 章节，成功时为空
success	Boolean	是否成功 true：成功 false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回的 13 位时间戳
result	Object	返回结果

result 参数说明

{
  "message": "是否成功",
  "action": "行为"
}

请求示例

{
  "dpValue": "",
  "workMode": "",
  "dpCode": "",
  "projectId": "",
  "roomId": ""
}

响应示例

{
  "message": "SUCCESS",
  "action": "设备群控"
}

上报 DP 状态

功能描述

使指定的设备主动上报 DP 状态。

接口地址

POST /v1.0/cloud/illume/device/send/query-state-cmd

请求参数

参数名	类型	参数类型	说明	是否必需
deviceId	String	body	设备 ID	true
dpCodes	List	body	DP Code 集合	False

返回参数

参数名	类型	说明
code	Integer	响应码，详情请参考 错误码 章节，成功时为空
success	Boolean	是否成功 true：成功 false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回的 13 位时间戳
result	Boolean	是否成功 true：成功 false：失败

result 参数说明

{
  true/false
}

请求示例

{
  "deviceId": "",
  "dpCodes": [
    "add_ele",
    "runtime"
  ]
}

响应示例

{
  "result": true,
  "success": true,
  "t": 1717673899783,
  "tid": "d9517952c7579d3d"
}

错误码

以下为该接口常见的业务异常。更多的异常错误，参考 全局错误码。

错误码	说明
500	系统错误
1106	非法权限