Skip to content

Commit

Permalink
Merge pull request #17 from emqx/update-product-name
Browse files Browse the repository at this point in the history
update product name from ecp edge to Neuronex
  • Loading branch information
LenaLenaPan authored Aug 18, 2023
2 parents edf9ae2 + 7a9ecf3 commit e3e3d8f
Show file tree
Hide file tree
Showing 95 changed files with 380 additions and 380 deletions.
2 changes: 1 addition & 1 deletion neuronex/preview.sh
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ THIS_DIR="$(cd "$(dirname "$(readlink "$0" || echo "$0")")"; pwd -P)"

docker rm ecp-doc-preview || true

docker run -p ${PORT}:8080 -it --name ecp-doc-preview \
docker run -p ${PORT}:8080 -it --name neuronex-doc-preview \
--platform linux/amd64 \
-v "$THIS_DIR"/directory.json:/app/docs/.vitepress/config/directory.json \
-v "$THIS_DIR"/zh_CN:/app/docs/zh/emqx-ecp/latest \
Expand Down
4 changes: 2 additions & 2 deletions neuronex/zh_CN/config/ecp_edge_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

插件可以分为北向应用和南向驱动程序。北向插件通常用于连接到云平台或像处理引擎这样的外部应用程序。南向插件是实现特定协议以访问外部设备的通信驱动程序。为了实现协议格式转换,至少需要一个北向插件和一个南向插件分别用于数据传递和数据采集。

登录 ECP Edge 后,您可点击**配置** -> **插件**查看系统的插件列表。您也可点击左上角的**添加插件**按钮安装自定义插件。
登录 NeuronEX 后,您可点击**配置** -> **插件**查看系统的插件列表。您也可点击左上角的**添加插件**按钮安装自定义插件。

您可访问[插件列表页](../intro/plugin-list.md)获取 ECP Edge 完整支持的插件列表。
您可访问[插件列表页](../intro/plugin-list.md)获取 NeuronEX 完整支持的插件列表。

## 查看可用插件模块

Expand Down
4 changes: 2 additions & 2 deletions neuronex/zh_CN/config/groups-tags/groups-tags.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 连接南向设备

点位是分配给一条信息的非分层唯一关键字,其中定义了设备中的数据存储位置和数据操作属性,还包含有关数据的一些元数据信息,如缩放、精确度和读/写属性等。点位将被分配到组中。每个组都有独立的轮询频率以从设备中读取数据。要建立设备与 ECP Edge 之间的通信,首先为南向驱动程序添加组和点位。创建好组和点位,即可从数据监控中获取点位的实时值。
点位是分配给一条信息的非分层唯一关键字,其中定义了设备中的数据存储位置和数据操作属性,还包含有关数据的一些元数据信息,如缩放、精确度和读/写属性等。点位将被分配到组中。每个组都有独立的轮询频率以从设备中读取数据。要建立设备与 NeuronEX 之间的通信,首先为南向驱动程序添加组和点位。创建好组和点位,即可从数据监控中获取点位的实时值。

## 在设备卡片中创建组

Expand Down Expand Up @@ -45,7 +45,7 @@



点位创建完成后,设备卡片的工作状态处于 **运行中**,连接状态应处于 **已连接**。若此时连接状态仍然处于 **未连接** 的状态,请先在 ECP Edge 运行环境终端执行以下指令,以确认 ECP Edge 运行环境能否访问到到对应的 IP 及端口:
点位创建完成后,设备卡片的工作状态处于 **运行中**,连接状态应处于 **已连接**。若此时连接状态仍然处于 **未连接** 的状态,请先在 NeuronEX 运行环境终端执行以下指令,以确认 NeuronEX 运行环境能否访问到到对应的 IP 及端口:

```bash
$ telnet <运行 Modbus 模拟器 PC 端的 IP> 502
Expand Down
2 changes: 1 addition & 1 deletion neuronex/zh_CN/config/import-export.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 导入/导出点位配置

ECP Edge 提供以 Excel 表格方式批量导入和导出标签配置信息的功能,以加速数据标签的配置,同时实现将创建的数据标签信息保存到外部存储中。
NeuronEX 提供以 Excel 表格方式批量导入和导出标签配置信息的功能,以加速数据标签的配置,同时实现将创建的数据标签信息保存到外部存储中。

## 配置导入

Expand Down
8 changes: 4 additions & 4 deletions neuronex/zh_CN/config/introduction.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 配置

本节主要介绍如何在 ECP Edge 中添加南向设备、建立其与 ECP Edge 的通信,并通过北向插件将其连接到云平台或处理引擎等外部应用。
本节主要介绍如何在 NeuronEX 中添加南向设备、建立其与 NeuronEX 的通信,并通过北向插件将其连接到云平台或处理引擎等外部应用。

## 关键概念

Expand All @@ -20,13 +20,13 @@

## 配置流程

以下为如何通过设置 ECP Edge 进行各种工业协议转换、进而完成数据传递和采集的工作流程。
以下为如何通过设置 NeuronEX 进行各种工业协议转换、进而完成数据传递和采集的工作流程。

1. [查看所有可用插件](../intro/plugin-list.md):使用各种工业插件可以实现 ECP Edge 的数据采集和传递功能。
1. [查看所有可用插件](../intro/plugin-list.md):使用各种工业插件可以实现 NeuronEX 的数据采集和传递功能。

2. [创建南向驱动](./south-devices/south-devices.md):根据工业协议为设备通信选择所有必需的南向插件。每个南向插件根据协议规范只有一个与设备或多个设备总线的连接。根据协议规范,每个南向插件只能与一个设备或关联多个设备的一条消息总线建立连接。

3. [建立设备与 ECP Edge 之间的通信](./groups-tags/groups-tags.md):首先为南向驱动程序添加组和点位。创建好组和点位,即可从数据监控中获取点位的实时值。为方便用户操作,ECP 支持通过离线 Excel 文件[批量导入](./import-export.md)相关配置信息。
3. [建立设备与 NeuronEX 之间的通信](./groups-tags/groups-tags.md):首先为南向驱动程序添加组和点位。创建好组和点位,即可从数据监控中获取点位的实时值。为方便用户操作,ECP 支持通过离线 Excel 文件[批量导入](./import-export.md)相关配置信息。

:::tip

Expand Down
16 changes: 8 additions & 8 deletions neuronex/zh_CN/config/north-apps/ekuiper/ekuiper.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

LF Edge [eKuiper] 是 Golang 实现的轻量级物联网边缘分析、流式处理开源软件,可以运行在各类资源受限的边缘设备上。eKuiper 的主要目标是在边缘端提供一个流媒体软件框架。eKuiper 的规则引擎允许用户提供基于 SQL 或基于图形的规则,在几分钟内创建物联网边缘分析应用。

ECP Edge eKuiper 插件使用户能够将收集到的数据发布到 eKuiper 以进一步处理。
作为一款工业网关,ECP Edge 为众多使用不同协议的不同设备提供一站式访问,而 eKuiper 具有数据过滤、聚合、转换和路由的能力。
NeuronEX eKuiper 插件使用户能够将收集到的数据发布到 eKuiper 以进一步处理。
作为一款工业网关,NeuronEX 为众多使用不同协议的不同设备提供一站式访问,而 eKuiper 具有数据过滤、聚合、转换和路由的能力。
将两个产品结合在一起,您将得到双重优势,这极大地降低了边缘计算解决方案的资源要求,并能发掘更多的用例。

## 参数
Expand All @@ -17,9 +17,9 @@ ECP Edge eKuiper 插件使用户能够将收集到的数据发布到 eKuiper 以

## 集成 eKuiper

ECP Edge 和 eKuiper 之间的交互是双向的,需要两边同时提供支持:
* ECP Edge 方面,提供 eKuiper 插件以支持向 eKuiper 发布数据并接收命令。
* eKuiper 方面,提供一个 ECP Edge 源以支持从 ECP Edge 订阅数据,以及一个 ECP Edge 动作以支持通过 ECP Edge 控制设备。
NeuronEX 和 eKuiper 之间的交互是双向的,需要两边同时提供支持:
* NeuronEX 方面,提供 eKuiper 插件以支持向 eKuiper 发布数据并接收命令。
* eKuiper 方面,提供一个 NeuronEX 源以支持从 NeuronEX 订阅数据,以及一个 NeuronEX 动作以支持通过 NeuronEX 控制设备。

两端可以使用 TCP 传输层,并支持多对多的连接。

Expand Down Expand Up @@ -82,10 +82,10 @@ ECP Edge 和 eKuiper 之间的交互是双向的,需要两边同时提供支

### *data-stream-processing* 北向节点处于未连接状态,但 eKuiper 运行正常。

确保您创建了使用 eKuiper ECP Edge 源的规则,并且 eKuiper 会延迟连接直到规则被启动。
确保您创建了使用 eKuiper NeuronEX 源的规则,并且 eKuiper 会延迟连接直到规则被启动。

### 如何查看 eKuiper 是否成功从 ECP Edge 采集到数据?
### 如何查看 eKuiper 是否成功从 NeuronEX 采集到数据?

1. 检查 **data-stream-processing** 节点处于连接状态,并且订阅了南向节点。
2. 通过仪表板的性能监控面板,检查 **data-stream-processing** 节点确实采集到了设备数据。
3. 如果使用 ECP Edge 仪表板,可以通过规则的统计面板,检查规则是否被触发。
3. 如果使用 NeuronEX 仪表板,可以通过规则的统计面板,检查规则是否被触发。
18 changes: 9 additions & 9 deletions neuronex/zh_CN/config/north-apps/monitor.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Monitor 插件

ECP Edge 在启动时创建一个 Monitor 单例节点,用于监控运行的 ECP Edge 实例。您可以在仪表板的**北向应用**页签中看到 Monitor 节点。
NeuronEX 在启动时创建一个 Monitor 单例节点,用于监控运行的 NeuronEX 实例。您可以在仪表板的**北向应用**页签中看到 Monitor 节点。

<figure align="center">
<img src="./_assets/monitor_node.png"
style="border:thin solid #E0DCD9; width: 60%"
alt="ECP Edge monitor 节点">
alt="NeuronEX monitor 节点">
<figcaption align = "center">
<sub><b>Fig.1 - ECP Edge Monitor 节点</b></sub>
<sub><b>Fig.1 - NeuronEX Monitor 节点</b></sub>
</figcaption>
</figure>

Expand Down Expand Up @@ -40,8 +40,8 @@ ECP Edge 在启动时创建一个 Monitor 单例节点,用于监控运行的 E

## 数据统计

ECP Edge Monitor 插件兼容 [Prometheus](https://prometheus.io/)[数据统计 HTTP API]
ECP Edge 仪板表的**关于**页面和**数据统计**页签使用这个 API 显示信息。
NeuronEX Monitor 插件兼容 [Prometheus](https://prometheus.io/)[数据统计 HTTP API]
NeuronEX 仪板表的**关于**页面和**数据统计**页签使用这个 API 显示信息。

可以通过点击**系统信息 -> 关于**打开**关于**页面。
<figure align="center">
Expand Down Expand Up @@ -77,13 +77,13 @@ ECP Edge 仪板表的**关于**页面和**数据统计**页签使用这个 API


::: warning 注意
数据统计 API 在 ECP Edge 进程的整个生命周期中都是启用的。
数据统计 API 在 NeuronEX 进程的整个生命周期中都是启用的。
启动或者停止 *monitor* 节点只会停止[心跳](#心跳消息)[事件](#事件消息)上报功能。
:::

## 心跳消息

Monitor 插件可以向 MQTT 服务器发送心跳消息,用于检查 ECP Edge 进程的存活或者节点的状态。
Monitor 插件可以向 MQTT 服务器发送心跳消息,用于检查 NeuronEX 进程的存活或者节点的状态。
除了 MQTT 连接参数,心跳消息功能由**心跳主题****心跳间隔**两个参数控制。
**心跳主题**参数指定心跳上报的 MQTT 主题,**心跳间隔**参数指定每条心跳消息之间间隔的秒数。

Expand All @@ -93,7 +93,7 @@ Monitor 插件可以向 MQTT 服务器发送心跳消息,用于检查 ECP Edge

心跳消息具有以下字段:
* `timestamp` : 消息生成时的 Unix 时间撮。
* `version` : ECP Edge 的版本信息。
* `version` : NeuronEX 的版本信息。
* `states` : 节点状态信息的数组,类似 [节点状态 HTTP API] 响应的数据.

以下是一个心跳消息样例。
Expand All @@ -118,7 +118,7 @@ Monitor 插件可以向 MQTT 服务器发送心跳消息,用于检查 ECP Edge

## 事件消息

事件代表 ECP Edge 进程中的内部状态变化,比如节点的创建,删除或者配置。
事件代表 NeuronEX 进程中的内部状态变化,比如节点的创建,删除或者配置。
系统管理员或者运维工程师通常比较关注这些事件。

Monitor 插件可以向 MQTT 服务器发送事件消息,使用的主题由**事件主题前缀**参数决定。
Expand Down
6 changes: 3 additions & 3 deletions neuronex/zh_CN/config/north-apps/mqtt/mqtt.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

MQTT 是一种为物联网设备和应用程序设计的消息协议,采用发布与订阅模型,具有轻量、高效、可靠的,支持实时通讯等优点。MQTT 非常适合资源受限的环境,特别是需要高效使用电力和带宽的场景。

ECP Edge 支持 MQTT 通讯协议。ECP Edge MQTT 插件允许用户快速构建使用 MQTT 协议的物联网应用程序,可以在设备和云之间进行通讯。
NeuronEX 支持 MQTT 通讯协议。NeuronEX MQTT 插件允许用户快速构建使用 MQTT 协议的物联网应用程序,可以在设备和云之间进行通讯。
使用 MQTT 插件,开发人员还可以向 IoT 设备发布消息,触发设备操作,例如打开或关闭灯、电机或者其他设备。
该插件还支持使用身份验证和加密通讯协议进行安全通讯,确保数据的安全性和隐私性。

Expand Down Expand Up @@ -47,7 +47,7 @@ ECP Edge 支持 MQTT 通讯协议。ECP Edge MQTT 插件允许用户快速构建

### 离线数据缓存

离线数据缓存是 MQTT 插件特有的功能,可以增强构建在 ECP Edge 上的应用程序的鲁棒性和可靠性。
离线数据缓存是 MQTT 插件特有的功能,可以增强构建在 NeuronEX 上的应用程序的鲁棒性和可靠性。

- 当网络中断发生时,MQTT 插件首先将数据存储在内存缓存中,并且仅当内存缓存已满时才将数据刷新到磁盘缓存中。
- 当网络恢复连接时,MQTT 插件将以 FIFO(先进先出)的顺序将缓存的数据发布到服务器上。
Expand All @@ -63,7 +63,7 @@ ECP Edge 支持 MQTT 通讯协议。ECP Edge MQTT 插件允许用户快速构建
SSL/TLS(安全套接字层/传输层安全)是一种安全协议,用于加密网络设备之间的通信通道,提升网络通信安全性。
MQTT over SSL/TLS 是一种通过 SSL/TLS 加密传输 MQTT 消息的安全方法,用于在客户端和 MQTT 服务器之间传输数据,以确保客户端和服务器之间传递的所有数据都是加密且安全的。

ECP Edge MQTT 插件支持 MQTT over SSL。要启用 SSL 加密:
NeuronEX MQTT 插件支持 MQTT over SSL。要启用 SSL 加密:

- 请在配置节点时打开 **SSL** 参数, 并提供证书授权机构的证书作为 **CA 证书**参数。
- 如果使用双向身份验证,还应通过**客户端证书****客户端私钥**,和**客户端私钥密码**参数分别提供客户端证书,私钥文件,和私钥文件密码。
Expand Down
14 changes: 7 additions & 7 deletions neuronex/zh_CN/config/north-apps/north-apps.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# 创建北向应用

插件可以分为北向应用和南向驱动程序。北向插件通常用于连接到云平台或像处理引擎这样的外部应用程序。本节主要介绍如何在 ECP Edge 中创建北向应用。
插件可以分为北向应用和南向驱动程序。北向插件通常用于连接到云平台或像处理引擎这样的外部应用程序。本节主要介绍如何在 NeuronEX 中创建北向应用。

目前 ECP Edge 主要支持四种北向插件:
目前 NeuronEX 主要支持四种北向插件:

- [MQTT 插件](./mqtt/mqtt.md)ECP Edge 支持 MQTT 通讯协议。 ECP Edge MQTT 插件允许用户快速构建使用 MQTT 协议的物联网应用程序,可以在设备和云之间进行通讯。
- [eKuiper 插件](./ekuiper/ekuiper.md):LF Edge [eKuiper](https://ekuiper.org/) 是 Golang 实现的轻量级物联网边缘分析、流式处理开源软件,可以运行在各类资源受限的边缘设备上。ECP Edge eKuiper 插件使用户能够将收集到的数据发布到 eKuiper 以进一步处理。
- [Sparkplug B 插件](./sparkplugb/sparkplugb.md):Sparkplug B 是一种建立在 MQTT 3.1.1 基础上的工业物联网数据传输规范。ECP Edge Sparkplug B 插件从设备采集到的数据可以通过 Sparkplug B 协议从边缘端传输到 Sparkplug B 应用中,用户也可以从应用程序向 ECP Edge 发送数据修改指令。
- [WebSocket 插件](./websocket.md):WebSocket 网络协议支持在单个 TCP 连接上提供双向通信通道。借助 ECP Edge WebSocket 插件,用户可以将采集的数据推送到 WebSocket 服务器。
- [Monitor 插件](./monitor.md)ECP Edge 在启动时创建一个 Monitor 单例节点,用于监控运行的 ECP Edge 实例。您可以在仪表板的**北向应用**页签中看到 Monitor 节点。
- [MQTT 插件](./mqtt/mqtt.md)NeuronEX 支持 MQTT 通讯协议。 NeuronEX MQTT 插件允许用户快速构建使用 MQTT 协议的物联网应用程序,可以在设备和云之间进行通讯。
- [eKuiper 插件](./ekuiper/ekuiper.md):LF Edge [eKuiper](https://ekuiper.org/) 是 Golang 实现的轻量级物联网边缘分析、流式处理开源软件,可以运行在各类资源受限的边缘设备上。NeuronEX eKuiper 插件使用户能够将收集到的数据发布到 eKuiper 以进一步处理。
- [Sparkplug B 插件](./sparkplugb/sparkplugb.md):Sparkplug B 是一种建立在 MQTT 3.1.1 基础上的工业物联网数据传输规范。NeuronEX Sparkplug B 插件从设备采集到的数据可以通过 Sparkplug B 协议从边缘端传输到 Sparkplug B 应用中,用户也可以从应用程序向 NeuronEX 发送数据修改指令。
- [WebSocket 插件](./websocket.md):WebSocket 网络协议支持在单个 TCP 连接上提供双向通信通道。借助 NeuronEX WebSocket 插件,用户可以将采集的数据推送到 WebSocket 服务器。
- [Monitor 插件](./monitor.md)NeuronEX 在启动时创建一个 Monitor 单例节点,用于监控运行的 NeuronEX 实例。您可以在仪表板的**北向应用**页签中看到 Monitor 节点。

4 changes: 2 additions & 2 deletions neuronex/zh_CN/config/north-apps/sparkplugb/cogent.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
![cogent1](./assets/cogent1.jpg)
![cogent2](./assets/cogent2.jpg)

## ECP Edge 侧配置
## NeuronEX 侧配置

1.ECP Edge **北向应用管理** 中添加一个 Sparkplug B 应用。
1.NeuronEX **北向应用管理** 中添加一个 Sparkplug B 应用。

2.**应用配置** 中填写 `客户端 ID``组 ID``节点 ID``服务器地址``服务器端口`, 点击 `提交` 并启动连接。
![ignition2](./assets/ignition2.jpg)
Expand Down
4 changes: 2 additions & 2 deletions neuronex/zh_CN/config/north-apps/sparkplugb/ignition.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@

5. 打开 **Config** -> **MQTT ENGINE/Setting** -> **Servers** -> **Setting**,点击 `Create new MQTT Server Setting...` 创建一个 `Name` 为 EMQX 的连接,`URL` 设置为 `tcp://localhost:1883`,点击 `Save Changes` 保存设置。

