Neuron User Guide - emqx.ioThe Neuron operator's terminal interface is menu driven. The screen is...

Neuron User Guide v1.4 1 17/7/2020

Copyright © 2020 EMQ Technologies Co., Ltd. – ALL RIGTHS RESERVED.

www.emqx.io

Neuron User Guide V1.4

by

Joey Cheung ([email protected])



www.emqx.io

1 General

This document describes how to install and setup the Neuron agent in Linux

system. It is not just a SCADA like system that can polling data from PLC

(Programmable Logical Controller) and transfer to IIoT platform, but also

contains some special features such as remote configuration for modern IIoT

platform. It supports a lot of industrial standard protocols and famous PLC

such as Siemens, Mitsubishi, Allen Bradley and Omron and it can collaborate

with IIoT platform to unleash the power of Industrial 4.0.

Neuron agent is running on a Linux system which is a multiuser, multitasking

operating system. The following description is a series of Linux instruction to

install and setup by using terminal. Remote terminal software such as such

PuTTY or term may be required. For web interface, a browser (i.e, Microsoft

Edge, Chrome, Firefox) are required.



www.emqx.io

2 Content

1 General ..................................................................................................... 2

2 Content ..................................................................................................... 3

3 Installation ................................................................................................ 5

3.1 Download ................................................................................... 5

3.2 Pre-requisites ............................................................................. 5

3.3 New Installation .......................................................................... 6

3.4 Autostart System Service ........................................................... 7

3.5 Fix bin/neuron.conf ..................................................................... 7

3.6 Starting the System .................................................................... 8

3.7 Stopping the System .................................................................. 8

3.8 Command Switches .................................................................... 8

3.9 Multiple Installation ..................................................................... 9

3.10 Docker Installation ...................................................................... 9

4 Terminal Interface ................................................................................... 10

4.1 Terminal Operation ................................................................... 11

4.1.1 Top Level Menu ................................................................. 12

4.1.2 Control Keys ...................................................................... 12

4.1.3 Yes/No Window ................................................................. 13

4.1.4 Messages .......................................................................... 13

4.1.5 Input Field.......................................................................... 14

4.1.6 Status Field ....................................................................... 14

4.1.7 CTRL-F Functions ............................................................. 15

4.2 Exit Neuron ............................................................................... 16

4.3 About ........................................................................................ 17

4.4 Login......................................................................................... 17

4.5 Configuration Setup .................................................................. 18

4.5.1 Channel/Object/Attribute/Tag Setup .................................. 19

4.5.2 Event/Alarm Message Setup ............................................. 27

4.5.3 Save New Configuration .................................................... 29

4.6 Script Programming .................................................................. 30

4.6.1 Global Variables ................................................................ 30

4.6.2 Main Program .................................................................... 32

4.6.3 Manual Mode Program ...................................................... 33

4.6.4 Auto Mode Program .......................................................... 33

4.6.5 Subroutines ....................................................................... 34

4.6.5.1 Free Subroutines ....................................................... 34

4.6.5.2 Create a Subroutine ................................................... 34

4.6.5.3 Edit a Subroutine ....................................................... 36

4.6.5.4 Copy a Subroutine ..................................................... 36



www.emqx.io

4.6.5.5 Delete a Subroutine ................................................... 37

4.7 Event/Alarm Message .............................................................. 37

4.7.1 Event/Alarm Status ............................................................ 38

4.7.2 Event/Alarm Historical Log ................................................ 39

4.8 Status Monitoring...................................................................... 41

4.8.1 Real-Time Data Monitoring................................................ 41

4.8.2 Agent List Monitoring ......................................................... 43

4.9 User Administration .................................................................. 44

4.9.1 User Setup ........................................................................ 45

4.9.2 New Password .................................................................. 46

5 Web Interface ......................................................................................... 48

5.1 Login......................................................................................... 48

5.2 Screen Layout .......................................................................... 48

5.2.1 Selection Menu.................................................................. 49

5.2.2 Command Button .............................................................. 50

5.2.3 Status Bar.......................................................................... 50

5.3 About ........................................................................................ 51

5.4 Configuration Setup .................................................................. 51

5.4.1 Channel/Object/Attribute/Tag Setup .................................. 52

5.4.2 Alarm/Event Message Setup ............................................. 55

5.4.3 Configuration Overview ..................................................... 55

5.4.4 Save New Configuration .................................................... 56

5.5 Script Programming .................................................................. 56

5.5.1 Global Variables ................................................................ 56

5.5.2 Script Editing ..................................................................... 57

5.6 Event/Alarm Message .............................................................. 57

5.6.1 Event/Alarm Current Status ............................................... 57

5.6.2 Event/Alarm Historical Log ................................................ 58

5.7 Status Monitoring...................................................................... 59

5.7.1 Real-Time Data Monitoring................................................ 59

5.7.2 Agent List Monitoring ......................................................... 60

5.8 User Administration .................................................................. 61

5.8.1 User Setup ........................................................................ 61

5.8.2 New Password .................................................................. 62



www.emqx.io

3 Installation

Following section describes how to install the Neuron software package on a

Linux device on x86 platform or ARM platform.

3.1 Download

Neuron software package can be download from EMQ website

https://www.emqx.io. For docker image, please download from docker hub

website https://hub.docker.com/r/emq/neuron.

Neuron agent supports following Linux system:

For x86 64-bit system,

Download file: neuron-1.4-x86_64.tar.gz

For ARM hardware floating support system,

Download file: neuron-1.4-armhf.tar.gz

For ARM 64-bit system,

Download file: neuron-1.4-arm64.tar.gz

For the number 1.4, 1 is major version number which may change if the entire

system structure enhancement, 4 is minor version number which may change

if there will be some additional features or there are some bug fixed patches

for the Neuron software.

Next token specifies the platform dependent for installation. For example,

x86_64 means x86 64bit platform, arm64 means ARM 64bit platform, etc.

