Skip to content

Commit 63f9a0e

Browse files
authored
Merge pull request #2644 from fengzeroz/main
readme: remove cn
2 parents 942fcf8 + 05b6d6b commit 63f9a0e

File tree

3 files changed

+71
-222
lines changed

3 files changed

+71
-222
lines changed

README-CN.md

Lines changed: 0 additions & 104 deletions
This file was deleted.

README.md

Lines changed: 71 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,57 @@
88
[![Twitter](https://img.shields.io/badge/Follow-EMQ-1DA1F2?logo=twitter)](https://twitter.com/EMQTech)
99
[![YouTube](https://img.shields.io/badge/Subscribe-EMQ-FF0000?logo=youtube)](https://www.youtube.com/channel/UC5FjR77ErAxvZENEWzQaO5Q)
1010

11-
English | [简体中文](https://github.com/emqx/neuron/blob/main/README-CN.md)
11+
Neuron is an Industrial IoT (IIoT) connectivity server that bridges industrial devices and modern data platforms. It supports dozens of industrial protocols and converts them into MQTT for seamless integration between IIoT platforms and shop-floor devices.
1212

13+
## About NeuronEX
1314

14-
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+
[NeuronEX](https://www.emqx.com/en/products/emqx-neuron) is the commercial distribution of Neuron, offering extended capabilities and professional support. Compared to the open-source Neuron:
1516

16-
![neuron-overview](docs/pictures/neuron-final.png)
17+
- **Extended protocol support**: Additional industrial protocols (e.g., OPC UA, Siemens S7, Ethernet/IP, etc.)
18+
- **Advanced dashboard**: Full-featured web UI with enhanced visualization and management capabilities
19+
- **Enterprise plugins**: More southbound device adapters, northbound application connectors, and rule engines
20+
- **Cloud integration**: Direct connectors for major cloud platforms (AWS, Azure, Google Cloud, etc.)
21+
- **Data security**: Enhanced encryption, auditing, and compliance features
22+
- **Professional support**: 24/7 technical support and regular updates
1723

18-
The following are some important features of Neuron:
24+
For more details, visit the [NeuronEX documentation](https://docs.emqx.com/en/neuronex/latest/).
1925

20-
- Edge native application with real-time capability to leverage the low latency network of edge side.
21-
- Loosely-coupled modularity architecture design for extending more functional services by pluggable modules.
22-
- Support hot plugins that can update device and application modules during runtime.
23-
- Support numerous protocols for industrial devices, including Modbus, OPCUA, Ethernet/IP, IEC104, BACnet and more.
24-
- Support simultaneous connection of a large number of industrial devices with different protocols.
25-
- 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.
26-
- Support data access to industrial applications, such as MES or ERP, SCADA, historian and data analytics software via SparkplugB solution.
27-
- Has very low memory footprint, less than 10M, and CPU usage, can run on limited resource hardware like ARM, x86 and RISC-V.
28-
- Support installation of native executable or deployed in containerized enviornment.
29-
- Control industrial devices, and make changes to the parameters and data tags through [HTTP API](docs/api/english/http.md) and [MQTT API](docs/api/english/mqtt.md) services.
30-
- Highly integrated with other EMQ products, including [EMQX](https://www.emqx.com/en/products/emqx), [NanoMQ](https://nanomq.io/), [eKuiper](https://ekuiper.org/).
31-
- The code of the core framework and Modbus, MQTT and eKuiper are licensed under open source LGPLv3.
26+
![neuron-overview](docs/pictures/neuron-final.png)
3227

33-
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).
28+
Key features:
29+
30+
- Edge-native application with real-time capability and low latency at the edge.
31+
- Loosely coupled modular architecture with pluggable modules for easy extension.
32+
- Hot-pluggable plugins: update device and application modules at runtime.
33+
- Broad protocol support: Modbus, OPC UA, Ethernet/IP, IEC 60870-5-104, BACnet, and more.
34+
- High concurrency: connect many devices with heterogeneous protocols simultaneously.
35+
- Built-in stream processing via [eKuiper](https://www.lfedge.org/projects/ekuiper) for rules and AI/ML analytics.
36+
- Northbound access for MES/ERP, SCADA, historians, and analytics via Sparkplug B.
37+
- Tiny footprint (<10 MB) and low CPU usage; runs on ARM, x86, and RISC-V.
38+
- Flexible deployments: native binaries or containers.
39+
- Manage devices and tags via [HTTP API](docs/api/english/http.md) and [MQTT API](docs/api/english/mqtt.md).
40+
- Works well with [EMQX](https://www.emqx.com/en/products/emqx), [NanoMQ](https://nanomq.io/), and [eKuiper](https://ekuiper.org/).
41+
- Core framework and Modbus/MQTT/eKuiper plugins are available under LGPLv3.
42+
43+
Note: The open-source edition provides a subset of plugins. For more plugins and a full-featured Dashboard, see [NeuronEX](https://www.emqx.com/en/products/neuronex).
44+
45+
## Table of Contents
46+
47+
- [Quick Start](#quick-start)
48+
- [Installation](#installation)
49+
- [Binaries](#binaries)
50+
- [Build from Source](#build-from-source)
51+
- [Configuration](#configuration)
52+
- [Documentation](#documentation)
53+
- [Dashboard](#dashboard)
54+
- [Community](#community)
55+
- [Contributing](#contributing)
56+
- [Security](#security)
57+
- [License](#license)
3458

3559
## Quick Start
3660

37-
Default username is `admin` and password is `0000`.
61+
Default credentials: username `admin`, password `0000`.
3862

3963
### Download
4064

@@ -46,11 +70,17 @@ $ cd neuron
4670
$ ./neuron --log
4771
```
4872

49-
Open a web browser and navigate to `http://localhost:7000` to access the Neuron web interface.
73+
Open a browser and navigate to `http://localhost:7000` to access the Neuron web interface.
74+
75+
## Installation
5076

51-
### Build and Run
77+
### Binaries
5278

53-
1. [Install Dependencies](https://github.com/emqx/neuron/install-dependencies.md)
79+
Download the latest release from [Releases](https://github.com/emqx/neuron/releases), then extract and run as shown above.
80+
81+
### Build from Source
82+
83+
1. [Install Dependencies](./Install-dependencies.md)
5484

5585
2. Build Neuron
5686
```bash
@@ -72,29 +102,41 @@ $ unzip neuron-dashboard.zip
72102
$ ./neuron --log
73103
```
74104

75-
5. Open a web browser and navigate to `http://localhost:7000` to access the Neuron web interface.
105+
5. Open a browser and navigate to `http://localhost:7000` to access the Neuron web interface.
76106

77-
### Docker
107+
## Configuration
78108

79-
```bash
80-
$ docker run -d --name neuron -p 7000:7000 emqx/neuron:2.6.9
81-
```
109+
- Web UI: `http://localhost:7000` (default credentials above)
110+
- Main config: `neuron.conf`
111+
- Default plugins: `default_plugins.json`
112+
- Logging: `zlog.conf` / `sdk-zlog.conf`
113+
114+
See the quick start for a hands-on walkthrough.
82115

83-
Currently, the latest image maintained for Neuron is `emqx/neuron:2.6.9`, and images for versions `2.7.x` and later are no longer provided.
116+
## Documentation
84117

85-
### [Modbus TCP Data Collection and MQTT Transmission](./docs/quick_start/quick_start.md)
118+
- Quick start: [Modbus TCP collection and MQTT publishing](./docs/quick_start/quick_start.md)
119+
- APIs: [HTTP](docs/api/english/http.md), [MQTT](docs/api/english/mqtt.md)
86120

87121
## Dashboard
88122

89123
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).
90124

91-
## Get Involved
125+
## Community
92126

93127
- Follow [@EMQTech on Twitter](https://twitter.com/EMQTech).
94128
- If you have a specific question, check out our [discussion forums](https://github.com/emqx/neuron/discussions).
95129
- For general discussions, join us on the [official Discord](https://discord.gg/xYGf3fQnES) team.
96130
- Keep updated on [EMQ YouTube](https://www.youtube.com/channel/UC5FjR77ErAxvZENEWzQaO5Q) by subscribing.
97131

132+
## Contributing
133+
134+
Contributions are welcome! Feel free to open issues and pull requests to improve Neuron. If you plan a larger change, please start a discussion first to align on direction.
135+
136+
## Security
137+
138+
If you believe you have found a security vulnerability, please avoid creating a public issue. Instead, contact the maintainers privately (e.g., via GitHub Security Advisories) so we can investigate and fix it responsibly.
139+
98140

99141
## License
100142

docs/quick_start/quick_start_cn.md

Lines changed: 0 additions & 89 deletions
This file was deleted.

0 commit comments

Comments
 (0)