Appearance
设备管理
添加设备
添加的设备需先由我方进行维护管理，且同一应用下下的设备尽量保持设备使用场景唯一
- URL：
/openapi/device/add - Method：
POST
请求参数
| 参数 | 类型 | 约束 |
|---|---|---|
| Body | ||
imei | String | 设备编号 |
name | String | 设备名称 |
productId | number | 产品id，必填 |
请求示例
json
{
"imei": "861290073728458",
"name":"设备名称",
"productId":123456789
}成功响应
条件：请求参数合法，并且用户身份校验通过。
状态码：200 OK
响应示例：
json
{
"code": 200,
"type": "success",
"message": "",
"extras": "string",
"time": "2024-07-30 16:54:21"
}更新设备
更新设备仅可更新设备名称
- URL：
/openapi/device/update - Method：
POST
请求参数
| 参数 | 类型 | 约束 |
|---|---|---|
| Body | ||
imei | String | 设备编号 |
name | String | 设备名称 |
请求示例
json
{
"imei": "861290073728458",
"name":"设备名称"
}成功响应
条件：请求参数合法，并且用户身份校验通过。
状态码：200 OK
响应示例：
json
{
"code": 200,
"type": "success",
"message": "",
"extras": "string",
"time": "2024-07-30 16:54:21"
}删除设备
- URL：
/openapi/device/delete - Method：
POST
请求参数
| 参数 | 类型 | 约束 |
|---|---|---|
| Body | ||
| Array | 设备编号列表 | |
imei | String | 设备编号 |
请求示例
json
["861290073728458"]成功响应
条件：请求参数合法，并且用户身份校验通过。
状态码：200 OK
响应示例：
json
{
"code": 200,
"type": "success",
"message": "",
"extras": "string",
"time": "2024-07-30 16:54:21"
}获取设备列表
添加的设备需先由我方进行维护管理，且同一应用下下的设备尽量保持设备使用场景唯一
- URL：
/openapi/device/list?page={page}&pageSize={pageSize} - Method：
GET
请求参数
| 参数 | 类型 | 约束 |
|---|---|---|
| Query | ||
page | Number | 页码，1开始 |
pageSize | Number | 每页条数 |
响应参数
| 参数 | 类型 | 约束 |
|---|---|---|
page | Number | 页码，1开始 |
pageSize | Number | 每页条数 |
total | Number | 总数 |
totalPages | Number | 总页数 |
hasPrevPage | Boolean | 是否有前一页 |
hasNextPage | Boolean | 是否有下一页 |
items | Array | 数据列表 |
imei | String | 设备编码 |
name | String | 设备名称 |
longitude | Number | 经度 |
latitude | Number | 纬度 |
isOnline | Number | 在线状态，1在线，0离线 |
lastestTime | Datetime | 上下线时间 |
addresses | Array | 子设备列表，可能为空，目前DL/T645协议和modbus会用到 |
pointNum | String | 子设备地址，一般为modbus站号或DL/T645表地址 |
name | String | 子设备名称 |
成功响应
条件：请求参数合法，并且用户身份校验通过。
状态码：200 OK
响应示例：响应数据按照添加时间倒序排序，最新添加的在前
json
{
"code": 200,
"type": "success",
"message": "",
"result": {
"page": 1,
"pageSize": 10,
"total": 2,
"totalPages": 1,
"items": [
{
"imei": "861290073728458",
"name": "东区采集器",
"addresses": [
{
"pointNum": "12",
"name": "空调"
},
{
"pointNum": "1212",
"name": "电灯"
}
],
"longitude": 118.7357630000,
"latitude": 31.9390006000,
"isOnline": 1,
"lastestTime": "2024-07-30 15:33:21"
}
],
"hasPrevPage": false,
"hasNextPage": false
},
"extras": null,
"time": "2024-07-30 17:30:59"
}获取设备详细信息
添加的设备需先由我方进行维护管理，且同一应用下下的设备尽量保持设备使用场景唯一
- URL：
/openapi/device/detail?imei={imei} - Method：
GET
请求参数
| 参数 | 类型 | 约束 |
|---|---|---|
| Query | ||
imei | String | 设备编号 |
响应参数
| 参数 | 类型 | 约束 |
|---|---|---|
imei | String | 设备编码 |
name | String | 设备名称 |
longitude | Number | 经度 |
latitude | Number | 纬度 |
isOnline | Number | 在线状态，1在线，0离线 |
lastestTime | Datetime | 上下线时间 |
addresses | Array | 子设备列表，可能为空，目前DL/T645协议和modbus会用到 |
pointNum | String | 子设备地址，一般为modbus站号或DL/T645表地址 |
name | String | 子设备名称 |
成功响应
条件：请求参数合法，并且用户身份校验通过。
状态码：200 OK
响应示例：
json
{
"code": 200,
"type": "success",
"message": "",
"result": {
"imei": "861290073728458",
"name": "东区采集器",
"addresses": [
{
"pointNum": "12",
"name": "空调"
},
{
"pointNum": "1212",
"name": "电灯"
}
],
"longitude": 118.7357630000,
"latitude": 31.9390006000,
"isOnline": 1,
"lastestTime": "2024-07-30 15:33:21"
},
"extras": null,
"time": "2024-07-30 17:30:59"
}设置采集设备的子设备列表
是否需要设置，需要视情况而定。例如，
4G电表，采用DL/T645协议，表地址会提前维护好，默认12个A，此处就不需要调用。
4G采集器，采集DL/T645协议的电表数据，可能采集多个电表，则需要调用此接口。
采集其他非modbus和DL/T645协议的设备，无需调用。
- URL：
/openapi/device/set?imei={imei} - Method：
POST
请求参数
| 参数 | 类型 | 约束 |
|---|---|---|
| Query | ||
imei | String | 设备编号 |
| Body | ||
| Array | 子设备列表，传空数组，则视为清空 | |
pointNum | String | 子设备地址，一般为modbus站号或DL/T645表地址 |
name | String | 子设备名称 |
请求示例
json
[{
"pointNum": "12",
"name": "空调"
}]成功响应
条件：请求参数合法，并且用户身份校验通过。
状态码：200 OK
响应示例：
json
{
"code": 200,
"type": "success",
"message": "",
"extras": "string",
"time": "2024-07-30 16:54:21"
}设备透传
当云端主动采集设备时，需要调用
- URL：
/openapi/device/transparent - Method：
POST
请求参数
| 参数 | 类型 | 约束 |
|---|---|---|
| Body | ||
imei | String | 设备编号 |
cmd | String | 指令 |
请求示例
json
{
"imei": "12",
"cmd": "xxxxxxx"
}成功响应
条件：请求参数合法，并且用户身份校验通过。
状态码：200 OK
响应示例：响应的cmd需要自行解析
json
{
"code": 200,
"type": "success",
"message": "",
"result":{
"imei":"12",
"cmd":"aaaaaaaa"
},
"extras": "string",
"time": "2024-07-30 16:54:21"
}设备软重启
- URL：
/openapi/device/restart - Method：
POST
请求参数
| 参数 | 类型 | 约束 |
|---|---|---|
| Body | ||
imei | String | 设备编号 |
请求示例
json
{
"imei": "12",
}成功响应
条件：请求参数合法，并且用户身份校验通过。
状态码：200 OK
响应示例：重启指令发送后不会有设备响应，请关注设备上线信息
json
{
"code": 200,
"type": "success",
"message": "",
"extras": "string",
"time": "2024-07-30 16:54:21"
}