Prerequisite Setup

Installstion

NeuronEX

Because the NeuronEX version integrates eKuiper, and the page adds a data stream processing section, so only the NeuronEX version needs to be installed.

  1. $ sudo docker pull emqx/neuronex:latest
  2. $ sudo docker run -d --name neuron -p 7000:7000 --privileged=true --restart=always emqx/neuronex:latest

Install Neuron and eKuiper separately

Users can choose to install Neuorn and eKuiper separately, and use docker-compose to install and configure them directly. The docker-compose.yml example is as follows, and the installed version can be selected according to requirements.

  1. version: '3.4'
  3. services:
  5.   ekuiper-manager:
  6.     image: emqx/ekuiper-manager:1.5.0
  7.     container_name: ekuiper-manager
  8.     ports:
  9.       - "9082:9082"
  11.   ekuiper:
  12.     image: lfedge/ekuiper:1.5.1-slim
  13.     hostname: ekuiper
  14.     container_name: ekuiper
  15.     ports:
  16.       - "9081:9081"
  17.       - "127.0.0.1:20498:20498"
  18.     environment:
  19.       MQTT_SOURCE__DEFAULT__SERVER: tcp://broker.emqx.io:1883
  20.       KUIPER__BASIC__CONSOLELOG: "true"
  21.       KUIPER__BASIC__IGNORECASE: "false"
  22.     volumes:
  23.       - nng-ipc:/tmp
  25.   neuron:
  26.     image: emqx/neuron:2.3.0
  27.     hostname: neuron
  28.     container_name: neuron
  29.     ports:
  30.       - "7000:7000"
  31.     volumes:
  32.       - nng-ipc:/tmp
  34.   source:
  35.     image: alpine/httpie
  36.     container_name: httpie
  37.     command:
  38.       - --ignore-stdin
  39.       - --check-status
  40.       - ekuiper:9081/streams
  41.       - sql=CREATE STREAM neuronStream() WITH (TYPE="neuron",FORMAT="json",SHARED="true");
  42.     depends_on:
  43.       - ekuiper
  44.       - neuron
  46. volumes:
  47.   nng-ipc:%

After successful execution, Neuron and eKuiper have been started respectively.

Login to kuiper-manager.

  • Address: http://$yourhost:9082
  • User name: admin
  • Password: public

Add the service as shown.

ekuiper_service

TIP

The address in Endpoint should fill in the local address where eKuiper is launched.

After adding the service, because docker-compose has created a data stream, there should be a neuronStream stream in the newly created service.

For the specific operation of eKuiper, please refer to ekuiper IntroductionPrerequisite Setup - 图2 (opens new window)

Dashboard

There is a pre-defined a data stream named neuronStream with type attribute neuron in data stream engine. Users are required to subscribe the desired data Groups of southbound devices. The subscribed data Groups will be the data stream for stream engine. All rules in stream engine would share this data stream.

Step 1 Check over the data stream processing application node

When you install a .deb or .rpm Neuron package, there is a default data-stream-processing application node in the northbound application management screen, as shown below.

data-stream-rules-adapter

The data stream processing node contains the following information

  • Application Name - data-stream-processing
  • Status - Running
  • State Change Button - ON
  • Connection Status - Disconnected
  • Plugin Module Name - ekuiper

Step 2 Subscribe to data groups of southbound devices

Click on any blank space of the data-stream-processing application node to enter the Group list screen for subscribing to the group, as shown below.

data-stream-rules-sub

To subscribe the data Groups of southbound device,

  • Click on the Add subscription button in the top right corner.
  • Click on the drop down box to select the southbound device, in this case, we select the modbus-tcp-1 device built above.
  • Select the Group you want to subscribe to in the drop-down box, in this case, we select the group-1 created above.
  • Click on Submit button to complete the subscription.