# 快速教程

# 环境搭建

# 软件包安装

实例中使用的环境是 Ubuntu 20.04.3,armv71。

  1. 下载安装包 Neuron 软件包可从 Neuron 官网 https://neugates.io/zh/downloads (opens new window) 上下载。

  2. 解压安装包 解压软件包到任何目录下(例如:/home/Neuron),输入命令:

sudo dpkg -i neuron-2.1.0-linux-armhf.deb
1

提示

安装 deb 包后,Neuron 自启动

# Neuron 相关操作

# 查看 Neuron 状态

sudo systemctl status neuron
1

# 停止 Neuron

sudo systemctl stop neuron
1

# 重启 Neuron

sudo systemctl restart neuron
1

# 在 Docker 中运行 EMQX

我们需要部署一个 MQTT Broker 客户端来做消息的连接处理,这里推荐使用 EMQX 。同样 EMQX 可以快速使用 Docker 容器安装使用。可从 EMQX 官网 (opens new window) 获取最新版本。

  1. 获取 Docker 镜像
docker pull emqx/emqx:4.4.3
1
  1. 启动 Docker 容器
docker run -d --name emqx -p 1883:1883 -p 8081:8081 -p 8083:8083 -p 8084:8084 -p 8883:8883 -p 18083:18083 emqx/emqx:4.4.3
1

# 安装 Modbus 模拟器

安装 PeakHMISlaveSimulator 软件,安装包可在 PeakHMI 官网 (opens new window) 中下载。 安装后,打开 Modbus TCP slave.

提示

Windows 中尽量关闭防火墙,否则可能会导致 Neuron 连接不上模拟器。

# 运行和使用

当环境和资源都准备好后,打开 Web 浏览器,输入运行 Neuron 的网关地址和端口号,即可进入到管理控制台页面,默认端口号为7000,例如:http://127.0.0.1:7000 (opens new window)

# 第一步,登录

打开页面,进入到登录界面,用户可使用初始用户名与密码登录(初始用户名:admin,初始密码:0000),如下图所示。

login

登录到控制面板:

  1. 填写默认用户名 admin.
  2. 填写默认密码 0000.
  3. 点击 登录 按键.

# 第二步,为设备驱动添加南向插件模块

配置菜单中选择南向设备管理,进入到南向设备管理界面,此时未添加任何设备,在本例中,我们将创建 Modbus TCP 设备,如下图所示。

south-devices-add

添加一个新的南向设备:

  1. 单击右上角的添加设备按键以显示添加新设备的对话框;
  2. 填写设备名称,例如 modbus-tcp-1;
  3. 点击下拉框,将显示现在可用的所有南向驱动协议,此次我们选择 modbus-tcp 的插件;
  4. 点击创建按键创建设备。

提示

你如果安装了有效的试用版或者商业版许可证,可以使用除了 modbus-tcp 插件以外的插件模块。南向驱动列表中只有 modbus-tcp 是开源插件模块。

# 第三步,管理南向设备节点列表

创建设备成功之后,会在南向设备管理界面出现一个新创建的设备的卡片,如下图所示。

south-devices

这个设备卡片包含以下信息:

  1. 设备名字 - 用户为设备提供的唯一名称。
  2. 设备配置按键 - 单击此按键可显示设备配置界面。
  3. 删除按键 - 单击此按键可将此设备从南向设备列表中删除。
  4. 节点状态 - 显示设备节点的当前状态,详情见下文。
  5. 状态切换按键 - 打开以连接到设备。
  6. 连接状态 - 显示设备的连接状态。
  7. 插件模块名称 - 用于显示此设备使用的插件模块的名称。

每个南向设备都有五种工作状态。

  • 初始化:首次添加南向设备卡片后,进入初始化状态;
  • 配置中:进入设备配置中,进行设备配置时,进入到配置中的状态;
  • 准备好:成功配置设备后,进入到准备好的状态;
  • 运行中:手动打开工作状态,进入到运行状态,在添加 Group 和 Tag 后,Neuron 连接到设备采集数据;
  • 停止:手动关闭工作状态,进入到停止状态,neuron 断开与设备的连接,停止采集数据;

# 第四步,设置南向设备参数

点击设备配置,进入设备配置界面,如下图所示。

south-setting

* 是必填项,每项后面都有一个字段说明键,鼠标悬停在上面,将会显示详细的描述信息。

  1. 填写运行 Modbus 模拟器的机器 IP;
  2. 填写 Modbus 模拟器的端口号,默认是502;
  3. 填写连接请求超时时间,默认是 3000;
  4. 选择连接模式,默认 Neuron 作为 Client 模式;
  5. 点击提交,完成设备配置;
  6. 点开设备卡片中的工作状态开关,使设备进入运行中的状态。

