Skip to content

Commit 1fd0193

Browse files
authored
Merge pull request #565 from gc87/spb-statictags-v2.12
[v2.12]feat(spb): static tags description
2 parents d2d9f3e + 31e86e5 commit 1fd0193

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

en_US/configuration/north-apps/sparkplugb/overview.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,16 @@ Sparkplug B is an application-based protocol running on top of MQTT, so the setu
1919
| **Client ID** | MQTT client ID, a unique identifier for the connection |
2020
| **Group ID** | The top-level logical grouping in the Sparkplug B protocol, which can represent entities such as factories or workshops |
2121
| **Node ID** | Unique Identification of Edge Nodes in Sparkplug B Protocol |
22-
| **SSL** | Whether to enable mqtt ssl, default false |
22+
| **Group Path** | Use the group name of the southbound device as the starting path of the Metric name. default true |
23+
| **Offline Data Caching** | Offline caching switch. Cache MQTT messages when offline, and sync cached messages when back online. |
24+
| **Cache Memory Size (MB)** | Max in-memory cache size in megabytes when MQTT connection exception occurs. Should be smaller than cache disk size. |
25+
| **Cache Disk Size (MB)** | Max in-disk cache size in megabytes when MQTT connection exception occurs. Should be larger than cache memory size. If nonzero, cache memory size should also be nonzero. |
26+
| **Cache Sync Interval (MS)** | Cache message retransmission interval, unit: milliseconds |
2327
| **Broker Host** | MQTT Broker Host |
2428
| **Broker Port** | MQTT Broker Port |
2529
| **Username** | Username to use when connecting to Broker |
2630
| **Password** | Password to use when connecting to Broker |
31+
| **SSL** | Whether to enable mqtt ssl, default false |
2732
| **CA** | Ca file, enabled only if the ssl value is true |
2833
| **Client Cert** | Cert file, enabled only if the ssl value is true |
2934
| **Client Key** | Key file, enabled only if the ssl value is true |
@@ -42,6 +47,11 @@ Click the device card or row on the **North Apps** page, then **Add Subscription
4247
- **South device**: Select the southbound device you want to subscribe to, for example, 'modbus-tcp-1'.
4348
- **Group**: Select a group from the southbound device, for example, 'group-1'.
4449

50+
Add static tags in Json format and report them simultaneously with the southbound data tags:
51+
``` json
52+
{"location":"sh","number":"12345613"}
53+
```
54+
4555
## Use Case
4656

4757
- You can use the Neuron Sparkplug B plugin to report data to EMQX, and decode the complete and accurate data results through the EMQX's encoding and decoding functions. For specific steps, see [Integration with EMQX](sparkplug.md).

zh_CN/configuration/north-apps/sparkplugb/overview.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,16 @@ Sparkplug B 是运行在 MQTT 之上的应用型协议,所以在 Neuron 中的
1717
| **客户端 ID** | MQTT 客户端 ID,连接的唯一标识 |
1818
| **组 ID** | Sparkplug B 协议中的最顶层逻辑分组,可以代表工厂或车间等实体 |
1919
| **节点 ID** | Sparkplug B 协议中的边缘节点唯一标识 |
20-
| **SSL** | 是否启用 mqtt ssl,默认 false |
20+
| **组 Path** | 将南向设备的组名称作为指标名称的起始路径,值为 true 时启用, 默认开启 |
21+
| **离线缓存** | 离线缓存开关。连接断开时缓存 MQTT 消息,连接重建时同步缓存的 MQTT 消息到服务器, 值为 true 时开启,默认关闭 |
22+
| **缓存内存大小** | 当 MQTT 连接异常时,最大的内存缓存大小(单位:MB)。应该小于缓存磁盘大小。 |
23+
| **缓存磁盘大小** | 当 MQTT 连接异常时,最大的磁盘缓存大小(单位:MB)。应该大于缓存内存大小。如果不为 0,缓存内存大小也应该不为 0。 |
24+
| **缓存消息重传间隔** | 缓存消息重传间隔(MS),单位毫秒 |
2125
| **服务器地址** | MQTT Broker 主机 |
2226
| **服务器端口** | MQTT Broker 端口号 |
2327
| **用户名** | 连接到 Broker 时使用的用户名 |
2428
| **密码** | 连接到 Broker 时使用的密码 |
29+
| **SSL** | 是否启用 mqtt ssl,默认 false |
2530
| **CA 证书** | ca 文件,只在 ssl 值为 true 时启用 |
2631
| **客户端证书** | cert 文件,只在 ssl 值为 true 时启用 |
2732
| **客户端私钥** | key 文件,只在 ssl 值为 true 时启用 |
@@ -37,6 +42,11 @@ Sparkplug B 是运行在 MQTT 之上的应用型协议,所以在 Neuron 中的
3742

3843
点击 SparkPlugB 节点卡片,进入**组列表**页,点击 **添加订阅** 选择要订阅的点位组,订阅南向设备的点位组。完成订阅后,我们的北向 SparkPlug B 应用将开始接受南向数据。
3944

45+
添加 Json 格式静态数据点位,与数采测点同时上报:
46+
``` json
47+
{"location":"sh","number":"12345613"}
48+
```
49+
4050
## 应用场景
4151

4252
您可通过 Neuron Sparkplug B 插件将数据上报到 EMQX,并通过 EMQX 的编解码功能得到正确完整的数据结果,具体结果,见 [集成 EMQX](sparkplug.md)

0 commit comments

Comments
 (0)