设备控制面板
大约 2 分钟
设备控制面板
控制面板基于百度 amis 低代码引擎,为单台设备配置可视化操作页面(amis JSON),面板运行时会注入 deviceId 等上下文参数,可直接调用平台接口控制设备。
创建控制面板
| POST | /admin-api/iot/control-panel/create |
|---|
请求数据类型 :application/json;charset=UTF-8
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| title | 面板标题 | json | true | string |
| description | 面板描述 | json | false | string |
| deviceId | 关联设备id | json | true | long |
| productKey | 产品productKey | json | false | string |
| deviceName | 设备唯一标识 | json | false | string |
| clientType | 客户端类型,如 "1" | json | false | string |
| content | 面板内容,amis JSON 字符串 | json | false | string |
| Authorization | 认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌 | header | true | string |
响应状态
| 状态码 | 说明 |
|---|---|
| 200 | OK |
响应参数
| 参数名称 | 参数说明 | 数据类型 |
|---|---|---|
| status | 状态码,值为0正常,其他值为异常 | int |
| code | 结果同status一样,冗余字段 | int |
| data | 创建成功返回面板id | long |
| msg | 状态消息 | string |
查询控制面板分页
| GET | /admin-api/iot/control-panel/page |
|---|
请求数据类型 :application/json;charset=UTF-8
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| pageNo | 页码,从 1 开始,示例值(1) | query | false | int32 |
| pageSize | 每页条数,最大值为 1000,示例值(10) | query | false | int32 |
| title | 面板标题 | query | false | string |
| deviceId | 关联设备id | query | false | long |
| createTime | 创建时间时间范围 | query | false | array[datetime] |
| Authorization | 认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌 | header | true | string |
响应状态
| 状态码 | 说明 |
|---|---|
| 200 | OK |
响应参数
| 参数名称 | 参数说明 | 数据类型 |
|---|---|---|
| status | 状态码,值为0正常,其他值为异常 | int |
| code | 结果同status一样,冗余字段 | int |
| data | 分页数据 | object |
| ---total | 返回结果条数 | int |
| ---list | 返回数据列表 | array |
| ------id | 面板id | long |
| ------title | 面板标题 | string |
| ------description | 面板描述 | string |
| ------deviceId | 关联设备id | long |
| ------productKey | 产品productKey | string |
| ------deviceName | 设备唯一标识 | string |
| ------clientType | 客户端类型 | string |
| ------content | 面板内容,amis JSON 字符串 | string |
| ------createTime | 创建时间 | string |
| msg | 状态消息 | string |
更新 / 删除 / 详情
| 方法 | 路径 | 说明 |
|---|---|---|
| PUT | /admin-api/iot/control-panel/update | 更新面板,请求参数同创建,另需传 id(必填) |
| DELETE | /admin-api/iot/control-panel/delete | 删除面板,query 参数:id(必填) |
| GET | /admin-api/iot/control-panel/get | 查询面板详情,query 参数:id(必填);该接口为匿名访问(@PermitAll),用于面板页面渲染时获取配置 |
提示
字段名注意是 clientType(客户端类型),不是 type。amis JSON 的编写方法参考 amis 官方文档。