3.2 Pre-requisites

The following Linux distros or devices have been tested for Neuron agent.

Linux distros or devices Neuron package required

Debian package system for x86

Debian 9.x

Ubuntu 16.xx Desktop

https://www.emqx.io/

https://hub.docker.com/r/emq/neuron



www.emqx.io

Ubuntu 18.xx Desktop

Linuxmint 18

neuron-1.4-x86_64.tar.gz

Redhat package system for x86

Fedora 30 Workstation

Centos 7.x-1810

Raspberry Pi 2

neuron-1.4-armhf.tar.gz

Raspberry Pi 3

neuron-1.4-arm64.tar.gz

Raspberry Pi 4

Neuron-1.4-arm64.tar.gz

3.3 New Installation

This section describes how to install the Neuron software package for the first

time in Linux system. Every new Linux system MUST run the following once.

Note: For the new installation, system user password might be required.

1) Create a new Linux account “neuron” which will be used for Neuron

software package installation. Or run following command to create it.

~$ sudo useradd neuron -m -s /bin/bash

2) Exit and Login as “neuron” user to Linux prompt ~$.

3) Download Neuron software package from EMQ website.

4) Extracting the software package to ~/bin files, enter the command:

~$ tar -zxvf neuron-1.4-x86_64.tar.gz

5) After extraction, fix the library path and permission of Neuron agent.

~$ sudo ~/bin/installneuron.sh

Device file access permission fixed

RedHat series ssl and crypto library path fixed (for RedHat only)

6) Run Neuron agent first time to build directories ~/dat. enter the command:

~$ neuronsrt



www.emqx.io

7) Stop running the Neuron agent, enter the command:

~$ neuronsrt -s

8) Exit the shell or Restart the system.

The installation is now completed. To start the Neuron agent, login as neuron

user and enter the command neuronsrt.

3.4 Autostart System Service

Neuron agent can be installed as an autostart system service on Linux system

so that Neuron will start up itself every time when Linux start up.

1) Login as “neuron” user

2) Run the autostart service installation script:

~$ sudo installneuron.sh -startup

Note: Follow the instructions from the installation procedure. In general,

answer with the default answer (simply press ENTER) on questions that

appears. This installation must have sudo privilege.

3) To start system service or to restart the Linux system

~$ sudo service neurond start

4) To control system service

~$ sudo service neurond start|restart|stop|status

3.5 Fix bin/neuron.conf

This section describes how to modify some software variables such as MQTT

broker address, username, password, UUID, etc. However, there are some

other settings that controlling the behavior of the software.

To modify the variable in neuron.conf

1) Login as neuron user

2) Edit the connection parameters’ file in ~/bin for basic connection details:

~$ vi bin/neuron.conf



www.emqx.io

3.6 Starting the System

This section describes how to start the Neuron agent.

1) login as “neuron”

2) The Neuron agent can be started by

~$ neuronsrt

Note: If autostart service is installed as described in section 3.5, there is no

need to enter the command neuronsrt at the $ prompt.

3) If the system is based on the Linux desktop environment, open a terminal

and Enter the command for terminal interface.

~$ neuronsrt -t

3.7 Stopping the System

This section describes how to stop the Neuron agent

1) login as “neuron”

2) The Neuron agent stops by entering the command

~$ neuronsrt -s

NOTE! The Linux should not be powered off without stopping Neuron agent.

3.8 Command Switches

This section describes the available switches to the “neuronsrt” command.

Switch Description

-h print help.

-p print running status.

-u shutdown the Linux system.

-r restart only

-n restart with new configuration.

-s stop running

-f fix data directories.



www.emqx.io

-d start with simulation driver

-t start terminal user interface

3.9 Multiple Installation

Neuron agent supports multiple installation on a single Linux system. They are

running as clustering. Each can have its own configured driver and tag

configuration.

To install multiple copies, multiple user account is required. Each account will

be installed the neuron once.

1) Repeat section 3.4 new installation for each user account.

2) For each user account, modify bin/neuron.conf as section 3.6.

Note: BE CAREFUL! The following two variables must be different for each

account.

INSTANCENO=1 Instance number (0-9) is a number

to identify different Neuron installed

on same Linux system.

UUID=16538d28-4592-11e9-a787-

00e067109f12

Universal Unique ID (must be 36

digits)

3) Install the auto-start system service as section 3.5 ONCE only for all user

accounts.

4) To auto-start all user account at once, /etc/neurond.conf must be fixed.

~$ sudo vi /etc/neurond.conf

Note: All user accounts’ name must be listed out in this configure file

5) To control all clustering neurons

~$ sudo service neurond start|restart|stop|status

3.10 Docker Installation

Neuron agent supports implementing docker containers. Neuron docker

image is available in Docker Hub http://hub.docker.com

http://hub.docker.com/



www.emqx.io

Repository: somastech/neuron:v1.2

1) To run docker neuron from hub

~$ sudo docker run somastech/neuron:v1.2

2) To view neuron in container

~$ sudo docker exec -it {containerid} /bin/bash

3) Edit the bin/neuron.conf in container

~{containerid}$ vi bin/neuron.conf

4) To startup a terminal interface

~{containerid}$ neuronsrt -t

5) To stop neuron container

~$ sudo docker container stop {containerid}

Neuron also supports docker stack deployment.

1) Start swarm to allow stack deployment

~$ sudo docker swarm init

2) To start docker stack

~$ sudo docker stack deploy -c docker-compose.yml neuron

Note: docker-compose.yml contains some neuron.conf variables. Modify them

in docker-compose.yml directly instead of getting inside the container.

3) To stop the docker stack

~$ sudo docker stack rm neuron

4) To list out those containers

~$ sudo docker container ls

5) To remove swarm

~$ sudo swarm leave --force

4 Terminal Interface

This section describes in detail the different functions that can be used to



www.emqx.io

operate system in the terminal. By use follow commend to start terminal

