Module Setting

This document introduces how to setup parameter and data tag point information in configuration for northbound applications and southbound drivers.

TIP

uint16 corresponds to the word type. uint32 corresponds to dword type.

MQTT

The data collected from the device can be transmitted to the mqtt broker through mqtt application, and instructions can be sent to neuron through mqtt application.

Parameter Setting

Modbus

The modbus protocol includes three drivers: modbus RTU, modbus tcp, and modbus RTU over TCP.Except for the device configuration, the three protocols support the same data types and address formats.

Modbus TCP / Modbus RTU over TCP Parameter Setting

Modbus RTU Parameter Setting

Support Data Type

• INT16
• INT32
• UINT16
• UINT32
• FLOAT
• BIT
• STRING

Address Format

SLAVE!ADDRESS[.BIT][#ENDIAN][.LEN[H][L][D][E]]

SLAVE

Required, Slave is the slave address or site number.

ADDRESS

Required, Address is the register address.The Modbus protocol has four areas, each area has a maximum of 65536 registers, and the address range of each area is shown in the table below. It should be noted that the storage area as large as 65536 is generally not required in practical applications. Generally, PLC manufacturers generally use an address range within 10000. Please pay attention to fill in the correct point address according to the area and function code of the device.

TIP

Some device documents use function codes and register addresses to describe instructions. Because register address numbers start from 0, the register address range for each region is 0 to 65535. First, determine the highest digit of the address according to the function code, and add 1 to the register address as the address of Neuron.

example, function is 0x03, and register address is 0, then address used by neuron is 400001. function is 0x02, and register address is 5, then address used by neuron is 100006.

.BIT

Optional, a bit of a register address, for example:

#ENDIAN

Optional, endianness, applicable to int16/uint16/int32/uint32/float data types, see the table below for details.

Example:

.LEN[H][L][D][E]

When the data type is string type, .LEN is a required, indicating the length of bytes that the string needs to occupy. Each register contains H, L, D and E four storage methods, as shown in the table below.

Example:

OPC UA

Parameter Setting

Authentication mode:

• anonymos, requires OPCUA server to enable anonymous login;
• username-password, The OPCUA server needs to create a username with access permission. Neuron will automatically match the security Settings of OPCUA server and try to log in.
• cert-key + anonymos, which requires OPCUA server to enable appropriate security settings and set certificates, and enable anonymous login;
• cert-key + username-password, the OPCUA server must have created a username with access permission, and enable appropriate security Settings and set the certificate;

Certificate Setting

OPCUA can login to OPC-UA server by user self-signed certificate, certificate and key must meet the following conditions.

• CERTIFICATE and KEYFILE must be set at the same time
• Certificate must be generated by X.509v3 standard
• The SAN field of the Certficate must contain URI:urn:xxx.xxx.xxx, with the “xxx” part being a custom part
• Certificate file and key file must be encoded with DER format

The certificate file can be imported into the target server in advance and set as trust, or it can be set by neuron and submitted automatically and then set as trust by the server.

Certificate generation steps(Windows/Linux/Mac):

$openssl req -config localhost.cnf -new -nodes -x509 -sha256 -newkey rsa:2048 -keyout localhost.key -days 365 -subj "/C=DE/O=neuron/CN=NeuronClient@localhost" -out localhost.crt
$openssl x509 -in localhost.crt -outform der -out client_cert.der
$openssl rsa -inform PEM -in localhost.key -outform DER -out client_key.der
$rm localhost.crt
$rm localhost.key

The *.cnf file specified by -config can be modified using the template file for openssl (opens new window) to be modified to include the following configuration section:

[ v3_req ]
# Extensions to add to a certificate request
basicConstraints = CA:FALSE
keyUsage = nonRepudiation, digitalSignature, keyEncipherment
subjectAltName = @alt_names
[ alt_names ]
URI.1 = urn:xxx.xxx.xxx
DNS.1 = localhost
#DNS.2 = localhost
IP.1 = 127.0.0.1
#IP.2 = 0.0.0.0

-days can set the value as desired.

Certificate conversion

You can convert PEM certificate and private key to DER format by following steps and commands

1. Save all the contents including “——-BEGIN CERTIFICATE——-“ and “——-END CERTIFICATE——-“ as 1.crt;
2. Save all the contents including “——-BEGIN PRIVATE KEY——-“ and “——-END PRIVATE KEY——-“ as 1.key;
3. Execute the following command:

openssl x509 -in 1.crt -outform der -out cert.der   
openssl rsa -inform PEM -in 1.key -outform DER -out key.der

Support Data Type

• INT8 (OPCUA SBYTE type)
• INT16
• INT32
• INT64
• UINT8 (OPCUA BYTE type)
• UINT16
• UINT32 (also used to represent DATETIME types)
• UINT64
• FLOAT
• DOUBLE
• BOOL
• STRING

Addresses Format

IX!NODEID

IX is the namespace index.

NODEID is the node id.

Example:

TIP

Please refer to OPC UA standard for the explanation of namespace index and node id.

The data type set by Neuron must match the OPCUA data type.

Siemens S7 ISOTCP

The s7comm plugin is used for Siemens PLCs with network port, such as s7-200/300/400/1200/1500.

Parameter Setting

TIP

When using the S7COMM plugin to access the S7 1200/1500 PLC, you need to use Siemens software(TIA16) to make some settings for the PLC.( For detailed settings, please refer to plc-settings. )

• The optimized block access must be turned off.
• The access level must be “full” and the “connection mechanism” must allow GET/PUT.

Support Data Type

• INT16
• UINT16
• INT32
• UINT32
• FLOAT
• DOUBLE
• BIT
• STRING

Address Format

AREA ADDRESS[.BIT][.LEN]

AREA ADDRESS

Example:

.BIT

Optional, referring to a bit of an address.

Example:

.LEN

When the data type is a string type, it is required and indicates the length of the string.

Example:

OMRON FINS on TCP

The fins plugin is used for Omron PLCs with network port, such as CP2E.

Parameter Setting

Support Data Type

• UINT8
• INT8
• INT16
• UINT16
• INT32
• UINT32
• FLOAT
• DOUBLE
• BIT
• STRING

Address Format

AREA ADDRESS[.BIT][.LEN[H][L]]

AREA ADDRESS

Example:

.BIT

Optional, referring to a bit of an address.

Example:

.LEN[H][L]

When the data type is string type, it is a required, .LEN indicates the length of the string, including H and L two endianness, the default is H .

Example:

Mitsubishi MELSEC QnA3E

The qna3e plugin is used to access Mitsubishi’s QnA compatible PLCs via Ethernet, including Q series (MC), iQ-F series (SLMP) and iQ-L series.

Parameter Setting

Support Data Type

• INT16
• UINT16
• INT32
• UINT32
• FLOAT
• DOUBLE
• BIT
• STRING

Address Format

AREA ADDRESS[.BIT][.LEN[H][L]]

AREA ADDRESS

Example:

.BIT

It can only be used in non-bit type area, which means to read the specified bit of the specified address, and the binary bit index range is [0, 15].

.LEN[H][L]

When the data type is string, .LEN indicates the length of the string; H and L can be optional to indicate two byte orders, the default is H byte order.

Example:

IEC 60870-5-104

Parameter Setting

Support Data Type

• uint16
• int16
• float
• bit
• int8
• uint8

Address Format

IOA

KNXnet/IP

Parameter Setting

Note that setting with the multicast address 224.0.23.12 normally requires that the KNXnet/IP device and Neuron are in the same sub network.

Due to the way how KNXnet/IP protocol works, the KNX plugin may not be able to work correctly if Neuron is installed using some virtualisation technology such as virtual machines or docker. In a Linux host with docker, using the docker option --net=host is required. In other cases, we recommend that you install Neuron using binary packages.

Support Data Type

• bit
• bool
• int8
• uint8
• int16
• uint16
• float

Address Format

• GROUP_ADDRESS,INDIVIDUAL_ADDRESS

Represents a KNX individual address that is a member of the group address. When reading the KNX plugin sends a GroupValueRead tunnelling request using the specified group address, and updates the tag value upon receiving a GroupValueResp matching the specified individual address. When writing the KNX plugin sends a GroupValueWrite tunnelling request using the specified group address.

Example:

0/0/1,1.1.1 represents a KNX individual address 1.1.1 that is a member of the group address 0/0/1.

• GROUP_ADDRESS,INDIVIDUAL_ADDRESS,BIT

Same as above, but for uint8 values with fewer than 8 bits, such as KNX data point types B2 and B1U3, etc. BIT represents the number of bits.

Example:

0/0/1,1.1.1,2 represents a KNX individual address 1.1.1 that is a member of the group address 0/0/1, the data is of 2 bit.

BACnet/IP

Parameter Setting

Support Data Type

• float
• bit

Address Format

AREA[ADDRESS]

Example:

DL/T645-2007

The dlt645 protocol supports serial and tcp connection.

Parameter Setting

serival

TCP

Supported data types

• UIN8
• UINT16
• UINT32
• UIN64

Address format

mail_address#DI3-DI2-DI1-DI0

• mail_address represents the mailing address of the meter.
• DI3-DI2-DI1-DI0 represents the data identification, and all points only support read attributes, and expressed in hexadecimal.

E.g 123456789012#02-01-01-00, represents the value of the A-phase voltage of the meter device with the mailing address 123456789012.

TIP

Support a node to configure multiple mailing addresses, that is a single serial port multi-device connection.

Please refer to the DL/T645-2007 industry standard data coding table for the specific data item name corresponding to the data identifier.

• The data length is 1, and the data type is UINT8.
• The data length is 2, and the data type is UINT16.
• The data length is 3 or 4, and the data type is UINT32.
• The data length is 5 or 6 or 7 or 8, and the data type is UINT64.
• Set the value of Decimal according to the data format, e.g, if the data format is XXX.X, then Decimal is set to 0.1.

Sparkplug_B

Data collected by Neuron from the device can be transmitted from the edge to the Sparkplug_B application using the Sparkplug_B protocol. Users can also send data modification instructions to Neuron from the application. Sparkplug_B is an application-type protocol that runs on top of MQTT, so the setup in Neuron is similar to the MQTT driver.

Parameter Setting

NON A11

The non a11 plugin is used for NON-A11 device.

Parameter Setting

Support Data Type

• INT16
• UINT16
• INT32
• UINT32
• FLOAT
• STRING

Address Format

COMMAND ! OFFSET[.LEN]

Example:

ADS

The ads plugin is used for Beckhoff ADS/AMS devices.

Parameter Setting

Note that a ADS route corresponding to the parameter setting should created in the target TC runtime (PLC), so that neuron could correctly communicate with the PLC.

Support Data Type

• BOOL
• INT8
• UINT8
• INT16
• UINT16
• INT32
• UINT32
• INT64
• UINT64
• FLOAT
• DOUBLE
• STRING

Address Format

INDEX_GROUP,INDEX_OFFSET

Both INDEX_GROUP and INDEX_OFFSET could be in decimal or hexadecimal format independently.

Example:

OPC DA

Neuron can indirectly access OPCDA servers running on Windows operating systems through the external auxiliary program neuopc.exe. neuopc converts the DA protocol to the UA protocol, and then obtains data through Neuron’s existing opcua driver. All accessible points of DA are mapped to the “namespace 2” of UA, and the ID of the point is kept with DA. unanimous.

Parameter Setting

The component package of neuopc can be downloaded from the project page (opens new window) of neuopc (neuopc is an open source project under the GPL agreement). Refer to neuopc operating environment settings for system configuration of installation and remote connection.

neuopc setting

step:

1. Fill in DA Host, you can fill in IP or Hostname, if you don’t fill in, it defaults to this machine;
2. Try to click the drop-down button of DA Server, you can try to get the DA Server list of the target Host, if the drop-down is empty, it means that no DA Server on the target host can be detected;
3. Click the Connect button. After the server is successfully connected, all available measuring point information of the current DA Server will be displayed, and the connection information of the current server will appear in the status bar, as shown in Figure 8;
4. Set UA Port;
5. Set UA User;
6. Set UA Password;
7. Click the Run button. After the UA server starts, all the measuring points in the list will be mapped to the NeuOPC directory of the UA Server. The UA namespace of all measuring points is 2. At this time, the related setting items of UA will become unavailable. ;
8. Double-click the Name column of the neuopc measuring point list to copy the corresponding measuring point name to the clipboard, and then paste it in the neuron tag form.

Neuron opcua connection configuration

step:

1. Add an opcua device in neuron southbound device management;
2. Modify the endpoint url in the device configuration to the UA Server address of neuopc;
3. Fill in the Username in the device configuration, which is consistent with the setting in neuopc;
4. Fill in the Password in the device configuration, which is the same as that set in neuopc;
5. Submit the setup form directly without filling in the Cert and Key.

Support Data Type

• INT8（OPCUA SBYTE type）
• INT16
• INT32
• INT64
• UINT8（OPCUA BYTE type）
• UINT16
• UINT32（also used to represent DATETIME types）
• UINT64
• FLOAT
• DOUBLE
• BOOL
• STRING

Address Format

IX!NODEID

IX Namespace index, IX can only be 2 when accessing neuopc.

NODEID Node ID, consistent with the string in the UA server.

Example:

CNC FANUC FOCAS

Support arch: amd64, armv7

Parameter Setting

Support Data Type

• uint8
• int8
• uint16
• int16
• uint32
• int32
• uint64
• int64
• float
• double
• bit
• string

CNC Data

CNC address example

PMC Data

PMC address example

Mitsubishi MELSEC A1E

The a1e plug-in is used to access Mitsubishi’s A series, FX3U, FX3G, iQ-F series PLCs via Ethernet, iQ-F requires a specific firmware version.

Parameter Setting

Support Data Type

• INT16
• UINT16
• INT32
• UINT32
• FLOAT
• DOUBLE
• BIT
• STRING

Address Format

AREA ADDRESS[.BIT][.LEN[H][L]]

AREA ADDRESS

Example:

.BIT

It can only be used in non-bit type area, which means to read the specified bit of the specified address, and the binary bit index range is [0, 15].

.LEN[H][L]

When the data type is string, .LEN indicates the length of the string; H and L can be optional to indicate two byte orders, the default is H byte order.

Example:

EtherNet/IP(CIP)

Parameter Setting

Data Type

• INT8
• UINT8
• INT16
• UINT16
• INT32
• UINT32
• INT64
• UINT64
• FLOAT
• DOUBLE
• BOOL
• BIT
• STRING
• WORD
• DWORD
• LWORD

Address Format

TAG NAME