提示

运行的 Neuron 和模拟器必须要在同一个网段下。

# 第五步,在节点中创建组

点击设备节点卡片任意空白处,进入 Group 列表管理界面,此时会显示一个空的列表,如下图所示。

group-add

为设备节点创建一个组:

  1. 点击创建按键,弹出创建 Group 的对话框;
  2. 填写 Group 名称,例如 group-1;
  3. 填写 Interval,设置 neuron 从设备采集数据的时间间隔及将数据上报到 MQTT 的时间间隔。最小可设置 100ms,但在采集的数据较多时,如果数据监控界面报点位值失效的错误,可以适当调大 interval 的值;
  4. 点击提交,完成组的创建。

# 第六步,管理群组列表

Group 列表中会显示刚新建的 Group,如下图所示。

group-list

组列表中包含了以下信息:

  1. 清空按键,一键删除所有创建的组。当用户选择了一些组后,点击删除按键,可以快速批量删除选中的组。创建按键用于创建新的组。
  2. 全选列表中的所有组。
  3. 单选列表中的某个组。
  4. 查看 图标用于查看组的配置信息。
  5. 创建 图标用于为当前组创建 tags。
  6. 删除 图标用于删除当前组。

# 第七步,添加数据标签到组中

点击组中的 Tag 列表图标,进入到 Tag 列表管理界面,如下图所示。

tag-list-null

此时我们可以选择创建按键手动创建 Tags,也可以通过点击导入按键,用 Excel 的形式批量导入 Tags 信息。

导出按键也可用于将已经创建的数据标签详细信息导出到 Excel 文件中。 清空按键用于一键删除列表中的所有数据标签。删除按键用于删除选定的标签。

# 第八步,设置数据标签详细信息

单击创建按键,进入数据标签的信息设置界面,如下图所示。在本例中,我们将介绍手动添加标签的方式。

tags-add

将向您展示如何一个一个地手动添加标签设置信息。但是,所有的数据标签都可以先输入到 Excel 表中,然后通过再导入到组中。

为组创建标签:

  1. 填写 Tag 名称,例如,tag1;
  2. 填写驱动地址,例如,1!40001。详细的驱动地址使用说明请参阅 驱动使用说明
  3. 拉选择 Tag 类型,例如,Read, Write,Subscribe 暂时不支持 ;
  4. 下拉选择数据类型,例如,int16;
  5. 单击添加按键添加下一个标签,重复 1 - 4 知道添加到最后一个标签;
  6. 可选择删除一个标签;
  7. 点击创建按键,完成 Tag 的创建;

提示

这里可以通过添加按键,再新建一个 Tag,Tag 创建成功后,信息框旁边会出现一个删除按键。

# 第九步,管理组的数据标签

完成所有标签创建后,标签列表,如下图所示。

tag-list

  • 导入按键,以 Excel 形式批量配置 tag 信息;
  • 导出按键,以 Excel 形式输出已经创建的 tag 信息;
  • 清空按键,一键删除所有的标签;
  • 删除按键,在选择全选时,再点击删除按钮,效果等同于清空,可删除所有 tag。当单选某些 tag 时,再点击删除按键,可快捷批量删除选择的 tag;
  • 每个标签包含了名称,地址,类型,读写属性,描述,重新编辑 tag 信息的按键和删除按键。

# 第十步,查看数据监控中的数据

监控菜单下选择数据监控,进入数据监控界面,查看已创建标签读取到的数值,如下图所示。

data-monitoring

数据监控以组为单位:

  1. 下拉框选择想要查看的南向设备,这里选择上面已经创建好的 modbus-tcp-1;
  2. 下拉框选择想要查看所选南向设备下的组,这里选择上面已经创建好的 group-1;
  3. 选择完成,页面将会展示读取到组底下每一个标签的值;

提示

您如果发现数值是一个无效的数值,您可以在模拟器中调整字节顺序的设置。Modbus TCP 模拟器的字节顺序默认是 BE 3,4,1,2

# 第十一步,更改模拟器数据标签值

通过设置模拟器里寄存器的值,查看数据监控显示的值是否与模拟器中的值一致,如下图所示。

monitor

# 第十二步,在界面中输入反控设备的值

当 Tag 设置了写属性时,数据监控界面的 Tag 会有一个写操作,点击Write可以实现反控设备,如下图所示。

write

  1. 单击要改值的标签末尾的按键;
  2. 选择是否以十六进制方式输入;
  3. 输入标签新值;
  4. 单击提交按键提交新的值。

提示