interface.

~$ neuronsrt -t

4.1 Terminal Operation

The Neuron operator's terminal interface is menu driven.

The screen is divided in four fields. The top field is the header field with some

global information. The second field is the working field. The third field is the

status field with some important information. The fourth field is the software

function key field with information about the meaning of the function keys for

the function in progress.

To select an item in the current menu, use the up, down, left and right arrows,

HOME or END to position to the desired item and press ENTER.

To exit a function or to go to previous menu, press ESC. To go to the top-level

menu, press CTRL-Q (hold down CTRL and press Q). This can also be used

to exit a function and go immediately to the top-level menu.

When walking around in the menus, the path is shown on the second row in

the header field.

Inside a function following keys are normally used:

Key Description

ESC Exit the function and return to the menu level. Normally this key

will exit the function without execute the changes that have been

made. Only a few functions execute a change without any

verification.

CTRL-Q Exit the function and go to the top-level menu.

F1-F4 Software function key (used in different ways depending of the

function).

TAB Move to next input field.

BACKTAB Move to previous input field.

ENTER Move to next input field/next row.

RUBOUT Erase character to left of the cursor.

INSERT Insert blank row/character before row/character under the

cursor.



www.emqx.io

DELETE Erase row/character under the cursor.

ARROWS Move to desired direction (row/character/field/item).

HOME Move to top row/first character.

END Move to bottom row/last character

PAGE UP Move to same row on previous page.

PAGE DN Move to same row on next page.

4.1.1 Top Level Menu

After going back in menus with ESC several times or pressing CTRL-Q (hold

down CTRL and press Q), the top-level menu is reached.

All function descriptions below start from the top-level menu.

4.1.2 Control Keys

This section describes the control keys that can be used for certain functions.

A few control keys are equal to keys on the keypad. This is to make the

software compatible on terminals that do not have those keys.

To use the control keys, hold down CTRL and press the letter A to Z.

CTRL-x Description Keypad equivalence

CTRL-A



www.emqx.io

CTRL-B Bottom line END

CTRL-C

CTRL-D Down line Down arrow

CTRL-E Escape (to previous level) ESC

CTRL-F Function key call

CTRL-G

CTRL-H Backspace BS or <--

CTRL-I Tabulation TAB

CTRL-J Enter ENTER

CTRL-K

CTRL-L Left position Left arrow

CTRL-M Enter ENTER

CTRL-N Next page PAGE DOWN

CTRL-O Open (insert) line/character INSERT

CTRL-P Previous page PAGE UP

CTRL-Q Quit (to top menu level)

CTRL-R Right position Right arrow

CTRL-S Search FIND

CTRL-T Top line HOME

CTRL-U Up line Up arrow

CTRL-V

CTRL-W

CTRL-X Delete line/character DELETE

CTRL-Y

CTRL-Z

4.1.3 Yes/No Window

Some functions use a dialogue box with a description and a yes/no selection.

To select the answer, use left and right arrows. Use ENTER to verify

selection.

In this dialogue box, ESC or CTRL-Q will not work.

4.1.4 Messages

Some functions use a message box to show a message. Press any key to exit

from this message box.



www.emqx.io

4.1.5 Input Field

An input field is a field where the operator is expected to enter some

information. Enter and most of the special keys terminates the input. When

entering text/digit, the characters will overwrite the characters under the

cursor.

If the text in the input field is inverted, when pressing a text/digit character, the

whole field will be cleared. To avoid clearing (e.g. if just make a small change

in the input field), use the right arrow. Then the text will not be inverted any

more.

Key Description

ENTER Terminate the input.

RUBOUT Erase character to left of the cursor.

INSERT Insert blank character before character under the cursor.

DELETE Erase character under the cursor.

ARROWS Move to desired direction (row/character/field/item).

HOME Move to first position in the field.

END Move to the position after the last position.

4.1.6 Status Field

The status field show some important information. This information is all

shown in red color and is grouped as follows:

Text Description

COMM OK Communication with the control system is OK.

COMM DWN Communication with the control system is down (not OK).

MANU Manual mode for the machine.

SERV Service mode for the machine.

AUTO Auto mode for the machine.

INACTIVE System has no valid configuration yet.

STANDBY System has valid configuration but in standby mode, no

data polling, telemetry but has heartbeat.

ACTIVE System has valid configuration and in running state which



www.emqx.io

data polling, telemetry and heartbeat are all in active state.

CONNECTED Connection with MQTT broker server is OK.

DISCONNECT Connection with MQTT broker server is down (not OK).

UNACK ALARM Unacknowledged alarm exist, the summary alarm is

normally lightening.

ALARM All alarms are acknowledged but one or more alarms are

still existing.

4.1.7 CTRL-F Functions

When pressing CTRL-F, a new sub-menu appears. This menu has some

additional functions. To select one of these functions, press the leading letter

or digit.

Function Description

1-(1)0 Simulates function key F1 to F10, where 1-9 means F1-F9 and 0

means F10 (this is useful for terminals that do not have any function

keys).

H Help (see below).

B Back tabulate (BACKTAB).

E Select.

This function is currently not used, it is reserved for future use.

S Search.

This function is currently not used, it is reserved for future use.

L Login/Logout (see below).

P Print function. The current function is completely printed on one or

several pages. This is not valid for all functions. If not valid the C

function below can be used.

C Print screen. This will print the current screen and is not dependent



www.emqx.io

of the underlying function.

A Alarm acknowledge. This will acknowledge the summary alarm

indication lamp. This will also bring up the alarm function, without

leaving the current function

4.2 Exit Neuron

This function is to exit the operator's interface without stopping Neuron agent.

The user is still in the Linux shell ($ prompt) and can execute other

commands.

1) Select MAIN MENU -> EXIT NEURON

2) Select YES on the question if exit Neuron terminal operator's interface.

3) Enter Neuron password to exit. If the password is not correct, return will

