Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

61850 doc #534

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions en_US/api/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -1306,6 +1306,10 @@ To update both group name and interval:
//optional, when using the MQTT plugin, the topic field needs to be added
"params": {
"topic": "/neuron/mqtt/group-1"
},
//optional, static tags
"static_tags": {
"static_tag1": "aabb", "static_tag2": 1.401, "static_tag3": false, "static_tag4": [1,2,4]
}
}
```
Expand Down Expand Up @@ -1350,6 +1354,10 @@ To update both group name and interval:
"params": {
//when using the MQTT plugin, the topic key is the upload topoic
"topic": "/neuron/mqtt/modbus1/group1"
},
//optional, static tags
"static_tags": {
"static_tag1": "aabb", "static_tag2": 1.401, "static_tag3": false, "static_tag4": [1,2,4]
}
},
{
Expand Down Expand Up @@ -1400,6 +1408,10 @@ To update both group name and interval:
"params": {
//when using the MQTT plugin, the topic key is the upload topic
"topic": "/neuron/mqtt/group-1"
},
//optional, static tags
"static_tags": {
"static_tag1": "aabb", "static_tag2": 1.401, "static_tag3": false, "static_tag4": [1,2,4]
}
}
```
Expand Down Expand Up @@ -1487,6 +1499,10 @@ To update both group name and interval:
//when using the MQTT plugin, the topic field needs to be added
"params": {
"topic": "/neuron/mqtt/group-1"
},
//optional, static tags
"static_tags": {
"static_tag1": "aabb", "static_tag2": 1.401, "static_tag3": false, "static_tag4": [1,2,4]
}
},
{
Expand Down
53 changes: 53 additions & 0 deletions en_US/configuration/north-apps/mqtt/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,59 @@ The following example data is in *values-format*, where tag values collected suc
}
```

### Custom Format

In the custom format, use built-in variables to define the data upload format.

#### Variables

| *variable* | *description* |
| ------------------ | ---------------------- |
| `${timestamp}` | The UNIX timestamp when the data was read. |
| `${node}` | The name of the southbound node. |
| `${group}` | The name of the group. |
| `${tag_values}` | The array of valid tag values. |
| `${tag_errors}` | The array of error codes. |
| `${static_tags}` | The array of static tags. |

#### Example

The custom format is defined using built-in variables.
```json
{
"timestamp": "${timestamp}",
"node": "${node}",
"group": "${group}",
"values": "${tag_values}",
"static": "${static_tags}"
}
```

The following is an example of the custom format data.
```json
{
"timestamp": 1650006388943,
"node": "modbus",
"group": "group",
"values": [
{
"name": "tag0",
"value": 123
},
{
"name": "tag1",
"value": false
}
],
"static": [
{
"name": "static_tag1",
"value": 456
}
]
}
```

::: tip
Tag value is returned only when the tag is read successfully. If something goes wrong when reading a tag, the error code is returned.
:::
Expand Down
17 changes: 13 additions & 4 deletions en_US/configuration/south-devices/iec61850/faq.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
# FAQ

## Device status shows disconnected
## 10900 - 10999: IEC61850 Driver Error Codes

Verify that the IEC61850 server is up and running correctly, you can use Telnet to test the server port for accessibility

Make sure the Neuron device connection is set up correctly
* 10900: Object invalidated
* 10901: Hardware fault
* 10902: Temporarily unavailable
* 10903: Object access denied
* 10904: Object undefined
* 10905: Invalid address
* 10906: Type unsupported
* 10907: Type inconsistent
* 10908: Object attribute inconsistent
* 10909: Object access unsupported
* 10910: Object non-existent
* 10911: Object value invalid
57 changes: 2 additions & 55 deletions en_US/configuration/south-devices/iec61850/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,65 +21,12 @@ After clicking **Create**, you will be redirected to the **Device Configuration*
| -------- | -------------------------- |
| **Device IP Address** | Target device IP |
| **Device Port** | Target device port, Default 102 |
| **Local AP Title** | ACSE AP-Title of this device as string (default = '1,1,1,999') |
| **Local AE Qualifier** | ACSE AE-Qualifier of this device (default = 12) |
| **Local P Selector** | Local PSAP-Address (PSAP = Presentation Service Access Point, default = 1) |
| **Local S Selector** | Local SSAP-Address (SSAP = Session Service Access Point, default = 1) |
| **Local T Selector** | Local TSAP-Address (TSAP = Transport Service Access Point, default = 1) |
| **Remote AP Title** | ACSE AP-Title of remote device as string (default = '1,1,1,999.1') |
| **Remote AE Qualifier** | ACSE AE-Qualifier of remote device (default = 12) |
| **Remote P Selector** | Remote PSAP-Address (PSAP = Presentation Service Access Point, default = 1) |
| **Remote S Selector** | Remote SSAP-Address (SSAP = Session Service Access Point, default = 1) |
| **Remote T Selector** | Remote TSAP-Address (TSAP = Transport Service Access Point, default = 1) |
| **Authentication Enabled** | Whether to enable Authentication |
| **Authentication Method** | Set authentication method if authentication is enabled, values: Password/None |
| **Authentication Password** | Set authentication password if authentication is enabled |

| **GI Interval** | The interval at which the device sends a general interrogation. Set to 0 to disable general interrogation. Unit: seconds |
## Configure Data Groups and Tags

After the plug-in is added and configured, the next step is to establish communication between your device and Neuron by adding groups and tags to the Southbound driver.

Once device configuration is completed, navigate to the **South Devices** page. Click on the device card or device row to access the **Group List** page. Here, you can create a new group by clicking on **Create**, then specifying the group name and data collection interval.

Upon successfully creating a group, click on its name to proceed to the **Tag List** page. This page allows you to add device tags for data collection. You'll need to provide information such as the tag address, attributes, and data type.

For information on general configuration items, see [Connect to Southbound Devices](../south-devices.md). The subsequent section will concentrate on configurations specific to the driver.

### Data Types

* INT8
* UINT8
* INT16
* UINT16
* INT32
* UINT32
* INT64
* UINT64
* FLOAT
* DOUBLE
* BOOL
* STRING

### Address Format

> Logical Devices/Logical Nodes$FC$DO$DA

### Example Addresses

| Address | Data Type | Description |
| ------------------------------------- | -------- | ---------------------------------------------------- |
| GenericIO/GGIO1$CF$Mod$ctlModel | INT8 | LD-GenericIO,LN-GGIO1,FC-CF,DO-Mod,DA-ctlModel |
| GenericIO/GGIO1$CO$SPCSO1$Oper$ctlNum | UINT8 | LD-GenericIO,LN-GGIO1,FC-CO,DO-SPCSO1,DA-Oper$ctlNum |
| GenericIO/GGIO1$CF$SPCSO1$ctlModel | INT16 | LD-GenericIO,LN-GGIO1,FC-CF,DO-SPCSO1,DA-ctlModel |
| GenericIO/GGIO1$CO$SPCSO2$Oper$ctlNum | UINT16 | LD-GenericIO,LN-GGIO1,FC-CO,DO-SPCSO2,DA-Oper$ctlNum |
| GenericIO/GGIO1$CF$SPCSO2$ctlModel | INT32 | LD-GenericIO,LN-GGIO1,FC-CF,DO-SPCSO2,DA-ctlModel |
| GenericIO/GGIO1$ST$SPCSO4$Oper$ctlNum | UINT32 | LD-GenericIO,LN-GGIO1,FC-ST,DO-SPCSO4,DA-Oper$ctlNum |
| GenericIO/GGIO1$CF$SPCSO3$ctlModel | INT64 | LD-GenericIO,LN-GGIO1,FC-CF,DO-SPCSO3,DA-ctlModel |
| GenericIO/GGIO1$ST$SPCSO1$ctlNum | UINT64 | LD-GenericIO,LN-GGIO1,FC-ST,DO-SPCSO1,DA-ctlNum |
| GenericIO/GGIO1$MX$AnIn1$mag$f | FLOAT | LD-GenericIO,LN-GGIO1,FC-MX,DO-AnIn1,DA-mag$f |
| GenericIO/GGIO1$MX$AnIn3$mag$f | DOUBLE | LD-GenericIO,LN-GGIO1,FC-MX,DO-AnIn3,DA-mag$f |
| GenericIO/GGIO1$CO$SPCSO1$Oper$Test | BOOL | LD-GenericIO,LN-GGIO1,FC-CO,DO-SPCSO1,DA-Oper$Test |
| GenericIO/LLN0$DC$NamPlt$vendor | STRING | LD-GenericIO,LN-GGIO1,FC-DC,DO-NamPlt,DA-vendor |
The IEC61850 plugin only supports the automatic addition of groups and tags by importing an SCL file. The Report block in the SCL file generates readable data groups, and the points are generated based on the referenced DataSet. Points are generated for data with FC as CO, SP, and SG. Writable points are generated in a separate Control group.

## Use Case

Expand Down
18 changes: 17 additions & 1 deletion zh_CN/api/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -1317,6 +1317,10 @@ Neuron 将为 IIoT 平台提供一系列 API 服务,用于查询基本信息
//when using the MQTT plugin, the topic field needs to be added
"params": {
"topic": "/neuron/mqtt/group-1"
},
//optional, static tags
"static_tags": {
"static_tag1": "aabb", "static_tag2": 1.401, "static_tag3": false, "static_tag4": [1,2,4]
}
}
```
Expand Down Expand Up @@ -1361,7 +1365,11 @@ Neuron 将为 IIoT 平台提供一系列 API 服务,用于查询基本信息
"params": {
//when using the MQTT plugin, the topic key is the upload topoic
"topic": "/neuron/mqtt/modbus1/group1"
}
},
//optional, static tags
"static_tags": {
"static_tag1": "aabb", "static_tag2": 1.401, "static_tag3": false, "static_tag4": [1,2,4]
}
},
{
"driver": "modbus2",
Expand Down Expand Up @@ -1411,6 +1419,10 @@ Neuron 将为 IIoT 平台提供一系列 API 服务,用于查询基本信息
"params": {
//when using the MQTT plugin, the topic key is the upload topic
"topic": "/neuron/mqtt/group-1"
},
//optional, static tags
"static_tags": {
"static_tag1": "aabb", "static_tag2": 1.401, "static_tag3": false, "static_tag4": [1,2,4]
}
}
```
Expand Down Expand Up @@ -1499,6 +1511,10 @@ Neuron 将为 IIoT 平台提供一系列 API 服务,用于查询基本信息
"params": {
"topic": "/neuron/mqtt/group-1"
}
//optional, static tags
"static_tags": {
"static_tag1": "aabb", "static_tag2": 1.401, "static_tag3": false, "static_tag4": [1,2,4]
}
},
{
//driver name
Expand Down
55 changes: 54 additions & 1 deletion zh_CN/configuration/north-apps/mqtt/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
## 数据上报

Neuron MQTT 插件将采集到的数据以 JSON 形式发布到指定的主题。
上报数据的具体格式由**上报数据格式**参数指定,有 *tags-format* 和 *values-format* 两种格式
上报数据的具体格式由**上报数据格式**参数指定,有多种格式可选

### 上报主题

Expand Down Expand Up @@ -72,6 +72,59 @@ Neuron MQTT 插件将采集到的数据以 JSON 形式发布到指定的主题
}
```

