Skip to content

Latest commit

 

History

History
99 lines (69 loc) · 5.68 KB

README.md

File metadata and controls

99 lines (69 loc) · 5.68 KB

Neuron

GitHub Release Docker Pulls codecov Slack Discord Twitter YouTube

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.

neuron-overview

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 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.
  • Support simultaneous connection of a large number of industrial devices with different protocols.
  • Combine with the rule engine function provided by 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 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 and MQTT API services.
  • Highly integrated with other EMQ products, including EMQX, NanoMQ, eKuiper.
  • The code of the core framework and Modbus, MQTT and eKuiper are licensed under open source LGPLv3. Commercial modules require a EMQ License to run.

For more information, please visit Neuron homepage.

Get Started

Run Neuron using Docker

docker run -d --name neuron -p 7000:7000 -p 7001:7001 -p 9081:9081 --privileged=true --restart=always emqx/neuron:latest

Next, please follow the getting started guide to tour the Neuron features.

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. 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.

More installation options

If you prefer to install and manage Neuron yourself, you can download the latest version from neugates.io/downloads?os=Linux.

For more installation options, see the Neuron installation documentation.

Documentation

The Neuron documentation is available at neugates.io/docs/en/latest/.

Get Involved

Build From Source

Install required dependencies

Install-dependencies

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 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

See LICENSE.