be made to the menu.

4) Select YES if all Neuron programs should stop. Otherwise the Neuron will

continue to run the line.

5) The Linux shell prompt $ will appear. To start the Neuron operator's

terminal interface again, enter the command “neuronsrt -t”.



www.emqx.io

4.3 About

This function shows the id of the Neuron agent and the different modules.

1) Select MAIN MENU -> ABOUT

2) Press any key to return to the menu level.

4.4 Login

This function is used to make a login as a Neuron user.

1) Enter the username and password in the dialog box.

2) To logout, press F4 (LOGOUT). A new empty Neuron user login box

appear. Login with username and password.

3) To clear the login access level (set to 0 (VIEW), press F2 (CLEAR). This

is an easy way of making sure that no other person could use your login to

change data in the Neuron.

4) To change the login access level to any allowed level for this user, press

F3 (CHANGE). After entering the password, a list of allowed levels appears.

Select desired level from this list.

6) A Neuron user login box appear. Enter the neuron username and



www.emqx.io

password. At first installation, only one neuron user exists, "admin" with a

default password “0000” by default. A Neuron login level box appear. Set the

desired login level or press ENTER to continue.

7) If this is the first installation, login as root with the default password. Avoid

running as superuser. Instead add users and logout superuser and login as

any of the new users. When those initialize superuser tasks are done, change

the default password for superuser.

4.5 Configuration Setup



www.emqx.io

These functions are used to setup object attributes for data polling with PLC

and for script programming. In Neuron agent, object is a basic unit for

collecting data variables called attributes that describe data in organized

structure. In short, object encapsulates attributes to describe its behaviors.

These attributes will be assigned to the channel the user can setup at the

beginning. There are two kinds of channel, Ethernet channel or Serial

channel. Each ethernet channel can setup up to 9 sets of IP address and port

number. Serial channel needs the details of device file location, baud rate,

data bit, stop bit and parity bit.

Some object attributes would trigger the alarms, warnings or events points by

checking up the condition and comparing its own value with other pre-defined

values. The triggered alarms, warnings or events will be logged down in local

Linux system.

1) Select MAIN MENU -> CONFIGURATION SETUP

4.5.1 Channel/Object/Attribute/Tag Setup

This function is used to create/edit/delete objects in the current configuration.

1) Select MAIN MENU -> CONFIGURATION SETUP ->

CHANNELS/OBJECTS/ATTRIBUTES SETUP

2) A list of objects is shown in table. Use the cursor UP or DOWN to point to

desired row. To change the detail settings of this row, press ENTER. To add a

row before this row, press INS. To add a row at the end of list, press F2 (ADD

ROW). To delete this row, press DEL.

Column Description

No This is index number of the object.

Name This is the name of the object. (30 characters)

Size This is the number of objects that share the same attributes and

characteristics.

Time This is time interval of data refresh rate for transmission. (in

second)



www.emqx.io

Logs This is time interval of data logging on the disk. (in second)

T This is a Timestamp flag that whether timestamp field is preset

with data. (Y/N)

D This is a Display flag that indicate entire object data would be

transferred to platform. (Y/N)

L This is Logging flag. If it is ON, entire object data will be stored

on the disk when the connection to platform is not available.

(Y/N)

3) After getting in the detail settings screen, all details of that object are

shown. To change detail, press F4 (CHANGE). Name, Size, Refresh Time,

and Logging Time can be modified.

4) To change the Timestamp flag, press F5 (TIMESTAMP Y/N). To change

the Display flag, press F6 (REFRESH Y/N). To change the Logging flag, press

F7 (LOGGING Y/N).



www.emqx.io

5) After finishing the modification, to save the changes, press F4 (SAVE). To

continue the next detail setup, press F1 (CONTINUE) or ENTER. The Prefix

and Suffix dialog box has been shown.

6) To change Prefix and Suffix detail settings, press F4 (CHANGE). Use the

cursor UP or DOWN to point to desired row. To save the changes, press F4

(SAVE) again. After finishing the setup, press F1 (CONTINUE) to go back to

object list.

7) Repeat above steps to create all objects details.

8) To setup the communication driver for PLC or hardware, press F4



www.emqx.io

(DRIVER SETUP). A list of driver name and its description has been shown.

9) Use cursor LEFT or RIGHT to select the one to communicate with PLC.

To save the driver selection, press ENTER. There are two type of driver,

Ethernet and Serial. For Ethernet, go to step 10. For Serial, go to step 11.

10) There are up to 9 sets of hostname and port number for Ethernet. Use the

cursor UP or DOWN to point to desired channel. To change the details of each

channel, press F4 (CHANGE). To save the changes, press F4 (SAVE) again.

After finishing, press F1 (CONTINUE) to go on.



www.emqx.io

11) Serial driver supports only 1 set of device file, baud rate, data bit, stop bit

and parity bit. To change the device file, press F4 (CHANGE). To change the

baud rate, press F5 (BAUDRATE). To change the data bit, press F6

(DATABIT). To change the stop bit, press F7 (STOPBIT). To change the parity

bit, press F8 (PARITYBIT).

12) Object attributes can be defined after finishing driver setup. Use the

cursor UP or DOWN to select the object name. press F1 (ZOOM IN) to zoom

into attributes table list.

13) An attribute list of specific an object will be prompted. Use the cursor UP

or DOWN to point to desired row. To change the detail settings of this row,

press ENTER. To add a row before this row, press INS. To add a row at the

end of list, press F2 (ADD ROW). To delete this row, press DEL. To specify

the address of the attribute, press F3 (ADDRESS SETUP). If the attribute is

assigned with dummy variables, press F4 (DUMMY Y/N).

Column Description

Name This is the name of the attributes.

Type This is data type of the attributes. It includes

word – 2 bytes interger

uword – 2 bytes unsigned interger

dword – 4 bytes interger

udword – 4 bytes unsigned interger

bit – Boolean (Y/N)



