串口设备Api
串口设备的字段请查看字段说明
# 列表查询
接口说明
根据查询条件查询串口设备列表。
接口版本
v1接口地址
/api-web-v1/hardwares
请求方法
GET
请求参数
| 参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 | 默认 | 示例 |
|---|---|---|---|---|---|---|
| query | label | string | false | 模糊查询字段 | name | |
| query | search | string | false | 模糊查询值 | 测试 | |
| query | time | string | false | 时间范围查询字段,必须是设备字段中的时间或时间戳字段名，例如createdAt,updatedAt | createdAt | |
| query | range | string[] or string | false | 时间范围，开始时间到结束时间,可以是string[]或者以逗号分割的开始时间到结束时间或时间戳 | 2019-10-22T00:00:00.000Z,2022-01-22T00:00:00.000Z | |
| query | page | number | false | 分页第几页 | 1 | |
| query | limit | number | false | 单页几条数据 | 10 | |
| query | sort | string | false | 根据哪个字段排序 | _id | -createdAt |
| query | select | string | false | 只查询部分字段,字段名之间用过空格分隔,去掉某个字段的查询字段名前面加- | ||
| query | autopopulate | boolean | false | 自动关联数据，部分字段自动关联关系表查询，设置这个值可开关自动联表查询 | true | false |
| query | populate | string | false | 指定关联表查询,查询多个关联表用逗号分隔 | checks,operates | |
| query | hardwareWord | string | false | 指定设备字典 | 5ebe578fb64352001b1f3876 | |
| query | depart | string | false | 层级 | _id | |
| query | query['tags'] | string | false | 标签 | {$all:['空调']} |
请求参数举例
注意
GET请求所有参数类型都会变成string拼接在url上面，文档为了表述清晰，将示例结构以json格式编写
```json
{
"page":"1",
"limit":"2",
"sort":"-createdAt",
"autopopulate":"false"
}
```
// Make sure to add code blocks to your code group
返回参数
| 参数名称 | 数据类型 | 是否必须 | 参数描述 |
|---|---|---|---|
| code | number | True | 是否成功 |
| data | json | True | 返回数据 |
| -total | number | False | 串口设备总条数 |
| -rows | array | False | 当前返回的串口设备对象列表 |
返回参数举例
{
"code": 0,
"data": {
"total": 104,
"rows": [
{
"tags": [],
"_id": "5daf1060113f3a001bbe801c",
"loraSlave": "5daf0bbf113f3a001bbe7a8e",
"control": "5da994dc0dc418001b95d381",
"hardwareWord": "5d1f3f288ce12637b661b8e4",
"type": 1,
"serialData": {
"_id": "5d3fbacc402e615bdcda3426",
"baud": 9600,
"verification": "none",
"stopBit": 1,
"dataBit": 8
},
"shortAddress": "02",
"name": "电表-斯同瑞-三相02",
"attribute": [
{
"_id": "5d5d0a9e6f19a96b204701b0",
"key": "dy",
"value": "200,0.1,1,0,380",
"note": "上报次数,精度值(0.01-2.5),比较字节(从右到左),下限值(0),上限值(380) ."
},
{
"_id": "5d5d0a9e6f19a96b204701af",
"key": "dl",
"value": "200,0.5,1,0,10",
"note": "上报次数,精度值(0.01-2.5),比较字节(从右到左),下限值(0),上限值(10) ."
},
{
"_id": "5d5d0a9e6f19a96b204701ae",
"key": "dn",
"value": "200,0.1,1,0,20000",
"note": "上报次数,精度值(0.01-2.5),比较字节(从右到左),下限值(0),上限值(20000) ."
},
{
"_id": "5d5f5aa0d84775fc2598aded",
"key": "读取周期",
"value": "20",
"note": "s"
},
{
"_id": "5d5f5a9fd84775fc2598adec",
"key": "上报周期",
"value": "120",
"note": "s"
}
],
"creator": "5da994550dc418001b95d36f",
"createdAt": "2019-10-22T14:21:20.167Z",
"updatedAt": "2022-03-15T14:58:47.901Z",
"__v": 0,
"line": false,
"id": "5daf1060113f3a001bbe801c"
},
{
"tags": [],
"_id": "5daf0dc9113f3a001bbe7d1d",
"loraSlave": "5daf0bbf113f3a001bbe7a8e",
"control": "5da994dc0dc418001b95d381",
"hardwareWord": "5d73116a307640dd9aeff86e",
"type": 1,
"serialData": {
"_id": "5d73116a307640dd9aeff86f",
"comName": null,
"baud": 19200,
"verification": "none",
"stopBit": 1,
"dataBit": 8,
"state": false,
"address": null
},
"shortAddress": "01",
"name": "智能空开-曼顿-8路01",
"attribute": [],
"creator": "5da994550dc418001b95d36f",
"createdAt": "2019-10-22T14:10:17.638Z",
"updatedAt": "2019-10-22T14:10:17.638Z",
"__v": 0,
"line": false,
"id": "5daf0dc9113f3a001bbe7d1d"
}
]
}
}
# 查询单个设备
接口说明
根据查询条件查询单个串口设备。
接口版本
v1接口地址
/api-web-v1/hardwares/one
请求方法
GET
请求参数
| 参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 | 默认 | 示例 |
|---|---|---|---|---|---|---|
| query | label | string | false | 模糊查询字段 | name | |
| query | search | string | false | 模糊查询值 | 测试 | |
| query | time | string | false | 时间范围查询字段,必须是设备字段中的时间或时间戳字段名，例如createdAt,updatedAt | createdAt | |
| query | range | string[] or string | false | 时间范围，开始时间到结束时间,可以是string[]或者以逗号分割的开始时间到结束时间或时间戳 | 2019-10-22T00:00:00.000Z,2022-01-22T00:00:00.000Z | |
| query | sort | string | false | 根据哪个字段排序 | _id | -createdAt |
| query | select | string | false | 只查询部分字段,字段名之间用过空格分隔,去掉某个字段的查询字段名前面加- | ||
| query | autopopulate | boolean | false | 自动关联数据，部分字段自动关联关系表查询，设置这个值可开关自动联表查询 | true | false |
| query | populate | string | false | 指定关联表查询,查询多个关联表用逗号分隔 | checks,operates |
请求参数举例
注意
GET请求所有参数类型都会变成string拼接在url上面，文档为了表述清晰，将示例结构以json格式编写
```json
{
"sort":"-createdAt",
"autopopulate":"false"
}
```
// Make sure to add code blocks to your code group
返回参数
| 参数名称 | 数据类型 | 是否必须 | 参数描述 |
|---|---|---|---|
| code | number | True | 是否成功 |
| data | json | True | 返回数据 |
返回参数举例
{
"code": 0,
"data": {
"tags": [],
"_id": "5daf1060113f3a001bbe801c",
"loraSlave": "5daf0bbf113f3a001bbe7a8e",
"control": "5da994dc0dc418001b95d381",
"hardwareWord": "5d1f3f288ce12637b661b8e4",
"type": 1,
"serialData": {
"_id": "5d3fbacc402e615bdcda3426",
"baud": 9600,
"verification": "none",
"stopBit": 1,
"dataBit": 8
},
"shortAddress": "02",
"name": "电表-斯同瑞-三相02",
"attribute": [
{
"_id": "5d5d0a9e6f19a96b204701b0",
"key": "dy",
"value": "200,0.1,1,0,380",
"note": "上报次数,精度值(0.01-2.5),比较字节(从右到左),下限值(0),上限值(380) ."
},
{
"_id": "5d5d0a9e6f19a96b204701af",
"key": "dl",
"value": "200,0.5,1,0,10",
"note": "上报次数,精度值(0.01-2.5),比较字节(从右到左),下限值(0),上限值(10) ."
},
{
"_id": "5d5d0a9e6f19a96b204701ae",
"key": "dn",
"value": "200,0.1,1,0,20000",
"note": "上报次数,精度值(0.01-2.5),比较字节(从右到左),下限值(0),上限值(20000) ."
},
{
"_id": "5d5f5aa0d84775fc2598aded",
"key": "读取周期",
"value": "20",
"note": "s"
},
{
"_id": "5d5f5a9fd84775fc2598adec",
"key": "上报周期",
"value": "120",
"note": "s"
}
],
"creator": "5da994550dc418001b95d36f",
"createdAt": "2019-10-22T14:21:20.167Z",
"updatedAt": "2022-03-15T14:58:47.901Z",
"__v": 0,
"line": false,
"id": "5daf1060113f3a001bbe801c"
}
}
# 查询设备ID
接口说明
根据设备ID查询设备
接口版本
v1接口地址
/api-v1/hardwares/:id
请求方法
GET
请求参数
| 参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
|---|---|---|---|---|
| params | id | string | True | 串口设备ID |
请求参数举例
注意
GET请求所有参数类型都会拼接在url上面，文档为了表述清晰，将示例结构以json格式编写
{"_id":"5daf1060113f3a001bbe801c"}
返回参数
| 参数名称 | 数据类型 | 是否必须 | 参数描述 |
|---|---|---|---|
| code | number | True | 是否成功 |
| data | json | false | 返回设备信息 |
返回参数举例
{
"code": 0,
"data": {
"tags": [],
"_id": "5daf1060113f3a001bbe801c",
"loraSlave": "5daf0bbf113f3a001bbe7a8e",
"control": "5da994dc0dc418001b95d381",
"hardwareWord": "5d1f3f288ce12637b661b8e4",
"type": 1,
"serialData": {
"_id": "5d3fbacc402e615bdcda3426",
"baud": 9600,
"verification": "none",
"stopBit": 1,
"dataBit": 8
},
"shortAddress": "02",
"name": "电表-斯同瑞-三相02",
"attribute": [
{
"_id": "5d5d0a9e6f19a96b204701b0",
"key": "dy",
"value": "200,0.1,1,0,380",
"note": "上报次数,精度值(0.01-2.5),比较字节(从右到左),下限值(0),上限值(380) ."
},
{
"_id": "5d5d0a9e6f19a96b204701af",
"key": "dl",
"value": "200,0.5,1,0,10",
"note": "上报次数,精度值(0.01-2.5),比较字节(从右到左),下限值(0),上限值(10) ."
},
{
"_id": "5d5d0a9e6f19a96b204701ae",
"key": "dn",
"value": "200,0.1,1,0,20000",
"note": "上报次数,精度值(0.01-2.5),比较字节(从右到左),下限值(0),上限值(20000) ."
},
{
"_id": "5d5f5aa0d84775fc2598aded",
"key": "读取周期",
"value": "20",
"note": "s"
},
{
"_id": "5d5f5a9fd84775fc2598adec",
"key": "上报周期",
"value": "120",
"note": "s"
}
],
"creator": "5da994550dc418001b95d36f",
"createdAt": "2019-10-22T14:21:20.167Z",
"updatedAt": "2022-03-15T14:58:47.901Z",
"__v": 0,
"line": false,
"id": "5daf1060113f3a001bbe801c"
}
}
# 查询设备ID+检测器控制器
接口说明
根据设备ID查询设备并且会将设备下的检测器和控制器放入设备信息
接口版本
v1接口地址
/api-v1/hardwares/:id/full
请求方法
GET
请求参数
| 参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
|---|---|---|---|---|
| params | id | string | True | 串口设备ID |
请求参数举例
注意
GET请求所有参数类型都会拼接在url上面，文档为了表述清晰，将示例结构以json格式编写
{"_id":"5daf1060113f3a001bbe801c"}
返回参数
| 参数名称 | 数据类型 | 是否必须 | 参数描述 |
|---|---|---|---|
| code | number | True | 是否成功 |
| data | json | false | 返回设备信息 |
返回参数举例
{
"code": 0,
"data": {
"tags": [],
"_id": "5daf1060113f3a001bbe801c",
"loraSlave": "5daf0bbf113f3a001bbe7a8e",
"control": "5da994dc0dc418001b95d381",
"hardwareWord": "5d1f3f288ce12637b661b8e4",
"type": 1,
"serialData": {
"_id": "5d3fbacc402e615bdcda3426",
"baud": 9600,
"verification": "none",
"stopBit": 1,
"dataBit": 8
},
"shortAddress": "02",
"name": "电表-斯同瑞-三相02",
"attribute": [
{
"_id": "5d5d0a9e6f19a96b204701b0",
"key": "dy",
"value": "200,0.1,1,0,380",
"note": "上报次数,精度值(0.01-2.5),比较字节(从右到左),下限值(0),上限值(380) ."
},
{
"_id": "5d5d0a9e6f19a96b204701af",
"key": "dl",
"value": "200,0.5,1,0,10",
"note": "上报次数,精度值(0.01-2.5),比较字节(从右到左),下限值(0),上限值(10) ."
},
{
"_id": "5d5d0a9e6f19a96b204701ae",
"key": "dn",
"value": "200,0.1,1,0,20000",
"note": "上报次数,精度值(0.01-2.5),比较字节(从右到左),下限值(0),上限值(20000) ."
},
{
"_id": "5d5f5aa0d84775fc2598aded",
"key": "读取周期",
"value": "20",
"note": "s"
},
{
"_id": "5d5f5a9fd84775fc2598adec",
"key": "上报周期",
"value": "120",
"note": "s"
}
],
"creator": "5da994550dc418001b95d36f",
"createdAt": "2019-10-22T14:21:20.167Z",
"updatedAt": "2022-03-15T14:58:47.901Z",
"__v": 0,
"line": false,
"checks": [
{
"line": false,
"value": null,
"valueStr": null,
"boardConfigStr": "{}",
"_id": "5daf0dc9113f3a001bbe7d2f",
"name": "开关8电流",
"company": "A",
"icon": "icon-dianliuchuanganqi",
"interval": "[[\"停止\",\"运行\"],[1],[0,10]]",
"precision": 1,
"sort": 8,
"canRead": true,
"control": "5da994dc0dc418001b95d381",
"shortAddress": "407",
"creator": "5da994550dc418001b95d36f",
"createdAt": "2019-10-22T14:10:17.986Z",
"updatedAt": "2022-03-22T07:23:44.378Z",
"__v": 0,
"parentName": "LoraSlave",
"parent": "5daf1060113f3a001bbe801c"
},
{
"line": false,
"value": 498.49,
"valueStr": null,
"boardConfigStr": "{}",
"_id": "5daf1060113f3a001bbe8029",
"name": "C相电压",
"company": "V",
"icon": "icon-48",
"interval": "[[\"停止\",\"运行\"],[24],[0,380]]",
"precision": 1,
"sort": 3,
"canRead": true,
"control": "5da994dc0dc418001b95d381",
"shortAddress": "34",
"creator": "5da994550dc418001b95d36f",
"createdAt": "2019-10-22T14:21:20.363Z",
"updatedAt": "2022-03-15T14:58:31.122Z",
"__v": 0,
"valueAt": "2019-10-22T14:21:34.638Z",
"parentName": "Hardware",
"parent": "5daf1060113f3a001bbe801c"
},
{
"line": false,
"value": 242.05,
"valueStr": "运行",
"boardConfigStr": "{}",
"_id": "5daf1060113f3a001bbe8027",
"name": "B相电压",
"company": "V",
"icon": "icon-48",
"interval": "[[\"停止\",\"运行\"],[24],[0,380]]",
"precision": 1,
"sort": 2,
"canRead": true,
"control": "5da994dc0dc418001b95d381",
"shortAddress": "33",
"creator": "5da994550dc418001b95d36f",
"createdAt": "2019-10-22T14:21:20.328Z",
"updatedAt": "2022-03-15T14:58:31.122Z",
"__v": 0,
"valueAt": "2019-10-22T14:21:34.635Z",
"parentName": "Hardware",
"parent": "5daf1060113f3a001bbe801c"
},
{
"line": false,
"value": 0,
"valueStr": null,
"boardConfigStr": "{}",
"_id": "5daf1060113f3a001bbe8031",
"name": "电能",
"company": "kWh",
"icon": "icon-nenghao1",
"interval": "[[\"停止\",\"运行\"],[0.5],[0,99999999]]",
"precision": 1,
"sort": 7,
"canRead": true,
"control": "5da994dc0dc418001b95d381",
"shortAddress": "a",
"creator": "5da994550dc418001b95d36f",
"createdAt": "2019-10-22T14:21:20.520Z",
"updatedAt": "2022-03-15T14:58:31.122Z",
"__v": 0,
"valueAt": "2019-10-22T14:21:34.649Z",
"parentName": "Hardware",
"parent": "5daf1060113f3a001bbe801c"
},
{
"line": false,
"value": 368.62,
"valueStr": null,
"boardConfigStr": "{}",
"_id": "5daf1060113f3a001bbe802d",
"name": "B相电流",
"company": "A",
"icon": "icon-dianliuchuanganqi",
"interval": "[[\"停止\",\"运行\"],[1],[0,10]]",
"precision": 0.1,
"sort": 5,
"canRead": true,
"control": "5da994dc0dc418001b95d381",
"shortAddress": "39",
"creator": "5da994550dc418001b95d36f",
"createdAt": "2019-10-22T14:21:20.446Z",
"updatedAt": "2022-03-15T14:58:31.122Z",
"__v": 0,
"valueAt": "2019-10-22T14:21:34.644Z",
"parentName": "Hardware",
"parent": "5daf1060113f3a001bbe801c"
},
{
"line": false,
"value": 425.56,
"valueStr": null,
"boardConfigStr": "{}",
"_id": "5daf1060113f3a001bbe802b",
"name": "A相电流",
"company": "A",
"icon": "icon-dianliuchuanganqi",
"interval": "[[\"停止\",\"运行\"],[1],[0,10]]",
"precision": 0.1,
"sort": 4,
"canRead": true,
"control": "5da994dc0dc418001b95d381",
"shortAddress": "38",
"creator": "5da994550dc418001b95d36f",
"createdAt": "2019-10-22T14:21:20.413Z",
"updatedAt": "2022-03-15T14:58:31.122Z",
"__v": 0,
"valueAt": "2019-10-22T14:21:34.641Z",
"parentName": "Hardware",
"parent": "5daf1060113f3a001bbe801c"
},
{
"line": false,
"value": 157.03,
"valueStr": "运行",
"boardConfigStr": "{}",
"_id": "5daf1060113f3a001bbe8025",
"name": "A相电压",
"company": "V",
"icon": "icon-48",
"interval": "[[\"停止\",\"运行\"],[24],[0,380]]",
"precision": 1,
"sort": 1,
"canRead": true,
"control": "5da994dc0dc418001b95d381",
"shortAddress": "32",
"creator": "5da994550dc418001b95d36f",
"createdAt": "2019-10-22T14:21:20.289Z",
"updatedAt": "2022-03-15T14:58:31.122Z",
"__v": 0,
"valueAt": "2019-10-22T14:21:34.630Z",
"parentName": "Hardware",
"parent": "5daf1060113f3a001bbe801c"
},
{
"line": false,
"value": 274.51,
"valueStr": null,
"boardConfigStr": "{}",
"_id": "5daf1060113f3a001bbe802f",
"name": "C相电流",
"company": "A",
"icon": "icon-dianliuchuanganqi",
"interval": "[[\"停止\",\"运行\"],[1],[0,10]]",
"precision": 0.1,
"sort": 6,
"**canRead**": true,
"control": "5da994dc0dc418001b95d381",
"shortAddress": "3a",
"creator": "5da994550dc418001b95d36f",
"createdAt": "2019-10-22T14:21:20.483Z",
"updatedAt": "2022-03-15T14:58:31.122Z",
"__v": 0,
"valueAt": "2019-10-22T14:21:34.646Z",
"parentName": "Hardware",
"parent": "5daf1060113f3a001bbe801c"
}
],
"operates": [],
"id": "5daf1060113f3a001bbe801c"
}
}
# 新建
接口说明
新建一个串口设备。第三方不建议直接调用串口新建接口，此接口创建需实际设备。
接口版本
v1接口地址
/api-v1/hardwares
请求方法
POST
请求参数
| 参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
|---|---|---|---|---|
| body | - | Object | True | 串口对象字段说明 |
请求参数举例
{
"name":"测试设备",
"shortAddress":"001",
"type":0,
"control": "5da994dc0dc418001b95d381",
"hardwareWord":"5d1f3f288ce12637b661b8e4",
"serialData": {
"baud": 9600,
"verification": "none",
"stopBit": 1,
"dataBit": 8
}
}
// Make sure to add code blocks to your code group
返回参数
| 参数名称 | 数据类型 | 是否必须 | 参数描述 |
|---|---|---|---|
| code | number | True | 是否成功 |
| data | json | True | 返回创建的对象 |
返回参数举例
{
"code": 0,
"data": {
"tags": [],
"_id": "5daf1060113f3a001bbe801c",
"control": "5da994dc0dc418001b95d381",
"hardwareWord": "5d1f3f288ce12637b661b8e4",
"type": 0,
"serialData": {
"_id": "5d3fbacc402e615bdcda3426",
"baud": 9600,
"verification": "none",
"stopBit": 1,
"dataBit": 8
},
"shortAddress": "001",
"name": "测试设备",
"creator": "5da994550dc418001b95d36f",
"createdAt": "2022-03-15T14:58:47.901Z",
"updatedAt": "2022-03-15T14:58:47.901Z",
"__v": 0,
"line": false,
"id": "5daf1060113f3a001bbe801c"
}
}
第三方不建议直接调用串口新建接口，此接口创建需实际设备。文档不提供新增在线调试
# 编辑
接口说明
修改串口设备。第三方不建议直接调用串口修改接口，此接口使用需实际设备。
接口版本
v1接口地址
/api-v1/hardwares/:id
请求方法
PUT
请求参数
| 参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
|---|---|---|---|---|
| params | id | string | True | 修改的串口设备ID |
| body | - | Object | True | 串口对象字段说明 |
请求参数举例
{
"name":"测试设备修改"
}
// Make sure to add code blocks to your code group
返回参数
| 参数名称 | 数据类型 | 是否必须 | 参数描述 |
|---|---|---|---|
| code | number | True | 是否成功 |
| data | json | True | 返回创建的对象 |
返回参数举例
{
"code": 0,
"data": {
"tags": [],
"_id": "5daf1060113f3a001bbe801c",
"control": "5da994dc0dc418001b95d381",
"hardwareWord": "5d1f3f288ce12637b661b8e4",
"type": 0,
"serialData": {
"_id": "5d3fbacc402e615bdcda3426",
"baud": 9600,
"verification": "none",
"stopBit": 1,
"dataBit": 8
},
"shortAddress": "001",
"name": "测试设备修改",
"creator": "5da994550dc418001b95d36f",
"createdAt": "2022-03-15T14:58:47.901Z",
"updatedAt": "2022-03-15T14:58:47.901Z",
"__v": 0,
"line": false,
"id": "5daf1060113f3a001bbe801c"
}
}
第三方不建议直接调用串口修改接口，此接口修改需实际设备。文档不提供修改在线调试
# 删除
接口说明
删除一个串口设备。第三方不建议直接调用串口删除接口，此接口需实际设备。
接口版本
v1接口地址
/api-v1/hardwares/:id
请求方法
DELETE
请求参数
| 参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
|---|---|---|---|---|
| params | id | string | True | 删除的串口设备ID |
请求参数举例
只需发送删除设备的ID
返回参数
| 参数名称 | 数据类型 | 是否必须 | 参数描述 |
|---|---|---|---|
| code | number | True | 是否成功 |
| message | string | false | 成功删除返回complete |
返回参数举例
{
"code": 0,
"message": "complete"
}
第三方不建议直接调用串口删除接口，此接口需实际设备。文档不提供删除在线调试
上次更新: 2023/03/20, 15:30:53