### 自定义格式

在自定义格式中,可以使用内置支持的变量自定义数据上报格式。

#### 内置变量

| *变量名称* | *说明* |
| ------------------ | ---------------------- |
| `${timestamp}` | 数据采集时的 UNIX 时间戳。 |
| `${node}` | 被采集的南向节点的名字。 |
| `${group}` | 被采集的南向节点的点位组的名字。 |
| `${tag_values}` | 南向采集点位有效值的数组。 |
| `${tag_errors}` | 南向采集点位报错的数组。 |
| `${static_tags}` | 订阅时自定义配置的静态点位。 |

#### 示例

自定义数据格式配置为:
```json
{
"timestamp": "${timestamp}",
"node": "${node}",
"group": "${group}",
"values": "${tag_values}",
"static": "${static_tags}"
}
```

数据上报的格式为:
```json
{
"timestamp": 1650006388943,
"node": "modbus",
"group": "group",
"values": [
{
"name": "tag0",
"value": 123
},
{
"name": "tag1",
"value": false
}
],
"static": [
{
"name": "static_tag1",
"value": 456
}
]
}
```

::: tip
当点位采集成功时,返回采集到的数据。当点位采集发生错误时,返回错误码,不再返回数值。
:::
Expand Down
18 changes: 14 additions & 4 deletions zh_CN/configuration/south-devices/iec61850/faq.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
# 常见问题
# FAQ

## 设备状态显示连接断开
## 10900 - 10999: IEC61850 驱动错误码

确认 IEC61850 服务器是否正确启动,可以使用 Telnet 测试服务器端口是否可访问
* 10900: 无效对象
* 10901: 硬件故障
* 10902: 暂时不可用
* 10903: 对象访问被拒绝
* 10904: 对象未定义
* 10905: 无效地址
* 10906: 类型不支持
* 10907: 类型不一致
* 10908: 对象属性不一致
* 10909: 对象访问不支持
* 10910: 对象不存在
* 10911: 对象值无效

确保 Neuron 的设备连接设置正确
Loading
Loading