设备中该点位也必须具有可写属性。

# 第十三步,为应用程序添加北向插件模块

配置菜单中选择北向应用管理,进入到北向应用管理界面,会有一个默认的数据流应用节点,如需要,可手动添加更多的应用节点,在本例中,我们将创建一个 mqtt 应用节点,如下图所示。

north-add

添加一个 MQTT 云连接模块:

  1. 点击右上角的添加应用按键;
  2. 填写应用名称,例如,mqtt-1;
  3. 点击下拉框,将显示现在可用的所有北向应用,此次我们选择 mqtt 的插件。

# 第十四步,管理北向应用节点列表

创建应用成功之后,会在北向应用管理界面出现一个刚刚创建的应用的卡片,如下图所示。

north

应用卡片中包含应用名称,设备配置按键,删除按键,工作状态,连接状态和该设备卡片使用的插件名称,点击卡片任意空白处,还可进入 Group 列表管理界面。

应用节点包括以下信息:

  1. 应用名称 - 用户为应用程序设置的唯一名称;
  2. 应用配置按键 - 单击此按键以显示应用程序配置界面;
  3. 删除按键 - 单击此按键可将此应用程序从应用程序列表中删除;
  4. 节点状态 - 显示应用节点的当前状态,详情见下文;
  5. 状态切换按键 - 打开以连接到应用程序;
  6. 连接状态 - 显示应用程序当前连接状态;
  7. 插件模块名称 - 用于显示此应用程序使用的插件模块的名称。

每个北向应用节点都有五种工作状态:

  • 初始化:首次添加北向应用卡片后,进入初始化状态;
  • 配置中:进行应用配置时,进入到配置中的状态;
  • 准备好:成功配置应用后,进入到准备好的状态;
  • 运行中:手动打开工作状态,进入到运行状态,neuron 连接到北向应用,进行传输数据;
  • 停止:手动关闭工作状态,进入到停止状态,neuron 断开与北向应用的连接,停止传输数据;

# 第十五步,设置北向应用参数

点击应用配置按键,进入到应用配置界面,如下图所示。

north-setting

*是必填项,鼠标悬停在后面的字段说明图标上,将会显示详细的说明信息。

设置 MQTT 连接:

  1. 填写 MQTT 的 Client ID,例如,mqtt1,详细订阅主题请参阅 MQTT Topics
  2. 选填自定义的 MQTT 发布主题;
  3. 选择上传格式;
  4. 设置 SSL 认证选项;
  5. 填写 MQTT Broker 的 hostname,这里默认连接的是 emqx 公共的 broker;
  6. 填写 MQTT Broker 的端口号;
  7. 选填设置的用户名;
  8. 选填设置的密码;
  9. 点击提交,完成北向应用的配置,点开应用卡片中的工作状态开关,使应用进入运行中的状态。

# 第十六步,订阅南向标签组

点击应用节点卡片任意空白处,进入到订阅 Group 界面,如下图所示。

subscriptions-add

订阅南向设备的数据组:

  • 点击右上角的添加订阅按键添加订阅;
  • 点击下拉框选择南向设备,本例我们选择上面建好的 modbus-tcp-1 的设备;
  • 点击下拉框选择所要订阅的 Group,本例我们选择上面建好的 group-1;
  • 点击提交,完成订阅。

# 第十七步,管理订阅的群组列表

成功添加订阅后, Group 列表中将显示所有订阅的 Group,如下图所示。

subscription

组列表包含了以下信息:

  • 清空按键,一键取消所有订阅的 Group。
  • 删除按键,在选择全选时,再点击删除按钮,效果等同于清空,可取消所有 Group 的订阅。当单选某些 Group 时,再点击删除按键,可快捷批量取消已选择的 Group 的订阅。
  • 每个组都包含了组名称,设备名称和删除按键。

# 第十八步,查看 MQTT 代理中的负载

订阅完成后,我们可以使用 MQTT 客户端(这里推荐使用 MQTTX,可在官网中下载https://www.emqx.com/zh/products/mqttx (opens new window) 连接到刚才部署好的 EMQX 代理来查看上报的数据,如下图所示。

mqttx

订阅成功之后可以看到 MQTTX 可以一直接收到 Neuron 采集并上报过来的数据。

  • 打开 MQTTX 添加新的连接,正确填写名称与刚部署好的 EMQX Edge 的 Host 与 Port,完成连接;
  • 添加新的订阅,默认的上传 Topic 的主题格式为neuron/{mqtt_clientid}/upload,其中 {mqtt_clientid} 是在 Neuron 界面中北向应用中配置的Client-id,本例我们填写上面设置好的 mqtt1