www.emqx.io

datetime – Unix timestamp value

float – IEEE floating value

double – IEEE double floating value

ascii16 – ASCII value

D This is a decimal point for data type for word, uword, dword,

udword only. Other data type will display ‘-‘.

A If this attribute has address defined, it shows ‘*’. If no address

specifies, use “-” to represent in the field and if it is a dummy

attribute, it shows ‘D’ in the field.

T This is a display flag that indicate entire object data would be

transferred to platform. (Y/N)

C This is a changeable flag that indicate this attribute whether can

be changed during operation. (Y/N)

RW Read/Write direction for PLC, this represents the direction of

read or write, or both read/write for PLC

Rtime This is read polling time interval for PLC when RW is read or

read/write. For RW is write, it shows ‘-‘.

14) After getting in the detail settings screen, all details of the attribute are

shown. To change the settings, press F4 (CHANGE). After making the

changes, press F4 (SAVE) again to save the changes.



www.emqx.io

15) To change the attribute data type, press F5 (DATA TYPE). If word, or

uword, dword, udword, has been chosen, a decimal value input box will be

shown. Enter the decimal value and then press ENTER.

16) To change display flag. press F6 (TRANSMIT Y/N). To change

changeable flag, press F7 (CHANGE Y/N).

17) To change RW direction, press F8 (READ/WRITE). If Read or Read/Write

has been chosen, a read time interval dialog box will be shown. Enter the

polling time interval for this attribute. Press F4 (SAVE) to go back to Attribute

list.



www.emqx.io

18) After getting in the address setup dialog, to change the addresses of the

attribute, press F4 (CHANGE). To save the changes, press F4 (SAVE). After

finishing, press F1 (CONTINUE) to go back attribute list screen.



www.emqx.io

4.5.2 Event/Alarm Message Setup

This function is used to delete an object in the current project.


EVENTS/WARNINGS/ALARMS SETUP

2) A list of messages is shown in table. Use the cursor UP or DOWN to point

to desired row. To change the detail settings of this row, press ENTER. To

add a row before this row, press INS. To add a row at the end of list, press F2

(ADD ROW). To delete this row, press DEL.

Column Description

Object1 This is first object of the message.

Attribute1 This is first attribute of the message.

Type This is the operation type of message. It indicates whether bit

operation, value operation, or text operation of an alarm.

Object2 This is second object of the message.

Attribute2 This is second attribute of the message.

Cat This column is to distinguish the level of importance of each



www.emqx.io

alarm such as, alarm, warning, event, log, command, etc.

Sub If the field has Tag type, it would store the subroutine number of

being called when there is a change to this tag in running mode.

3) After getting in the detail settings screen, all details of that message are

shown. To change detail, press F4 (CHANGE). Object1, Attribute1, Operator,

Object2, Attribute2, Category and Subroutine can be modified.

4) To change the Object1 and Attribute1 settings, press F5 (FIRST OBJ). To

change the operator of the message, press F6 (OPERATOR). To change the

Object2 and Attribute2 settings, press F7 (SECOND OBJ). To change the

category of the message, press F8 (CATEGORY).



www.emqx.io

4.5.3 Save New Configuration

This function is used to generate the new change of the objects, alarms and

channels in the current configuration.


OVERALL ELEMENTS CHECKUP

2) To generate the configuration json format file, press F8 (CREATE

CONFIG).



www.emqx.io

4.6 Script Programming

Neuron has an own programming language, Neuron Script Programming, for

handling of special demands in controlling the line. It is a high-level c-like

programming language.

The main feature with the script programming is that advanced solutions can

be made with the language, without changing in the standard program

package. This also means that the customer will have this powerful tool to

later make changes in the system.

The different parts of the programming environment are running in a

sequential order. First there is an idle loop (time interrupt) of one second

before the main program starts.

All changes in the program can be made while running the line. Of course,

there could be some side effect if making an erroneous change.

1) Select MAIN MENU -> NEURON SCIRPT PROGRAMMING

4.6.1 Global Variables

This function is used to view or change the global variables for the script

programming language. Those global variables can be used by all programs.



www.emqx.io

When making a change, all unchanged global variables will remain their

values. Changed (number of words) or new global variables will get the value

zero.

1) Select MAIN MENU -> NEURON SCIRPT PROGRAMMING ->

GLOBAL VARIABLES

2) To change a value, press F4 (CHANGE ROW). After making the

changes, press F4 (SHOW ROW). To insert a row, press INSERT. To delete a

row, press DELETE.

3) To save and exit, press F1 (SAVE AND EXIT).

The different columns have following meaning:

Column Description

Variable G. Global variable name (without leading G.).

Nos Number of words in array. If e.g. using an array variable with one

word for each station where the index should be the station

number, add one extra word for the index 0 (e.g. 36 stations with

first station 1 should reserve 37 words for the variable).

Description Description of variable. A description (header) can be written

leaving Variable G. and Nos blank.



www.emqx.io

4.6.2 Main Program

This is the first program that starts. When execution is ready, following

happens:

If the communication with the control system is down, the program returns to

the idle loop to sleep for one second.

If the line is in manual mode, the manual mode program starts. Otherwise, if

the line is in auto mode, the auto mode program starts.


MAIN PROGRAM

2) To select a statement at left column, press F2 (STATEMENT)

3) To edit the expression of the program.




www.emqx.io

4.6.3 Manual Mode Program

This program starts after the main program if the line is in manual mode.

When execution is ready, the program start execution of manu mode routine

and returns to the idle loop to sleep for one second.


MANUAL PROGRAM

2) To edit the program.


4.6.4 Auto Mode Program

This program starts after the main program if the line is in auto mode. When

execution is ready, the program starts execution of auto mode routine and

returns to the idle loop to sleep for one second.


AUTO PROGRAM

2) To edit the program.



www.emqx.io


4.6.5 Subroutines

