AI 自适应感应

更新时间:2023-04-25 02:37:29下载pdf

AI 自适应感应是一款基于云端 AI 算法,自动调整传感器控制灯光保持时长的应用。通过对传感器所安装环境的感应历史数据计算,以一定的周期频率,自动调整传感器的延迟关灯时间,使传感器控制更贴近现场使用场景,提高用户体验。

请求方式 API 描述
POST /v1.0/illumination/aisensing/deivce/batch 批量增加设备
POST /v1.0/illumination/aisensing/deivce/remove 批量删除设备
GET /v1.0/illumination/aisensing/deivce/page 分页查询列表
POST /v1.0/illumination/aisensing/deivce/removeHirshory 批量删除历史数据
GET /v1.0/illumination/aisensing/config 查询自适应感应算法的状态
POST /v1.0/illumination/aisensing/config 修改自适应感应算法的状态
GET /v1.0/illumination/aisensing/listPIRDeviceByRoomId 根据房间和项目查询可用设备
GET /v1.0/illumination/aisensing/project/roomTree 获取项目下的空间树形结构(只查询传感设备)

查询自适应感应算法的状态

功能描述

从项目维度查询自适应感应算法的当前状态,每个项目中只有一个算法开关配置。

接口地址

GET /v1.0/illumination/aisensing/config

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID true

返回参数

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

Result 说明

参数名 类型 说明
algorithmSwitch Boolean AI 自适应感应算法开关
projectId String 项目 ID

请求示例

{
  "projectId": "sadad2313s****"
}

响应示例

{
  "algorithmSwitch": true,
  "projectId": "sadad2313sadad"
}

修改自适应感应算法的状态

功能描述

修改自适应感应算法的状态,维护算法的开启和关闭状态。关闭后,云端将不会再下发对设备池内感应设备的延时控制。

接口地址

POST /v1.0/illumination/aisensing/config

请求参数

参数名 类型 参数类型 说明 是否必需
algorithmSwitch boolean body 算法开关(T=开启,F=关闭) true
projectId String body 项目 ID true

返回参数

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

请求示例

{
  "algorithmSwitch": "false",
  "projectId": "231312313"
}

响应示例

true

分页查询列表

功能描述

分页查询列表,即查询当前项目的AI算法池设备列表,项目 ID为必填项,支持空间ID的条件查询,支持多语言文案返回。

接口地址

GET /v1.0/illumination/aisensing/deivce/page

请求参数

参数名 类型 参数类型 说明 是否必需
pageSize int body 每页数量 false
pageNo int body 页码 false
projectId String body 项目 ID true
roomId String body 空间ID false
lang String body 多语言代码; false

返回参数

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

Result 说明

参数名 类型 说明
total Integer 总数
list List 列表
deviceId String 设备 ID
deviceType String 设备类型
deviceName String 设备名称
projectId String 项目 ID
roomId String 房间 ID
roomName Stirng 房间名称
validTime String 校验时间
bizCode String 业务编码
gmtCreate String 创建时间
gmtModified String 修改时间

请求示例

{
  "lang": "zh",
  "projectId": "ssdk2131ks****",
  "roomId": "131321ad****"
}

响应示例

{
  "total": "3",
  "list": [
    {
      "deviceId":"sadadad****",
      "projectId":"adad2131****",
      "roomId":"sadadk231232****",
      "deviceName":"这是个控制设备",
      "bizCode":"asdadk231****"
    }
  ]
}

批量增加设备

功能描述

可从已配置的感应设备列表(根据房间和项目查询可用设备)中批量选择设备信息进行提交,入参中的生效时间默认为当前时间。

接口地址

POST /v1.0/illumination/aisensing/deivce/batch

请求参数

参数名 类型 参数类型 说明 是否必需
requestList.deviceId String body 设备 ID true
requestList.deviceName String body 设备名称 true
requestList.projectId String body 项目 ID true
requestList.roomId String body 空间ID true
requestList.validTime date body 生效时间 false
projectId String body 项目 ID true

返回参数

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

请求示例

{
  "requestList.validTime": "2312332221",
  "requestList.roomId": "dad1k23213a****",
  "requestList.deviceName": "设备A",
  "requestList.projectId": "dasdaad*****",
  "requestList.deviceId": "adasd123213a****"
}

响应示例

true

批量删除设备

功能描述

从算法池中移除设备,移除后的设备将不会参与算法,也不会再有云端下发的控制指令。

接口地址

POST /v1.0/illumination/aisensing/deivce/remove

请求参数

参数名 类型 参数类型 说明 是否必需
pirDiviceIds String[] body 设备 ID列表 true
projectId String body 项目 ID true

返回参数

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

请求示例

{
  "pirDiviceIds": "sadadad23123123,21312313****",
  "projectId": "sdakjk231****"
}

响应示例

true

批量删除历史数据

功能描述

批量删除历史数据,即删除选中设备的历史DP上报消息,将重新开始上报收集并计算模型。

接口地址

POST /v1.0/illumination/aisensing/deivce/removeHirshory

请求参数

参数名 类型 参数类型 说明 是否必需
pirDiviceIds String[] body 设备 ID列表 true
projectId String body 项目 ID true

返回参数

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

请求示例

{
  "pirDiviceIds": "sadad123****,213123ada****",
  "projectId": "dsada2313a****"
}

响应示例

true

根据房间和项目查询可用设备

功能描述

根据房间和项目查询可用设备,这里会将不支持 AI 自适应的感应设备及所有非感应设备排除,仅能查询出支持 AI 自适应功能的设备列表.

接口地址

GET /v1.0/illumination/aisensing/listPIRDeviceByRoomId

请求参数

参数名 类型 参数类型 说明 是否必需
roomId String body 房间 ID true
projectId String body 项目 ID true

返回参数

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

result参数说明

参数名 类型 说明
deviceId String 设备 ID
deviceName String 设备名称
projectId String 项目 ID
roomId String 项目名称

请求示例

{
  "projectId": "adad23131****",
  "roomId": "2313ada****"
}

响应示例

[
  {
    "deviceId": "dad23****",
    "deviceName": "智能设备",
    "projectId": "adad23131****",
    "roomId": "2313ada****"
  }
]

获取项目下的空间树形结构(只查询传感设备)

功能描述

获取项目下的空间树形结构(只查询传感设备)。

接口地址

GET /v1.0/illumination/aisensing/project/roomTree

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID true

返回参数

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

Result 说明

参数名 类型 说明
totalPointCount Integer 空间内的点位数
totalRoomDeviceCount Integer 设备数
list LIst 房间列表
roomId String 房间 ID
name String 房间名称
roomLevel Integer 空间属性,房间级别

请求示例

{
  "projectId": "asdassdasdk2****"
}

响应示例

{
  "totalPointCount": 20,
  "totalRoomDeviceCount": 1,
  "list": [
    {
      "roomId": "sadad23****",
      "name": "这是一个房间名称",
      "roomLevel": 2,
    }
  ]
}

错误码

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

错误码 说明
500 系统错误