mirror of
https://github.com/emqx/neuron.git
synced 2026-10-29 07:06:32 +08:00
update readme
This commit is contained in:
fengzero
+42
-95
@@ -9,7 +9,7 @@
|
||||
|
||||
|
||||
|
||||
[English](https://github.com/neugates/neuron/blob/main/README.md) | 简体中文
|
||||
[English](https://github.com/emqx/neuron/blob/main/README.md) | 简体中文
|
||||
|
||||
Neuron 是一款开源的、轻量级工业协议网关软件，支持数十种工业协议的一站式设备连接、数据接入、MQTT 协议转换，为工业设备赋予工业 4.0 时代关键的物联网连接能力。
|
||||
|
||||
@@ -18,45 +18,66 @@ Neuron 是一款开源的、轻量级工业协议网关软件，支持数十种
|
||||
以下是 Neuron 的一些重要特性：
|
||||
|
||||
- 具有实时能力的边缘原生应用程序可以利用边缘端的低延迟网络。
|
||||
- 松耦合模块化 [架构设计](https://neugates.io/docs/zh/latest/introduction/architecture/architecture.html) 通过可插拔模块扩展更多功能服务。
|
||||
- 松耦合模块化架构设计，通过可插拔模块扩展更多功能服务。
|
||||
- 支持可以在运行时更新设备和应用程序模块的热插件。
|
||||
- 支持多种工业设备协议，包括 Modbus、OPCUA、Ethernet/IP、IEC104、BACnet 等 [更多协议](https://neugates.io/docs/zh/latest/configuration/south-devices/south-devices.html)。
|
||||
- 支持多种工业设备协议，包括 Modbus、OPCUA、Ethernet/IP、IEC104、BACnet 等。
|
||||
- 支持同时连接大量不同协议的工业设备。
|
||||
- 结合[eKuiper](https://www.lfedge.org/projects/ekuiper)提供的规则引擎功能，快速实现基于规则的设备控制或 AI/ML 分析。
|
||||
- 通过 [SparkplugB](https://neugates.io/docs/zh/latest/use-cases/use_cases.html#mqtt-sparkplugb-%E8%A7%A3%E5%86%B3%E6%96%B9%E6%A1%88) 解决方案支持对工业应用程序的数据访问，例如 MES 或 ERP、SCADA、historian 和数据分析软件。
|
||||
- 通过 SparkplugB 解决方案支持对工业应用程序的数据访问，例如 MES 或 ERP、SCADA、historian 和数据分析软件。
|
||||
- 具有非常低的内存占用，小于 10M 的内存占用和 CPU 使用率，可以在 ARM、x86 和 RISC-V 等资源有限的硬件上运行。
|
||||
- 支持在本地安装可执行文件或部署在容器化环境中。
|
||||
- 控制工业设备，通过[HTTP API](https://neugates.io/docs/zh/latest/http-api/http-api.html)和[MQTT API](https://neugates.io/docs/en/latest/north-apps/mqtt/api.html) 服务更改参数和数据标签。
|
||||
- 控制工业设备，通过HTTP API 和 MQTT API 服务更改参数和数据标签。
|
||||
- 与其他 EMQ 产品高度集成，包括 [EMQX](https://www.emqx.com/zh/products/emqx)、[NanoMQ](https://nanomq.io/zh)、[eKuiper](https://ekuiper.org/zh)。
|
||||
- 核心框架和 Modbus、MQTT 和 eKuiper 的代码在 LGPLv3 的许可下开源。商业模块需要 [EMQ 许可证](https://neugates.io/docs/zh/latest/introduction/license-describe.html) 才能运行。
|
||||
- 核心框架和 Modbus、MQTT 和 eKuiper 的代码在 LGPLv3 的许可下开源。
|
||||
|
||||
获取更多信息，请访问 [Neuron 官网](https://neugates.io/zh)。
|
||||
开源版本只提供了部分插件，要使用更多的插件以及更完善的 Dashboard，请使用 [NeuronEX](https://www.emqx.com/zh/products/neuronex)。
|
||||
|
||||
## 快速开始
|
||||
|
||||
#### 使用 Docker 运行 Neuron
|
||||
### 下载 tar 包运行
|
||||
|
||||
```
|
||||
docker run -d --name neuron -p 7000:7000 -p 7001:7001 -p 9081:9081 --privileged=true --restart=always emqx/neuron:latest
|
||||
选择 [Relase](https://github.com/emqx/neuron/releases) 版本下载
|
||||
|
||||
```bash
|
||||
$ tar xvf neuron-{version}-linux-amd64.tar.gz
|
||||
$ cd neuron
|
||||
$ ./neuron --log
|
||||
```
|
||||
|
||||
接下来请参考 [快速入门](https://neugates.io/docs/zh/latest/quick-start/hardware-specifications.html) 开启您的 Neuron 之旅。
|
||||
浏览器中打开 `http://localhost:7000` 访问 Neuron。
|
||||
|
||||
> **提示**
|
||||
>
|
||||
> Neuron 开源版只包含 Modbus 和 MQTT 驱动。
|
||||
>
|
||||
> 您可以[免费申请 15 天试用期限的 License](https://www.emqx.com/zh/apply-licenses/neuron)，加载所有的驱动。
|
||||
|
||||
#### 更多安装方式
|
||||
### 源码编译运行
|
||||
|
||||
您可以从 [neugates.io/zh/downloads?os=Linux](https://neugates.io/zh/downloads?os=Linux) 下载不同格式的 Neuron 安装包进行手动安装。
|
||||
1. [安装依赖](https://github.com/emqx/neuron/install-dependencies.md)
|
||||
|
||||
也可以直接访问 [Neuron 安装文档](https://neugates.io/docs/zh/latest/installation/installation.html) 查看不同安装方式的操作步骤。
|
||||
2. 编译 Neuron
|
||||
```bash
|
||||
$ git clone https://github.com/emqx/neuron
|
||||
$ cd neuron && mkdir build && cd build
|
||||
$ cmake .. && make
|
||||
```
|
||||
|
||||
## 文档
|
||||
3. 下载并解压 Dashboard
|
||||
```bash
|
||||
$ wget https://github.com/emqx/neuron-dashboard/releases/download/2.6.3/neuron-dashboard.zip
|
||||
|
||||
Neuron 文档地址：[https://neugates.io/docs/zh/latest/](https://neugates.io/docs/zh/latest/)。
|
||||
# 解压 neuron-dashboard.zip 到 build 目录
|
||||
$ unzip neuron-dashboard.zip
|
||||
```
|
||||
|
||||
3. 运行 Neuron
|
||||
```bash
|
||||
$ ./neuron --log
|
||||
```
|
||||
|
||||
4. 浏览器中打开 `http://localhost:7000` 访问 Neuron。
|
||||
|
||||
### 采集 Modbus TCP 数据并通过 MQTT 发送。
|
||||
|
||||
## Dashboard
|
||||
|
||||
开源版 [Dashboard](https://github.com/emqx/neuron-dashboard) 最新 Release 的版本为 2.6.3，目前已暂停开发与维护，此版本也是 Neuron 默认集成的版本。要用更完善与更专业的 Dashboard，请使用 [NeuronEX](https://www.emqx.com/zh/products/neuronex)。
|
||||
|
||||
## 社区
|
||||
|
||||
@@ -66,80 +87,6 @@ Neuron 文档地址：[https://neugates.io/docs/zh/latest/](https://neugates.io/
|
||||
- 关注我们的 [bilibili](https://space.bilibili.com/522222081)，获取最新物联网技术分享。
|
||||
- 关注我们的 [微博](https://weibo.com/emqtt) 或 [Twitter](https://twitter.com/EMQTech)，获取 Neuron 最新资讯。
|
||||
|
||||
## 从源码构建
|
||||
|
||||
**安装依赖**
|
||||
|
||||
请参考 [Install-dependencies](https://github.com/emqx/neuron/blob/main/Install-dependencies.md)
|
||||
|
||||
**编译**
|
||||
|
||||
```
|
||||
$ git clone https://github.com/emqx/neuron
|
||||
$ cd neuron
|
||||
$ mkdir build && cd build
|
||||
$ cmake .. && make
|
||||
```
|
||||
|
||||
**安装 Dashboard**
|
||||
|
||||
在 [neuron-dashboard](https://github.com/emqx/neuron-dashboard/releases) 页面下载最新的 `neuron-dashboard.zip`，解压后放到 Neuron 可执行目录下的 dist 目录中。
|
||||
|
||||
**运行**
|
||||
|
||||
```
|
||||
$ cd build
|
||||
$ ./neuron
|
||||
```
|
||||
|
||||
>**修改日志级别**
|
||||
>
|
||||
>在 zlog.conf 文件的规则中更改日志级别。可用的日志级别包括 INFO，DEBUG，NOTICE，WARN，ERROR 和 FATAL。
|
||||
|
||||
## 测试
|
||||
|
||||
### 单元测试
|
||||
|
||||
运行所有的单元测试
|
||||
|
||||
```shell
|
||||
$ cd build
|
||||
$ ctest --output-on-failure
|
||||
```
|
||||
|
||||
### 功能测试
|
||||
|
||||
运行所有的功能测试
|
||||
|
||||
```shell
|
||||
$ sudo apt-get install -y mosquitto
|
||||
$ mosquitto -v &
|
||||
$ python3 -m pip install -U pip
|
||||
$ python3 -m pip install -r ft/requirements.txt
|
||||
$ python3 -m robot --maxerroelines=600 -P ft/ -d ft/reports ft
|
||||
```
|
||||
|
||||
### 压力测试
|
||||
|
||||
在目录`ft/data/persistence/`中有压力测试的数据集。
|
||||
|
||||
运行压力测试
|
||||
|
||||
```shell
|
||||
# 安装依赖
|
||||
$ pip3 install -r ft/requirements.txt
|
||||
|
||||
# 使用http接口在数据集total-10k上进行测试
|
||||
$ python3 -m robot -P ft/ --variable neuron_api:http --variable dataset:total-10k -d ft/http-total-10k ft/pressure.test
|
||||
# 使用http接口在数据集total-50k上进行测试
|
||||
$ python3 -m robot -P ft/ --variable neuron_api:http --variable dataset:total-50k -d ft/http-total-50k ft/pressure.test
|
||||
|
||||
# 如果使用mqtt接口则需要MQTT服务器，此例为mosquitto
|
||||
$ mosquitto -v &
|
||||
|
||||
# 使用mqtt接口在数据集simple-1k上进行测试
|
||||
$ python3 -m robot -P ft/ --variable neuron_api:mqtt --variable dataset:simple-1k -d ft/mqtt-simple-1k ft/pressure.test
|
||||
```
|
||||
|
||||
## 开源许可
|
||||
|
||||
|
||||
@@ -8,6 +8,9 @@
|
||||
[](https://twitter.com/EMQTech)
|
||||
[](https://www.youtube.com/channel/UC5FjR77ErAxvZENEWzQaO5Q)
|
||||
|
||||
English | [简体中文](https://github.com/emqx/neuron/blob/main/README-CN.md)
|
||||
|
||||
|
||||
Neuron is an Industrial IoT (IIoT) connectivity server for modern big data and AI/ML technology to leverage the power of Industrial 4.0. It supports one-stop access to dozens of industrial protocols and converts them into MQTT protocol and realize the interconnection between IIoT platforms and various industrial devices.
|
||||
|
||||
|
||||
@@ -15,46 +18,65 @@ Neuron is an Industrial IoT (IIoT) connectivity server for modern big data and A
|
||||
The following are some important features of Neuron:
|
||||
|
||||
- Edge native application with real-time capability to leverage the low latency network of edge side.
|
||||
- Loosely-coupled modularity [architecture design](https://neugates.io/docs/en/latest/introduction/architecture/architecture.html) for extending more functional services by pluggable modules.
|
||||
- Loosely-coupled modularity architecture design for extending more functional services by pluggable modules.
|
||||
- Support hot plugins that can update device and application modules during runtime.
|
||||
- Support numerous protocols for industrial devices, including Modbus, OPCUA, Ethernet/IP, IEC104, BACnet and [more](https://neugates.io/docs/en/latest/configuration/south-devices/south-devices.html).
|
||||
- Support numerous protocols for industrial devices, including Modbus, OPCUA, Ethernet/IP, IEC104, BACnet and more.
|
||||
- Support simultaneous connection of a large number of industrial devices with different protocols.
|
||||
- Combine with the rule engine function provided by [eKuiper](https://www.lfedge.org/projects/ekuiper) to quickly implement rule-based device control or AI/ML analytics.
|
||||
- Support data access to industrial applications, such as MES or ERP, SCADA, historian and data analytics software via [SparkplugB](https://neugates.io/docs/en/latest/use-cases/sparkplug/sparkplug.html) solution.
|
||||
- Support data access to industrial applications, such as MES or ERP, SCADA, historian and data analytics software via SparkplugB solution.
|
||||
- Has very low memory footprint, less than 10M, and CPU usage, can run on limited resource hardware like ARM, x86 and RISC-V.
|
||||
- Support installation of native executable or deployed in containerized enviornment.
|
||||
- Control industrial devices, and make changes to the parameters and data tags through [HTTP API](https://neugates.io/docs/en/latest/api/configuration.html) and [MQTT API](https://neugates.io/docs/en/latest/configuration/north-apps/mqtt/api.html) services.
|
||||
- Control industrial devices, and make changes to the parameters and data tags through HTTP API and MQTT API services.
|
||||
- Highly integrated with other EMQ products, including [EMQX](https://www.emqx.com/en/products/emqx), [NanoMQ](https://nanomq.io/), [eKuiper](https://ekuiper.org/).
|
||||
- The code of the core framework and Modbus, MQTT and eKuiper are licensed under open source LGPLv3. Commercial modules require a [EMQ License](https://neugates.io/docs/en/latest/installation/license-install/license-install.html) to run.
|
||||
- The code of the core framework and Modbus, MQTT and eKuiper are licensed under open source LGPLv3.
|
||||
|
||||
For more information, please visit [Neuron homepage](https://neugates.io/).
|
||||
Neuron only provides limited plugins in the open source version. To use more plugins and a more complete Dashboard, please use [NeuronEX](https://www.emqx.com/en/products/neuronex).
|
||||
|
||||
## Get Started
|
||||
## Quick Start
|
||||
|
||||
#### Run Neuron using Docker
|
||||
### Download
|
||||
|
||||
```
|
||||
docker run -d --name neuron -p 7000:7000 -p 7001:7001 -p 9081:9081 --privileged=true --restart=always emqx/neuron:latest
|
||||
You can download from [Release](https://github.com/emqx/neuron/releases).
|
||||
|
||||
```bash
|
||||
$ tar xvf neuron-{version}-linux-amd64.tar.gz
|
||||
$ cd neuron
|
||||
$ ./neuron --log
|
||||
```
|
||||
|
||||
Next, please follow the [getting started guide](https://neugates.io/docs/en/latest/quick-start/hardware-specifications.html) to tour the Neuron features.
|
||||
Open a web browser and navigate to `http://localhost:7000` to access the Neuron web interface.
|
||||
|
||||
> **Limitations**
|
||||
>
|
||||
> Neuron open source edition only includes Modbus and MQTT drivers.
|
||||
>
|
||||
> If you need more driver protocol support and edge computing services, you can choose Neuron's commercial version [NeuronEX](https://www.emqx.com/en/products/neuronex).
|
||||
> NeuronEX comes with a built-in license for 30 data tags that can be applied to all southbound drivers. And NeuronEX also supports edge intelligent analysis of industrial data to enable you to quickly gain business insights. To download NeuronEX, please click [here](https://www.emqx.com/en/downloads-and-install/neuronex).
|
||||
### Build and Run
|
||||
|
||||
#### More installation options
|
||||
1. [Install Dependencies](https://github.com/emqx/neuron/install-dependencies.md)
|
||||
|
||||
If you prefer to install and manage Neuron yourself, you can download the latest version from [neugates.io/downloads?os=Linux](https://neugates.io/downloads?os=Linux).
|
||||
2. Build Neuron
|
||||
```bash
|
||||
$ git clone https://github.com/emqx/neuron
|
||||
$ cd neuron && mkdir build && cd build
|
||||
$ cmake .. && make
|
||||
```
|
||||
|
||||
For more installation options, see the [Neuron installation documentation](https://neugates.io/docs/en/latest/installation/installation.html).
|
||||
3. Download and Unzip Dashboard
|
||||
```bash
|
||||
$ wget https://github.com/emqx/neuron-dashboard/releases/download/2.6.3/neuron-dashboard.zip
|
||||
|
||||
## Documentation
|
||||
# Unzip neuron-dashboard.zip to the build directory
|
||||
$ unzip neuron-dashboard.zip
|
||||
```
|
||||
|
||||
The Neuron documentation is available at [neugates.io/docs/en/latest/](https://neugates.io/docs/en/latest/).
|
||||
4. Run Neuron
|
||||
```bash
|
||||
$ ./neuron --log
|
||||
```
|
||||
|
||||
5. Open a web browser and navigate to `http://localhost:7000` to access the Neuron web interface.
|
||||
|
||||
### Modbus TCP Data Collection and MQTT Transmission
|
||||
|
||||
## Dashboard
|
||||
|
||||
The open-source version of the [Dashboard](https://github.com/emqx/neuron-dashboard) is currently at version 2.6.3, which has been suspended for development and maintenance. This version is also the one integrated by default with Neuron. For a more complete and professional Dashboard, please use [NeuronEX](https://www.emqx.com/en/products/neuronex).
|
||||
|
||||
## Get Involved
|
||||
|
||||
@@ -63,36 +85,6 @@ The Neuron documentation is available at [neugates.io/docs/en/latest/](https://n
|
||||
- For general discussions, join us on the [official Discord](https://discord.gg/xYGf3fQnES) team.
|
||||
- Keep updated on [EMQ YouTube](https://www.youtube.com/channel/UC5FjR77ErAxvZENEWzQaO5Q) by subscribing.
|
||||
|
||||
## Build From Source
|
||||
|
||||
**Install required dependencies**
|
||||
|
||||
[Install-dependencies](https://github.com/emqx/neuron/blob/main/Install-dependencies.md)
|
||||
|
||||
**Build**
|
||||
|
||||
```
|
||||
$ git clone https://github.com/emqx/neuron
|
||||
$ cd neuron
|
||||
$ mkdir build && cd build
|
||||
$ cmake .. && make
|
||||
```
|
||||
|
||||
**Install Dashboard**
|
||||
|
||||
Download the latest `neuron-dashboard.zip` from the [neuron-dashboard](https://github.com/emqx/neuron-dashboard/releases) page, unzip it and put it to the `dist` directory under the Neuron executable directory.
|
||||
|
||||
**Run**
|
||||
|
||||
```
|
||||
$ cd build
|
||||
$ ./neuron
|
||||
```
|
||||
|
||||
>**Log level**
|
||||
>
|
||||
>Change the log level in the rules in the zlog.conf file. Available levels include INFO, DEBUG, NOTICE, WARN, ERROR and FATAL.
|
||||
>
|
||||
|
||||
## License
|
||||
|
||||
|
||||
@@ -503,7 +503,8 @@ ssize_t neu_conn_recv(neu_conn_t *conn, uint8_t *buf, ssize_t len)
|
||||
conn->param.log,
|
||||
"tcp conn fd: %d, recv buf len %zd, ret: %zd, errno: %s(%d)",
|
||||
conn->fd, len, ret, strerror(errno), errno);
|
||||
if (ret == 0 || (conn->connection_ok && ret == -1 && errno != EAGAIN)) {
|
||||
if (ret == 0 ||
|
||||
(conn->connection_ok && ret == -1 && errno != EAGAIN)) {
|
||||
conn_disconnect(conn);
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user