## ECP Edge 侧配置
## NeuronEX 侧配置

1.ECP Edge **北向应用管理** 中添加一个 Sparkplug B 应用。
1.NeuronEX **北向应用管理** 中添加一个 Sparkplug B 应用。

2.**应用配置** 中填写 `客户端 ID``组 ID``节点 ID``服务器地址``服务器端口`, 点击 `提交` 并启动连接。
![ignition2](./assets/ignition2.jpg)
Expand Down
2 changes: 1 addition & 1 deletion neuronex/zh_CN/config/north-apps/sparkplugb/sparkplugb.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Sparkplug B 是一种建立在 MQTT 3.1.1 基础上的工业物联网数据传输规范。Sparkplug B 在保证灵活性和效率的前提下,使 MQTT 网络具备状态感知和互操作性,为设备制造商和软件提供商提供了统一的数据共享方式。

ECP Edge 从设备采集到的数据可以通过 Sparkplug B 协议从边缘端传输到 Sparkplug B 应用中,用户也可以从应用程序向 ECP Edge 发送数据修改指令。Sparkplug B 是运行在 MQTT 之上的应用型协议,所以在 ECP Edge 中的设置与 MQTT 驱动相似。
NeuronEX 从设备采集到的数据可以通过 Sparkplug B 协议从边缘端传输到 Sparkplug B 应用中,用户也可以从应用程序向 NeuronEX 发送数据修改指令。Sparkplug B 是运行在 MQTT 之上的应用型协议,所以在 NeuronEX 中的设置与 MQTT 驱动相似。

## 参数

Expand Down
Loading

0 comments on commit e3e3d8f

Please sign in to comment.