Subroutines are a set of execution statements can be started from any

program, including other (or same) subroutines. Subroutines can be nested.

When execution is ready, the program returns to the calling program.


SUBROUTINE MENU

4.6.5.1 Free Subroutines

This function is used to see the number of free/used subroutines.


SUBROUTINE MENU -> FREE

2) Press any key to return to the menu level.

4.6.5.2 Create a Subroutine

This function is used to create a new subroutine.



www.emqx.io


SUBROUTINE MENU -> CREATE SUBROUTINE

2) Select the subroutine number for the new subroutine.

3) Enter the description of the program

4) Edit the new subroutine (see Edit a Subroutine).



www.emqx.io

4.6.5.3 Edit a Subroutine

This function is used to view or change an existing subroutine.


SUBROUTINE MENU -> EDIT SUBROUTINE

2) Select the subroutine to be edited in the pick-up menu.

3) The subroutine name appears. To continue to next screen, press F1

(CONTINUE). To change the name, press F4 (CHANGE ROW). After making

the changes, press F4 (SHOW ROW).

4) Next screen is the script programming subroutine. To edit the program.


4.6.5.4 Copy a Subroutine

This function is used to copy an existing subroutine to a new subroutine.


SUBROUTINE MENU -> COPY SUBROUTINE



www.emqx.io

2) Select the source subroutine in the pick-up menu.

3) Select the subroutine number for the target (new) subroutine.

4) Select YES on the question if edit the new subroutine (if wanted).

5) Edit the new subroutine (see Edit a Subroutine).

4.6.5.5 Delete a Subroutine

This function is used to delete an existing subroutine.


SUBROUTINE MENU -> DELETE SUBROUTINE

2) Select the subroutine to be deleted in the pick-up menu.

3) Select YES on the question if delete the subroutine (if wanted).

4.7 Event/Alarm Message

In the machine, there are several alarm points that are continuously

monitored. The alarms are sorted in up to 16 different categories (A, B, C etc.)

depending of the nature of the alarm. This is to easier determine how

important an alarm is. The numbers of alarms are application dependent.

When an alarm occurs, a summary alarm indication lamp is activated. The

summary alarm is acknowledged from the terminal by the operator. When the

alarms are displayed on the terminal, they are sorted in categories. This

function always shows the current alarm status.

If there is an alarm that is on, but is not relevant for the line, it can be disabled.

This could be, for example, a low-level alarm in a station that is not used. In

the disable alarm function, all alarms for a certain station can be disabled.

In the alarm text, dynamic values can be included. This is to easier find the

cause for an alarm.

1) Select MAIN MENU -> WARNING AND ALARM MESSAGE



www.emqx.io

4.7.1 Event/Alarm Status

This function is used to view the current active alarm points. The alarms are

sorted in up to 16 different categories (A, B, C etc.) depending of the nature of

the alarm. This is to easier determine how important an alarm is.


summary alarm is acknowledged by this function or by using CTRL-F + A.

Individual acknowledge of alarms is done in this function, one by one.

The alarm function can also be carried out by pressing CTRL-F and A from the

current function, without leaving it.

There are six different show modes. ACTIVE ENABLED shows all enabled

alarms that are currently on or unacknowledged. ACTIVE UNACK shows all

alarms that are unacknowledged. ACTIVE ALL shows all alarms (including

disabled alarms) that are currently on or unacknowledged. ALL ALARMS

show all alarms in the system, whether they are on or off. ALL ENABLED

shows all alarms in the system that are not disabled, whether they are on or

off. ALL DISABLED show all alarms in the system that are disabled, whether

they are on or off.

All show modes display the status in real time. In addition, all functions can be

performed in all different show modes.

1) Select MAIN MENU -> WARNING AND ALARM MESSAGE ->

WARNING AND ALARM STATUS

2) The default show mode is ACTIVE ENABLED

3) To acknowledge an alarm, press F1 (ACKNOWLEDGE).

4) If all stations are selected, to select all alarms for only one station, press

F2 (SELECT STATION). If only one station is selected, to select all alarms all

stations, press F2 (SELECT ALL).

5) To change show mode, press F3 (SHOW MODE) and select the desired

mode. Arrows right (next show mode) or left (previous show mode) can also

be used (instead of F3).

6) If an alarm is enabled, it can be disabled by pressing F4 (DISABLE). If an



www.emqx.io

alarm is disabled, it can be enabled by pressing F4 (ENABLE).

The different columns have following meaning:

Column Description

Categ Alarm category.

Stat Alarm status (ON or OFF)

Comment Alarm condition (Unack, Disabled or blank)

Text Alarm text including dynamic values

4.7.2 Event/Alarm Historical Log

This function is used to view the alarm historical log. Every time an alarm is

going on or off or ack, the event is logged to an alarm log file.

This report contains date and time, category, status on or off and the alarm

text, including dynamic values. The dynamic values will be 0 for alarm events

with off status.

The report displays the alarm events in time order, event by event.

Every time an alarm is going on or off, the event is logged to an alarm log file.



www.emqx.io

This report contains date and time, status on or off and the alarm text,

including dynamic values. The dynamic values will be 0 for alarm events with

off status.

The report displays the alarm events in time order, event by event. Search

pattern can be used to only show the events with matching text.

1) Select MAIN MENU -> WARNING AND ALARM MESSAGE ->

WARNING AND ALARM HISTORICAL LOG

2) Select searching parameters. Unused fields mean all/from first.

Select year, month, date and time for when the search should start. To search

from beginning, press F1 (FIRST). To search from first this date, press F3

(FIRST TODAY). To search from the end and backwards, press F2 (LAST).

Select required search parameters (category and search pattern for the alarm

text).

To execute the search, press F4 (EXECUTE) or press ENTER from last row.

Search will start for any alarm with a matching search pattern. If no match is

found, the message "Not found" appear.

3) The first (or last if searching from the end was selected) alarm is

displayed.

