modelRT/api.md

116 lines
2.4 KiB
Markdown

# 接口协议
## 实时数据接口示例
### 开启实时数据的订阅
```json
{
"action": "start",
"components": [
{
"interval": "1",
"targets": [
"grid1.zone1.station1.ns1.tag1.transformfeeder1_220.I_A_rms",
"grid1.zone1.station1.ns1.tag1.transformfeeder1_220.I_B_rms"
]
},
{
"interval": "2",
"targets": [
"grid1.zone1.station1.ns1.tag1.transformfeeder1_220.I_C_rms"
]
}
]
}
```
### 实时数据订阅成功
```json
{
"targets": [
{
"id": "grid1.zone1.station1.ns1.tag1.transformfeeder1_220.I_A_rms",
"code": "1001",
"msg": "subscription success"
},
{
"id": "grid1.zone1.station1.ns1.tag1.transformfeeder1_220.I_B_rms",
"code": "1002",
"msg": "subscription failed"
}
]
}
```
### 实时数据的返回
```json
{
"targets": [
{
"id": "grid1.zone1.station1.ns1.tag1.transformfeeder1_220.I_A_rms",
"datas": [
{
"time": 1736305467506000000,
"value": 1
},
{
"time": 1736305467506000000,
"value": 1
}
]
},
{
"id": "grid1.zone1.station1.ns1.tag1.transformfeeder1_220.I_B_rms",
"datas": [
{
"time": 1736305467506000000,
"value": 1
},
{
"time": 1736305467506000000,
"value": 1
}
]
}
]
}
```
### 结束实时数据的获取
```json
{
"action": "stop",
"targets": [
"grid1.zone1.station1.ns1.tag1.transformfeeder1_220.I_A_rms",
"grid1.zone1.station1.ns1.tag1.transformfeeder1_220.I_B_rms"
]
}
```
## 实时数据状态值
| 动作描述 | 示例值 |
| :--- | :--- |
| 订阅成功 | 1001 |
| 订阅失败 | 1002 |
| 实时数据返回成功 | 1003 |
| 实时数据返回失败 | 1004 |
| 取消订阅成功 | 1005 |
| 取消订阅失败 | 1006 |
## 实时数据标志
### 以设备语言中的type作为区分方式
| 标志描述 | 示例值 |
| :--- | :--- |
| 遥测 | TE |
| 遥信 | TI |
| 遥控 | TC |
| 遥调 | TA |
| 定值 | - |