Lora设备Api
Lora设备的字段请查看字段说明
# 列表查询
接口说明
根据查询条件查询Lora设备列表。
接口版本
v1接口地址
/api-web-v1/lora-slaves
请求方法
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格式编写
{
"page":"1",
"limit":"2",
"sort":"-createdAt",
"autopopulate":"false"
}
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回数据 |
-total | number | False | Lora设备总条数 |
-rows | array | False | 当前返回的Lora设备对象列表 |
返回参数举例
{
"code": 0,
"data": {
"total": 71,
"rows": [
{
"status": 1,
"tags": [],
"_id": "5da99fdd25daef001b464d87",
"name": "温湿度-NAYOTA-LORA",
"attribute": [
{
"_id": "5d4c022ec3d2be6d95c41c00",
"key": "温湿度采样周期",
"value": "10"
},
{
"_id": "5d4c022ec3d2be6d95c41bff",
"key": "定时上报周期",
"value": "1800"
},
{
"_id": "5d4c022ec3d2be6d95c41bfe",
"key": "触发上报温度差",
"value": "1"
},
{
"_id": "5d4c022ec3d2be6d95c41bfd",
"key": "触发上报湿度差",
"value": "1"
}
],
"type": "06",
"loraMaster": "5da994dc0dc418001b95d385",
"control": "5da994dc0dc418001b95d381",
"loraData": {
"_id": "5da5c5707c13d7001bdb4fd4",
"type": 0,
"comName": "/dev/ttyAMA0",
"address": "01",
"frequency": "1d34ce80",
"bandwidth": "07",
"codingrate": "02",
"factor": "09"
},
"agreement": "5d4c015bc3d2be6d95c41be9",
"hardwareWord": "5d4c022ec3d2be6d95c41bfc",
"creator": "5da994550dc418001b95d36f",
"createdAt": "2019-10-18T11:19:57.310Z",
"updatedAt": "2022-03-15T14:58:51.744Z",
"shortAddress": "0001",
"__v": 1,
"line": false,
"id": "5da99fdd25daef001b464d87"
},
{
"status": 1,
"tags": [],
"_id": "5da9a1ca25daef001b464f1e",
"name": "温湿度-NAYOTA-LORA",
"attribute": [
{
"_id": "5d4c022ec3d2be6d95c41c00",
"key": "温湿度采样周期",
"value": "10"
},
{
"_id": "5d4c022ec3d2be6d95c41bff",
"key": "定时上报周期",
"value": "1800"
},
{
"_id": "5d4c022ec3d2be6d95c41bfe",
"key": "触发上报温度差",
"value": "1"
},
{
"_id": "5d4c022ec3d2be6d95c41bfd",
"key": "触发上报湿度差",
"value": "3"
}
],
"type": "06",
"loraMaster": "5da994dc0dc418001b95d385",
"control": "5da994dc0dc418001b95d381",
"loraData": {
"_id": "5da5c5707c13d7001bdb4fd4",
"type": 0,
"comName": "/dev/ttyAMA0",
"address": "01",
"frequency": "1d34ce80",
"bandwidth": "07",
"codingrate": "02",
"factor": "09"
},
"agreement": "5d4c015bc3d2be6d95c41be9",
"hardwareWord": "5d4c022ec3d2be6d95c41bfc",
"creator": "5da994550dc418001b95d36f",
"createdAt": "2019-10-18T11:28:10.716Z",
"updatedAt": "2022-03-15T14:58:50.613Z",
"shortAddress": "0003",
"__v": 1,
"line": false,
"id": "5da9a1ca25daef001b464f1e"
}
]
}
}
# 查询单个设备
接口说明
根据查询条件查询单个Lora设备。
接口版本
v1接口地址
/api-web-v1/lora-slaves/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格式编写
{
"sort":"-createdAt",
"autopopulate":"false"
}
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回数据 |
返回参数举例
{
"code": 0,
"data": {
"status": 1,
"tags": [],
"_id": "5da99fdd25daef001b464d87",
"name": "温湿度-NAYOTA-LORA",
"attribute": [
{
"_id": "5d4c022ec3d2be6d95c41c00",
"key": "温湿度采样周期",
"value": "10"
},
{
"_id": "5d4c022ec3d2be6d95c41bff",
"key": "定时上报周期",
"value": "1800"
},
{
"_id": "5d4c022ec3d2be6d95c41bfe",
"key": "触发上报温度差",
"value": "1"
},
{
"_id": "5d4c022ec3d2be6d95c41bfd",
"key": "触发上报湿度差",
"value": "1"
}
],
"type": "06",
"loraMaster": "5da994dc0dc418001b95d385",
"control": "5da994dc0dc418001b95d381",
"loraData": {
"_id": "5da5c5707c13d7001bdb4fd4",
"type": 0,
"comName": "/dev/ttyAMA0",
"address": "01",
"frequency": "1d34ce80",
"bandwidth": "07",
"codingrate": "02",
"factor": "09"
},
"agreement": "5d4c015bc3d2be6d95c41be9",
"hardwareWord": "5d4c022ec3d2be6d95c41bfc",
"creator": "5da994550dc418001b95d36f",
"updatedAt": "2022-03-15T14:58:51.744Z",
"shortAddress": "0001",
"__v": 1,
"line": false,
"id": "5da99fdd25daef001b464d87"
}
}
# 查询设备ID
接口说明
根据设备ID查询设备
接口版本
v1接口地址
/api-v1/lora-slaves/:id
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | Lora设备ID |
请求参数举例
注意
GET请求所有参数类型都会拼接在url上面,文档为了表述清晰,将示例结构以json格式编写
{"_id":"5da99fdd25daef001b464d87"}
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | false | 返回设备信息 |
返回参数举例
{
"code": 0,
"data": {
"status": 1,
"tags": [],
"_id": "5da99fdd25daef001b464d87",
"name": "温湿度-NAYOTA-LORA",
"attribute": [
{
"_id": "5d4c022ec3d2be6d95c41c00",
"key": "温湿度采样周期",
"value": "10"
},
{
"_id": "5d4c022ec3d2be6d95c41bff",
"key": "定时上报周期",
"value": "1800"
},
{
"_id": "5d4c022ec3d2be6d95c41bfe",
"key": "触发上报温度差",
"value": "1"
},
{
"_id": "5d4c022ec3d2be6d95c41bfd",
"key": "触发上报湿度差",
"value": "1"
}
],
"type": "06",
"loraMaster": "5da994dc0dc418001b95d385",
"control": "5da994dc0dc418001b95d381",
"loraData": {
"_id": "5da5c5707c13d7001bdb4fd4",
"type": 0,
"comName": "/dev/ttyAMA0",
"address": "01",
"frequency": "1d34ce80",
"bandwidth": "07",
"codingrate": "02",
"factor": "09"
},
"agreement": "5d4c015bc3d2be6d95c41be9",
"hardwareWord": "5d4c022ec3d2be6d95c41bfc",
"creator": "5da994550dc418001b95d36f",
"createdAt": "2019-10-18T11:19:57.310Z",
"updatedAt": "2022-03-15T14:58:51.744Z",
"shortAddress": "0001",
"__v": 1,
"line": false,
"id": "5da99fdd25daef001b464d87"
}
}
# 查询设备ID+检测器控制器
接口说明
根据设备ID查询设备并且会将设备下的检测器和控制器放入设备信息
接口版本
v1接口地址
/api-v1/lora-slaves/:id/full
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | Lora设备ID |
请求参数举例
注意
GET请求所有参数类型都会拼接在url上面,文档为了表述清晰,将示例结构以json格式编写
{"_id":"5da99fdd25daef001b464d87"}
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | false | 返回设备信息 |
返回参数举例
{
"code": 0,
"data": {
"status": 1,
"tags": [],
"_id": "5da99fdd25daef001b464d87",
"name": "温湿度-NAYOTA-LORA",
"attribute": [
{
"_id": "5d4c022ec3d2be6d95c41c00",
"key": "温湿度采样周期",
"value": "10"
},
{
"_id": "5d4c022ec3d2be6d95c41bff",
"key": "定时上报周期",
"value": "1800"
},
{
"_id": "5d4c022ec3d2be6d95c41bfe",
"key": "触发上报温度差",
"value": "1"
},
{
"_id": "5d4c022ec3d2be6d95c41bfd",
"key": "触发上报湿度差",
"value": "1"
}
],
"type": "06",
"loraMaster": "5da994dc0dc418001b95d385",
"control": "5da994dc0dc418001b95d381",
"loraData": {
"_id": "5da5c5707c13d7001bdb4fd4",
"type": 0,
"comName": "/dev/ttyAMA0",
"address": "01",
"frequency": "1d34ce80",
"bandwidth": "07",
"codingrate": "02",
"factor": "09"
},
"agreement": "5d4c015bc3d2be6d95c41be9",
"hardwareWord": "5d4c022ec3d2be6d95c41bfc",
"creator": "5da994550dc418001b95d36f",
"createdAt": "2019-10-18T11:19:57.310Z",
"updatedAt": "2022-03-15T14:58:51.744Z",
"shortAddress": "0001",
"__v": 1,
"line": false,
"checks": [
{
"line": false,
"value": 2.56,
"valueStr": null,
"boardConfigStr": "{}",
"_id": "5da99fdd25daef001b464d90",
"name": "电压",
"company": "V",
"icon": "icon-48",
"interval": null,
"precision": 0.1,
"sort": 1,
"canRead": false,
"control": "5da994dc0dc418001b95d381",
"shortAddress": "0",
"creator": "5da994550dc418001b95d36f",
"createdAt": "2019-10-18T11:19:57.406Z",
"updatedAt": "2022-03-15T14:58:31.122Z",
"__v": 0,
"valueAt": "2019-10-30T11:15:14.099Z",
"parentName": "LoraSlave",
"parent": "5da99fdd25daef001b464d87"
},
{
"line": false,
"value": 49.7,
"valueStr": null,
"boardConfigStr": "{}",
"_id": "5da99fdd25daef001b464d91",
"name": "湿度",
"company": "%",
"icon": "icon-kongqishidu",
"interval": null,
"precision": 1,
"sort": 3,
"canRead": false,
"control": "5da994dc0dc418001b95d381",
"shortAddress": "2",
"creator": "5da994550dc418001b95d36f",
"createdAt": "2019-10-18T11:19:57.418Z",
"updatedAt": "2022-03-15T14:58:31.122Z",
"__v": 0,
"valueAt": "2019-10-30T11:15:14.102Z",
"parentName": "LoraSlave",
"parent": "5da99fdd25daef001b464d87"
},
{
"line": false,
"value": 23.4,
"valueStr": null,
"boardConfigStr": "{}",
"_id": "5da99fdd25daef001b464d93",
"name": "温度",
"company": "℃",
"icon": "icon-wenshidu",
"interval": null,
"precision": 0.1,
"sort": 2,
"canRead": false,
"control": "5da994dc0dc418001b95d381",
"shortAddress": "1",
"creator": "5da994550dc418001b95d36f",
"createdAt": "2019-10-18T11:19:57.430Z",
"updatedAt": "2022-03-15T14:58:31.122Z",
"__v": 0,
"valueAt": "2019-10-30T11:15:14.104Z",
"parentName": "LoraSlave",
"parent": "5da99fdd25daef001b464d87"
}
],
"operates": [],
"id": "5da99fdd25daef001b464d87"
}
}
# 新建
接口说明
新建一个Lora设备。第三方不建议直接调用Lora设备新建接口,此接口创建需实际设备。
接口版本
v1接口地址
/api-v1/lora-slaves
请求方法
POST
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
body | - | Object | True | Lora设备对象字段说明 |
请求参数举例
{
"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"
}
}
第三方不建议直接调用Lora设备新建接口,此接口创建需实际设备。文档不提供新增在线调试
# 编辑
接口说明
修改Lora设备。第三方不建议直接调用Lora设备修改接口,此接口使用需实际设备。
接口版本
v1接口地址
/api-v1/lora-slaves/:id
请求方法
PUT
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 修改的Lora设备ID |
body | - | Object | True | Lora设备对象字段说明 |
请求参数举例
{
"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"
}
}
第三方不建议直接调用Lora设备修改接口,此接口修改需实际设备。文档不提供修改在线调试
# 删除
接口说明
删除一个Lora设备。第三方不建议直接调用Lora设备删除接口,此接口需实际设备。
接口版本
v1接口地址
/api-v1/lora-slaves/:id
请求方法
DELETE
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 删除的Lora设备ID |
请求参数举例
只需发送删除设备的ID
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
message | string | false | 成功删除返回complete |
返回参数举例
{
"code": 0,
"message": "complete"
}
第三方不建议直接调用Lora设备删除接口,此接口需实际设备。文档不提供删除在线调试