4) To continue to search matching pattern, use arrows up or down. To get

next/previous alarm in time order (no matching check is done), use PAGE

DOWN/UP. To get first/last alarm in time order (no matching check is done),

use HOME/END. To change the search parameters, press F3 (NEW

SEARCH).



www.emqx.io

4.8 Status Monitoring

These functions are used to work with the different status functions in the

machine.

4.8.1 Real-Time Data Monitoring

This function is used to view and change all object data variables that would

be spitted into different object views. This function is used to show the

parameters such as pH value, sequence steps, side transporter positions,

weight, conductivity and other interesting values that can be by interest for the

operator.

The first type is object variables where it just stores the value in the object

field, and it will not be transferred to and from PLC. The second type is object

string where it usually stores the string instead of value. The third type is tag

variables. This is the only variable type to be transferred between PLC and

Neuron.

1) Select MAIN MENU -> REAL-TIME DATA MONITORING

2) To view different groups can popup the selection menu by using press F3

(CHANGE OBJECT).



www.emqx.io

3) More details about the object has been shown.



www.emqx.io

4.8.2 Agent List Monitoring

This function is used to view the details of all agents that connect to same

MQTT broker server for message exchange between themselves and with

platform. This function is used to show the usage and license parameters

such as no of tags allowed, no of alarms allowed, expire date, data usage

remain, drivers allowed and other functions available for the project.

1) Select MAIN MENU -> AGENT LIST MONITORING



www.emqx.io

2) To view details of specific agent. Users can popup the agent detail

information by using press ENTER to selected agent in the list.

4.9 User Administration

Multiusers are allowed for Neuron agent. Each user has its own password and

has its own access level, which is a collection of access right the user can

perform in the Neuron agent that the system administrator can assigned to the

Neuron agent. The access levels do not necessarily have to be in order. A

user can at any time reduce its access level to a lower access level, and later

raise it again. Each function in the Neuron agent has a set of valid access

levels.

When creating a user, the system administrator selects a username, and

assign a password. The user can later change his password. In addition, a

time-out time in minutes can be set. The purpose of this time-out time is if the

user, after logging in, does not touch the keyboard, the access level will be set

to 0 (VIEW). Then, to be able to get a higher access level, the operator has to

raise its access level, using his password. At any time, if the user does not

have the access level set to the level required for the current function but has

permission to change to the required access level, the Neuron agent will ask

for the password. Then after entering the correct password, the user will get

temporary access to this function. After exiting this function, to do the same

again, the user has to raise the access level or enter the password again. If a

time-out occurs, also this temporary access will no longer be valid.



www.emqx.io

There is one predefined user, (admin), which is the same as the Neuron

administrator. The super user has its password set to a default at delivery,

which for security reason, should be changed after installation. Normally, no

one should be logged in as super user to run the Neuron, this should only be

done when doing administration tasks.

4.9.1 User Setup

This function is used to create a new user or to change an old user detail.

Only super user (root) has access to this function.

1) Select MAIN MENU -> USERS ADMINISTRATION ->

USER SETUP

2) Enter password.

3) To create a new user, enter the name of the new user. To change an

existing user, enter the name of this user. The values for this user will be

displayed, except password which is hidden for security reasons. To list

existing usernames, press F2 (LIST USERS). To create a new user with the

same data as an existing user, enter the name of the existing user and change

the username to the new user. The remaining data will then be the same,

change if required (e.g. password).

4) To erase a user, press F3 (ERASE USER).

5) To change the password, enter the new password. Else press ENTER to

step to next field. After logging in, the user can change the user password

(see 7.8).

6) Enter the time-out time in minutes. If the keyboard has not been touched

within this time, the access level will be changed to 0 (VIEW). If no automatic

reduction of access level is required, set the time-out time to 0.

7) To add an access level, move the cursor to the access level in the right

column (Available levels) and press ENTER (or F3 SELECT). This level will

now be moved to the left column. To remove an access level, move the cursor

to the access level in the left column (Allowed levels) and press ENTER (or F3

UNSELECT). This level will now be moved to the right column.



www.emqx.io

8) To define the default login level, the suggested level when this user login,

move the cursor to the access level in the left column (Allowed levels) and

press F2 (LOGIN LEVEL).

9) To save a user, press F1 (SAVE USER).

4.9.2 New Password

This function provides a possibility to change the password for the user

currently logged in.

NOTE! Be careful to keep the Neuron super (root) user password in a safe

place. To retain a forgotten Neuron password, the Linux super user must be

contacted.

1) Select MAIN MENU -> USERS ADMINISTRATION ->

NEW PASSWORD

2) Enter (old) user password.

3) Enter the new user password.



www.emqx.io

4) Re-enter the new user password (for security reason).

6) Select YES on the question if save the new password (the old password

will not be valid). If NO is selected, the old password is still valid (and not

the new).



www.emqx.io

5 Web Interface

This section describes in detail the different functions that can be used to

operate Neuron in Web interface. To start the web interface, open a web

browser (i.e, Microsoft Edge, Chrome, or Firefox). Enter the address of

gateway and port no. will be 7000 for Neuron. For example,

5.1 Login

The first screen shown in the browser will be the login page as following. The

superuser account is “admin” and the default password is “0000”. After first

login, you should change your superuser password for better security.

5.2 Screen Layout

This is the first screen will be displayed when you get in the Neuron. In the

upper part, there is a menu selection bar that contains 3 kind of features. First

is Status menu which contains the data, event, alarm monitoring features.



www.emqx.io

Second menu is configuration which is used to setup the PLC or device

communication details. Last is administration menu. At the top right hand

corner, there are three command button which are used to control the Neuron

system. The lower part is the status bar that show the current status of

Neuron.

5.2.1 Selection Menu

Status Menu

Configuration Menu



www.emqx.io

Administration Menu

5.2.2 Command Button

There are 3 command buttons at the top right hand corner. The left one is

