Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dragonxu/edgex-thingsboard
https://github.com/dragonxu/edgex-thingsboard
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dragonxu/edgex-thingsboard
- Owner: dragonxu
- License: mit
- Created: 2021-04-25T13:37:56.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-04-23T07:21:12.000Z (almost 4 years ago)
- Last Synced: 2024-08-05T14:15:27.579Z (6 months ago)
- Size: 64.5 KB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.cn.md
- License: LICENSE
Awesome Lists containing this project
- awesome-thingsboard - Edgex-thingsboard - micro service that connects Edgex to Thingsboard by MQTT (Integrations / IoT systems)
README
# Edgex-thingsboard
用于将Edgex网关接入Thingsboard物联网平台。
- 将 Edgex 设备自动连接到 Thingsboard
- 将 Edgex 设备数据上报到 Thingsboard
- 响应 Thingsboard RPC 命令
## 使用方式
启动服务时，需配置Thingsboard服务端MQTT的连接信息。
如使用配置文件方式：
```
[Mqtt]
Address = "tcp://localhost:1883"
Username = "edgex-thingsboard"
ClientId = "client-id"
Timeout = 10000
```
或使用环境变量方式：
```
MQTT_ADDRESS: tcp://localhost:1883
MQTT_USERNAME: edgex-thingsboard
MQTT_CLIENTID: client-id
MQTT_TIMEOUT: "10000"
```
其中：
|参数|名称|描述|
|---|---|---|
| Mqtt.Address | MQTT Broker 地址| |
| Mqtt.Username | 用户名 | |
| Mqtt.ClientId | 客户端ID | |
| Mqtt.Timeout | 超时时间 | 单位为毫秒 |
## 编译
使用消息总线 zeroMQ [需要先安装 zeroMQ 库](https://github.com/edgexfoundry/edgex-go#zeromq).
## 实现原理
### 连接设备
1. Edgex会按如下格式发送MQTT消息给Thingsboard：
发送消息：
```json
{
"device": "Virtual-Sensor-01"
}
```
其中：
|参数|名称|描述|
|---|---|---|
| device | 设备名称 ||
### 控制RPC
1. Thingsboard会按如下格式发送MQTT消息给Edgex：
发送消息：
```json
{
"device": "Virtual-Sensor-01",
"data": {
"id": 4,
"method": "GET",
"service": "edgex-core-command",
"uri": "/api/version",
"params": {},
"api_timeout": 10000
}
}
```
其中：
|参数|名称|描述|
|---|---|---|
| device | 设备名称 ||
| data.id | 请求ID ||
| data.service | 微服务名称 ||
| data.uri | HTTP接口地址 ||
| data.method | HTTP请求方法 ||
| data.params | HTTP请求参数 ||
| data.api_timeout | HTTP请求超时时间 | 单位为毫秒 |
|service值|对应微服务名称|微服务接口地址|
|---|---|---|
| edgex-core-command | 命令微服务 | https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-command |
| edgex-core-data | 核心数据微服务 | https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-command |
| edgex-core-metadata | 元数据微服务 | https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-command |
| edgex-support-notifications | 通知微服务 | https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-command |
| edgex-support-scheduler | 调度微服务 | https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/support-scheduler/1.2.1 |
| edgex-sys-mgmt-agent | 系统管理微服务 | https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/support-scheduler/1.2.1 |
2. Edgex处理完RPC消息后，会返回如下MQTT消息给Thingsboard：
```json
{
"device": "Virtual-Sensor-01",
"id": 4,
"data": {
"http_status": 200,
"success": true,
"message": "",
"result": {}
}
}
```
其中：
|参数|名称|描述|
|---|---|---|
| id | 请求ID ||
| device | 设备名称 ||
| data.http_status | HTTP状态码 ||
| data.success | 响应结果 ||
| data.message | 响应错误信息 ||
| data.result | 响应数据 ||
### 遥测数据
Edgex会将遥测数据按如下格式发往给Thingsboard：
```json
{
"Device A": [{
"ts": 1483228800000,
"values": {
"temperature": 42,
"humidity": 80
}
}, {
"ts": 1483228801000,
"values": {
"temperature": 43,
"humidity": 82
}
}],
"Device B": [{
"ts": 1483228800000,
"values": {
"temperature": 42,
"humidity": 80
}
}]
}
```