start/stop button that can temporarily pause the system. Once the system is

paused. The system status will turn into standby mode and no telemetry data

will be sent out. The middle button is used to restart the Neuron system. The

right one is for sending the configuration data to Neuron system.

5.2.3 Status Bar

There are five kinds of system status in Neuron.

Status Description

COMM UP PLC/device communication up

COMM DOWN PLC/device communication down

MANU machine in manual mode

AUTO machine in auto mode

SERV machine in service mode

ACTIVE Neuron system in active mode



www.emqx.io

INACTIVE Neuron system in inactive mode

STANDBY Neuron system in standby mode

SEMI Neuron system in semi-active mode

MQCONNECT MQ broker connected

MQDISCONNECT MQ broker disconnected

NO ALARM No alarm found

ALARM Alarms

UNACK ALARM Unacknowlegde alarms

5.3 About

This screen is to tell you about the system detailed information about Neuron,

including system version, data usage, expire date, UUID and etc.

5.4 Configuration Setup

These functions are used to setup the PLC communication details in terms of

channel, object, attributes and tag address for PLC data polling and for script

programming. Moreover, a list of events and alarms can be defined also in

configuration on the basis of object and attributes.



www.emqx.io

5.4.1 Channel/Object/Attribute/Tag Setup

There are two kinds of channel, Ethernet channel or Serial channel. Each

ethernet channel can setup up to 9 sets of IP address and port number. Serial

channel needs the details of device file location, baud rate, data bit, stop bit

and parity bit.

After finishing the setup of Channel, start to setup object details.



www.emqx.io

To add an object to a list, press the “Create” button at the right. An object

setup dialog box will be prompted.

After finishing the object setup, press the attribute to enter to attribute setup.

By pressing the “Create” button, it will shows a input dialog box for attribute

setup. Setup the name, attribute type and details.

After getting in the detail settings screen, all details of the attribute are shown.

To change the settings as you needed. After making the changes, press



www.emqx.io

“Submit” to save the changes.

After prompting up the address setup dialog, setup or change the addresses

of the attribute. The number of addresses depends on the number of object

created.



www.emqx.io

5.4.2 Alarm/Event Message Setup

Some object attribute values can be setup to trigger an alarm or event by

checking up its condition or comparing its own value with other preset values.

5.4.3 Configuration Overview

The configuration overview page is only for overall configuration checking.



www.emqx.io

5.4.4 Save New Configuration

After finishing the configuration setup, press the “Send” button to transfer the

configuration settings the Neuron system would check up. If it passes the

checkup, it would restarts the system to initiate the new configuration. The

web interface would be forcibly to logout once system restarts.

5.5 Script Programming

Neuron contains a script parser that can read a high-level c-like syntax

statement to deal with special controlling demand of the machine.

All changes in the scripts can be made while the machine is running. Of

course, there could be some side effect if making an erroneous change.

5.5.1 Global Variables

Add the global variables in this page, press “Submit” when finishing.



www.emqx.io

5.5.2 Script Editing

There is a drop down box “Routine” at the top. Inside there will be 3 basic

program which are Main, Auto and Manual. Subroutine could be created by

pressing the “Create” button. It shows a dialog box and need to enter a name

and subroutine no. If successfully created, this subroutine will be shown in

drop down box.

All useless created subroutine in the dropdown box can be deleted by

pressing the “Delete” button. After making the necessary scripts, press the

“Submit” button to save the scripts to the system.

5.6 Event/Alarm Message

This Event/Alarm message is used to view the current active alarm points.

The alarms are sorted the nature of the alarm. This is to easier determine how

important an alarm is.

5.6.1 Event/Alarm Current Status

There are six different show modes in dropdown box. ACTIVE ENABLED

shows all enabled alarms that are currently on or unacknowledged. ACTIVE

UNACK shows all alarms that are unacknowledged. ACTIVE ALL shows all



www.emqx.io

alarms (including disabled alarms) that are currently on or unacknowledged.

ALL ALARMS show all alarms in the system, whether they are on or off. ALL

ENABLED shows all alarms in the system that are not disabled, whether they

are on or off. ALL DISABLED show all alarms in the system that are disabled,

whether they are on or off.

All show modes display the status in real time. In addition, all functions can be

performed in all different show modes.


summary alarm is acknowledged by pressing the acknowledge one by one.

5.6.2 Event/Alarm Historical Log

This function is used to view the alarm historical log. Every time an alarm is

going on or off or ack, the event is logged to an alarm log file.

This report contains date and time, category, status on or off and the alarm

text, including dynamic values. The dynamic values will be 0 for alarm events

with off status.

The report displays the alarm events in time order, event by event.



www.emqx.io

5.7 Status Monitoring

This function can show data monitoring and alarm status.

5.7.1 Real-Time Data Monitoring

This page is used to view and change all object data variables. It will shows

the real-time data and for some changeable variables. There is a “Write”

command on the right. Press this button and enter the value.



www.emqx.io

There are also a trend diagram for each variable. By pressing the “History”

button, it shows the historical trends for the variable. By pressing the “Current”

button, it shows the current trends for the variable.

5.7.2 Agent List Monitoring

This page will list out all Neuron agent in the same group. It contains the data

usage, expired date, maximum allowed objects and attributes for the current

project.



www.emqx.io

5.8 User Administration

The following functions are mainly to create a user for Neuron system.

5.8.1 User Setup

This page is used to manage the user. Press the “Add” button to add a user.

To delete user, press the “Delete” to remove the current row.

When pressing the “Add” button, a Add New User dialog box will be shown.

Enter the name and password. Pick the access level for this user.



www.emqx.io

5.8.2 New Password

This page is used to change password of the current user.

END

Date post:	05-Oct-2020
Category:	Documents
Upload:	others
View:	0 times
Download:	0 times

Neuron User Guide - emqx.ioThe Neuron operator's terminal interface is menu driven. The screen is...

Documents