netIOT Edge Gateway User manual - hilscher.com · 2018-07-11 · 4Connectors and mounting ..... 10 4.1Mounting ... Real-Time Ethernet connectors4.5 The Edge Gateway has 2 RJ45-connectors

User manual

netIOT Edge GatewayNIOT-E-TIB100-GB-RE (remote)

Hilscher Gesellschaft für Systemautomation mbHwww.hilscher.com

DOC170501UM01EN | Revision 1 | English | 2018-03 | Released | Public

Table of contents 2/215

Table of contents1 Introduction .............................................................................................................................. 5

1.1 About the user manual ..................................................................................................... 51.2 List of revisions ................................................................................................................ 5

2 Brief description ...................................................................................................................... 6

3 Device drawings....................................................................................................................... 73.1 Positions of the interfaces ................................................................................................ 73.2 Dimensions ...................................................................................................................... 9

4 Connectors and mounting .................................................................................................... 104.1 Mounting ........................................................................................................................ 104.2 LED sticker..................................................................................................................... 104.3 Power supply.................................................................................................................. 104.4 LAN connectors.............................................................................................................. 114.5 Real-Time Ethernet connectors ..................................................................................... 114.6 USB connectors ............................................................................................................. 114.7 Serial Interface ............................................................................................................... 12

4.7.1 RS-232............................................................................................................ 124.7.2 RS-485............................................................................................................ 12

4.8 Wi-Fi............................................................................................................................... 13

5 LEDs........................................................................................................................................ 145.1 Positions of the LEDs on the gateway ........................................................................... 145.2 Gateway status LEDs..................................................................................................... 155.3 LEDs of the LAN interface.............................................................................................. 155.4 LEDs of the PROFINET IO Device interface.................................................................. 165.5 LEDs of the EtherNet/IP Adapter interface .................................................................... 17

6 Commissioning the Edge Gateway ...................................................................................... 186.1 Establishing the IP address communication .................................................................. 186.2 Using the web browser to establish a connection with the Edge Gateway .................... 20

6.2.1 Using the host name ....................................................................................... 206.2.2 Access to the Edge Gateway in the Windows network environment .............. 216.2.3 Using the IP address....................................................................................... 21

7 Edge Gateway Manager......................................................................................................... 227.1 Calling the Edge Gateway Manager .............................................................................. 227.2 Edge Gateway Manager web page................................................................................ 23

8 Control Panel.......................................................................................................................... 258.1 Opening the control panel .............................................................................................. 25

8.1.1 First login ........................................................................................................ 268.1.2 Secure connection .......................................................................................... 27

8.2 Control Panel commands............................................................................................... 318.2.1 Overview and main menu ............................................................................... 318.2.2 System information and system time .............................................................. 328.2.3 Packet management ....................................................................................... 49

Edge Gateway | NIOT-E-TIB100-GB-RE (remote)DOC170501UM01EN | Revision 1 | English | 2018-03 | Released | Public

© Hilscher 2018


8.2.4 Network........................................................................................................... 508.2.5 Services .......................................................................................................... 558.2.6 User management .......................................................................................... 588.2.7 Security certificates......................................................................................... 618.2.8 Help................................................................................................................. 648.2.9 Session ........................................................................................................... 64

9 Node-RED - The wiring editor ............................................................................................... 669.1 Modelling IoT flows with nodes ...................................................................................... 679.2 Opening Node-RED ....................................................................................................... 689.3 Graphical user interface ................................................................................................. 709.4 Working with Node-RED ................................................................................................ 72

9.4.1 Menu Deploy................................................................................................... 749.4.2 Dashboard ...................................................................................................... 76

9.5 List of nodes................................................................................................................... 869.6 MQTT input node ........................................................................................................... 899.7 MQTT output node ......................................................................................................... 949.8 OPC UA input node........................................................................................................ 969.9 OPC UA output node ................................................................................................... 102

10 Examples for Node-RED...................................................................................................... 10410.1 Example 1: Inject and debug node............................................................................... 10410.2 Example 2: MQTT input node ...................................................................................... 10610.3 Example 3: MQTT output node .................................................................................... 11010.4 Example 4: OPC UA input node................................................................................... 11410.5 Example 5: OPC UA output node ................................................................................ 12010.6 Example 6: Fieldbus input node................................................................................... 12710.7 Example 7: Fieldbus output node................................................................................. 134

11 Configuring and using the fieldbus node.......................................................................... 14211.1 Overview ...................................................................................................................... 14211.2 Configuring the fieldbus and defining the signals......................................................... 144

11.2.1 Creating a new fieldbus configuration........................................................... 14411.2.2 Changing the existing fieldbus configuration ................................................ 15111.2.3 Loading firmware and configuration.............................................................. 156

12 Configuring PROFINET and defining signals.................................................................... 15812.1 User interface............................................................................................................... 15812.2 Menu commands.......................................................................................................... 158

12.2.1 Project - Save ............................................................................................... 15912.2.2 GSDML Download ........................................................................................ 15912.2.3 Printing the configuration .............................................................................. 15912.2.4 Help - Contents ............................................................................................. 16012.2.5 Help - Information ......................................................................................... 160

12.3 Configuration tree......................................................................................................... 16112.3.1 PROFINET configuration .............................................................................. 16112.3.2 IO and signal configuration ........................................................................... 16212.3.3 Signal definitions overview............................................................................ 17112.3.4 Download of the GSDML file......................................................................... 17212.3.5 Help............................................................................................................... 172


© Hilscher 2018


13 Configuring EtherNet/IP and defining signals .................................................................. 17313.1 User interface............................................................................................................... 17313.2 Menu commands.......................................................................................................... 173

13.2.1 Project - Save ............................................................................................... 17413.2.2 EDS Download.............................................................................................. 17413.2.3 Printing the configuration .............................................................................. 17513.2.4 Help - Contents ............................................................................................. 17513.2.5 Help - Information ......................................................................................... 175

13.3 Configuration tree......................................................................................................... 17613.3.1 EtherNet/IP configuration.............................................................................. 17613.3.2 IO and signal configuration ........................................................................... 17713.3.3 Signal definitions overview............................................................................ 18513.3.4 Download of the EDS file .............................................................................. 18613.3.5 Help............................................................................................................... 187

14 Edge Server .......................................................................................................................... 18814.1 Function principle ......................................................................................................... 188

14.1.1 Communication with IT-network and mobile devices.................................... 18814.1.2 Communication with the OT-network............................................................ 19014.1.3 Access rights to the REST API ..................................................................... 19014.1.4 Functions of the Edge Server ....................................................................... 19114.1.5 Internal structure of the Edge Server ............................................................ 192

14.2 Edge Server Control Center......................................................................................... 19314.2.1 Starting the Edge Server Control Center ...................................................... 19314.2.2 Functions ...................................................................................................... 19314.2.3 Service list..................................................................................................... 194

14.3 Configuration of the Edge Server................................................................................. 19614.3.1 The configuration of IP address area............................................................ 19614.3.2 Selecting the protocols to scan for field devices ........................................... 199

15 Technical data ...................................................................................................................... 20015.1 Technical Data NIOT-E-TIB100-GB-RE....................................................................... 20015.2 Technical data PROFINET IO Device.......................................................................... 20215.3 Technical data EtherNet/IP Adapter............................................................................. 203

16 Decommissioning, dismounting and disposal ................................................................. 20416.1 Putting the device out of operation............................................................................... 20416.2 Removing device from top hat rail................................................................................ 20416.3 Disposal of waste electronic equipment....................................................................... 204

17 Appendix............................................................................................................................... 20517.1 Legal notes................................................................................................................... 205

List of figures ....................................................................................................................... 209

List of tables......................................................................................................................... 213

Contacts................................................................................................................................ 215


© Hilscher 2018

Introduction 5/215

1 Introduction

1.1 About the user manualThis user manual describes the installation, configuration and functionalityof the device NIOT-E-TIB100-GB-RE .

1.2 List of revisionsRevision Date Author Revision1 2018-03-13 HH, RG All sections created.

Table 1: List of revisions


© Hilscher 2018

Brief description 6/215

2 Brief descriptionHilscher's netIOT Edge Gateway NIOT-E-TIB100-GB-RE securelyconnects Real-Time Ethernet automation networks with a „Cloud“ or anyIoT-directed application.As a field device, it is performing a cyclic I/O data exchange with the PLCand communicates with further IoT-capable field devices within theautomation network.These key field data exchanged in real-time form the basis for intelligenthigher-level IoT applications for cyber-physical processes and M2Msolutions.

The gateway is designed for continuous operation in environments withpermanent intranet or Internet connection. Security mechanisms such asthe physical separation of automation and IT network, a secure operatingsystem, the execution of signed firmware and packets, as well asencryption techniques of the latest standards secure the data integrity andoffer protection against data theft.

The gateway base function forms the web-based Thing Wiring editor Node-RED, which serves to model the flows in the devices. Data apps and dataprofiles are created within minutes with predefined function blocks of theeditor. OPC UA and MQTT functions address objects in IoT-capable fielddevices or in the cloud via standardized IoT protocols.

The Hilscher netIOT Service offers additional software packets to extendthe Edge Gateway base functions by further applications or accesses tospecific clouds.

Figure 1: Edge Gateway communication structure


© Hilscher 2018

Device drawings 7/215

3 Device drawings

3.1 Positions of the interfaces

Fieldbus

SYS

1

9

APL SEC POW

GPO1 WWAN WLAN BAT

COM

1

2

4

5

3

6

8 7

10

11

2

Figure 2: Positions of the interfaces of NIOT-E-TIB100-GB-RE


© Hilscher 2018


Pos. Interface For details see(1) Gateway state LEDs (8 x) Gateway status LEDs(2) Antenna (1 x Wi-Fi), optional: Available at device variant

NIOT-E-TIB100-GB-RE/WF only.Wi-Fi [} page 13]

(3) LED communication state of Real-Time Ethernet.Name und function depends on used RTE protocol:PROFINET IO Device = SF (System failure)EtherNet/IP Adapter = MS (module status)

LEDs of the PROFINET IO Deviceinterface [} page 16]LEDs of the EtherNet/IP Adapterinterface [} page 17]

(4) Real-Time Ethernet connector (RJ45 jacket) channel 0 Real-Time Ethernet connectors [} page 11](5) Real-Time Ethernet connector (RJ45 jacket) channel 1(6) LED communication state of Real-Time Ethernet.

Name und function depends on used RTE protocol:PROFINET IO Device = BF (Bus failure)EtherNet/IP Adapter = NS (network status)

LEDs of the PROFINET IO Deviceinterface [} page 16]LEDs of the EtherNet/IP Adapterinterface [} page 17]

(7) USB connector (1x USB 3.0) USB connectors [} page 11](8) USB connector (1x USB 2.0) USB connectors [} page 11](9) LAN connector (RJ45 jacket) port 2 / Eth1 LAN connectors [} page 11]

(10) LAN connector (RJ45 jacket) port 1 / Eth0 LAN connectors [} page 11](11) Serial interface connector COM (RS-232/485, can be

configured)Serial Interface [} page 12]

Table 2: Positions of the interfaces of NIOT-E-TIB100-GB-RE


© Hilscher 2018


3.2 Dimensions

Fieldbus

SYS APL SEC POW

GPO1 WWAN WLAN BAT

COM

1

2

12

0m

m

63 mm

106

mm

10

6m

m

106 mm

100 mm

Figure 3: Dimensions


© Hilscher 2018

Connectors and mounting 10/215

4 Connectors and mounting

4.1 MountingMount the Edge Gateway on a DIN rail onto the wall of the cabinet.

4.2 LED stickerEach fieldbus system uses its own names for the LED displays. Therefore,an LED sticker with the names of the respective fieldbus system is includedwithin the delivery of the Edge Gateway. Stick the sticker of the fieldbussystem to be used to the I/O shield of the fieldbus interface of the EdgeGateway.

Figure 4: LED label

4.3 Power supplyDC 24V Pin Signal Description

+ +24 V DC +24 V DC- GND Ground (Reference potential)

FE Functional earth

Table 3: Power supply connector


© Hilscher 2018


4.4 LAN connectorsThe Edge Gateway has two LAN connectors for connecting it to the cloudnetwork, positions (10) and (9) (see section Positions of theinterfaces [} page 7]).

The MAC addresses of the LAN interfaces are printed on the device label.

Section Configuring Ethernet communication (LAN) [} page 50] describes,how you can set the IP address parameters of the LAN interfaces.

4.5 Real-Time Ethernet connectorsThe Edge Gateway has 2 RJ45-connectors to connect the fieldbus to aReal-Time Ethernet network (OT network), positions (4) and (5) (seesection Positions of the interfaces [} page 7]).

For data exchange at the fieldbus, use the fieldbus input and output in nodeNode-RED. Sections Example 6: Fieldbus input node [} page 127] andExample 7: Fieldbus output node [} page 134] describe how to access thecyclic I/O data of the fieldbus in Node-RED.

4.6 USB connectorsThe Edge Gateway has 2 USB connectors (1), positions (7) and (8) (seesection Positions of the interfaces [} page 7]).

You do not need the USB connectors for operation of the Edge Gateway.You need the USB connector if you connect a keyboard in order to changesettings in the BIOS or if you do a firmware recovery with a USB stick.


© Hilscher 2018


4.7 Serial InterfaceThe Edge Gateway has one configurable serial interface (position (11)).You can use the serial interface as RS-232 or RS-485 interface.

Prerequisites

You have to set the interface type in the BIOS. For this, you need akeyboard with USB connector, and a serial cable.

BIOS settings

In the BIOS, select Advanced > IT8786 Super IO Configuration > SerialPort 1 Configuration for COM1 or Serial Port 2 Configuration for COM2.Serial Port Configuration ParameterSerial Port Enabled

DisabledDevice Settings Display only

Serial Port (COM): IO=248h; IRQ=5Onboard Serial Port Mode RS232

RS485 (do not use this setting)RS485 Auto (use this setting for RS-485 only, because RTScontrol is active)

Table 4: Parameters of the serial interface

4.7.1 RS-232RS-232 Pin Signal Description

1 DCD Data Carrier Detect2 RXD Receive signal3 TXD Send signal4 DTR Data Terminal Ready5 ISO_GND Ground (reference potential)6 DSR Data Set Ready7 RTS Request to Send8 CTS Clear to Send9 RI Ring Indicator

Table 5: RS-232 D-Sub

4.7.2 RS-485RS-485 Pin Signal Description

1 Rx/Tx‑ Send/receive signal negative2 Rx/Tx+ Send/receive signal positive3 n.c. -4 n.c. -5 ISO_GND Ground (reference potential)6 n.c. -7 n.c. -8 n.c. -9 n.c. -

Table 6: RS-485 D-Sub


© Hilscher 2018


4.8 Wi-FiYou can use the Edge Gateway for wireless network communication. TheEdge Gateway supports 2 Wi-Fi operating modes: Access Point andClient. Operating mode Access Point allows the Edge Gateway to connectto other Wi-Fi devices in order to configure the Edge Gateway from amobile device for example. Operating mode Client allows the EdgeGateway to be connected to any Wi-Fi Access Point.

Section WiFi describes how you activate the antennas and how to set theWi-Fi operating mode.


© Hilscher 2018

LEDs 14/215

5 LEDs

5.1 Positions of the LEDs on the gateway

Fieldbus

SYS

1

9

APL SEC POW

GPO1 WWAN WLAN BAT

COM

1

2

3

2

7

4

5

6

10

11

12

Figure 5: NIOT-E-TIB100-GB-RE LED positions


© Hilscher 2018

LEDs 15/215

5.2 Gateway status LEDsLEDs indicating system status, application status, voltage supply, batterystate, as well as activity of the serial interface COM, and GPIOs. Theposition of the LEDs is indicated by position (1), see in section Positions ofthe LEDs on the gateway [} page 14].

LED Color MeaningSYS yellow/

green

System status

APL yellow/ green

Application status

SEC blau Security status

POW yellow Power supply OK

GPO1 yellow/ green

GPIO1 (programmable, currently not used)

WWAN yellow WWAN status

WLAN yellow Wireless LAN status

BAT yellow Battery state

Table 7: Description of gateway status LEDs

5.3 LEDs of the LAN interfaceLEDs indicating state of the LAN communication. For the positions of theLAN LEDs, see section Positions of the LEDs on the gateway [} page 14].

LED Color State MeaningLINKSee positions (2) and(4)

Duo LED green/orange

(green) On 1 GBit network connection

(orange) On 100 MBit network connection

(off) Off 10 MBit or no network connection

RX/TXSee positions (3) and(5)

LED yellow

(yellow) On The device does not send/receive frames.

(yellow) Flickering(loaddependent)

The device sends/receives frames.

(off) Off The device does not send/receive Ethernet frames.

Table 8: LEDs LAN interface


© Hilscher 2018

LEDs 16/215

5.4 LEDs of the PROFINET IO Device interfaceLED Color State MeaningSF (System Failure)Position in the devicedrawing: (2)

Duo LED red/green

(off) (Off) No error

(red) Flashing (1 Hz, 3 s)

DCP signal service is initiated via the bus.

(red) On Watchdog timeout; channel, generic or extended diagnosispresent; system error

BF (Bus Failure)Position in the devicedrawing: (7)

Duo LED red/green

(off) Off No error

(red) Flashing (2 Hz)

No data exchange

(red) On No configuration; or low speed physical link; or no physical link

LINKCH0 (3) , CH1 (5)

LED green

(green) On The device is linked to the Ethernet.

(off) Off The device has no link to the Ethernet.

RX/TXCH0 (4) , CH1 (6)

LED yellow

(yellow) Flickering (loaddependent)

The device sends/receives Ethernet frames.


Table 9: LED states for the PROFINET IO-Device protocol

LED state DefinitionFlashing (1 Hz, 3 s)

The indicator turns on and off for 3 seconds with a frequency of 1 Hz: “on” for 500 ms, followed by “off” for 500 ms.

Flashing (2 Hz)

The indicator turns on and off with a frequency of 2 Hz: “on” for 250 ms, followed by “off” for 250 ms.

Flickering (loaddependent)

The indicator turns on and off with a frequency of approximately 10 Hz to indicate high Ethernetactivity: "on" for approximately 50 ms, followed by "off" for 50 ms. The indicator turns on and off inirregular intervals to indicate low Ethernet activity.

Table 10: LED state definitions for the PROFINET IO-Device protocol


© Hilscher 2018

LEDs 17/215

5.5 LEDs of the EtherNet/IP Adapter interfaceLED Color State MeaningMS (module status)Position in the devicedrawing: (2)

Duo LED red/green

(green) On Device operational: The device is operating correctly.

(green) Flashing (1 Hz)

Standby: The device has not been configured.

(red/green)

Flashing (1 Hz)

Self-test:The device is performing its power up testing.


Minor fault: The device has detected a recoverable minor fault.E. g. an incorrect or inconsistent configuration can be consideredas a minor fault.

(red) On Major fault: The device has detected a non-recoverable majorfault.

(off) Off No power: The power supply to the device is missing.

NS (Network status)Position in the devicedrawing: (7)

Duo LED red/green

(green) On Connected: The device has at least one established connection(even to the Message Router).

(green) Flashing (1 Hz)

No connections:The device has no established connections, buthas obtained an IP address.

(red/green)

Flashing (1 Hz)

Self-test:The device is performing its power up testing.


Connection timeout: One or more of the connections in whichthis device is the target have timed out. This status will be finishedonly if all timed out connections are reestablished or if the deviceis reset.

(red) On Duplicate IP: The device has detected that its IP address isalready in use.

(off) (Off) Not powered, no IP address:The device does not have an IPaddress (or is powered off).

LINKCH0 (3) , CH1 (5)

LED green

(green) On The device is linked to the Ethernet.

(off) Off The device has no link to the Ethernet.

ACTCH0 (4) , CH1 (6)

LED yellow

(yellow) Flickering (loaddependent)

The device sends/receives Ethernet frames.


Table 11: LED states for the EtherNet/IP Adapter protocol

LED state DefinitionFlashing (1 Hz) The indicator turns on and off with a frequency of 1 Hz:

“on” for 500 ms, followed by “off” for 500 ms.Flickering (loaddependent)

The indicator turns on and off with a frequency of approximately 10 Hz to indicate high Ethernetactivity: on for approximately 50 ms, followed by off for 50 ms. The indicator turns on and off inirregular intervals to indicate low Ethernet activity

Table 12: LED state definitions for the EtherNet/IP Adapter protocol


© Hilscher 2018

Commissioning the Edge Gateway 18/215

6 Commissioning the Edge Gateway

6.1 Establishing the IP address communicationAn IP address is required to address the Edge Gateway in the LANnetwork.

The following figure shows the factory setting of the LAN interfaces and theassignment of the connections.

Figure 6: Default settings of the Ethernet network connectors

You have two possibilities of establishing a connection with the EdgeGateway (factory setting):

NetNetwork connection - alternative 1: DHCP server available

If a DHCP server is available in the network:Ø Use an Ethernet cable to connect the LAN connection port 1 (eth0)

(see position (7) in section Positions of the interfaces [} page 7]) with anetwork in which a DHCP server is available.

ð The Edge Gateway obtains an IP address from the DHCP server.Access to the Edge Gateway is possible now.

Note:The Edge Gateway sends a request to a DHCP server once afterswitching on the device or after each connection of the Ethernetcable, i.e. when the Edge Gateway detects a link signal. If you wantto activate a request of the Edge Gateway to the DHCP servermanually, pull off the Ethernet cable from the Edge Gateway andreconnect it to the Edge Gateway.

Read section Using the web browser to establish a connection with theEdge Gateway [} page 20] to find out how to access the Edge Gateway.


© Hilscher 2018


Network connection - alternative 2: Direct connection and adaptationof the IP address of the PC or notebook used for commissioning

The IP address of the Edge Gateway (factory setting) is 192.168.253.1and the subnet mask is 255.255.255.0 at LAN connection port 2 (eth1,see position (5) in section Positions of the interfaces [} page 7]).

If no DHCP server is available, you can set an IP address on your PC ornotebook, which suits the same subnet:Ø Use an Ethernet cable to connect the LAN connection port 2 (eth1)

directly with your PC or notebook.Ø Open the Control panel.Ø Click on Network and Sharing Center.Ø Click on Change adapter settings.Ø Double click the name of the network connection: Local Area

Connection. (The name of the network connection may be different onyour PC.)

Ø Click on Properties.Ø Double click on Internet Protocol Version 4 (TCP/IPv4).Ø Set the following IP address, e.g. 192.168.253.2 and subnet mask

255.255.255.0.

Ø Click on Ok and then click on Close.ð Now you can access the Edge Gateway from your PC or notebook.

Read section Using the IP address [} page 21] to find out how to accessthe Edge Gateway.


© Hilscher 2018


6.2 Using the web browser to establish a connection with theEdge Gateway

You have three possibilities to access the Edge Gateway:1. by means of the host name (see section Using the host

name [} page 20])2. by access via the Windows network (see section Access to the Edge

Gateway in the Windows network environment [} page 21]),3. by using the IP address (see section Using the IP

address [} page 21]).

6.2.1 Using the host nameThe Edge Gateway has a host name you can use to access the device.

Where do you find the host name on the device?

The device is delivered (factory setting) with a label printed at its bottom. Inthe figure below the host name has a red frame.

Figure 7: Device label: Hostname

Establishing a connection with the host nameØ Enter the following address in the address line of your browser:

https://<hostname>Example: For the device with the host name NTB827EB1D9D94 enterhttps:// NTB827EB1D9D94

ð The Edge Gateway Manager opens.

You can now use the Edge Gateway manager to configure the device. Forthis purpose, read section Edge Gateway Manager web page [} page 23].


© Hilscher 2018


6.2.2 Access to the Edge Gateway in the Windows network environmentTo be located easily in the network, the Edge Gateway uses the UPnPtechnology (Universal Plug and Play). This technology will display the EdgeGateway in the Windows network environment.Ø To display all devices in the network, click on Network in the Windows

Explorer.Ê You will find the Edge Gateway under Other Devices:

Figure 8: netIOT Edge Gateway in the Windows network

Ø Open the context menu of this entry and select Properties.Ê The menu provides information on the Edge Gateway, e.g. serial

number, MAC address, host name or die IP address.Ø Click on the link under Device web page.ð The Edge Gateway manager opens.Ø To open the Edge Gateway manager, you can also double-click on the

device icon.

ð The Edge Gateway manager opens.


6.2.3 Using the IP addressIf you know the IP address of one of the LAN connections of the EdgeGateway and if you are physically connected to your operating device, youcan use your web browser to establish a connection with the EdgeGateway by entering this IP address directly. Should your operating devicebe configured with an IP address only, but without a subnet mask, youroperating device has to be located in the same subnet as the EdgeGateway to be able establish a connection.Ø Enter the IP address in the address line of the web browser as follows:

https://<IP address>Example: https://10.11.5.61

ð The Edge Gateway manager opens.



© Hilscher 2018

Edge Gateway Manager 22/215

7 Edge Gateway Manager

7.1 Calling the Edge Gateway ManagerThe Edge Gateway manager is a web page with tiles that allow rapidaccess to the applications integrated in the device or to external webpages.

The Edge Gateway uses the secured HTTPS protocol to access web pagesstored in the Edge Gateway.Ø To open the Edge Gateway manager, enter the following information in

the address line of your browser: https://<Host name of the Edge Gateway> orhttps://<IP address of the Edge Gateway>

ð Your browser displays the Edge Gateway manager.

Figure 9: Edge Gateway Manager

Note:Remember that the secured HTTPS protocol is used here, not thewidely spread HTTP protocol.


© Hilscher 2018


7.2 Edge Gateway Manager web pageThe Edge Gateway Manager displays tiles that allow rapid access to theapplications integrated in the device or external web pages.Icon Function

Opens the control panel of the Edge Gateway.The control panel configures the Edge Gateway and displaysinformation on the system. Section Control Panel [} page 25]describes the possibilities of configuration as well as the displayedinformation on the system.

Opens the wiring editor Node-RED.Section Node-RED - The wiring editor [} page 66]describes howto create applications for the Edge Gateway.

Opens the Node-RED Dashboard (graphical user interface).

Opens the Edge Server Control Center.See section Edge Server [} page 188].

Opens the Edge Gateway documentation stored in the device.

Opens the homepage of the Device Information Portal in theInternet.Requires a connection to the Internet.

Opens the homepage of the netIOT platform in the Internet.Requires a connection to the Internet.


© Hilscher 2018


Icon FunctionOpens the Hilscher homepage in the Internet.Requires a connection to the Internet.

Opens legal information concerning the Edge Gateway.Requires a connection to the Internet.

Table 13: Starting applications with the Edge Gateway Manager


© Hilscher 2018

Control Panel 25/215

8 Control Panel

8.1 Opening the control panelWith the control panel you can configure the Edge Gateway and displaydevice-specific information.Ø Click the tile Control Panel.

Ø The login screen for the Control Panel is displayed.

Ø Enter your user name and your password.Ø Click at Login.ð The Control Panel will be displayed.


© Hilscher 2018


8.1.1 First login

Setting the administrator password when the control panel is calledfor the first time

The dialog box Set Administrator Password is displayed when the controlpanel is called for the first time.

Figure 10: Edge Gateway Manager - Setting the administrator password

To set a new administrator password, proceed as follows:Ø Enter the preset password under Current Password. With the first

commissioning, the password is: admin

Ø Enter the new administrator password. It must have at least 7characters. For reasons of safety, Hilscher recommends usingsignificantly more characters. A strong password consists of upper andlower case letters, digits and special characters. A quality indicator inthe dialog box evaluates the password.

Weak password Mediocre password Strong password


© Hilscher 2018


Ø Click Change Password only after the entered password has beenevaluated as strong.

ð The administrator password for the user account Admin has thus beenchanged.

ð As an administrator you can now use the control panel, create furtherusers in the user management, and assign access rights.

8.1.2 Secure connectionEdge Gateways support web connections secured by SSH/TSL viahttps:// accesses only.

By definition, a secure connection can provide an efficient protection only ifa certificate proves that the server is secure. Only then can runningtransactions of the initiating browser and the server be considered asprotected against interception and data theft.

This is why the browser at first inquires a certificate of verification from theserver (Gateway). This certificate proves that the issuer has verified thesecurity of the server. Each browser provides a preinstalled list of knownauthorized issuers of certificates.

Each time the certificate of the server arrives at the browser, the browsercompares the issuer of the certificate with the issuers stored in the list ofknown authorized issuers of certificates.

If the issuer of the certificate is not listed, the browser will signal acertificate error and request the user's confirmation to continue because itassumes that the connection is insecure.

As standard, Edge Gateways contain a certificate issued by Hilscher that isnot on the list of the known authorized issuers of certificates. Due to that,the browser signals an insecure connection and requests the confirmationto continue. When this confirmation has been given once, any futureconnections will be established without further requests.

Note:In the control panel you can replace this certificate any time by thecertificate of a known authorized issuer of certificates, see sectionUploading and installing own security certificates [} page 62]).


© Hilscher 2018


8.1.2.1 Connection without certificate with Microsoft Internet Explorer

Microsoft Internet Explorer: Edge Gateway Manager will not bedisplayed

If you use the Microsoft Internet Explorer and the following page isdisplayed, click the option Continue to this web site (not recommended).

Figure 11: Security error message of the Internet Explorer

8.1.2.2 Connection without certificate with Firefox

If you use Firefox as a browser, a self-signed certificate will cause thefollowing error message:

Figure 12: Security error message of the Firefox browser (1)

To avoid this message caused by a self-signed certificate, proceed asfollows:Ø To display the complete message, click Advanced.

Figure 13: Security error message of the Firefox browser (2)

Ø To define an exceptional rule that enables the display of the userinterface without repeated error messages, click Add Exception.


© Hilscher 2018


Figure 14: Firefox dialog box: Adding exceptional safety rule

Ø To save the setting permanently, check the box Permanently storethis exception.

Ø To save the rule, click Confirm Security Exception.ð When you open the control panel in future, security messages will no

longer be displayed.

8.1.2.3 Connection without certificate with Google Chrome

If you use Google Chrome as web browser, you will get the following errormessage due to a self-signed certificate.

Figure 15: Security error message of Google Chrome (1)

Proceed as follows in order to avoid the following message, which iscaused by a self-signed certificate,Ø Click at ADVANCED to display the complete message.


© Hilscher 2018


Figure 16: Security error message of Google Chrome (2)

Ø In order to continue, click at Proceed to ... (unsafe).ð The Control Panel is displayed.


© Hilscher 2018


8.2 Control Panel commands

8.2.1 Overview and main menuThe following figure displays the main menu of the Control Panel.

Figure 17: Main menu of the Control Panel

Menu Description Details in sectionSystem > Info Center Displaying the system information, monitoring of

the processor core temperature, and a systemmonitor for the usage of CPU, main memory, andSSD.

Displaying systeminformation [} page 32]

System > License Manager Display of activated licenses, upload anddownload of the license file.

License Manager [} page 33]

System > Time Settings of system time and time synchronization. Setting the systemtime [} page 37]

System > Backup and Restore Backup and recovery of the files of the Linuxoperating system of the Edge Gateway.

Backup and restore [} page 40]

System > Reboot Rebooting the Linux operating system of the EdgeGateway

Rebooting thesystem [} page 47]

System > Shutdown Shutting down the Linux operating system of theEdge Gateway

System shutdown [} page 48]

Package Manager > Packages Managing the packages of the Linux-basedoperating system of the Edge Gateway.

Managing packets [} page 49]

Network > LAN Configuring the Ethernet interfaces to the ITnetwork and OT network (fieldbus).

Configuring Ethernetcommunication(LAN) [} page 50]

Network > WiFi Configuring the WiFi communication Configuring wirelesscommunication (WiFi)

Network > Field Configuring the operating mode of the fieldbusinterface (Real-Time Ethernet).

Field [} page 53]

Network > Hostname Displaying and configuring the host nameidentifying the Edge Gateway in the network.

Hostname [} page 54]

Services > Service List Displaying, starting, and stopping the services ofthe Edge Gateway.

Starting, stopping and configuringservices [} page 55]

User Management > Roles Displaying and configuring the permissions foruser roles.

Managing user roles [} page 58]

User Management > Accounts Displaying user accounts und assigning userroles.

Managing useraccounts [} page 60]

Security > SSL Certificate Installing the SSL safety certificate. Security certificates [} page 61]Help > Info Displaying current software version. Help [} page 64]Session > User Profile Displaying the permissions of the user. User profile [} page 64]Session > Logout Logout Logout [} page 65]

Table 14: Functional overview of the Control Panel


© Hilscher 2018


For the pages which can be invoked via the Control Panel, the followingapplies:

If for the selected page, no access right for reading is present, this has thefollowing implications:· No data are displayed. All important controls and displays of the page

are grayed out respectively inactive.· The error message Permission denied is displayed when accessing

the page.

If there is read but no write access right present, this has the followingimplications:· The error message Permission denied is displayed when trying to

make a change.

8.2.2 System information and system time

8.2.2.1 Displaying system information

Open this page with System > Info Center. No access rights are requiredin order to open this page. This page shows e.g. the firmware version andthe serial number of the Edge Gateway.

Figure 18: Page Info Center


© Hilscher 2018


The Info Center displays the following information:System info DescriptionHardware ident. Serial number of the Edge GatewayModel name Model designation of the Edge Gateway (NIOT-E-TIB100-GB-RE )Firmware version Complete version designation of the firmware stored in the Edge

GatewaySystem time Synchronization status of the internal clock of the Edge Gateway.

When the clock is synchronized via the network, the IP address andthe name of the time server used for synchronization will bedisplayed. The user has to configure the time zone.

Processor name Name of the microprocessor (CPU) installed in the Edge Gateway.Table 15: Info Center: Area System info

Monitoring DescriptionCPU usage Number of microprocessor cores plus clock frequency and average

utilization of each core in the Edge GatewayMemory utilization Size and average utilization of the main memory in the Edge GatewayStorage space Display of available memory and the memory that is currently utilized

on the integrated Solid-State-Disk of the Edge GatewayTable 16: Info Center: Area Monitoring

Temperature DescriptionCPU temperature Display of the temperature of each processor core in the Edge

GatewayTable 17: Info Center: Area Temperature

If the data of the area Monitoring cannot be read, this is grayed out.

8.2.2.2 License Manager

Open this page with System > License Manager.

The functionality of an Edge Gateway can be extended. The use ofparticular functions requires a license. On this page you can see whichlicenses are present in the device and you can transfer a license file intothe device.

8.2.2.2.1 Which licenses are present in the device?

In order to display the licenses contained in the Edge Gateway, use theLicense Manager. You can open it as follows:Ø Open the Control Panel.Ø Select System>License Manager.


© Hilscher 2018


Ê The window of the License Manager opens:

Figure 19: License Manager with license for the passive mode of operation

The table License enabled Software Packages displays the currentlyavailable licenses, in the example a license for the passive mode ofoperation of the Edge Gateways is available.

Open Details window in the License Manager

To open the Details window:Ø Click at the info button on the left edge of the line (within column

Details ).Ê The Details window opens:

Figure 20: License information in window Details

For each license, it displays the license type (Column Type), a briefdescription (Column Description) and the expiration date (ColumnExpires) .


© Hilscher 2018


8.2.2.2.2 How to order and receive a license

The following instruction explains how to order a license for your EdgeGateway to be used in passive mode of operation and receive a license file.

If you order device and license together or after ordering the license, youreceive a delivery note. After receiving the delivery note order the licensefile from Hilscher by e-mail. Specify the following information in your e-mail:1. The denomination of the desired license2. The number of your delivery note (for reference)3. The LAN MAC address of your device (to be taken from the device

label)4. The e-mail address, to which the license download link shall be sent to.

Specify the following as the subject of your e-mail:

Request for a netIOT Licence

Ø Send the e-mail to Hilscher: [email protected]Ø Hilscher creates an individual license file for your Edge Gateway

according to the information supplied by you.Ø Hilscher sends this file back to you as an attachment within the answer

e-mail. Consequently, this license file has to be transferred into theEdge Gateway as described in section How to transfer a license into thedevice? [} page 36].


© Hilscher 2018

mailto:[email protected]


8.2.2.2.3 How to transfer a license into the device?

Load the individual license file received from Hilscher from your PC into theEdge Gateway. Do the upload as follows:Ø Open the Control Panel in a web browser.Ø Select System > License Manager.Ø Click on Upload License.Ê A file selection dialog opens.Ø Select the license file. This file has the file extension *.LIC.Ø Click on OK.Ê The license file is transferred into the Edge Gateway. If the transfer is

successful, the following message is displayed:

Figure 21: Message after the transfer of the license file into the Edge Gateway

Ê To activate the license, a restart of the Edge Gateways is necessary.Ø Click on OK.Ê The license is installed now, but becomes active after the next restart of

the Edge Gateways.Ø For a restart, select System > Reboot.ð The license is activated.


© Hilscher 2018


8.2.2.3 Setting the system time

Open this page with System > Time.

In order to access this page you require the following access right:

Setting the system time

On this page, you can set the system time and the time zone this timerelates to. You can set the system time in two ways:Type Selection Method Standard

presettingmanually Manual selection by entering date and time yesautomatically NTP synchronized by means of a time server no.

Table 18: Setting the system time

Figure 22: Time configuration page

Setting the system time manuallyØ Click the option Manual.Ø Enter the time in the input field Time in the format hh:mm:ss.Ø Set the date using the calendar input field Date.

Ø Click at .ð The system time is set.


© Hilscher 2018


Setting the system time automatically using a time server

You can synchronize the time using a time server that uses the NetworkTime Protocol (NTP). Under NTP synchronized there is a list where youcan enter such time servers. The list of NTP servers will be worked off fromtop to bottom until a server gives a valid answer and synchronizationoccurs.Ø Click the option NTP Synchronized.Ø Click Add NTP server.Ê The dialog box for entering the NTP server is displayed.

Ø In the input field NTP server enter the address of a server which usesthe NTP to synchronize the time: E.g.: To add the server for time synchronization of the Physikalisch-Technische Bundesanstalt (the National Metrology Institute ofGermany) to the list, enter the address ptbtime1.ptb.de in the inputfield NTP server.

Ø Click Add.ð The system time is set via the NTP. As soon as the system time is set

successfully, the following information will be displayed under Status:Synchronized to time server <IP address of the timeserver>:<Port number of the time server > (<NTPaddress of the time server>)


© Hilscher 2018


Setting the time zone

With the selection list Timezone you can adjust the time zone to your localtime in which the Edge Gateway is so that the set time can be interpretedcorrectly (e.g. summer time conversion). For this purpose, the selection listTimezone offers many setting options. The default value is Universal. ForCentral European Time set CET.

Take care of the following notes:

Effects of setting the system timeOnce the system has been set, system services and Node-RED flows,which use the system time for synchronization, lose their reference time,i.e. they refer to the new time set.

Note:For information on the NTP, see Wikipedia under https://en.wikipedia.org/wiki/Network_Time_Protocol (English) or https://de.wikipedia.org/wiki/Network_Time_Protocol (German). There youwill also find links to lists of NTP servers for various countries.


© Hilscher 2018

https://en.wikipedia.org/wiki/Network_Time_Protocol

https://en.wikipedia.org/wiki/Network_Time_Protocol

https://de.wikipedia.org/wiki/Network_Time_Protocol

https://de.wikipedia.org/wiki/Network_Time_Protocol


8.2.2.4 Backup and restore

Open this page by System > Backup and Restore.

You have to login as Administrator to use this function.

This page offers the possibility to store the complete system files of theLinux operating system of your Edge Gateway onto an external massstorage device and to restore it from there, if necessary.

Backup

Observe the following information:· The duration of the backup depends on the quantity of data.· A running backup cannot be interrupted.· The backup can deteriorate the performance of the Edge Gateway.· Save the backup on an external data carrier because any existing

backup will be overwritten irrevocably without prior notice.

In order to create a backup of your system, proceed as follows:Ø Select System > Backup and Restore in the control panel.Ê The following screen is displayed:

Figure 23: Backup and recovery

Ø Click at .


© Hilscher 2018


Ê The following warning message is issued:

Figure 24: Warning message

To improve the safety you can optionally define a password within inputfield Password. If a password has been specified, that password must beentered at each attempt to access the created backup file.

Furthermore, this warning message explains the above mentionedconsequences of starting the backup process such as time expense,increased system load and missing possibility of abortion.Ø In order to start the backup process, click at Yes.Ê The following screen indicates the start of the backup process by the

message text Backup in progress

Figure 25: Backup in progress

ð If the backup process has successfully been finished, the formerly

grayed out button is activated and thebackup file is offered for possible download. This means, the backup ofsystem files has been completed.


© Hilscher 2018


Recovery from internal backup

Choose this option to restore the system using the stored data, if alreadyan internal backup has been performed within your device.

Take care of the following consequences of system recovery:· that the former system is fully replaced and overwritten by the system

stored in the backup file.· that the system is stopped.· that a new start of the system is initiated.· that this process can last for a significant amount of time and cannot be

interrupted.· that you must not interrupt power supply of the Edge Gateway in

any case.

In order to restore your system from a previous internal backup, proceed asfollows.

Ø Select System>Backup and Restore within the Control Panel..Ê The following screen appears:



© Hilscher 2018


Ø Click at Ê The following recovery dialog is displayed:

Figure 27: Recovery dialog

Ê If there is already an internal backup present in the system, you will

notice that the button is activated.

Note:If a password has been specified at creation of the backup file to berestored, that password must be entered in input field Password!

Ø Click at .Ê The following security query is displayed:

Figure 28: Security query prior to system recovery from internal backup file

Ê You are informed about the above mentioned consequences of systemrecovery.

Ø If you want to proceed taking into account these consequences, then

click at .Ø The system on your device is restored from the system files stored

within the internal backup. In any way, do not interrupt the power supplyof the Edge Gateway during system recovery!


© Hilscher 2018


Recovery from external backup

Choose this option to restore the system using the stored data, if alreadyan internal backup has been performed within your device and you havedownloaded this backup to an external storage medium or device.

Take care of the following consequences of system recovery:· that the former system is overwritten and fully replaced by the system

stored in the backup file.· that a new start of the system is initiated.· that this process can last for a significant amount of time and cannot be

interrupted.· that you must not interrupt power supply of the Edge Gateway in any

case.

In order to restore your system from a previous external backup (i.e.download of an internal backup), proceed as follows.Ø Select System>Backup and Restore within the Control Panel.Ê The following screen appears:



© Hilscher 2018


Ø Click at .Ê The following recovery dialog appears:

Figure 30: Recovery dialog (external source)

Note:If a password has been specified at creation of the backup file to berestored, that password must be entered in input field Password!

Ø Click at Explorer.Ê A file selection dialog appears.Ø Select the image file with your stored system (file extension is *.img).Ê The following message dialog is displayed:

Figure 31: Message prior to starting recovery from external backup

Ê You are informed about the above mentioned consequences of systemrecovery.

Ø If you want to proceed taking into account these consequences, then

click at .ð The selected file is checked for correctness. If the file is no image file,

does not contain a backup or is defective in any other way, an errormessage is displayed. Otherwise your system is recovered fromexternal backup. In any way, do not interrupt the power supply of theEdge Gateway during system recovery!


© Hilscher 2018


Delete local backup

If you want to delete a locally present internal backup, you can perform thisas follows:Ø Select menu entry System>Backup and Restore within the Control

Panel.Ê The following screen appears:

Figure 32: Backup and restore when backup file is present

Ø Click at .Ê The following safety query indicates the danger of possible data loss at

deleting the backup, if it has not externally been saved via the downloadfunction.

Figure 33: Safety query before deletion of local backup

Ø If you are still sure, that you really intend to delete the local backup,

click at ð The local backup is internally deleted. Right of Local backup the text No

backup is displayed now instead the name of the former backup.


© Hilscher 2018


Downloading a local backup

To download an existing local backup (image file) from the Egde Gatewayto an external data carrier, proceed as follows:Ø Select System > Backup and Restore in the control panel.Ê The following screen will be displayed:

Figure 34: Backup and Restore

Ø Click Download local backup.Ø Select a storage location.ð The download of your backup will be started and the backup will be

stored on the external data carrier.

8.2.2.5 Rebooting the system


In order to reboot the system:Ø Within the Control Panel select menu entry System>RebootÊ The following safety query is displayed:

Figure 35: Reboot safety query

Ø If you really intend to reboot the system, answer to the safety query with

.ð The Linux operating system of your Edge Gateway is shut down and

then immediately restarted.

Note:Take care of the consequences of shutting down and restarting foryour network, if you reboot the Edge Gateway.


© Hilscher 2018


8.2.2.6 System shutdown


In order to shut down the system:Ø Within the Control Panel select menu entry System>Shutdown.Ê The following safety query is displayed:

Figure 36: Warning for consequences of shutdown

Ø If you really intend to shut down the system, answer to the safety query

with .ð The Linux operating system of your Edge Gateway is shut down.

Note:Take care of the consequences for your network, if you shut downthe Edge Gateway.


© Hilscher 2018


8.2.3 Packet management

8.2.3.1 Managing packets

Open this page with Package Manager > Packages.


Managing packets

This page contains the package management of the Linux-based operatingsystem of the Edge Gateway. This page· lists the installed packages including version,· adds new signed packages or· updates already installed signed packages.

Note:You can only install packages signed by Hilscher!

Use the package management only when Hilscher requests you to use thepackage management.


© Hilscher 2018


8.2.4 Network

8.2.4.1 Configuring Ethernet communication (LAN)

Open this page with Network > LAN.


Access to LAN (Ethernet network)

On this page you configure the Ethernet interfaces eth0, eth1 (both onthe side of the cloud) and cifx0 (on the side of the fieldbus).

The Ethernet interface cifx0 is deactivated when delivered (factorysetting). Section “Activating the Ethernet interface cifx0“ (see below)describes how you can activate this interface.

For each Ethernet interface you can configure how to set the IP address:· The Edge Gateway is to obtain the IP address parameters automatically

from a DHCP server: Option DHCP.· The IP address parameters are manually entered by the user: Option

Fixed address.

The IP address parameters include the IP address, the subnet mask, theGateway address, and the IP addresses of the 1st and 2nd domain nameserver.

The default IP address of the LAN connection eth1 (Port 2) is192.168.253.1 with the subnet mask 255.255.255.0.

Figure 37: Default LAN configuration


© Hilscher 2018


Column MeaningName displays the name of the LAN interface.MAC address displays the MAC address of the LAN interface.Settings Selecting the configuration method: Here you can select between

· DHCP (IP address parameters automatically obtained from a DHCPserver) or

· Fixed address (IP address parameters entered by the user)If you enter the IP address manually, also always enter the subnetmask and the Gateway address.

Domain NameSystem

If you enter the IP address parameters manually, enter the IP addressof the 1st and 2nd domain name server.

Table 19: Table LAN: Meaning of the columns

If you want to save your changes permanent, click on Save changes.


© Hilscher 2018


Activating the Ethernet interface cifx01. Select operating mode and firmware

Ø Open the Field page with Network > Field.Ê The Field page is displayed.Ø Set the operating mode to Active.Ø Select for Firmware either PROFINET IO Device or EtherNet/IP

Adapter.Ø Click on Change mode.Ø Confirm the question with Yes.Ê The device is prepared.

2. Start the Node-RED service.Ø Open the Service page with Services > Service List.Ê The Service page is displayed.Ø If the Node-RED service is in the state Stop (yellow), then mark the

service Node-RED.Ø Set the Autostart to enabled that the Node-RED service is started with

the next start of the device also.Ø Click on Apply.Ø Click at Operating status on Start.Ê The Node-RED service has been started and is displayed green.

3. Display Ethernet interface cifx0Ø Open the LAN page with Network > LAN.ð The Ethernet interface cifx0 is activated and you can configure it now.

Figure 38: LAN configuration (cifx0 activated)


© Hilscher 2018


8.2.4.2 Field

Open this page with Network > Field.


Access to Field

On this page you configure the operating mode of the fieldbus interface(Real-Time Ethernet). The fieldbus interface is deactivated when delivered(factory setting).Operating mode DescriptionActive In the operating mode Active, the device can send and receive data on

the fieldbus interface. Note: The operating mode Active is required forthe typical operation of the Edge Gateway.In this operating mode, select a firmware: PROFINET IO Device orEtherNet/IP Adapter. Note: Do not use the PROFIBUS DP Slavefirmware.In Node-RED use

· the fieldbus input node to receive data from the fieldbus (see sectionExample 6: Fieldbus input node [} page 127]) and

· the fieldbus output node to send data to the fieldbus (see sectionExample 7: Fieldbus output node [} page 134]).

Passive In this operating mode Passive, the device receives data from thefieldbus interface. The receives data can be processed in Node-RED ora Docker application. Table Operating modes in the passive operatingmode [} page 53] describes further operating modes.

Inactive The interface is deactivated.Table 20: Operating mode fieldbus interface

The passive operating mode offers you further operating modes.

The user manual Passive operating mode describes capabilities ofthe Edge Gateway in the passive operation mode.

Operating mode DescriptionConfiguration In operating mode Configuration, you can transfer the signal

configuration in the Edge Gateway. After you have transferred the signalconfiguration in the Edge Gateway, change the operating mode toOperational.

Operational The received data can be processed in Node-RED using the passivefieldbus input node.The Edge Gateway has to be configured before using the operationmode Configuration.

Docker The received data can can be processed in a Docker application. TheEdge Gateway does not need a signal configuration in this mode.

Table 21: Operating modes in the passive operating mode


© Hilscher 2018


8.2.4.3 Hostname

Open this page with Network > Hostname.


Access to hostname of Edge Gateway

On this page you configure the host name.

The host name identifies the device via the WiFi or LAN network.

The default host name starts with the two letters "NT" followed by the LANMAC address of the LAN connection port 1 of the Edge Gateway. ExampleNT0002A233E559. The default host name is printed on the label at thebottom of the Edge Gateway. With the host name you can access the EdgeGateway from your PC even without knowing the IP address of the EdgeGateway (also see Using the web browser to establish a connection withthe Edge Gateway [} page 20]).

If the Edge Gateway does not obtain an IP address from a DHCP server,the system cannot translate the host name and you cannot access thedevice.

Figure 39: Hostname

Input field Hostname

In order to specify the hostname, enter a string with arbitrary lengthconsisting of ASCII characters into the input field Hostname.

Saving the host name

The hostname is saved by clicking at .

If storing the hostname has succeeded, the following message box isdisplayed:


© Hilscher 2018


8.2.5 Services

8.2.5.1 Starting, stopping and configuring services

Open this page with Services > Service List.

On this page you can· display the list of the running services,· display the operating status of each service,· start and stop single services,· activate/deactivate Autostart.

A service can allow you individual settings.

The list of services is displayed at the left edge:

Figure 40: List of default services

For a quick overview, the operating status of each service is displayed incolor.Color Operating statusgreen The service is being executed.yellow The service is configured, but not executed.red The service is neither configured nor executed.grey Right for accessing this service is missing

Table 22: Operating statuses of the services

8.2.5.1.1 Node-RED service

Download of the current NodeRED Flow

In order to store the current NodeRED flow into a file on your computer:

Ø Click on .Ê A message box depending from the used web browser (example shown

in figure: Microsoft Internet Explorer) asks you whether you want tostore the file containing the current NodeRED flow. The filenameconsists of backup-flow_ and the current date in the format JJJJ-MM-DD.

Ø Select Save as and select the file path.ð The NodeRED flow is stored for further use with the file name

mentioned above within the selected path.


© Hilscher 2018


Upload of the current Node-RED Flow

Important:Uploading a Node-RED flow overwrites the currently loaded flowbeyond retrieval. If you might need the currently loaded flow infuture, store it via Download prior to starting the upload.

Ø Click on .Ê A file selection dialog appears.Ø Select the file with a stored Node-RED flow, which you want to upload.Ê A security query informing about the risk of overwriting the current

Node-RED flow appears.Ø If you are sure no longer to need the current NodeRED flow, click on

OK.ð The selected flow is uploaded now. This overwrites the previously

loaded flow. The message Node-RED flow has been overridden isdisplayed.

Figure 41: Message at overwriting of current NodeRED flow

Deleting the current Node-RED flowØ Click on Delete.Ê The following security request is displayed:

Figure 42: Security request at deletion of current NodeRED flow

Ø Click on OK.ð The current Node-RED flow is deleted. Afterwards, there is no chance

to restore this flow anyway.


© Hilscher 2018


Undo last deploy in Node-RED

Ø Click on .Ê A security query warns for danger of data loss due to undo of deploy.

Figure 43: Security query for Undo last deploy

Ø If you are really sure that you want to undo the last deploy, then click onOK.

ð The last deploy is undone.

Note:For further information about Deploy in Node-RED, see sectionMenu Deploy [} page 74].


© Hilscher 2018


8.2.6 User managementThe administrator manages users by means of two configuration pages:· User roles (determining new roles and assigning access rights) and· User accounts (adding, processing, and deleting).

Defining a user account is accomplished by assigning a predefined role tothe user.

8.2.6.1 Managing user roles

Open this page with User Management > Roles.

On this page, you can determine roles and assign access rights ontoresources to these roles.

The roles Administrator and View are standard and cannot be deleted.

Figure 44: Page for configuring roles

An access right is set per resource. Each configuration page of the controlpanel which contains settable device parameters is a resource. Access viaREST-API (see Functions of the Edge Server [} page 191]) is also aresource.


© Hilscher 2018


An access right can be assigned to the following single resources:Access right / Resource Access to resource

accomplished via menuentry

Usage

SystemSetting the system time System >Time Setting the system

time [} page 37]Packet managementManaging packets Package Manager >

PackagesManaging packets [} page 49]

Network accessAccess to LAN (Ethernetnetwork)

Network > LAN Configuring Ethernetcommunication(LAN) [} page 50]

Access onto WiFI (wirelessnetwork)

Network > WiFi Configuring wirelesscommunication (WiFi)

Access onto hostname of EdgeGateway

Network > Hostname Hostname [} page 54]

Access onto Field network(Ethernet network)

Network > Field

ServicesConfigure service "S" (Thedisplayed names depend onthe installed services.)

Services > Service "S" Starting, stopping andconfiguringservices [} page 55]

SecurityInstall security certificates Security > SSL/TLS

CerticateUploading and installing ownsecuritycertificates [} page 62]

Edge ServerAccess via REST-API Edge Server (REST API) Functions of the Edge

Server [} page 191]Table 23: Access rights onto resources

Each resource may obtain one of the following access rights:Access rights onto resource CheckboxNo access NoneRead access only ReadRead and write access Read, Write

Table 24: Access rights to resources


© Hilscher 2018


Adding a new role

Ø Click at

ð The dialog box for entering the role name is displayed.

Ø Enter a name for the role, e.g. User.Ø Click Add.ð The role is added.

Setting the access rights of a roleØ Click a role.ð The resources and access rights for this role will be displayed.Ø Assign the access right per resource.

Ø Click at

8.2.6.2 Managing user accounts

Open this page with User Management > Accounts.

On this page you can· add· process· delete user accounts.

Figure 45: User account page

Each user account has a user name, a password, and an assigned role.


© Hilscher 2018


8.2.7 Security certificatesThe menu Security offers you the possibility to display the contents ofsecurity certificates and to upload and install these.


SSL/TLS Certificate

Open this page with Security > SSL/TLS Certificate.

This page SSL/TLS Certificate displays information about the currentlyused security certificate. You also can upload and install a new securitycertificate here (file type *.pem, file size less than <=0.5 MB).

Figure 46: SSL/TLS Certificate page


© Hilscher 2018


8.2.7.1 Uploading and installing own security certificates

In the upper area of page SSL Certificate you can select an own securitycertificate including the private key that is associated with the certificate.

Figure 47: SSL Certificate – Upload area

Uploading and installing the certificate1. In order to upload and install the certificate, proceed as follows:

Ø Select your certificate to be uploaded and installed with the Browsebutton right of the field Certificate.

Ø Select the private key associated with your certificate with the Browsebutton right of the field Private Key.

Note:The expected file type for security certificates and private keys is*.pem (Privacy enhanced electronic mail format). You can findmore information about this file format in Wikipedia at https://en.wikipedia.org/wiki/Privacy-enhanced_Electronic_Mail.

Ø Click at Upload and install certificates.ð The security certificate is uploaded and installed.


© Hilscher 2018

https://en.wikipedia.org/wiki/Privacy-enhanced_Electronic_Mail

https://en.wikipedia.org/wiki/Privacy-enhanced_Electronic_Mail


8.2.7.2 Information about the currently loaded security certificate

In the lower area of page SSL Certificate information concerning thecurrently loaded security certificate is displayed.

Figure 48: SSL Certificate – Info area

The single lines have the following meanings:Line Abbrevia

tionMeaning

Identity/verifiedby

CN Identity/verified by

country C Countrystate ST Statelocality L Localityorganization O Organizationorganizationalunit

OU Organization unit

mail CN E-mail addressvalidity starts - Start of validity duration of certificatevalidity ends - End of validity duration of certificate

Table 25: Information about the security certificate

In factory-new state the Edge Gateway contains a self-signed certificate.You should replace this by an own certificate that you can upload andinstall in the way described above.


© Hilscher 2018


8.2.8 HelpOpen this page with Help> Info. No access rights are required in order toopen this page.

This page displays the firmware version of the Edge Gateway.

Figure 49: Info page

8.2.9 Session

8.2.9.1 User profile

Open this page with Session> User Profile. No access rights are requiredin order to open this page.

Figure 50: User profile page

On this page you can· display the access rights of your user account,· change your E-mail address, and· change your password.


© Hilscher 2018


Changing the e-mail address

Ø Click at .Ê The dialog Edit user account is displayed.

Figure 51: Dialog "Edit user account"

Ø Specify your e-mail address at the input field E-mail.

Ø Click at .ð The specified e-mail address is stored.

Changing the password

Ø Click on .Ê The dialog Edit user account is displayed.Ø Check change user password.Ø Specify your password at the input field New Password.Ø In order to confirm your input, specify your password again at the input

field Confirm Password.

Ø Click on .ð The changed password is saved.

8.2.9.2 Logout

To log out from the Edge Gateway, use Session> Logout. No accessrights are required to select this menu entry. Prior to accessing the EdgeGateway again, a new login (Specifying user name and password) isnecessary.


© Hilscher 2018

Node-RED - The wiring editor 66/215

9 Node-RED - The wiring editorThe task of a gateway in the Internet of Things is to establish easyconfigurable flexible connections between different devices. The netIOTEdge Gateway uses Node-RED for this task, a very flexible visual wiringeditor for the Internet of Things.

Node-RED was developed by IBM. It is a web-based graphical tool with anintuitive user interface for wiring nodes for an application-specific data flow.Nodes are wired by means of a mouse with drag and drop.

Node-RED is based on node.js a platform independent runtimeenvironment to develop Web applications with server side java scripting.

This manual explains you how to use Node-RED for configuration andwiring of nodes within the netIOT Edge Gateway.

This manual refers to the following versions:· Node-RED version minimal 0.17.x· node.js minimal V4.x

Note:You can find information about Node-RED in the Internet: http://nodered.org/. The current documentation is available here: http://nodered.org/docs/. For beginning, read the document GettingStarted: http://nodered.org/docs/getting-started/.


© Hilscher 2018

http://nodered.org/

http://nodered.org/

http://nodered.org/docs/

http://nodered.org/docs/

http://nodered.org/docs/getting-started/


9.1 Modelling IoT flows with nodesTo combine physics and logic, Node-RED models ("flows") and works with("nodes") which represent objects in the Internet of Things. You can relatethese objects to physical interfaces as well as to logic functions.

Figure 52: Comparison of the physical and logic view

By means of Drag&Drop the nodes are interactively wired with one anotherto get flows, as shown in the following figure.

Figure 53: Wiring the nodes

The following basic properties apply to one Node-RED node:· A node fulfills a specific, defined task.· A node has entry masks for setting the basic operating parameters.· A node can have inputs and outputs.· A node can be connected with other nodes via its inputs and outputs.· A node can modify and overwrite data before passing the data on.· A node transports data via the msg object in the JSON format.

The msg object always contains the objects .topic and .payload.· .topic identifies the message.· .payload contains the payload to be transported.

Node-RED has an ample library with already predefined nodes which areready for immediate use.


© Hilscher 2018


Node-RED categorizes nodes. The following categories of nodes exist,e.g.:· input· output· function· social· storage· analysis· advanced· GatewayKit

Nodes offer functions, e.g.:· Web-based communication· TCP/UDP send/receive· MQTT publish/subscribe· Serial send/receive· Time emitter

9.2 Opening Node-REDThis section describes how to call Node-RED for configuring the flow withinthe netIOT Edge Gateway.

To open Node-RED, proceed as follows:Ø Open the Edge Gateway manager (see Calling the Edge Gateway

Manager [} page 22])Ø In the Edge Gateway manager click on the tile Node-RED.

Ê The Node-RED start screen will be displayed.


© Hilscher 2018


Ø Enter your user name and password.

Ø Click on Login.ð The Node-RED workspace will be displayed.

Figure 54: Node-RED workspace

Note:Remember that the secured HTTPS protocol is used here, not thewidely spread HTTP protocol.

If the Node-RED workspace does not open, read the following sections incompliance with the browser used:

Connection without certificate with Microsoft Internet Explorer [} page 28]

Connection without certificate with Firefox [} page 28]

Connection without certificate with Google Chrome [} page 29]


© Hilscher 2018


9.3 Graphical user interface

Graphical user interface

The following figure and table describe the elements of the user interface.

3 4 52

15

16

1

14

12 1113 9

6

8

7

10

Figure 55: Node-RED user interface

Position number Description(1) Worksheet which contains one or more flows. This worksheet has

the name Flow 1.(2) Add worksheet(3) Deploy, to transfer the configuration (flows) into the device(4) Logout(5) Node-RED menu(6) Display of configuration nodes

If necessary, the display has to be activated first: Node-RED menu> View > Configuration nodes.

(7) Debug outputIf necessary, the display has to be activated first: Node-RED menu> View > Debug messages.

(8) Information outputIf necessary, the display has to be activated first: Node-RED menu> View > Information.

(9) SidebarThe sidebar can be switched on or off.

(10) Zoom(11) Workspace which contains one or more worksheets.(12) Expand or collapse the node library(13) Node library(14) Node category(15) Nodes(16) Node filter

Table 26: Node-RED user interface


© Hilscher 2018


Nodes

The following figure and table describe the elements of a node.

57

1 2 3 4

6

Figure 56: Node

Position number Description(1) Node icon(2) Node name (editable)(3) The red triangle shows that a required parameter is not configured

yet.(4) The blue circle shows that this node has been changed but not

transmitted yet.(5) Output port (if available)(6) Node status (if available)(7) Input port (if available)

Table 27: Node elements


© Hilscher 2018


9.4 Working with Node-REDIn Node-RED you can process data using1. Input nodes (nodes that read data),2. Processing nodes and3. Output nodes (nodes that write data).

You can wire nodes by connecting their input and output ports. Byconnecting the nodes you create a data flow that is simply called "flow" inthe user interface. The flow direction is always fixed: From input node tooutput node. Insert the nodes in a worksheet, configure these nodes,connect them, and deploy the result to the Edge Gateway.

Procedure (overview)1. Inserting a node from the library2. Configuring node parameters:

A node may require parameters that you can configure in an edit dialog.The fieldbus node is an example for a node which is configured via anedit dialog.

3. Connecting nodes to determine the flow:In Node-RED the data flow is realized as „flow“.

4. Using Deploy to activate the flow in the Edge Gateway:The flow in the workspace still has to be activated in the Edge Gateway.For this purpose Deploy is used to transmit the flow from the workspaceto the Edge Gateway.

Procedure (step by step)1. Inserting nodes from the library

Ø Use the mouse to drag a node from the library and insert the node inthe flow.


© Hilscher 2018


2. Configuring node parametersØ Double-click on the node.ð The edit dialog will be displayed.

3. Connecting nodes to determine the flowØ Connect the input node with the output node. For this purpose hold

down the mouse button and draw a line (wire) from the output port ofthe node (in the example called „Hello World“-node) to the input port ofthe other node.

ð Thus, the two nodes are connected by a line (wire) in the workspace,but they are not yet activated in the Edge Gateway.

4. Using Deploy to activate the flow in the Edge GatewayØ Click on Deploy.

ð The flow will be deployed from the workspace to the Edge Gateway andactivated.


© Hilscher 2018


9.4.1 Menu DeployThe menu Deploy offers further commands to control the deployment of theflow.

Figure 57: Menu Deploy

Command DescriptionFull deploys the entire workspace.Modified Flows deploys only those flows which contain modified nodes.Modified Nodes deploys only nodes that have been modified.

Table 28: Commands of menu Deploy

ProcedureØ Click on the white arrow located at the right edge of the red button

Deploy.Ê The menu Deploy opens.Ø Click on the menu command to be executed.Ê The dialog box Confirm Deploy is displayed.


© Hilscher 2018


Ê The dialog box Confirm Deploy is displayed.Ê A dialog box will indicate incorrectly configured nodes in the workspace,

if there are any, and ask whether you really want to execute the deployprocedure.

Ø Click on Cancel to correct any possible errors.ð The flow has not been deployed to the Edge Gateway.

orØ Click on Confirm deploy to deploy the flow to the Edge Gateway and

activate it.ð Thus, the flow is activated in the Edge Gateway.


© Hilscher 2018


9.4.2 DashboardBeginning with Version 0.14, Node-RED simply allows to design integratedgraphical user interfaces. These graphical user interfaces are calleddashboards and designed within the dashboard configuration using somespecial nodes.

These special nodes contain graphical elements for control and display,which are used for input and output purposes. These are called widgets.Node/Widget

Function

button Adds a button to the user interfacedropdown Adds a dropdown list to the user interfaceswitch Adds a switch to the user interfaceslider Adds a slider to the user interfacenumeric Adds a widget for putting in numerical values to the user interfacetext input Adds a widget for text input to the user interfacecolour picker Adds a widget for color selection to the user interfaceform Adds a form to the user interfacetext Display of a non-editable text field on the user interfacegauge Adds a round gauge display to the user interfacechart Adds a chart to the user interface (can be configured as line chart, bar

chart or pie chart)notification Displays the contents of a message msg.payload as popup

notification or as dialog box (Options Ok / Cancel on the user interfaceaudio out Adds audio output or speech output of textui control Allows to control the dashboard dynamicallytemplate Adds directives or HTML code for further processing

Table 29: Kinds of widgets for use in dashboards

Widgets can be organized in groups. These groups together appear onworksheets which are called tabs

9.4.2.1 Dashboard configuration (Overview)

The dashboard configuration occurs in register card Dashboard of the sidebar. In the following the structure of and the functions provided by of thedashboard configuration are explained.

The register card Dashboard of the Edge Bar is itself divided into threeregister cards:· Layout· Theme· Site


© Hilscher 2018


These register cards look as follows:Register card Layout Register card Theme Register card Site

They consist of the following elements:Number Area Register card(1) Button "Show current dashboard in the browser within new register card" Layout,

Theme, Site

(2) Editable tree structure for creating tabs, groups and widgets. See sections Working withtabs [} page 79], Working with groups [} page 80] and Working with widgets [} page 83].

Layout

(3) Area for displaying messages Layout

(4) List field „Menu links“.See section Working with menu links [} page 84]. Layout

(5) Selection list "Style" - allows the selection of colors for background display (light or dark background or user-defined color display)

Theme

(6) Input field „Custom Profile“- allows to put in a name for a theme - is only displayed, if option „Custom“ has been chosen in selection list "Style"

Theme

(7) Color selection field „Base Settings“ Theme(8) Color selection field „Page Settings“

- is only displayed, if option „Custom“ has been chosen in selection list "Style"Theme


© Hilscher 2018


Number Area Register card(9) Color selection field „Group Settings“

- is only displayed, if option „Custom“ has been chosen in selection list "Style"Theme

(10) Color selection field „Widget Settings“- for the selection of text color, base color and background color for widgets- is only displayed, if option „Custom“ has been chosen in selection list "Style"

Theme

(11) Input field „Title“ - for specifying the title of the dashboard

Site

(12) Selection list „Options“ - Showing or hiding the title bar - Swiping over tabs

Site

(13) Input field „Data Format“ - allows specifying the date format of your choice

Site

(14) Input fields „Sizes“ for sizes and distances of widgets SiteTable 30: Areas of the dashboard configuration

9.4.2.2 Display dashboard

You can visualize the dashboard currently configured in the active Node-RED flow and test it as f9ollows:

Ø Click at the button right of the input field Title.ð In the browser a new register card is opened, in which the dashboard is

displayed graphically.

9.4.2.3 Change title

You can change the title of a dashboard as follows:Ø Specify the title of the dashboard in input field Title of register card Site.

9.4.2.4 Background

Select the background color (light or dark) of the dashboard as follows:Ø In the selection list Style in register card Theme select option

„Light(default)" or „Dark“. The option Custom allows you to adjustadditional color settings.

ð The background color is changed. However, the change will geteffective at the next deploy operation.


© Hilscher 2018


9.4.2.5 Working with tabs

In this section, working with tabs is described, such as creating new tabs,changing tabs and deleting these.

Adding a tab

In this way you can add a tab to the dashboard:

Ø Click at icon (right of the text "Tabs").ð A new tab is added below the already preset ones.

Editing a tab

In this way, you edit a tab:Ø Move your mouse cursor to the tab to be edited (within the tree

structure).

Ê The icons and get visible.

Ø Click at the icon (right of the name of the according tab).ð The dialog Edit dashboard tab node is opened.

Figure 58: Dialog "Edit dashboard tab node"

Ø Specify the desired name of the tab in field Name.Ø If desired, specify the icon type within the field Icon, for instance,

Dashboard.

Ø In order to store, click at in dialog Edit dashboard tabnode.

ð The dialog Edit dashboard tab node is closed and the tab is adaptedaccording to your specifications.


© Hilscher 2018


Deleting a tab

So you can delete a tab:

Ø Click at the icon (right of the name of the according tab)ð The dialog Edit dashboard tab node is opened.


Ø In order to delete a tab, click at in dialog Edit dashboardtab node.

ð The dialog Edit dashboard tab node is closed and the tab is removedfrom the tree structure.

9.4.2.6 Working with groups

In this section, working with groups is described, such as creating newgroups and changing and deleting groups .

Adding a group to a tab

So you can add a group to the dashboard within a tab

Ø Click at the icon (right of the name of the according tab).ð A new group is added below the already present groups. If there is not

any group, the new group is directly added below the tab.


© Hilscher 2018


Editing a group

In this way, you can edit a group of widgets:

Ø Click at the icon (right of the name of the according group).ð The dialog Edit dashboard tab node is opened.


Ø Specify the desired name of the tab in field Name.Ø If you want to change the relation of a group to a superordinated tab,

you can select another tab from the selection list Tab. If you want torelate the group with a tab to be newly created, select entry Add newui_tab at the end of the selection list. Then a new tab is created and thecurrent group is related to this new tab.

Ø Specify the width of the group in field Width.Ø You can control via the checkbox Display Group Name whether the

name of the group as displayed in the field Name is displayed on thedashboard, or not.

Ø In order to store, click at in dialog Edit dashboard tabnode.

ð The dialog Edit dashboard tab node is closed and the group isadapted according to your specifications.


© Hilscher 2018


Deleting a group

In this way, you can delete a group (within a tab)

Ø Click at the icon (right of the name of the according tab).ð The dialog Edit dashboard tab node is opened.


Ø In order to delete a group, click at in dialog Edit dashboardtab node.

ð The dialog Edit dashboard tab node is closed and the group isremoved from the tab.


© Hilscher 2018


9.4.2.7 Working with widgets

In this section, working with widgets is described,such as creating newwidgets, changing widgets and deleting these.

Adding a widget to group

So you can add a widget of your choice to a group:Ø Select a node for a widget from the node group dashboard out of the

node library, for instance for a line chart, bar chart or pie chart the nodefor the widget Chart.

Ø Pull this node onto your worksheet using Drag&Drop.Ø Double-click onto this node.Ê The edit dialog of the node is opened. Name and contents of the edit

dialog depend on the choice of the node. At its upper edge, thiscontains the three buttons Delete, Cancel und Done.

Note:Further information can be found in the documentation of Node-RED. You can find it at https://github.com/node-red/node-red-dashboard.

Ø Configure the widget according to your needs.Ø Select the group from the selection list, to which you want to add the

widget having just been configured.Ø Finish configuration by clicking at Done.ð The widget is stored including its configured settings and it is assigned

to the selected group.

Editing a widget

In this way, you edit a widget:

Ø Click at the icon (right of the name of the according widget).ð The edit dialog of the widget to be edited is opened. The name and the

contents of this edit dialog strongly depends on the type of therespective widget such as button, dropdown, switch, slider,numeric, textinput, form, colour picker, gauge, chart,audio out, notification, text, template or ui control.

Note:Further information can be found in the documentation of Node-RED. You can find it athttps://github.com/node-red/node-red-dashboard.

Ø Select the desired settings for your widget.

Ø Click at .ð The edit dialog is closed and the settings of your widget are stored.


© Hilscher 2018

https://github.com/node-red/node-red-dashboard





Deleting a widget

So you can delete a widget:

Ø Click at the icon (right of the name of the according widget).ð The edit dialog of the widget to be edited opens.

Ø Click at .ð The widget is deleted and removed from the group, to which it belonged

previously.

9.4.2.8 Working with menu links

Adding a link

So you can add a further link to the dashboard:Ø Click at icon (right of the text "Menu links").ð A new link is added at the end of the link list below "Menu links".

Editing a link

In this way, you edit a link within the link list:

Ø Click at the icon (right of the name of the according link).ð The dialog Edit dashboard tab node is opened.

Figure 62: Dialog "Edit link node"

Ø Specify the desired name of the tab in field Name.Ø Specify the link address in the field Link (Protocol http or https).Ø Specify in field Icon, how the link should be opened (Options

dashboard or open_in_browser)Ø Choose whether the link in the browser should be opened within a new

tab (Option New Tab) or within an iframe (Option iframe).


© Hilscher 2018


Ø In order to store, click at in dialog Edit link node.ð The dialog Edit link node is closed and the link is adapted according to

your specifications.

Deleting a link

So you can delete a link

Ø Click at the icon (right of the name of the according link).ð The dialog Edit dashboard tab node is opened.

Figure 63: Dialog "Edit link node"

Ø In order to delete a link, click at in dialog Edit link node.ð The dialog Edit link node is closed and the link is removed from the

link list.


© Hilscher 2018


9.5 List of nodesThe following table lists the nodes of the standard scope of delivery.Category NodeInput inject

catchstatuslinkmqtthttpwebsockettcpudpfieldbusI/Oopc ua (client)s7commWatson IoTserial

Output debuglinkmqtthttp responseweb sockettcpudpfieldbusLEDI/Oopc ua (client)s7commWatson IoTserial


© Hilscher 2018


Category NodeFunction function

templatedelaytriggercommenthttp requesttcp requestswitchchangerangesplitjoincsvhtmljsonxmlyamlsparkplugrbe

Social email inemail outtwitter intwitter out

Storage file tailfile insqlitefile out

Analysis sentimentAdvanced watch

feedparseexec

Cloud azureiothubModbus Modbus Response

Modbus ReadModbus GetterModbus Flex GetterModbus WriteModbus Flex WriteModbus ServerModbus Queue InfoModbus Flex Connector


© Hilscher 2018


Category NodeDashboard button

dropdownswitchslidernumerictext inputdate pickercolour pickerformtextgaugechartaudio outnotificationui controltemplate

Table 31: List of standard nodes


© Hilscher 2018


9.6 MQTT input nodeThe MQTT input node allows you to receive data from an MQTT broker viathe MQTT protocol using the MQTT function subscribe.

Figure 64: MQTT input node

Parameters of the MQTT input node

This section describes the parameters of the MQTT input node.

Figure 65: Dialog box Edit MQTT in node

Parameter Type DescriptionServer Selection list The selection list Server shows the MQTT broker to be used.

If MQTT brokers are already defined, they will be listed here.The selection list Server always contains a further entry Addnew mqtt-broker to add a new MQTT broker if no MQTTbroker has been defined yet or if already existing brokers arenot to be used.

Topic Input field In the input field Topic you can enter the topic for the MQTTcommunication. If no name has been entered, but an inputhas been made under Topic, this input will be used as nodename in the Node-RED workspace.Topic # causes all topics of the broker to be received.

Name Input field Here you enter the name of the MQTT input node that isdisplayed at the node in Node-RED and used foridentification.

Table 32: Parameter MQTT input node


© Hilscher 2018


If you select Add new mqtt-broker in the list Server and click Edit thereafter, the dialog box Add new mqtt-broker config node will bedisplayed. In this dialog box you can configure the parameters for aconnection to an MQTT broker.

Figure 66: Dialog box MQTT broker config node – tab Connection

Tab Connection

In the tab Connection you can configure the connection to the server.Parameter Type DescriptionServer Input field Here you indicate with which MQTT broker the Node-RED

MQTT input node shall communicate.For the communication with an external MQTT brokerspecify the IP address of this broker here or specifylocalhost (denoting the locally defined host computer).foraddressing the integrated MQTT broker of the EdgeGateway

Port Input field Here you enter the port via which Node-RED communicateswith MQTT. Port 1883 (for standard MQTT) or 8883 (forMQTT with TLS encryption) is usually used here.

Client ID Input field If the box Use clean session is not checked, you have toenter the client ID here to identify the client.If the box Use clean session is checked, no entry isrequired because in this case the client ID will be producedautomatically.

Keep alivetime

Input field Here you enter the lifetime of the connection.

Use cleansession

Checkbox By checking this box you can activate a clean sessionduring which the client ID is produced automatically.

Use legacyMQTT 3.1support

Checkbox By checking this box you can activate MQTT 3.1 support.

Table 33: Parameters in the tab Connection


© Hilscher 2018


Tab Security

In the tab Security you can configure the parameters for a secureconnection, e.g. authentication and encryption.

Figure 67: Dialog box MQTT broker config node - tab Security

Parameter Type DescriptionUser name Input field Here you enter the user name for the connection.Password Input field Here you enter the password for the connection.Enablesecure(SSL/TLS)connection

Checkbox By checking this box, the MQTT protocol will be transmittedto SSL/TLS via a secure connection with encryption. Forreason of data security, we recommend checking this box.

Verifyservercertificate

Checkbox By checking this box, the security certificate of the serverwill be verified, which will cause the browser to sendsecurity messages in case of problems with the certificate.This checkbox is active only if the checkbox Enable secure(SSL/TLS) connection has been checked.

Table 34: Parameters in the tab Security


© Hilscher 2018


Tab Birth Message

In the tab Birth Message you can configure the topic that is sent when anew connection is established.

Figure 68: Dialog box MQTT broker config node - tab Birth Message

Parameter Type DescriptionTopic Input field In the input field Topic you can enter the topic of the MQTT

communication. If you leave this field blank, no BirthMessage will be sent. In that case, all other parameters ofthis tab are meaningless.

QoS Selection list You can set the selection list QoS (Quality of Service) toone of the three values 0, 1, and 2.The meaning of thesevalues is as follows:0 = At most once (no acknowledge by the receiver)1 = At least once (the sender stores the message until itreceives an acknowledge from the receiver)2 = Exactly once (Sender and receiver acknowledge themessage using additional acknowledge messages)

Retain Selection list Here you can set whether the connection is to bemaintained after use:TRUE: The connection is to be maintained.FALSE: The connection will be terminated.

Payload Input field Here you can enter the payload (text) to be transmitted inthe Birth Message via MQTT.

Table 35: Parameters in the tab Birth Message


© Hilscher 2018


Tab Will Message

In the tab Will Message you configure the topic that is sent before aconnection is terminated.

Information on the Will Message, an MQTT message that is sent at the endof the lifetime of a node, if a topic is entered here.

Figure 69: Dialog box MQTT broker config node - tab Will Message

Parameter Type DescriptionTopic Input field In the input field Topic you can enter the topic of the MQTT

communication. If you leave this field blank, no WillMessage will be sent. In that case, all other parameters ofthis tab are meaningless.

QoS Selection list You can set the selection list QoS (Quality of Service) toone of the three values 0, 1, and 2. The meaning of thesevalues is as follows:0 = At most once (no acknowledge by the receiver)1 = At least once (the sender stores the message until itreceives an acknowledge from the receiver)2 = Exactly once (Sender and receiver acknowledge themessage using additional acknowledge messages)


Payload Input field Here you can enter the payload (text) to be transmitted inthe Will Message via MQTT.

Table 36: Parameters in the tab Will Message


© Hilscher 2018


9.7 MQTT output nodeThe MQTT output node allows you to send data to an MQTT broker via theMQTT protocol using the MQTT function publish.

Figure 70: MQTT output node

Parameters of the MQTT output node

This section describes the parameters of the MQTT output node.

Figure 71: Dialog box Edit MQTT out node


© Hilscher 2018


Parameter Type DescriptionServer Selection list The selection list Server shows the MQTT broker to be

used.If MQTT brokers are already defined, they will be listedhere. The selection list Server always contains a furtherentry Add new mqtt-broker to add a new MQTT broker ifno MQTT broker has been defined yet or if already existingbrokers are not to be used.

Topic Input field In the input field Topic you can enter the topic of the MQTTcommunication. If no name has been entered, but an inputhas been made under Topic, this input will be used as nodename in the Node-RED workspace.

QoS Selection list You can set the selection list QoS (Quality of Service) toone of the three values 0, 1, and 2. The meaning of thesevalues is as follows:0 = At most once (no acknowledge by the receiver)1 = At least once (the sender stores the message until itreceives an acknowledge from the receiver)2 = Exactly once (Sender and receiver acknowledge themessage using additional acknowledge messages)


Name Input field Here you enter the name of the MQTT output node that isdisplayed at the node in Node-RED and used foridentification.

Table 37: Parameters of the Edit MQTT out node

If you select Add new mqtt-broker in the list Server and click Edit thereafter, the dialog box Add new mqtt-broker config node will bedisplayed. In this dialog box you can configure the parameters for aconnection to an MQTT broker.

The parameters of tabs Connection, Security, Birth Message, and WillMessage of the MQTT output and input node are identical and described insection MQTT input node [} page 89].


© Hilscher 2018


9.8 OPC UA input nodeWith the OPC UA input node you can read data, i.e. one or severalattributes of an object, of an OPC UA server. The OPC UA input node hasthe function of a client.

Figure 72: OPC UA input node

Parameters of the OPC UA input node

This section describes the parameters of the OPC UA input node.

Figure 73: Dialog box Edit OPC UA in node – tab Home

Tab HomeParameter Type DescriptionServer Selection list The selection list Server indicates the OPC UA server with

which the node shall communicate..If any OPC UA servers are already defined, they will belisted here. The selection list Server always contains anentry Add new OPC UA client to add a new OPC UA serverif no OPC UA server has been defined yet or if alreadyexisting servers are not to be used.

Variable Display field Here, the name of the variable is displayed the data ofwhich is read. The name of a variable will be displayed onlyafter a variable has been selected with the Browse function. This requires a connection to the OPC UA server.

Topic Input field In the input field Topic you can enter a topic that the node atthe output port passes on with the JSON object foridentification to succeeding nodes.

Name Input field Here you enter the name that is displayed at the node.Table 38: Parameters of the configuration dialog OPC UA in node


© Hilscher 2018


If you select Add new opcua client in the list Server and click Edit thereafter, the dialog box Add new opcua-client config node will bedisplayed. In this dialog box you can configure a parameter for aconnection to an OPC UA server.

Figure 74: Dialog box „Add new opcua client config node“

The address of the OPC UA server is structured as follows: opc.tcp://<IP addresse:port

Example: opc.tcp://192.168.253.12:4840

Port 4840 is the standard port for unencrypted OPC UA communication.

The following figure shows a configured Home tab.

Figure 75: Dialog box „Edit opcua in node“ – tab Home


© Hilscher 2018


Tab Browse

Figure 76: Dialog box Edit OPC UA in node – tab Browse

To be able to use the browser function, you must perform the followingsteps in order to fulfill the requirements:Ø Establish a connection to the OPC UA server.Ø Enter the OPC UA server address (Parameter Server in dialog window

Add new opcua-client config node, see above).Ø Transmit the OPC UA input node to the Edge Gateway using Deploy.

The left window of the tab Browse displays the objects of the server’saddress space within a tree structure. The right window displays theattributes of the object selected in the left window.

Tab Mode

In the tab Mode you select the parameters for the operating modeSubscribe or Polling (under Transfer).


© Hilscher 2018


Operating mode Polling

Figure 77: Dialog box Edit OPC UA in node – tab Mode - Polling

By means of the selection list Payload you configure the amount of thepayload.

Figure 78: Options of the selection list Payload

Option Descriptionall All data is transmitted as payload.value The value is transmitted only. The value is transmitted without time stamp.specific Only data that you can select by checking one box or several boxes will be

transferred. The time stamp will be transferred, too.Table 39: Options of the payload list

By selecting the option specific you can select the attributes to betransmitted in the payload.

Figure 79: OPC UA in - specific payload


© Hilscher 2018


In the list Repeat you select if, when, and at what interval you want torepeat the reading of data from the OPC UA server.

Figure 80: Options of the list Repeat

Option Descriptionnone no repetitioninterval

You can set the time interval for periodic repetitions of the data transmissionvia OPC UA.

at a specifictime

You can set that the data is transmitted regularly at defined, selectableweekdays at a fixed time.

intervalbetweentime

Additionally, you can limit the space of time in which the periodic repetitions(at every) take place to an exact time range (between and) and definedweekdays.

Table 40: Options of the list Repeat


© Hilscher 2018


Operating mode Subscribe

Figure 81: Dialog Box Edit OPC UA in node – tab Mode - Subscribe

The parameters of the operating mode Subscribe are described in thefollowing table.Parameter DescriptionPublishing Duration of the publishing interval (in milliseconds)Life Time Life time (in milliseconds)Priority Relative priorityKeep Alive Number of empty messages sent until the client is informed

about timeout of session.Sampling Period of time during which the monitored parameters can be

processed and analyzed (in milliseconds)Queue size Number of the elements of the queueDiscard old If selected, old values are discarded

Table 41: Parameters in Subscription Settings and Monitored Items Settings


© Hilscher 2018


9.9 OPC UA output nodeWith the OPC UA output node you can read data, i.e. one attribute of anobject to an OPC UA server. The OPC UA output node has the function ofa client.

Figure 82: OPC UA output node

Parameters of the OPC UA output node

This section describes the parameters of the OPC UA output node.

Tab Home

Figure 83: Dialog box Edit OPC UA output node – tab Home

Parameter Type DescriptionServer Selection list The selection list Server indicates the OPC UA server with

which the node shall communicate.If any OPC UA servers are already defined, they will belisted here. The selection list Server always contains anentry Add new OPC UA client to add a new OPC UA serverif no OPC UA server has been defined yet or if alreadyexisting servers are not to be used.

NodeID Display field Here, the name of the variable is displayed the data ofwhich is written. The name of a variable will be displayedonly after a variable has been selected with the Browsefunction. This requires a connection to the OPC UA server.

Topic Input field In the input field Topic you can enter a topic.Name Input field Here you enter the name that is displayed at the node.

Table 42: Parameters of the configuration dialog Edit OPC UA out node


© Hilscher 2018


If you select Add new opcua client in the list Server and click Edit thereafter, the dialog box Add new opcua-client config node will bedisplayed. In this dialog box you can configure a parameter for aconnection to an OPC UA server.

Figure 84: Dialog box „Add new opcua client config node“

The address of the OPC UA server is structured as follows: opc.tcp://<IP address>:port

Example: opc.tcp://192.168.253.12:4840

Port 4840 is the standard port for unencrypted OPC UA communication.

Tab Browse

Figure 85: Dialog box Edit OPC UA out node – tab Browse

The left window of the tab Browse displays the objects in a tree structure.The right window displays the attributes of the object selected in the leftwindow. To be able to use the browser function, you must have entered theOPC UA server address, transmitted the OPC UA output node to the EdgeGateway by means of Deploy, and established a connection to the OPC UAserver.


© Hilscher 2018

Examples for Node-RED 104/215

10 Examples for Node-REDThe following sections describe examples for data flows.

10.1 Example 1: Inject and debug nodeThis example shows a simple flow with an inject node (input node) and adebug node (output node).

The inject node allows you to insert messages into a flow, either by clickingonce a button at the node or regularly by using a time interval between thesending of two messages.

The debug node allows you to display any messages (or the entiremessage object) in the sidebar. When the default settings of the debugnode are used, the payload of the message will be displayed only.

Prerequisites1. A connection with the Edge Gateway is established (see section Using

the web browser to establish a connection with the EdgeGateway [} page 20]).

2. The Node-RED workspace is open.

Step-by-step instructions1. Inserting an inject node:

Ø Drag an inject node from the node library and drop it in the worksheet.

2. Showing the sidebar:Ø Show the sidebar with the key combination Ctrl+spacebar or via the

Node-RED menu View > Show Sidebar.Ø Click the tab Info.Ø Click the inject node to show its properties and function description in

the tab Info.

3. Inserting a debug node:Ø Drag a debug node from the node library and drop it in the worksheet.

4. Connecting the nodesØ To connect inject node and debug node, hold down the left mouse

button and draw a connecting line (wire) from the output port of theinject node to the input port of the debug node.

ð The inject node can send messages to the debug node.


© Hilscher 2018


5. Deploy:Ø Click Deploy to transmit the nodes, that have so far existed in the editor

only, to the device and activate them. This procedure is calleddeployment.

ð The flow is activated in the Edge Gateway.

Note:For more information on Deploy, see section MenuDeploy [} page 74].

The example for copying[{"id":"46ae085e.4fd768","type":"debug","z":"9deaf786.3854a","name":"","active":true,"console":"false","complete":"false","x":330,"y":200,"wires":[]},{"id":"b2605825.aea4d","type":"inject","z":"9deaf786.3854a","name":"","topic":"","payload":"","payloadType":"date","repeat":"","crontab":"","once":false,"x":138,"y":188.5,"wires":[["46ae085e.4fd768"]]}]

Testing the flow and displaying messagesØ Click the tab Debugin the sidebar.Ø Click the left button at the inject node.ð The sidebar should display numbers. In the standard default setting, the

inject node uses the quantity of milliseconds that have elapsed sinceJanuary 1st, 1970, as payload.


© Hilscher 2018


10.2 Example 2: MQTT input nodeThe MQTT input node allows receiving data from an MQTT broker via theMQTT protocol and uses the MQTT function subscribe for this purpose.

Figure 86: MQTT input node

This example uses the MQTT input node together with a Debug node toreceive data via MQTT and to display the data thereafter in the tab Debugof the Node-RED sidebar.

Prerequisite1. A connection to the Edge Gateway is established (see section Using the

web browser to establish a connection with the EdgeGateway [} page 20])


Step-by-step instructions1. Inserting an MQTT input node:

Ø Drag an MQTT input node from the node library and drop it in theworksheet.

Ê The red triangle the MQTT input node is displayed with indicates thatthe node still needs some more parameters which you have to configurein the following steps.

2. Showing the sidebar:Ø Show the sidebar using the keyboard shortcut Ctrl+spacebar or via

the Node-RED menu View > Show Sidebar.Ø Click the tab Info.Ø Click the MQTT input node to display its properties and a functional

description in the tab Info.

3. Editing the MQTT input node:Ø To open the edit dialog, double-click on the MQTT input node.Ê The edit dialog for entering the parameters will be displayed.


© Hilscher 2018


4. Adding a broker:Ø If you use an MQTT node for the first time, the Server list contains the

entry Add new mqtt-broker only. In that case, click Edit to add anMQTT broker. As an alternative you can select a server from the listand continue with step 5.

Ê The dialog box Add new mqtt-broker config node will be displayed.Ø Enter the name localhost in the field Server of the tab Connection. By

means of localhost you address the MQTT broker integrated in theEdge Gateway.

Ø For this (simple) example you can adopt the preset parameters withouthaving to enter any further parameters.

Ø Click Add.Ê The MQTT broker is configured.Ê The dialog box returns to the first edit dialog.Ê Under Server the edit dialog shows the address and the port

localhost:1883.


© Hilscher 2018


5. Configuring the MQTT input node:Ø Enter the name of the topic that you want to receive in the field Topic,

e.g. Timestamp1. To receive all topics, enter #.Ø For QoS enter the value 1.Ø Enter the name of this node, e.g. MySubscribingNode, in the field

Name.Ê All parameters are entered.

Ø Click Done.Ê The configuration of the MQTT input node is completed and the red

triangle has disappeared.

6. Inserting a Debug node:Ø Drag a Debug node from the node library and drop it in the worksheet.

7. Connecting the nodes:Ø To connect the MQTT node with the Debug node, hold down the left

mouse button and draw a connecting line (wire) from the output port ofthe MQTT node to the input port of the Debug node.

ð


only, to the device and activate them.ð The flow is activated in the Edge Gateway.

ð As soon as the topic Timestamp1 changes, the Debug output willdisplay the new value.

The section MQTT input node [} page 89] describes the parameters of theMQTT input node.


© Hilscher 2018


The example for copying[{"id":"4a22a8ea.115788","type":"mqttin","z":"6b03759e.b5eb4c","name":"MySubscribingNode","topic":"Timestamp1","qos":"1","broker":"55ba4653.6e07b8","x":211,"y":512,"wires":[["2785278d.2d5bc8"]]},{"id":"2785278d.2d5bc8","type":"debug","z":"6b03759e.b5eb4c","name":"","active":true,"console":"false","complete":"false","x":402,"y":512,"wires":[]},{"id":"55ba4653.6e07b8","type":"mqtt-broker","z":"6b03759e.b5eb4c","broker":"localhost","port":"1883","clientid":"","usetls":false,"compatmode":true,"keepalive":"60","cleansession":true,"willTopic":"","willQos":"0","willPayload":"","birthTopic":"","birthQos":"0","birthPayload":""}]

Testing the flow and displaying messagesØ Click the tab Debugin the sidebar.Ø Use a device that is externally connected to the Edge Gateway to

execute a publish with MQTT on topic Timestamp1.- or -Copy and use the example MQTT output node (see section Example 3:MQTT output node [} page 110]).

ð The Debug node displays messages of the MQTT input node as soonas the topic Timestamp1 changes.


© Hilscher 2018


10.3 Example 3: MQTT output nodeThe MQTT output node allows you to send data to an MQTT broker via theMQTT protocol and uses the MQTT function publish for this purpose.

This example uses the MQTT output node together with an Inject node tosend data via MQTT.

Figure 87: MQTT output node

Prerequiste1. A connection to the Edge Gateway is established (see section Using the

web browser to establish a connection with the EdgeGateway [} page 20]).


Step-by-step instructions1. Inserting an Inject node:

Ø Drag an Inject node from the node library and drop it in the worksheet.

2. Inserting an MQTT output node:Ø Drag an MQTT output node from the node library and drop it in the

worksheet.Ê The red triangle the MQTT output node is displayed with indicates that

the node still needs some more parameters which you have to configurein the following steps.


the Node-RED menu View > Show Sidebar.Ø Click the tab Info.Ø Click the MQTT output node to display its properties and a functional



© Hilscher 2018


4. Editing the MQTT output node:Ø To open the edit dialog, double-click on the MQTT output node.Ê The edit dialog for entering the parameters will be displayed.

5. Adding a broker:Ø If you use an MQTT node for the first time, the Server list contains the

entry Add new mqtt-broker only. In that case, click Edit , to add anMQTT broker. As an alternative you can select a server from the listand continue with step 6.

Ê The dialog box Add new mqtt-broker config node will be displayed.Ø Enter the name localhost in the field Server of the tab Connection. By

means of localhost you address the MQTT broker integrated in theEdge Gateway.

Ø For this (simple) example you can adopt the preset parameters withouthaving to enter any further parameters.

Ø Click Add.Ê The MQTT broker is configured.Ê The dialog box returns to the first edit dialog.Ê Under Server the edit dialog shows the address and the port

localhost:1883.


© Hilscher 2018


6. Configuring the MQTT output node:Ø Enter the name of the topic that you want to send (publish) in the field

Topic, e.g. Timestamp1.Ø For QoS enter the value 1.Ø Enter the name of this node, e.g. MyPublishingNode, in the field

Name.Ê All parameters are entered.

Ø Click Done.Ê The configuration of the MQTT output node is completed and the red

triangle has disappeared.

7. Connecting the nodes:Ø To connect the Inject node with the MQTT node, hold down the left

mouse button and draw a connecting line (wire) from the output port ofthe Inject node to the input port of the MQTT node.

ð



The section MQTT output node [} page 94] describes the parameters of theMQTT output node.


© Hilscher 2018


The example for copying[{"id":"c28f8355.ed0b7","type":"inject","z":"6b03759e.b5eb4c","name":"","topic":"","payload":"","payloadType":"date","repeat":"","crontab":"","once":false,"x":187,"y":163,"wires":[["9bc7b36a.df3c3"]]},{"id":"9bc7b36a.df3c3","type":"mqttout","z":"6b03759e.b5eb4c","name":"MyPublishingNode","topic":"Timestamp1","qos":"1","retain":"","broker":"cf82b7fc.b44d18","x":461,"y":163,"wires":[]},{"id":"cf82b7fc.b44d18","type":"mqtt-broker","z":"6b03759e.b5eb4c","broker":"localhost","port":"1883","clientid":"","usetls":false,"compatmode":true,"keepalive":"60","cleansession":true,"willTopic":"","willQos":"0","willPayload":"","birthTopic":"","birthQos":"0","birthPayload":""}]

Testing the flow and displaying messagesØ Use a device that is externally connected to the Edge Gateway to

execute a subscribe with MQTT on topic Timestamp1.- or -Copy and use the example MQTT input node (see section Example 2:MQTT input node [} page 106]).

ð With each click on the button at the Inject node the topic Timestamp1 issent to the MQTT broker. If you use this example together with theexample MQTT input node, you can display the value of the topicTimestamp1 in the tab Debug.


© Hilscher 2018


10.4 Example 4: OPC UA input nodeThe OPC UA input node allows you to read data from an OPC UA servervia the OPC UA protocol.

This example uses the OPC UA input node together with a Debug node toreceive data via OPC UA and to display the data thereafter in the tabDebug of the Node-RED sidebar.

Figure 88: OPC UA input node

Prerequisites1. A connection to the Edge Gateway is established (see section Using the


2. The Node-RED workspace is open.3. The device with the OPC UA server is connected to the Edge Gateway.4. The IP-address of the OPC UA server is known to you.

Step-by-step instructions1. Inserting the OPC UA input node:

Ø Drag an OPC UA input node from the node library and drop it in theworksheet.

Ê The red triangle the OPC UA input node is displayed with indicates thatthe node still needs some more parameters which you have to configurein the following steps.


the Node-RED menu View > Show Sidebar.Ø Click the tab Info.Ø Click the OPC UA input node to display its properties and a functional



© Hilscher 2018


3. Editing the OPC UA input node:Ø To open the edit dialog, double-click on the OPC UA input node.Ê The edit dialog for entering the parameters will be displayed.

4. Adding the server:Ø If you use an OPC UA node for the first time, (the server list displays

Add new opcua ...), click Edit to add a new server.Ø Enter the server address in the field Server in the form opc.tcp://

<IP-address>:4840 (e. g. opc.tcp://192.168.253.12:4840).Port 4840 is the OPC UA standard port.

Ø Click Add or Update.Ê The dialog box returns to the first edit dialog.Ê Under Server the edit dialog displays the IP-address and the port.


© Hilscher 2018


5. Transferring the OPC UA input node into the Edge Gateway:Ø Before you can select an object with the Browse function, you have to

transfer the node: At first click Done and then Deploy to transmit thenodes, that have so far existed in the editor only, to the device andactivate them.

Ê The Edge Gateway executes the OPC UA node. The OPC UA nodetries to establish a connection to the server.

Ê If the OPC UA node has no connection to the server, node statusdisconnected will be displayed. Objects cannot be read. Only afterestablishing a connection to the OPC UA server can you continue theconfiguration of the OPC UA input node. E.g., check the Ethernetwiring, the IP-address, the device configuration, etc. If required, repeata Deploy.

Ê If the OPC UA node has a connection to the server, node statusconnected will be displayed.

6. Selecting the object:Ø To open the edit dialog, double-click the OPC UA input node.Ø Click the tab Browse.Ê If the OPC UA node has no connection to the server, the node can

neither read nor display the address space of the server. In that case

the edit dialog shows bars . Only after establishing a connection tothe OPC UA server can you continue the configuration of the OPC UAinput node. E.g., check the Ethernet wiring, the IP-address, the deviceconfiguration, etc. If required, repeat a Deploy.

Ê If the OPC UA node has a connection to the server, the node reads anddisplays the address space of the server.


© Hilscher 2018


Ø To select the object to be read (e. g. DIN1) from the address space,open the elements in the tree structure (+).

7. Setting the parameters:Ø Click the tab Mode.Ê The edit dialog for entering the parameters will be displayed.

Ø Under Transfer select the operating mode for the data transfer, e.g.polling.

Ø Under Payload select the scope of payload. E.g. select specific andcheck the boxes BrowseName and Value to transfer the name and thevalue with a time stamp.

Ø Under Repeat select how often and when the object is to be read, e.g.interval and 10 seconds so that the object is read every 10 seconds.


© Hilscher 2018


Ê All parameters are entered.

Ø Click Home.Ø Enter the name of the topic in the field Topic, e. g. Read_DIN1.Ø Enter the name of the node in the field Name, e. g. Read_DIN1.Ê The configuration of the OPC UA input node is completed.

Ø Click Done.Ê The configuration of the OPC UA input node is finished and the red

triangle has disappeared. The blue circle indicates that the modifiednode has not yet been transferred into the Edge Gateway.


© Hilscher 2018


8. Inserting the Debug node:Ø Drag a Debug node from the node library and drop it in the worksheet.

9. Connecting the nodes:Ø To connect the OPC UA node with the Debug node, hold down the left

mouse button and draw a connecting line (wire) from the output port ofthe OPC UA node to the input port of the Debug node.



The section OPC UA input node [} page 96] describes the parameters ofthe OPC UA input node.

The example for copying[{"id":"2a3f05cc.84618a","type":"opcuain","z":"c06a6a5f.9401c8","name":"Read_DIN1","opcua":"3c86364a.a184fa","opcua_tree":"{\"var\":'unknown'}","VariableName":"DIN1","selectedNodeId":"ns=3-i=1879048195","nodeId":"","repeat":"10","crontab":"","once":false,"topic":"Read_DIN1","opcua_endpoint":"","item_identifier":"","output_attributes":"NodeId,NodeClass,BrowseName,DisplayName,Description,WriteMask,UserWriteMask,Value,DataType,ValueRank,AccessLevel,UserAccessLevel,MinimumSamplingInterval,Historizing","output_selected_attributes":"","output_type":"specific","output_nodeClass":"Variable","repeattype_output":"specific","settings_nodeId":"","publishing":500,"lifeTime":2400,"priority":0,"maxKeepAliveCount":10,"AccessData_select":"unsubscribe","samplingInterval":250,"queueSize":10,"discardOldest":true,"x":185,"y":95,"wires":[["8ecff8fe.e50978"]]},{"id":"8ecff8fe.e50978","type":"debug","z":"c06a6a5f.9401c8","name":"","active":true,"console":"false","complete":"false","x":389,"y":95,"wires":[]},{"id":"3c86364a.a184fa","type":"opcuaclient","z":"c06a6a5f.9401c8","serveraddress":"opc.tcp://192.168.253.12:4840"}]

Testing the flow and displaying messagesØ Click the tab Debugin the sidebar.ð If the OPC UA input node has a connection to the OPC UA server, the

Debug node displays every 10 seconds messages of the OPC UA nodewhich contains the value of the object read.


© Hilscher 2018


10.5 Example 5: OPC UA output nodeThe OPC UA output node allows you to write data via the OPC UAprotocol.

This example uses two Inject nodes and the OPC UA output node to writedata via OPC UA.

Figure 89: OPC UA output node

Prerequisites1. A connection to the Edge Gateway is established (see section Using the


2. The Node-RED workspace is open.3. The device with the OPC UA server is connected to the Edge Gateway.4. The IP-address of the OPC UA server is known to you.

Step-by-step instructions1. Inserting the first Inject node:


2. Configuring the Inject node:Ø To open the edit dialog, double-click on the Inject node.Ê The edit dialog for entering the parameters will be displayed.Ø Select the entry number from the Payload list and enter number 1.Ø In the field Topic enter the name of the topic, e.g. Write1.Ø In the field Name enter the name of this node, e.g. Write number 1.Ê All parameters are entered.


© Hilscher 2018


3. Inserting the second Inject node:Ø Drag a further Inject node from the node library and drop it in the

worksheet.

4. Configuring the Inject node:Ø To open the edit dialog, double-click on the Inject node.Ê The edit dialog for entering the parameters will be displayed.Ø Select the entry number from the Payload list and enter number 2.Ø In the field Topic enter the name of the topic, e.g. Write2.Ø In the field Name enter the name of this node, e.g. Write number 2.Ê All parameters are entered.

5. Inserting the OPC UA output node:Ø Drag an OPC UA output node from the node library and drop it in the

worksheet.Ê The red triangle the OPC UA output node is displayed with indicates

that the node still needs some more parameters which you have toconfigure in the following steps.


the Node-RED menu View > Show Sidebar.Ø Click the tab Info.Ø Click the OPC UA output node to display its properties and a functional



© Hilscher 2018


7. Editing the OPC UA output node:Ø To open the edit dialog, double-click on the OPC UA output node.Ê The edit dialog for entering the parameters will be displayed.

8. Adding the server:Ø If you use an OPC UA node for the first time, (the server list displays

Add new opcua ...), click Edit to add a new server.Ø Enter the server address in the field Server in the form opc.tcp://

<IP-address>:4840 (e.g. opc.tcp://192.168.253.12:4840).Port 4840 is the OPC UA standard port.

Ø Click Add or Update.Ê The dialog box returns to the first edit dialog.Ê Under Server the edit dialog displays the protocol, the IP-address and

the port.


© Hilscher 2018


9. Transferring the OPC UA output node into the Edge Gateway:Ø Before you can select an object with the Browse function, you have to

transfer the node: At first click Done and then Deploy to transmit thenodes, that have so far existed in the editor only, to the device andactivate them.

Ê The Edge Gateway executes the OPC UA node. The OPC UA nodetries to establish a connection to the server.

Ê If the OPC UA node has no connection to the server, node statusdisconnected will be displayed. Objects cannot be read. Only afterestablishing a connection to the OPC UA server can you continue theconfiguration of the OPC UA output node. E.g., check the Ethernetwiring, the IP-address, the device configuration, etc. If required, repeata Deploy.

Ê If the OPC UA node has a connection to the server, node statusconnected will be displayed.

10. Selecting the object:Ø To open the edit dialog, double-click the OPC UA output node.Ø Click the tab Browse.Ê If the OPC UA node has no connection to the server, the node can

neither read nor display the address space of the server. In that case

the edit dialog shows bars . Only after establishing a connection tothe OPC UA server can you continue the configuration of the OPC UAoutput node. E.g., check the Ethernet wiring, the IP-address, the deviceconfiguration, etc. If required, repeat a Deploy.

Ø If the OPC UA node has a connection to the server, the node reads anddisplays the address space of the server.


© Hilscher 2018


Ø To select the object to be read (e.g. DOUT1) from the address space,open the elements in the tree structure (+).

Ø Click Home.Ø In the field Topic enter the name of the topic, e.g. Write_DOUT1.Ø In the field Name enter the name of the node, e.g. Write_DOUT1.Ê The configuration of the OPC UA output node is completed.

Ø Click Done.Ê The configuration of the OPC UA output node is finished and the red

triangle has disappeared. The blue circle indicates that the modifiednode has not yet been transferred into the Edge Gateway.


© Hilscher 2018


11. Connecting the nodes:Ø To connect the first Inject node with the OPC UA output node, hold

down the left mouse button and draw a connecting line (wire) from theoutput port of the Inject node to the input port of the OPC UA node.

Ø Connect the second Inject node with the OPC UA output node.Ê The nodes are connected.



The section OPC UA output node [} page 102] describes the parameters ofthe OPC UA output node.


© Hilscher 2018


The example for copying[{"id":"91519686.288888","type":"inject","z":"3c8fc4d2.60c41c","name":"Write number 1","topic":"Write1","payload":"1","payloadType":"num","repeat":"","crontab":"","once":false,"x":175,"y":85,"wires":[["7bcd2e96.bb147"]]},{"id":"c1e276e1.d665a8","type":"inject","z":"3c8fc4d2.60c41c","name":"Write number 2","topic":"Write2","payload":"2","payloadType":"num","repeat":"","crontab":"","once":false,"x":174,"y":155,"wires":[["7bcd2e96.bb147"]]},{"id":"7bcd2e96.bb147","type":"opcuaout","z":"3c8fc4d2.60c41c","name":"Write_DOUT1","opcua":"9bd76434.b638e8","opcua_tree":"{\"var\":\"unknown\"}","VariableName":"DOUT1","selectedNodeId_output":"ns=3-i=1879048201","selectAttribute":"","selecteddatatype":"Byte","topic":"Write_DOUT1","selectIdentifier_output":"1879048201","x":442,"y":120,"wires":[]},{"id":"9bd76434.b638e8","type":"opcuaclient","z":"3c8fc4d2.60c41c","serveraddress":"opc.tcp://192.168.253.12:4840"}]

Testing the flow

For testing the flow you need a connection to the OPC UA server.Ø Click the button to the left of Inject node 1.Ê Value 1 will be written to object DOUT1 in the OPC UA server.Ø Click the button to the left of Inject node 2.Ê Value 2 will be written to object DOUT1 in the OPC UA server.


© Hilscher 2018


10.6 Example 6: Fieldbus input nodeThe fieldbus input node allows you to receive data from the fieldbus, e.g.PROFINET, and uses signals to address this data. Before you can use thefieldbus input node, you have to configure the fieldbus and define thesignals.

Figure 90: Fieldbus input node

This example uses the fieldbus input node together with a Debug node toreceive fieldbus data (in this case PROFINET) and to display the datathereafter in the Debug tab of the Node-RED sidebar.




Step-by-step instructions1. Inserting the fieldbus input node:

Ø Drag a fieldbus input node from the node library and drop it in theworksheet.

Ê The red triangle the fieldbus node is displayed with indicates that thenode still needs some more parameters which you have to configure inthe following steps.


the Node-RED menu View > Show Sidebar.Ø Click the tab Info.Ø Click thefieldbus input node to display its properties and a functional



© Hilscher 2018


3. Editing the fieldbus input node:Ø To open the edit dialog, double-click on the fieldbus node.Ê The edit dialog for entering the parameters will be displayed.

4. Adding the fieldbus input node:Ø If you use a fieldbus node for the first time, (the fieldbus interface list

displays Add new fieldbus interface), click Edit to add a newfieldbus interface.

Ê The fieldbus configuration node will be displayed.


© Hilscher 2018


5. Selecting the fieldbus interface:Ø Check whether Currently loaded firmware displays the entry

PROFINET IO Device: Version ....

Ø If it is not displayed, use to select the entry PROFINET IO Deviceunder fieldbus interface and click Reconfigure.

6. Opening the fieldbus configurator (PROFINET configurator):Ø If Currently loaded firmware does not yet display the entry PROFINET

IO Device, repeat step 5.Ø If Currently loaded firmware displays the entry PROFINET IO Device,

click Open Fieldbus Configurator.

Ê A new tab with the PROFINET configuration interface will be displayed.

7. Configuring PROFINET:Ø Click IO and Signal configuration in the configuration tree (left).Ê The page IO Configuration with the list of Available IO items will be

displayed.Ø At first, double-click the entry 16 send byte (inputs) in the list of

Available IO items.Ø Then, double-click the entry 16 receive byte (outputs) in the list of

Available IO items.Ê The list of IO items displays 2 PROFINET modules.


© Hilscher 2018


8. Defining signal names for modules:Ø In the column Tag of the list IO items, click send_001 (index 001

named 16 send byte (inputs)).Ø Overwrite the available Tagname with the following new Tagname:

toController.Ø In the column Tag of the list IO items, click receive_001 (index 002

named 16 receive byte (outputs)).Ø Overwrite the available Tagname with the following new Tagname:

fromController.Ê The new Tagname which is part of the entire signal name is now

displayed for each module.

9. Defining signals for module 1:Ø Select 001: 16 send byte (inputs) in the configuration tree.

Ê The signal configuration page with information on module 001 will bedisplayed.

Ø Mark the available signal in the signal list.Ø Click Delete selected items.Ø Click Add new signals.Ê The Add new signals dialog box will be displayed.Ø Select the data type: Signed16.Ø Select the quantity: 8.Ø Under tag name base enter Temperature.Ø Click Ok.Ê Column Tag displays Temperature_1 to Temperature_8. If required,

you can adapt the signal names in the column Tag.


© Hilscher 2018


10. Defining signals for module 2:Ø Select 002: 16 receive byte (outputs) in the configuration tree.


Ø Mark the available signal in the signal list.Ø Click Delete selected items.Ø Click Add new signals.Ê The Add new signals dialog box will be displayed.Ø Select the data type Signed16.Ø Select the quantity: 8.Ø Under tag name base enter Set_temperature.Ø Click Ok.Ê Column Tag displays Set_temperature_1 to Set_temperature_8. If

required, you can adapt the signal names in the column Tag.

11. Saving the configuration:Ø To save the configuration in the Edge Gateway, click Project > Save in

the main menu of the PROFINET-configuration.Ê A message confirms that the configuration has been saved

successfully.Ø Click Ok.Ê The PROFINET configuration and signal definition are saved in the

Edge Gateway, but they are not activated yet.

12. Returning to Node-RED:Ø Return to the tab Node-RED in your browser.Ø To adopt a new/changed PROFINET configuration, click Reconfigure

interface.Ø To add a new fieldbus interface, click Add.

- or -Update is offered as an alternative. Click Update, if only signal nameshave been extended or changed, whereas the PROFINET configurationhas remained unchanged.

Ê The display returns to the edit dialog.

13. Entering names:Ø Under Name enter a node name e.g. MyInput.

14. Selecting a signal:

Ø Use to open the signal list and select a Signal e.g.input~fromController~Set_temperature_2.If the signal is not displayed, close the edit dialog with Done anddouble-click to reopen the fieldbus node.


© Hilscher 2018


15. Finishing the fieldbus input node:Ø Click Done.ð The red triangle in the upper right corner has disappeared, i.e. the

configuration of the fieldbus input node is completed, but not yetactivated in the Edge Gateway.

16. Inserting a Debug node:Ø Drag a Debug input node from the node library and drop it in the

worksheet.

17. Connecting the nodes:Ø To connect the fieldbus node with the Debug node, hold down the left

mouse button and draw a connecting line (wire) from the output port ofthe fieldbus node to the input port of the Debug node.



ð As soon as the value of the signal changes, the Debug output willdisplay the changed value/s and status information.

The example for copying

Note:To configure the fieldbus (in this case PROFINET), it is simply notenough to copy this example. You have to perform steps 6 to 12 ofthe step-by-step instructions for this purpose.

[{"id":"98832253.9224b","type":"fieldbusin","z":"ae0f59a7.16c008","name":"MyInput","FieldbusNodeVersion":"1.1.0","WrapperVersion":"1.1.0","WrapperCompileDate":"Sep 12016/08:37:12","MinExpectedNodeJSVersion":"4.5.0","selectedSignalPath":"input~fromController~Set_temperature_2","fieldbusObj":"e3a02a0f.a95938","x":179,"y":144,"wires":[["572ba7f6.f90c08"]]},{"id":"572ba7f6.f90c08","type":"debug","z":"ae0f59a7.16c008","name":"","active":true,"console":"false","complete":"false","x":361,"y":144,"wires":[]},{"id":"e3a02a0f.a95938","type":"fieldbusinterface","z":"ae0f59a7.16c008","selectedConfigPath":"","currentFirmwareName":"PROFINET IO Device: Version(3.9, build 0, revision6)","currentInterfaceName":"cifX0:PROFINETIO:Device","expectedInterfaceName":"cifX0:PROFINETIO:Device","expectedFirmwareName":"PROFINET IO Device: Version(3.9,build 0, revision6)","expectedFirmwarePath":"","selectedChannelNumber":"2","selectedDeviceNumber":"1291105","selectedSerialNumber":"20726"}]


© Hilscher 2018


Testing the flow and displaying messages

For testing the flow you need a connection to a configured PROFINET IOController which cyclicly exchanges I/O-data with the Edge Gateway. At thePROFINET IO Controller you have to set output data so that the fieldbusinput node can receive changed output data.Ø Click the tab Debugin the sidebar.Ø Set the output data at the PROFINET IO Controller: The example uses

the signal Set_temperature_2 and is byte 3 and 4 of module 16receive byte (outputs). Byte 1 and 2 have been assigned by theconfiguration Set_temperature_1.

ð The Debug node displays messages of the fieldbus input node as soonas the signal Set_temperature_2 changes.

The following figure shows the value 123 for the signalSet_temperature_2. The value 0 for "Error" indicates that the cyclicPROFINET communication works without problems.

Figure 91: Message of the fieldbus input node (without error)

The following figure displays a value for "Error" that is unequal to 0, i.e. thePROFINET communication does not work.

Figure 92: Message of the fieldbus input node (with error)


© Hilscher 2018


10.7 Example 7: Fieldbus output nodeThe fieldbus output node allows you to send data to the fieldbus, e.g.PROFINET, and uses signals to address this data. Before you can use thefieldbus output node, you have to configure the fieldbus and define thesignals.

Figure 93: Fieldbus output node

This example uses the fieldbus output node together with two Inject nodesto send data to the fieldbus.




Step-by-step instructions1. Inserting the first Inject node:



© Hilscher 2018


2. Configuring Inject node:Ø To open the edit dialog, double-click on the Inject node.Ê The edit dialog for entering the parameters will be displayed.Ø Select from the Payload list the entry number and enter number 1.Ø Enter in the field Topic the name of the topic, e.g. Send1.Ø Enter in the field Name the name for this node, e.g. Send number 1.Ê All parameters are entered.

3. Inserting the second Inject node:Ø Drag another Inject node from the node library and drop it in the

worksheet.


© Hilscher 2018


4. Configuring the Inject node:Ø To open the edit dialog, double-click on the Inject node.Ê The edit dialog for entering the parameters will be displayed.Ø Select from the Payload list the entry number and enter number 2.Ø Enter in the field Topic the name of the topic, e.g. Send2.Ø Enter in the field Name the name for this node, e.g. Send number 2.Ê All parameters are entered.

5. Inserting the fieldbus output node:Ø Drag a fieldbus output node from the node library and drop it in the

worksheet.Ê The red triangle the fieldbus node is displayed with indicates that the

node still needs some more parameters which you have to configure inthe following steps.


© Hilscher 2018



the Node-RED menu View > Show Sidebar.Ø Click the tab Info.Ø Click the fieldbus output node to display its properties and a functional

description in the tab Info.Ê The field Type of the tab Info shows the node type fieldbus.out.

7. Editing the fieldbus output node:Ø To open the edit dialog, double-click on the fieldbus node.Ê The edit dialog for entering the parameters will be displayed.

8. Adding a fieldbus interface:Ø If you use an fieldbus node for the first time, (the fieldbus interface list

displays Add new fieldbus interface), click Edit to add a newfieldbus interface.

9. Selecting the fieldbus interface:Ø Check whether Currently loaded firmware displays the entry

PROFINET IO Device: Version ....

Ø If it is not displayed, use to select the entry PROFINET IO Deviceunder fieldbus interface and click Reconfigure.


© Hilscher 2018


10. Opening the fieldbus configurator (PROFINET configurator):Ø If Currently loaded firmware does not yet display the entry PROFINET

IO Device, repeat step 9.Ø If Currently loaded firmware displays the entry PROFINET IO Device,

click Open Fieldbus Configurator.

Ê A new tab with the PROFINET configuration interface will be displayed.

11. Configuring PROFINET:Ø Click IO and Signal configuration in the configuration tree.Ê The page IO Configuration with the list of Available IO items will be

displayed.Ø At first, double-click the entry 16 send byte (inputs).Ø Then, double-click the entry 16 receive byte (outputs).Ê The list of IO items displays 2 PROFINET modules.

12. Defining signal names for modules:Ø In the column Tag of the list IO items, click send_001 (index 001

named 16 send byte (inputs)).Ø Overwrite the available Tagname with the following new Tagname:

toController.Ø In the column Tag of the list IO items, click receive_001 (index 002

named 16 receive byte (outputs)).Ø Overwrite the available Tagname with the following new Tagname:

fromController.Ê The new Tagname which is part of the entire signal name is now

displayed for each module.


© Hilscher 2018


13. Defining signals for module 1:Ø Select 001: 16 send byte (inputs) in the configuration tree.


Ø Mark the available signal in the signal list.Ø Click Delete selected items.Ø Click Add new signals.Ê The Add new signals dialog box will be displayed.Ø Select the data type Signed16.Ø Select the quantity: 8.Ø Under tag name base enter Temperature.Ø Click Ok.Ê Column Tag displays Temperature_1 to Temperature_8. If required,

you can adapt the signal names in the column Tag.

14. Defining signals for module 2:Ø Select 002: 16 receive byte (outputs) in the configuration tree.


Ø Mark the available signal in the signal list.Ø Click Delete selected items.Ø Click Add new signals.Ê The Add new signals dialog box will be displayed.Ø Select the data type Signed16.Ø Select the quantity: 8.Ø Under tag name base enter Set_temperature.Ø Click Ok.Ê Column Tag displays Set_temperature_1 to Set_temperature_8. If

required, you can adapt the signal names in the column Tag.

15. Saving the configuration:Ø To save the configuration in the Edge Gateway, click Project > Save in

the main menu of the PROFINET configuration.Ø A message confirms that the configuration has been saved

successfully.Ø Click Ok.Ê The PROFINET configuration and signal definition are saved in the

Edge Gateway, but they are not activated yet.


© Hilscher 2018


16. Returning to Node-RED:Ø Return to the tab Node-RED in your browser.Ø To adopt a new/changed PROFINET configuration, click Reconfigure

interface.Ø To add a new fieldbus interface, click Add

- or -/>Update is offered as an alternative. Click Update, if only signalnames have been extended or changed, whereas the PROFINETconfiguration has remained unchanged.

Ê The display returns to the edit dialog.

17. Entering names:Ø Under Name enter a node name, e.g. MyOutput.

18. Selecting a signal:

Ø Use to open the signal list and select a Signal e.g.output~toController~Temperature_2.If the signal is not displayed, close the edit dialog with Done anddouble-click to reopen the fieldbus node.

19. Finishing the fieldbus input node:Ø Click Done.ð The configuration of the fieldbus input node is completed, but not yet

activated in the Edge Gateway.

20. Connecting the nodes:Ø To connect the first Inject node with the fieldbus output node, hold down

the left mouse button and draw a connecting line (wire) from the outputport of the Inject node to the input port of the fieldbus node.

Ø Connect the second Inject node with the fieldbus output node.Ê The nodes are connected.




© Hilscher 2018


The example for copying

Note:To configure the fieldbus (in this case PROFINET), it is simply notenough to copy this example. You have to perform steps 10 to 16 ofthe step-by-step instructions for this purpose.

[{"id":"fa23cb52.763c48","type":"inject","z":"ae0f59a7.16c008","name":"Send number1","topic":"Send1","payload":"1","payloadType":"num","repeat":"","crontab":"","once":false,"x":192,"y":136,"wires":[["dcbda172.a1923"]]},{"id":"6663e56b.1bb5cc","type":"inject","z":"ae0f59a7.16c008","name":"Send number2","topic":"Send2","payload":"2","payloadType":"num","repeat":"","crontab":"","once":false,"x":190,"y":210,"wires":[["dcbda172.a1923"]]},{"id":"dcbda172.a1923","type":"fieldbusout","z":"ae0f59a7.16c008","name":"MyOutput","FieldbusNodeVersion":"1.1.0","WrapperVersion":"1.1.0","WrapperCompileDate":"Sep 12016/08:37:12","MinExpectedNodeJSVersion":"4.5.0","selectedSignalPath":"output~toController~Temperature_2","fieldbusObj":"e3a02a0f.a95938","x":469,"y":166,"wires":[]},{"id":"e3a02a0f.a95938","type":"fieldbusinterface","z":"ae0f59a7.16c008","selectedConfigPath":"","currentFirmwareName":"PROFINET IO Device: Version(3.9, build 0, revision6)","currentInterfaceName":"cifX0:PROFINETIO:Device","expectedInterfaceName":"cifX0:PROFINETIO:Device","expectedFirmwareName":"PROFINET IO Device: Version(3.9,build 0, revision6)","expectedFirmwarePath":"","selectedChannelNumber":"2","selectedDeviceNumber":"1291105","selectedSerialNumber":"20726"}]

Testing the flow and displaying messages

For testing the flow you need a connection to a configured PROFINET IOController which cyclicly exchanges I/O-data with the Edge Gateway. At thePROFINET IO Controller you have to display input data.Ø Verify that the status of the fieldbus node MyOutput displays

Communicating.Ø Click the button to the left of Inject node 1.ð Signal Temperature_2 is set to value 1 and transferred to the

PROFINET IO Controller.Ø Click the button to the left of Inject node 2.ð Signal Temperature_2 is set to value 2 and transferred to the

PROFINET IO Controller.Ø At the PROFINET IO Controller, display the input data in a window.


© Hilscher 2018

Configuring and using the fieldbus node 142/215

11 Configuring and using the fieldbus node

11.1 OverviewThe fieldbus input node allows you to receive data from the fieldbus system(e.g. PROFINET). The fieldbus output node allows you to send data to thefieldbus system. Each fieldbus node needs signals to address data. At first,configure the fieldbus system, then define the signals, and thereafter usesignals for the fieldbus input node or the fieldbus output node.

The fieldbus input node (fieldbus in) receives output datafrom the master:Fieldbus master (e.g. PROFINET IO controller) → fieldbusinput nodeStandard procedure1. Inserting the fieldbus input node2. Configuring the fieldbus system (e.g. PROFINET)3. Defining the signals4. Configuring the fieldbus input nodeThe fieldbus output node (fieldbus out) sends input data tothe master:Fieldbus output node → fieldbus master (e.g. PROFINET IOcontroller)Standard procedure1. Inserting the fieldbus output node2. Configuring the fieldbus system (e.g. PROFINET)3. Defining the signals4. Configuring the fieldbus output node

Table 43: Standard procedure


© Hilscher 2018


The following table shows the sequence of the configuration steps:

Open fieldbus node

Open PROFINET configuration Configure modules

Fieldbus node (configured) Project > Save Define signals

Reconfigure / Update

Deploy

Table 44: Configuration steps


© Hilscher 2018


11.2 Configuring the fieldbus and defining the signals

11.2.1 Creating a new fieldbus configurationThis section describes how to open the fieldbus configuration of the EdgeGateway from Node-RED using the PROFINET configuration as anexample.

Prerequisite

The Node-RED workspace is open.

1. Inserting and opening the fieldbus nodeØ Drag a fieldbus node from the node library and drop it in the workspace.

Ø Double-click the fieldbus node.ð The edit dialog Edit fieldbus in node will be displayed.

Figure 94: Edit dialog “Edit fieldbus in node”

Ø Click on Edit .Ê The edit dialog Add new fieldbus interface config node will be

displayed.


© Hilscher 2018


2. Opening the PROFINET configuration

Ø Click the square to the right of fieldbus interface .Ê The dialog box Add new fieldbus interface config node opens. The

fieldbus interface list is empty if no fieldbus interface has been definedyet.

Figure 95: Dialog box “Add new fieldbus interface config node”

Ê If one or several fieldbus interfaces have already been defined, theinterface/s will be offered for selection in the list.



© Hilscher 2018


Ø Configure the behaviour of the output signals of the fieldbus nodeduring the deploy process: Select Clear output signals on deploy, if during deploy the fieldbusnode should set the output data received by the master to 0. In thiscase, the Edge Gateway can signal 'no valid data' to the master.If this option is cleared, the output data hold their last state duringdeploy. In this case, the master has no information that the EdgeGateway does not process the received data anymore.

Ø Click Open fieldbus configurator .ð The user interface for the fieldbus configuration of the Edge Gateway

will be opened in a new browser window: (the example shows thePROFINET configuration)

Figure 97: PROFINET configuration


© Hilscher 2018


3. Configuring the modulesØ Click IO and signal configuration in the configuration tree (left).Ê The tables Available IO items and IO items will be shown in the

display area and the workspace.

Note:For more information on the tables Available IO items and IOitems (example PROFINET), see IO and signalconfiguration [} page 162].

Ø To select the inputs and outputs to be configured, double-click theappropriate entry in the upper table Available IO items, e.g. 4 byteinput and 8 byte output. Note: Use the scroll bar to display further entries.

Figure 98: Available IO items (Example in figure: PROFINET)

Ê After each double-click, the corresponding entry for defining an input oroutput signal will be displayed immediately in a new line of the lowertable IO items in einer neuen Zeile angezeigt.

Figure 99: IO items (Example: PROFINET)


© Hilscher 2018


4. Defining signalsØ As standard a signal definition is performed during which one single

signal of the data type OctetString will be defined which uses the entireavailable data length. If you wish to have another signal definition, you

can delete this definition (with the button ) anddefine new signals until the available data length is used up (with the

button ).Ø In the table columns Tag and Description, you can enter a short name

and a description for each defined signal.

Note:For more information on the signal definition, see section Definingsignals (procedure) [} page 168].

5. Saving the signal configurationØ Save your signal configuration via the menu function Project > Save.Ø The configuration is prepared.Ø Return to the Node-RED browser window that was originally used.


© Hilscher 2018


6. Reconfigure interface: Transfer firmware and configuration into EdgeGatewayØ Click the button Reconfigure interface in the dialog Add new fieldbus

interface config node.


This is necessary to make sure that the following information on thefieldbus interface in the Edge Gateway can be transmitted later: Firmware,configuration, and signal definitionsØ Click the button Add in the dialog Add new fieldbus interface config

node.Ê This operation causes the transmission of the fieldbus configuration to

the device and the update of the signal definitions to the fieldbus node.

7. DeployØ Perform a Deploy in the Node-RED. For this purpose, select one of the

three options of the selection list Deploy in the Node-RED window (top,right).

ð The flow will thus be transmitted to the Edge Gateway, and the newconfiguration will be applied in the Edge Gateway.


© Hilscher 2018


Message displayed on mismatch between the expected firmware andthe determined firmware

Should you receive a message like the one shown below when you openthe user interface to the fieldbus configuration of the Edge Gateway (afterstep 5), the expected firmware and the actually determined firmware do notmatch (EtherNet/IP Adapter is expected in the example shown, butPROFINET IO Device is actually loaded):

Figure 101: Error message – Firmware mismatch

In that case, check whether the desired firmware is really set underFieldbus interface.

If this is not the case, select the desired firmware in the list Fieldbusinterface and click Reconfigure interface.

Figure 102: Reconfigure interface

Note:For a detailed description of what happens when you click atReconfigure interface, see Loading firmware andconfiguration [} page 156].


© Hilscher 2018


11.2.2 Changing the existing fieldbus configurationThis section describes how to change the existing fieldbus configuration (inthis case PROFINET) des Edge Gateways from Node-RED.

Prerequisites1. The Node-RED workspace is open.2. On the Node-RED screen, there must already be a flow whose

workspace contains a fieldbus node. The node represents the previousfieldbus configuration of the Edge Gateway.

1. Opening the fieldbus node for changingØ In the workspace, double-click on the fieldbus node to be changed. It is

assumed that the node shown in the examples is preconfigured forPROFINET.

Figure 103: Fieldbus node

Ê The edit dialog Edit fieldbus in node will be displayed.

Figure 104: Dialog Edit fieldbus in node


© Hilscher 2018


Ê The selection list Fieldbus Interface displays all fieldbus interfaces thatare already configured. (In addition to that, there is an entry Add newfieldbus interface for adding a new fieldbus interface.)

Figure 105: Dialog Edit fieldbus in node

Ø Select the interface to be changed (in the example this is cifX0PROFINET...).


© Hilscher 2018


2. Opening the PROFINET configuration

Ø Click the square to the right of Fieldbus interface. Ê The dialog box Edit fieldbus interface node opens.

Figure 106: Dialog “Edit fieldbus interface config node”


Ø Click Open fieldbus configurator.

Figure 107: Button Open fieldbus configurator


© Hilscher 2018


ð The user interface for fieldbus configuration of the currently loadedfirmware of the Edge Gateway will be opened in a new browser window:If (as this example shows) PROFINET IO Device is the currently loadedfirmware, the user interface for PROFINET configuration of the EdgeGateway will open, see figure:

Figure 108: Start screen of the user interface for fieldbus configuration of the netIOT EdgeGateway (the example in the figure shows PROFINET)

3. Configuring modulesØ Make your changes in the fieldbus configuration. The possibilities you

have for this purpose are described in the chapters Configurationtree [} page 161] and Menu commands [} page 158].

4. Defining signalsØ If required, adapt the signal definitions as you desire.

5. Saving the signal configurationØ Once you have made all desired changes, save your fieldbus

configuration as described in section Project - Save [} page 159]:Ê The steps to be made in the user interface for fieldbus configuration of

the Edge Gateway are thus completed.Ø Return to the Node-RED browser window that was originally used.


© Hilscher 2018


6. Reconfigure interface: Transfer firmware and configuration into EdgeGatewayØ Click the button Reconfigure interface in the dialogEdit fieldbus interface

config node.

Figure 109: Dialog Edit fieldbus interface node

This is necessary to make sure that the following information on thefieldbus interface in the Edge Gateway can be transmitted later: Firmware,configuration, and signal definitions

Note:For a detailed description of what happens when you click thebutton Reconfigure interface, see Loading firmware andconfiguration [} page 156].


Ø Click the button Update in the dialog Edit fieldbus interface config nodeÊ This operation causes the transmission of the fieldbus configuration (in

this case: PROFINET) to the device and the update of the signaldefinitions to the fieldbus node:


© Hilscher 2018


7. DeployØ Perform a Deploy in the Node-RED. For this purpose, select one of the

three options of the selection list Deploy in the Node-RED window (top,right).

ð The flow will thus be transmitted to the netIOT Edge Gateway, and thenew configuration will be applied in the Edge Gateway.

If the GUI in step 4) could not successfully be started, a message similar tothe following appears:

Figure 110: Error message – Firmware mismatch

That means that the expected firmware and the actually determinedfirmware do not match. Check your settings in such a case!

11.2.3 Loading firmware and configurationThe button Reconfigure interface in the dialog Add new fieldbus interfaceconfig node serves to reconfigure the Edge Gateway completely including afirmware exchange. The previous firmware will be overwritten thereby.

In case of Reconfigure interface the following information will betransmitted to the fieldbus interface in the Edge Gateway:· Firmware· Configuration· Signal definitions


© Hilscher 2018


1. To exchange the firmware in the Edge Gateway for the firmware selectedunder Fieldbus interface, proceed as follows:Ø Click Reconfigure interface.Ê Two messages can appear depending on the situation. If the same

firmware is selected under Currently loaded firmware and Fieldbusinterface, the following message box appears:

Figure 111: Message box firmware already on board

Ê That means that the firmware has not been exchanged. The currentlyloaded firmware as well as its version number, build number, andrevision number are displayed in the message box. If the firmware loaded under Currently loaded firmware and Fieldbusinterface differs, the following message box appears:

Figure 112: Warning: Consequences of reconfiguration

Ê This message draws the attention to the consequences the firmwareexchange will have for the running operation (the networkcommunication of the Gateway will stop, modifications to the networkconfiguration will be lost).

Ø If you are really sure that you want to exchange the firmware althoughyou are aware of the consequences for the running operation, click OK.

ð Clicking OK triggers the following actions:1. The previous firmware will be deleted.2. The bootloader will be loaded into the Edge Gateway.3. The bootloader will be executed to load the selected firmware into the

Edge Gateway.4. The new firmware loaded will be started.


© Hilscher 2018

Configuring PROFINET and defining signals 158/215

12 Configuring PROFINET and defining signals

12.1 User interfaceThe following figure and table describe the elements of the user interface.

3

2 1

Figure 113: PROFINET user interface

Position number Description(1) Display area and workspace(2) Configuration tree(3) PROFINET configuration menu

Table 45: PROFINET configuration user interface

12.2 Menu commandsThe menu bar of the PROFINET configuration of the netIOT Edge Gatewayallows you to· save the configuration in the Edge Gateway (see Project -

Save [} page 159]),· download the GSDML-file from the Edge Gateway (see GSDML

Download [} page 159]),· print the configuration (see Printing the configuration [} page 159]),· call the help page (see Help - Contents [} page 160]), and· display the software version of the configuration GUI (see Help -

Information [} page 160]).


© Hilscher 2018


12.2.1 Project - SaveTo save the configuration in the device, proceed as follows:Ø Click Project > Save

.ð The configuration is saved in the Edge Gateway.

12.2.2 GSDML DownloadThe GSDML file contains the PROFINET properties of the Edge Gatewayand is required for configuring the PROFINET controller. Download theGSDML file from the Gateway so that you can use it in the configurationtool of the PROFINET controller.

To download the GSDML file, proceed as follows:Ø Click Download > GSDML.

ð A dialog to save the GSDML file is displayed.Ø Select a folder and click Save.Ø Use the saved GSDML file to configure the PROFINET Controller.

12.2.3 Printing the configurationTo print configuration and signal definition, proceed as follows:Ø Click Print > Print configuration.

ð The print dialog box will be displayed.Ø Select a printer or an output file and set the printing parameters.ð The current configuration and signal definition will be printed.


© Hilscher 2018


12.2.4 Help - ContentsThe Edge Gateway contains integrated documentation.Ø Click Help > Contents.

ð The integrated documentation is displayed

12.2.5 Help - InformationTo display the version of the PROFINET configuration software of thenetIOT Edge Gateway, proceed as follows:Ø Click Help > Info.

ð The version will be displayed.


© Hilscher 2018


12.3 Configuration treeMenu Submenu Description Details in sectionPROFINETconfiguration

- Shows a note about how to set PROFINETname of station

PROFINETconfiguration [} page 161]

IO and signalconfiguration

- Configuring input and output data. IO and signalconfiguration [} page 162]

depends onconfiguration

Defining signal names. Defining signals(procedure) [} page 168]

Signaldefinitionsoverview

- Displaying defined signal names. Signal definitionsoverview [} page 171]Send signals Displaying defned signal names.

Receive signals Displaying defined input signal names.GSDML filedownload

- Download and displaying the GSDML file. Download of the GSDMLfile [} page 172]

Help Contents Displaying help. Help [} page 172]Info Displaying current software version.

Table 46: PROFINET configuration tree

12.3.1 PROFINET configurationThis page only contains a note on the setting of the PROFINET devicename.

Figure 114: Note: Name of station

Note:In the factory setting of the Edge Gateway the PROFINET devicename (Name of station) is an empty name. Via a PROFINETconnection of the Edge Gateway you assign the PROFINET devicename with an engineering tool of the PROFINET IO controller or astand-alone tool. For this purpose the tools use the DCP protocol.


© Hilscher 2018


12.3.2 IO and signal configurationOn this page you configure the PROFINET input and output modules forthe Edge Gateway. The Edge Gateway is a PROFINET IO device.

The upper table (Available IO items) shows the list of available input andoutput modules. The lower table (IO items) shows the PROFINETconfiguration and is empty at the beginning.

An “IO Item” corresponds to a PROFINET input or output module. The datalength of PROFINET modules differs: Possible lengths are 1, 2, 3, 4, 8, 12,16, 20, 32, 64, 128 and 256 bytes for input or output data. The configuredmodules (“IO Items” in the lower table) are the basis for the signaldefinition.

Figure 115: List of the possible input and output modules

Figure 116: List of the configured input and output modules

The table “IO items” shows you the configured PROFINET input or outputmodules.Column name DescriptionIndex Shows the module index.Name Shows the name of the module.Tag Editable short name required for the signal name. The signal name

addresses the data.Description Editable description of the moduleLength in bytes Shows the module length in bytes.Byte offset Shows the start address of the module (offset in bytes) in the input-

and output data memory. The offset is calculated automatically.Table 47: Contents of the table “IO items”


© Hilscher 2018


DThe column Tag is editable for each module. The Tag is an essential partof the signal name. The following characters are allowed only:· Upper-case letters (A-Z),· lower-case letters (a-z),· numbers (0-9), and· underscore.

Do not enter two or more underscores in succession.

To open the signal configuration of the respective module, double-click anyline.

The following table lists the controls of the table IO Items.Control Description

Moves the marked IO item (module) upward by one line.Note: This changes the PROFINET configuration of the Edge Gateway and has tobe taken into account when configuring the PROFINET controller.Moves the marked IO item (module) downward by one line.Note: This changes the PROFINET configuration of the Edge Gateway and has tobe taken into account when configuring the PROFINET controller.Duplicates the marked IO item (module).Note: This changes the PROFINET configuration of the Edge Gateway and has tobe taken into account when configuring the PROFINET controller.Deletes the marked IO item (module).Note: This changes the PROFINET configuration of the Edge Gateway and has tobe taken into account when configuring the PROFINET controller.This selection allows you to filter the IO items.

· Send/Receive shows you all IO items (modules).

· Send shows you all send IO items (input modules).

· Receive shows you all receive IO items (output module).Each column offers you sort and search functions.To open the list to select from, click the column heading. To activate the filterfunction, enter the text in the filter input field and press the Enter key. You can use* as a wildcard for filtering. To deactivate the filter function again, delete any textentered in the filter input field and press the Enter key.

Table 48: Controls of the table “IO Items”


© Hilscher 2018


12.3.2.1 Signal definition page

On this page you can define the signals for the input and output modules ofthe PROFINET for the Edge Gateway. Signal names are required for thefieldbus node to address PROFINET data.

The table „IO item“ provides information on the selected IO item for whichyou define signals on this page.

Figure 117: Selected IO item (module) for which you define signals

Column name DescriptionIndex Shows the module index.Name Shows the module name.Tag Shows the short name required for the signal name.Length in bytes Shows the module length in bytes.Length in bits Shows the module length in bits.Byte offset Shows the start address of the module (offset in bytes) in the input

and output data memory. The offset will be calculated automatically.Table 49: Contents of table „IO item“

In the table Signals you can configure the signals for an IO item (module).The table shows you the current signal configuration and allows you toenter signal names, lengths and offset addresses.

Figure 118: List of the signal names of an IO item (module)


© Hilscher 2018


Column name DescriptionIndex Shows the module index.Name Shows the module name.Tag Editable short name required for the signal name. The signal name

addresses the data.Description Editable module description.Data type Data type of the signal. You can set the data type only when you

add a new signal.Length in bits Shows the module length in bits.Bit offset Shows the configured start address of the module (offset in bytes)

for a signal within a module.Table 50: Contents of the table „Signals“

The column Tag is editable for each module. The Tag is an essential part ofthe signal name. The following characters are allowed only:· Upper-case letters (A-Z),· lower-case letters (a-z),· numbers (0-9), and· underscore.

Do not enter two ore more underscores in succession.

The following table lists the controls of the table Signals.Controls Description

Moves the marked signal upward by one line.

Moves the marked signal downward by one line.

Adds a new signal. A dialog box for selecting the data type is displayed. You canset the data type of the signal in this dialog box only.

Deletes the marked signal.

Each column offers you sort and search functions.To open the list to select from, click the column heading. To activate the filterfunction, enter the text in the filter input field and press the Enter key. You can use* as a wildcard for filtering. To deactivate the filter function again, delete any textyou have entered in the filter input field and press the Enter key.

Table 51: Controls of the table „Signals“


© Hilscher 2018


12.3.2.2 Data types for signal names

The following table lists the data types for signal names.Name of the datatype

Description Bit length Value range

Bit list List of individual bitsThe number of bits ina list must be amultiple of 8.

1 0 (false), 1 (true)

OctetString Character sequence 8*(n+1)Integer8 Short integer 8 -128 … 127Integer16 Integer 16 -32768 … 32767Integer32 Double integer 32 -231 … +231-1Unsigned8 Unsigned short

integer8 0 … 255

Unsigned16 Unsigned integer /Word

16 0 …65535

Unsigned32 Unsigned doubleinteger

32 0 … +232-1

Float32 Floating point 32 ≈ -/+ 1038

Float64 Long Float 64 ≈ -/+ 10308

Table 52: Data types for signal names

12.3.2.3 Structure of the signal names

Signal names address the fieldbus data.

General structure of the signal names

Signal names have the following structure:· input~module_tag~signal_tag· output~module_tag~signal_tag

For a bit list the signal names have the following structure:· input~module_tag~bitlist_signal_tag· output~module_tag~bitlist_signal_tag

Parts of the signal name1. The prefix input or output is produced automatically.2. The tilde (~) separates the prefix and the module_tag.3. You can enter the name for module_tag as described in section

Configuring I/O [} page 167].4. The tilde (~) separates the module_tag and the signal_tag or the

module_tag and the bitlist_signal_tag.5. You can enter the name for signal_tag or bitlist_signal_tag as

described in section Defining signals (procedure) [} page 168].


© Hilscher 2018


12.3.2.4 Configuring I/O

The upper table (Available IO items) displays the list of the possible(selectable) input and output modules. The lower table (IO items) displaysthe PROFINET configuration and is empty at the beginning.

1. Inserting the IO item (module):Ø To insert the required IO item into the „IO item“ list, double-click the IO

item in the „Available IO item“ list.Ê The respective IO item will be inserted at the end of the list, if no „IO

Item“ line has been marked, or before a marked „IO item“ line.

Figure 119: List of the configured input and output modules

2. Entering the tag for the IO item:Ø Enter a name for each IO item in the column Tag using the characters

A‑Z, a‑z, 0‑9 and _ (underscore) only.Ê The name (Tag) is used for the signal name to address the data.

3. Entering the description of the IO item (optional):Ø In the column Description you can enter a text (e.g. temperature

sensor) which helps you describe the use of the data.Ê This description is used only if you print the signal list.

4. Configuring PROFINET:Ø Repeat steps 1‑3 until all required IO items (modules) are inserted into

the „IO Item“ list.ð The PROFINET configuration is prepared.

5. Saving the configuration:Ø To save the PROFINET configuration in the Edge Gateway, click

Project > Save.ð The PROFINET configuration in the Edge Gateway is saved, but not

active yet.Ø To activate the PROFINET configuration, you have to click

Reconfigure in the fieldbus node as soon as you have finished thePROFINET configuration.

In the next step define the signal names as described in section Definingsignals (procedure) [} page 168].


© Hilscher 2018


12.3.2.5 Defining signals (procedure)

Each IO item (module) contains one or more bytes for input or output data.To enable the fieldbus node to access the input or output data, you have toselect a signal at the fieldbus node. You can use the predefined signalname or define your own signal name.

The upper table (IO item) shows the IO item (module) for which you candefine signals on this page. For defining signals, use the lower table(Signals).

Each IO item (module) already has a predefined signal. The predefinedsignal comprises and addresses the entire IO item (module). If you want toaccess a „part“ of the IO item, you can define a new signal for this purpose.

Example 1: The IO item contains 16 bytes. If you want to access eachsingle byte, define 16 signals of data type byte each.

Example 2: The IO item contains 2 bytes that correspond to 16 digital inputor outputs. If you want to access each single bit, define 16 signals of datatype bit each.

Defining your own (new) signals1. Selecting the IO item (module):

Ø Select the IO item (module) for which you want to define signal namesin the configuration tree under IO and signal configuration.

Ê The selected IO item is displayed in the workspace.

2. Deleting the predefined signal:Ø Mark the predefined signal in the table Signals.Ø Click Delete selected items.

Ê The predefined signal is deleted and you can define your own signals.


© Hilscher 2018


3. Adding new signals:Ø Click Add new signals.

Ê The dialog box Add new Signals for selecting the data type isdisplayed.

4. Configuring signals:Ø Select the data type for the signal. The list of data types is described in

section Data types for signal names [} page 166].Ø Select the quantity. The possible values you can select depend on the

selected data type and the number of input or output bytes to which nosignal name has been assigned yet.

Ø To have an identical beginning for all signal names, enter a text in theinput field Tag name base. The extension „_1“, „_2“, etc. will be addedautomatically, if you have entered a value greater than 1 under"Quantity".

Ø Click OK.ð The new signal/s is/are defined and will be displayed in the table

Signals.

5. Modifying signals subsequently:Ø If required, you can subsequently modify the signal names in the

column Tag of the table Signals.Ø If required, you can enter a signal description in the column

Description of the table Signals.

6. Defining signals:Ø Repeat steps 1‑5 until you have defined all required signals.ð The signal definition is prepared.


© Hilscher 2018


7. Saving the configuration and signal definition:Ø To save the configuration and signal definition in the Edge Gateway,

click Project > Save.ð The configuration and signal definition in the Edge Gateway is saved,

but not active yet.Ø Click Update in the fieldbus node so that the fieldbus node reads the

signal definition again.Ø To activate the configuration, click Reconfigure in the fieldbus node as

soon as you have finished or changed the configuration.

The name in the column Tag is a part of the signal name and is describedas Signal_tag or Bitlist_signal_tag in section Structure of the signalnames [} page 166].


© Hilscher 2018


12.3.3 Signal definitions overviewThis page displays the list of the defined signals in the table „Send andReceive signals“. You can limit the display of the signals to send signals orreceive signals. The signal names on these pages are not editable.

Figure 120: List of the send and receive signals

If a module contains one or more signals, these signals will be displayedunder the respective module.Column names DescriptionIndex Shows the index of the module (3-digit) or signal (1 to 3 digits).Name Shows the name of the module or signal.Tag Short name required for the signal name. The signal name

addresses the data.Data type Sows the data type of the module or signal.Length in bits Shows the length of the module or signal in bits.Byte offset Shows the start address (offset in bytes) for a module in the input-

or output data memory. The offset will be calculated automatically.Bit offset Shows the configured start address (bit offset) for a signal within a

module.Table 53: Columns of the table of the send and receive signals

You can print the table using Print > Print configuration.


© Hilscher 2018


12.3.4 Download of the GSDML fileOn this page you can· display the contents of the GSDML file and· save the GSDML file on your PC (download).

The GSDML file contains the PROFINET properties of the Edge Gatewayand is required for configuring the PROFINET controller. Download theGSDML file from the Gateway so that you can use it in the configurationtool of the PROFINET controller.

Display of the GSDML file

The GSDML file is not editable in this window. The contents of the GSDMLfile is represented in different colors:· Violet: Names of elements.· Black: Texts.· Black and bold: Names of attributes.· Red: Values of attributes.

Download of the GSDML fileØ click on the ZIP file. The ZIP file contains the device description file

GSDML-V2.31-HILSCHER-NIOT-E-TIB100-GB-RE-xxxxxxxx.xmlÊ Your PC displays a dialog for saving the GSDML file.Ø Select a folder and click Save.Ø Use the saved GSDML file to configure the PROFINET Controller.

12.3.5 Help

Contents

Page with the contents of the online help (currently empty)

Info

This page displays the version of the PROFINET configuration software.


© Hilscher 2018

Configuring EtherNet/IP and defining signals 173/215

13 Configuring EtherNet/IP and defining signals

13.1 User interfaceThe following figure and table describe the elements of the user interface.

3

2 1

Figure 121: EtherNet/IP user interface

Position number Description(1) Display area and workspace(2) Configuration tree(3) EtherNet/IP configuration menu

Table 54: EtherNet/IP configuration user interface

13.2 Menu commandsThe menu bar of the EtherNet/IP configuration of the netIOT Edge Gatewayallows you to· save the configuration in the Edge Gateway (see Project -

Save [} page 174]),· print the configuration (see Printing the configuration [} page 175]),· download the EDS file from the Edge Gateway (see EDS

Download [} page 174]),· call the help page (see Help - Contents [} page 175]), and· display the software version of the configuration GUI (see Help -

Information [} page 175]).


© Hilscher 2018


13.2.1 Project - SaveTo save the configuration data in the device, proceed as follows:Ø Click Project > Save.

ð The configuration will be saved within the Edge Gateway.

13.2.2 EDS DownloadThe EDS file contains the Ethernet/IP properties of the Edge Gateway andis required for configuring the Ethernet/IP Scanner. Download the EDS filefrom the Edge Gateway in order to use it in the configuration tool of theEthernet/IP Scanner.

To download the EDS file, proceed as follows:Ø Click Download > EDS.

A dialog for saving the EDS file will be displayed.Ø Select a folder and then click Save.Ø Use the saved EDS file to configure the EtherNet/IP Scanner.


© Hilscher 2018


13.2.3 Printing the configurationTo print configuration and signal definition, proceed as follows:Ø Click Print > Print configuration.

ð The print dialog box will be displayed.Ø Select a printer or an output file and set the printing parameters.ð The current configuration and signal definition will be printed.

13.2.4 Help - ContentsThe Edge Gateway contains integrated documentation.Ø Click Help > Contents.

ð The integrated documentation is displayed.

13.2.5 Help - InformationTo display the version of the EtherNet/IP configuration software of thenetIOT Edge Gateway, proceed as follows:Ø Click Help > Info.

ð The version will be displayed.


© Hilscher 2018


13.3 Configuration treeMenu Submenu Description Details in sectionEtherNet/IPconfiguration

- Setting IP address (using DHCP, BOOTP ordirect input)

EtherNet/IPconfiguration [} page 176]

IO and signalconfiguration

- Configuring input and output data. IO and signalconfiguration [} page 177]

(depends onconfiguration)

Defining signal names. Defining signals(procedure) [} page 183]

Signaldefinitionsoverview

- Displaying defined signal names. Signal definitionsoverview [} page 185]Send signals Displaying defined send signal names.

Receive signals Displaying defined receive signal names.EDS filedownload

- Download of EDS file and contents of EDS file. Download of the EDSfile [} page 186]

Help Contents Displaying online help. Help [} page 187]Info Displaying current software version.

Table 55: EtherNet/IP configuration tree

13.3.1 EtherNet/IP configuration

Figure 122: IP Settings

This page allows to define the method used for assigning an IP address tothe Edge Gateway. This assignment can be accomplished eitherautomatically via DHCP or BOOTP or manually by specifying the followinginformation:· IP address of Edge Gateway· Network mask of Edge Gateway· IP address of the gateway, to which the Edge Gateway is connected

within the IP network

Parameters for setting the IP addressesParameter DescriptionDHCP Activate/ deactivate DHCP protocol in order to configure the IP address

via DHCP.BootP Activate/ deactivate BootP protocol in order to configure the IP address

via BootP.Fixed Address Activate/ deactivate a fixed IP configurationIP address Specify the IP address of the Edge Gateway when configuring IP

settings manually.Network mask Specify the network mask of the Edge Gateway when configuring IP

settings manually.Gateway If necessary, specify the gateway address of the IP gateway here.

Table 56: Parameters for setting the IP addresses


© Hilscher 2018


If multiple options have been checked, these are evaluated in the followingsequence:1. DHCP2. BOOTP3. Fixed IP settings

13.3.2 IO and signal configurationOn this page, you configure the send and receive assemblies for EtherNet/IP within the Edge Gateway. The Edge Gateway works as an EtherNet/IPAdapter

In the context of EtherNet/IP, an „IO Item“ corresponds to an EtherNet/IPsend or receive assembly.

The upper table (Available IO items) displays the list of the possible(selectable) send and receive assemblies:· The Send Assembly (IO item Send, Instance ID usually 100) acts as a

producer and transmits data from the application to the network.· The Receive Assembly (IO item Receive, Instance ID usually 101) acts

as a consumer and transmits data from the network to the application.

At maximum, one send and one receive assembly can be configured.EtherNet/IP assemblies have a configurable data length: possible lengthsrange from 1 up to 504 Byte each for send and receive data (see columnsMin_length and Max_length).

The lower table (IO items) displays the EtherNet/IP configuration and isempty at the beginning.

The configured assemblies („IO Items“ in the lower table) are the basis forthe signal definition. They are displayed in the lower table below “IO Items”.

Figure 123: List of the possible send and receive assemblies

Figure 124: List of the configured send and receive assemblies

The table „IO items“ shows you the currently configured EtherNet/IP sendand receive assemblies.


© Hilscher 2018


Column name DescriptionIndex Shows the index of the assembly.Name Shows the name of the assembly.Tag Editable short name required for the signal name. The signal name

addresses the data.Description Editable description of the assembly.Data length Contains the length of the assembly in bytes.Byte offset Shows the start address of the assembly (offset in bytes) in the

input- and output data memory. The offset is calculatedautomatically.

Table 57: Contents of the table „IO items“

The column Tag is editable for each assembly. The Tag is an essential partof the signal name. The following characters are allowed only:· Upper-case letters (A-Z),· lower-case letters (a-z),· numbers (0-9), and· the underscore.


To open the signal configuration of the respective assembly, double-clickany line.

The following table lists the controls of the table IO Items.Control Description

Moves the marked IO item (module) upward by one line.

Moves the marked IO item (module) downward by one line.

Without function.

Deletes the marked IO item (module).Note: This changes the EtherNet/IP configuration of the Edge Gateway and has tobe taken into account when configuring the EtherNet/IP Scanner.This selection allows you to filter the IO items.

· Send/Receive shows you all IO items (modules).

· Send shows you all send IO items (input assemblies).

· Receive shows you all receive IO items (output assembly).Each column offers you sort and search functions.To open the list to select from, click the column heading. To activate the filterfunction, enter the text in the filter input field and press the Enter key. You can use* as a wildcard for filtering. To deactivate the filter function again, delete any textentered in the filter input field and press the Enter key.

Table 58: Controls of the table „IO Items“


© Hilscher 2018


13.3.2.1 Signal definition page

On this page, you can define the signals for the input and outputassemblies of the EtherNet/IP for the Edge Gateway. Signal names arerequired for the fieldbus node to address EtherNet/IP data.

The table „IO item“ provides information on the selected IO item for whichyou define signals on this page.

Figure 125: Selected IO item (assembly) for which you define signals

Column name DescriptionIndex Shows the index of the assembly.Name Shows the name of the assembly.Tag Editable short name required for the signal name.Length in bytes Contains the length of the assembly in bytes.Length in bits Shows the length of the assembly in bits.Byte offset Shows the start address of the assembly (offset in bytes) in the

input- and output data memory. The offset is calculatedautomatically.

Table 59: Contents of the table „IO items“

In the table Signals you can configure the signals for one IO item(assembly). The table shows you the current signal configuration andallows you to enter signal names, lengths and offset addresses.

Figure 126: List of the signal names of an IO item (assembly)


© Hilscher 2018


Column name DescriptionIndex Shows the index of the assembly.Name Shows the name of the assembly.Tag Editable short name required for the signal name. The signal name

addresses the data.Description Editable description of the assembly.Data type Data type of the signal. You can set the data type only when you

add a new signal.Length in bits Shows the assembly length in bits.Bit offset Shows the configured start address for a signal within the assembly

(offset in bytes).Table 60: Contents of the table „IO items“

The column Tag is editable for each signal. The Tag is an essential part ofthe signal name. The following characters are allowed only:· Upper-case letters (A-Z),· lower-case letters (a-z),· numbers (0-9), and· the underscore.


The following table lists the controls of the table Signals.Control Description

Moves the marked signal upward by one line.

Moves the marked signal downward by one line.

Adds a new signal. A dialog box for selecting the data type is displayed. You canset the data type of the signal only in this dialog box.

Deletes the marked signal(s).

Each column offers you sort and search functions.To open the list to select from, click the column heading. To activate the filterfunction, enter the text in the filter input field and press the Enter key. You can use* as a wildcard for filtering. To deactivate the filter function again, delete any textyou have entered in the filter input field and press the Enter key.

Table 61: Controls of the table „Signals“


© Hilscher 2018


13.3.2.2 Data types for signal names

The following table lists the data types for signal names.Name of data type Description Length in bits Allowed value rangebit list List of single bits

The number of bits inthe list must be amultiple of 8.

1 0 (false), 1 (true)

octetString String of octets(bytes)

8*(n+1)

signed8 Short signed integer 8 -128 … 127signed16 Signed integer 16 -32768 … 32767signed32 Double signed integer 32 -231 … +231-1unsigned8 Unsigned short

integer8 0 … 255

unsigned16 Unsigned integer /Word

16 0 …65535

unsigned32 Unsigned doubleinteger

32 0 … +232-1

real32 Real (Floating point ) 32 ≈ -/+ 1038

real64 Long real 64 ≈ -/+ 10308

Table 62: Data types for signal names

13.3.2.3 Structure of the signal names

Signal names address the fieldbus data.

General structure of the signal names

Signal names have the following structure:· input~Modul_Tag~Signal_Tag· output~Modultag~Signal_Tag

For a bit list, the signal names have the following structure:· input~Modul_Tag~Bitlisten_Signal_Tag· output~Modul_Tag~Bitlisten_Signal_Tag

Parts of the signal name1. The prefix input or output is produced automatically.2. The tilde (~) separates the prefix and the assembly_tag.3. You can enter the name for assembly_tag as described in section

Configuring I/O [} page 182].4. The tilde (~) separates the assembly_tag and the signal_tag or the

assembly_tag and the bitlist_signal_tag.5. You can enter the name for signal_tag or bitlist_signal_tag as

described in section Defining signals (procedure) [} page 183].


© Hilscher 2018


13.3.2.4 Configuring I/O

The upper table (Available IO items) displays the list of the possible(selectable) send and receive assemblies: The lower table (IO items)displays the EtherNet/IP configuration and is empty at the beginning.

1. Inserting the IO item (assembly):Ø To insert the required IO item into the „IO item“ list, double-click the IO

item in the „Available IO item“ list.Ê The respective IO item will be inserted at the end of the list, if no „IO

Item“ line has been marked, or before a marked „IO item“ line.

Figure 127: List of the configured send and receive assemblies

2. Entering the tag for the IO item:Ø Enter a name for each IO item in the column Tag using the characters

A‑Z, a‑z, 0‑9 and _ (underscore) only.Ê The name (Tag) is used for the signal name to address the data.

3. Entering the description of the IO item (optional):Ø In the column Description you can enter a text (e.g. temperature

sensor) which helps you describe the use of the data.Ê This description is used only if you print the signal list.

4. Configuring EtherNet/IP:Ø Repeat steps 1‑3 until all required IO items (assemblies) are inserted

into the „IO Item“ list.ð The EtherNet/IP configuration is prepared.

5. Saving the configuration:Ø To save the EtherNet/IP configuration in the Edge Gateway, click

Project> Save.ð The EtherNet/IP configuration in the Edge Gateway is saved, but not

active yetØ To activate the EtherNet/IP configuration, you have to click

Reconfigure in the fieldbus node as soon as you have finished theEtherNet/IP configuration.

In the next step define the signal names as described in section Definingsignals (procedure) [} page 183].


© Hilscher 2018


13.3.2.5 Defining signals (procedure)

Each IO item (assembly) contains one or more bytes for input or outputdata. To enable the fieldbus node to access the input or output data, youhave to select a signal at the fieldbus node. You can use the predefinedsignal name or define your own signal name.

The upper table (IO item) shows the IO item (assembly) for which you candefine signals on this page. For defining signals, use the lower table(Signals).

Each IO item (assembly) already has a predefined signal. The predefinedsignal comprises and addresses the entire IO item (assembly). If you wantto access a „part“ of the IO item, you can define a new signal for thispurpose.

Example 1: The IO item contains 16 bytes. If you want to access eachsingle byte, define 16 signals of data type byte each.

Example 2: The IO item contains 2 bytes that correspond to 16 digital inputor outputs. If you want to access each single bit, define 16 signals of datatype bit each.

Defining your own (new) signals1. Selecting the IO item:

Ø Select the IO item for which you want to define signal names in theconfiguration tree under IO and signal configuration.

Ê The selected IO item is displayed in the workspace.

2. Deleting the predefined signal:Ø Mark the predefined signal in the table Signals.Ø Click Delete selected items.

Ê The predefined signal is deleted and you can define your own signals.


© Hilscher 2018


3. Adding new signals:Ø Click Add new signals.

Ê The dialog box Add new Signals for selecting the data type isdisplayed.

Ê Configuring signals:Ø Select the data type for the signal. The list of data types is described in

section Data types for signal names [} page 181].Ø Select the quantity. The possible values you can select depend on the

selected data type and the number of input or output bytes to which nosignal name has been assigned yet.

Ø To have an identical beginning for all signal names, enter a text in theinput field Tag name base. The extension „_1“, „_2“, etc. will be addedautomatically, if you have entered a value greater than 1 under"Quantity".

Ø Click OK.ð The new signal/s is/are defined and will be displayed in the table

Signals.

4. Modifying signals subsequently:Ø If required, you can subsequently modify the signal names in the

column Tag of the table Signals.Ø If required, you can enter a signal description in the column

Description of the table Signals.

5. Defining signals:Ø Repeat steps 1‑5 until you have defined all required signals.ð The signal definition is prepared.


© Hilscher 2018


6. Saving the configuration and signal definition:Ø To save the configuration and signal definition in the Edge Gateway,

click Project > Save.ð The configuration and signal definition in the Edge Gateway is saved,

but not active yet.Ø Click Update in the fieldbus node so that the fieldbus node reads the

signal definition again.Ø To activate the configuration, click Reconfigure in the fieldbus node as

soon as you have finished or changed the configuration.

The name in the column Tag is a part of the signal name and is describedas Signal_tag or Bitlist_signal_tag in section Structure of the signalnames [} page 181].

13.3.3 Signal definitions overviewAn overview on the current signal definitions is displayed on page “SignalDefinitions Overview”. This page displays the list of the defined signals inthe table „Send and Receive signals“. You can restrict the display of thesignals to send signals or receive signals. The signal names on thesepages are not editable.

Figure 128: List of the send and receive signals

If an assembly contains one or more signals, these signals will be displayedunder the respective assembly.


© Hilscher 2018


Column names DescriptionIndex Shows the index of the assembly (3-digit) or signal (1 to 3 digits).Name Shows the name of the assembly or signal.Tag Short name required for the signal name. The signal name

addresses the data.Data type Shows the data type of the assembly or signal.Length in bits Shows the length of the assembly or signal in bits.Byte offset Shows the start address (offset in bytes) for an assembly in the

input- or output data memory. The offset will be calculatedautomatically.

Bit offset Shows the configured start address (bit offset) for a signal within anassembly.

Table 63: Columns of the table of the send and receive signals

You can print this table using Print > Print configuration.

13.3.4 Download of the EDS fileOn this page you can· display the contents of the EDS file and· save the EDS file on your PC (download).

The EDS file contains the Ethernet/IP properties of the Edge Gateway andis required for configuring the Ethernet/IP Scanner. Download the EDS filefrom the Edge Gateway in order to use it in the configuration tool of theEthernet/IP Scanner.

Display of the EDS file

The EDS file is not editable in this window.

Download of the EDS fileØ Click the file with the extension .ZIP. The ZIP file contains the device

description fileHILSCHER NIOT-E-TIB100-GB-RE EIS V1.1.EDS

Ê A dialog for saving the ZIP file is displayed.Ø Select Save and then click on OK.Ø Select a folder and click Save.Ø Extract the ZIP file to get the EDS file.Ø Use this EDS file to configure the EtherNet/IP Scanner.


© Hilscher 2018


13.3.5 Help

Contents

Opens a page offering access to the contents of the online help system.See Help - Contents [} page 175].

Info

This page only displays the current version of the EtherNet/IP configurationsoftware. See Help - Information [} page 175].


© Hilscher 2018

Edge Server 188/215

14 Edge ServerThis chapter describes the Edge Server for Hilscher Edge GatewaysVersion 0.4.x and higher and explains the following topics:· Communication, functions and internal structure of the Edge Server

(see chapter Function principle [} page 188])· The Edge Server Control Center [} page 193]· The Configuration of the Edge Server [} page 196]

14.1 Function principleThe Edge Server· is a software component that has been developed by Hilscher and is

executed under the Linux operating system of the Edge Gateway.· enables secure and capsuled access from the IT-network to functions

and protocols embedded within the Edge Gateway via a REST API.From the IT network means here, e.g. from the cloud or an applicationon a mobile device (e.g. a mobile phone) or also from the EdgeGateway itself via functions of the integrated Node-RED application..

· is a secure link between Web-applications and the OT-network thatallows only indirect access to the OT-network via the provided EdgeServer services and functions.In any way, direct access to the OT-network, which would counteract the security concept of the EdgeGateway is not possible.

· allows access to processes having been prepared in an automated way,e.g.– the scan of the field devices of the OT-network (automation network)– or the identification of the topology.

· is used for acquiring the status of the OT network and the field devicesconnected with this network and to provide it in JSON format forapplications performing further processing..

14.1.1 Communication with IT-network and mobile devicesA REST API (also called RESTful API or RESTful interface) is aprogramming interface (API) which uses HTTP-requests like GET, PUT,POST and DELETE to access data between a web-based client and aserver. The abbreviation REST stands for Representational State Transfer,API for Application Programming Interface.

The Edge Server uses a REST API to provide the client with its services.The client application uses this REST API to communicate with the EdgeServer. The Edge Server communicates exclusively via the secure ProtocolHTTPS limiting the communication to the services GET, POST, and PUT.

The following figure shows the Edge Server structure:


© Hilscher 2018

Edge Server 189/215

Figure 129: Edge Server structure

Note:For more information on the protocol HTTPS, see https://en.wikipedia.org/wiki/HTTPS, on REST APIs, see https://en.wikipedia.org/wiki/Representational_State_Transfer.


© Hilscher 2018

https://en.wikipedia.org/wiki/HTTPS

https://en.wikipedia.org/wiki/HTTPS

https://en.wikipedia.org/wiki/Representational_State_Transfer

https://en.wikipedia.org/wiki/Representational_State_Transfer

Edge Server 190/215

14.1.2 Communication with the OT-networkTo communicate with the connected OT-network the Edge Server uses,among other protocols, the protocols SNMP (Simple Network ManagementProtocol) and ARP (Address Resolution Protocol). In addition to this,PROFINET protocols are used for communication with PROFINET devices,and an IO-Link UDP protocol transmitting encapsulated IO-Link data isused for communication with IO-Link master devices in the OT-network.

Note:see Configuration of the Edge Server [} page 196] Concerning SNMP, see https://de.wikipedia.org/wiki/Simple_Network_Management_Protocol. Concerning ARP, see https://de.wikipedia.org/wiki/Address_Resolution_Protocol.

14.1.3 Access rights to the REST APIAccess to the REST API is governed by rights as follows:1. In order to request data from the Edge Server using the REST API

(HTTP method GET), read access rights are required.2. In order to make changes within the Edge Server using the REST API

(HTTP methods PUT and POST), write access rights are required.3. You can check whether you have the required access rights via the

menu entry User profile [} page 64].4. Granting read and right access rights requires administrator rights and

is described in section Managing user roles [} page 58].


© Hilscher 2018

https://de.wikipedia.org/wiki/Simple_Network_Management_Protocol

https://de.wikipedia.org/wiki/Simple_Network_Management_Protocol

https://de.wikipedia.org/wiki/Address_Resolution_Protocol

https://de.wikipedia.org/wiki/Address_Resolution_Protocol

Edge Server 191/215

14.1.4 Functions of the Edge ServerVia its REST API the Edge Server provides functions from the groupsDEVICE (device handling), FILE (file handling), GATEWAY (information ongateway), PROGRESS (information on progress), TOPOLOGY (informationon topology), and USER (user login) for access from the IT-network:Group Function Method

(HTTPS)Name

DEVICEdevicehandling

Reading device information GET /device/info

Setting device information POST /topology/device/infoDetailed device list withadditional information

GET /device/list

Reading parameters GET /device/parameterWriting parameters POST /device/parameterReading parameter list GET /device/parameter/listCyclic reading of process data orreading of parameters

GET /device/processData

Cyclic writing of process data orwriting of parameters

POST /device/processData

List of process data GET /device/processData/listFILEfile handling

File-upload (firmware,configuration, device descriptionfiles, general data)

PUT /file

GATEWAY information onthe gateway

Information on installedpackages and internal modules

GET /gateway/package/info

Access to product data GET /gateway/infoPROGRESSinformation onprogress

Request of progress informationon running tasks

GET /progress

TOPOLOGYinformation ontopology

List of topology scan resultswithin a defined period

GET /topology/networkScanList

Output of a network status list GET /topology/networkStatus/list

USERuser login

Authentication of the app POST /user/loginLogout request POST /user/logout

Table 64: Functions of the Edge Server

Note:For a detailed description of the functions and parameters providedby the netIOT Edge Server API, see http://www.netiot.com/external/stkit-doku/.


© Hilscher 2018

http://www.netiot.com/external/stkit-doku/

Edge Server 192/215

14.1.5 Internal structure of the Edge ServerThe following figure shows the environment of the Edge Server for theEdge Gateways:

Figure 130: Edge Server environment

The following figure shows the internal structure of the Edge Server for theEdge Gateways:

Figure 131: Internal structure of the Edge Server


© Hilscher 2018

Edge Server 193/215

14.2 Edge Server Control Center

14.2.1 Starting the Edge Server Control CenterThe Edge Server Control Center is a tool for commissioning andadministrating the Edge Server. It can be started via the netIOT EdgeServer Icon within the Edge Gateway Manager (see Edge GatewayManager [} page 22]).

Figure 132: netIOT Edge Server icon within the Edge Gateway Manager

14.2.2 FunctionsThe Edge Server Control Center provides the following functions:· Information on the Edge Server· Configuration of the Edge Server· List of services· Scan protocols of field devices


© Hilscher 2018

Edge Server 194/215

14.2.3 Service listThe service list contains valuable information on the components of theEdge Server. To display the service list, proceed as follows:Ø Select entry Service list in menu Services.ð The service list is displayed. Each listed service represents an installed

component of the Edge Server.

Figure 133: Edge Server Control Center

The left part of the window lists all services with their name and a symbolindicating the current state of operation of the service.Symbol Meaning

RunningService is running

InfoFor this service, an informative message has been stored (see below).

Warning For this service, a warning message has been stored.

Error For this service, an error message has been stored.

Table 65: Symbols for the state of operation in the service list


© Hilscher 2018

Edge Server 195/215

You can select one of these services in the left part of the window. A bluebar marks the currently selected service. The right part of the windowadditionally shows the following data concerning the selected service:· Name of service / component· Operating status (displayed as text)· Last information· Version· Description· Information on the author


© Hilscher 2018

Edge Server 196/215

14.3 Configuration of the Edge ServerFor the configuration of the Edge Server, the following two steps arenecessary in this order:1. The configuration of the used IP address area

(see The configuration of IP address area [} page 196])2. The configuration of field devices

(see Selecting the protocols to scan for field devices [} page 199])

14.3.1 The configuration of IP address areaTo configure the IP address range used, proceed as follows:Ø Open the menu System in the Edge Server Control Center and select

menu entry Configuration.Ê The configuration screen page displays the settings for the server

configuration.

Figure 134: Server configuration


© Hilscher 2018

Edge Server 197/215

Ø Click Scanning in the left column.Ê The screen page for the scan settings (Scanning) is displayed:

Figure 135: Configuration of the scan settings

Ø Here you can define several address ranges. To create a new input line

for entering an IP-address range click . Makesure, that an entered IP-address range falls into the IP-address range ofthe OT-network to allow the scanning of the connected devices.

Ø Under Start address enter the start address of the IP-address range,e.g. 192.168.0.1.

Ø Under End address enter the end address of the IP-address range,e.g. 192.168.0.8.

Note:For configuring the Edge Gateway, we strongly recommend you toset cifX0 to the IP-address 192.168.0.8. For the correctconfiguration of the IP-address range, the entered IP-addressesmust fall into the range of the cifX0 network and its IP-address.


© Hilscher 2018

Edge Server 198/215

Ø To save your settings in the Edge Server, click .ð Now, the screen page for the scan settings should look like that:

Figure 136: Correct configuration of the scan settings


© Hilscher 2018

Edge Server 199/215

14.3.2 Selecting the protocols to scan for field devicesThe protocols used to scan the individual field devices in the set IP-addressrange are set in the Edge Server Control Center.

To activate or deactivate individual protocols:Ø Select menu entry Scanning in menu Services within the Edge Server

Control CenterÊ The protocol configuration will be displayed:

Figure 137: Scan protocol configuration

Ø On this page, you can set the scan protocols to be active or inactiveindividually for each address of the configured IP-address range. Forthe basic registration of the field devices, you should activate the scanprotocols SNMP and ARP.

Note:Check the boxes IO-Link or PROFINET for IP-addresses in theconfigured IP-address range only if the corresponding IO-Linkmaster devices or PROFINET devices are connected andconfigured.

Ø To save your settings in the Edge Server, click .ð Thus, your scan protocol settings of the field devices are saved.


© Hilscher 2018

Technical data 200/215

15 Technical data

15.1 Technical Data NIOT-E-TIB100-GB-RENIOT-E-TIB100-GB-RE Parameter ValueProduct Part number 1321.200

Application For demanding IoT applications with larger quantityscale. Sufficient performance reserve for futureapplication expansions. Node-RED as basis, nativecloud connectors* as option.

Functions Services for IoT data mining anddistribution

Node-RED: MQTT Broker/Client, OPC UA Client, serial

Data connection, processing andcloud connectivity

Node-RED, IBM Watson, Azure IoT Hub, native cloudconnectors*

Web services (REST) OT network scan, diagnostics, device statusSecurity Booting Booting of signed software

Access HTTPS, TLSProcessors CPU 1.33 GHz Atom®, Intel® E3805Software Operating system Security Enhanced Linuxmemory RAM 2 GB DDR3 RAM

Flash memory 16 GB eMMC Flash memory8 GB application8 GB backup

Power Voltage 12 V DC ± 2.4 V DC or 24 V DC ± 4.8 V DCCurrent (at 24 V DC) 750 mAPower of the used power supplyunit

18 W

Connector 3-pin terminal blockIT interface Interface type 2 x 10/100/1000 Mbit, Intel® I210AT

LAN connector 2 x RJ45 socketOT interface OT network PROFINET IO-Device, EtherNet/IP Adapter

In listening mode: PROFINET, EtherCAT, EthernetInterface type 10BASE-T/100BASE-TX, potential free, Hilscher netX

100Connector 2 x RJ45 socket

Interfaces USB 1 x USB 2.0 (500 mA) 1 x USB 3.0 (900 mA)

Wi-Fi 802.11n (Option \WF only), flexible antenna connectionSerial interface 1 x RS-232/485 (can be configured)Display connection -

Display LED display 8 LEDsReal-time clock Buffering yes, battery (service interval 10 years)Environment Ambient temperature range for

operation-20°C ... +65°C with air flow

Ambient temperature range forstorage

-20°C ... +80°C

Humidity range 10 % … 95 % relative humidity (non-condensing)Device Dimensions 120 mm (H) x 63 mm (W) x 106 mm (D), without

antennaWeight 600 gHousing MetalMounting top hat railFan fanless


© Hilscher 2018


NIOT-E-TIB100-GB-RE Parameter ValueConformity RoHS YesConformance with EMCdirectives

CE sign Yes

Shock and vibrationresistance

Shock resistance 50 G, half sine, 11 ms, IEC 60068-2-27Vibration resistance Random: 2 Grms @ 5~500 Hz, IEC 60068-2-64

Sinusoidal: 2 Grms @ 5~500 Hz, IEC 60068-2-64* usable with netIOT service product only (NIOT-S-LIC-xxx)

Table 66: Techncal data NIOT-E-TIB100-GB-RE


© Hilscher 2018


15.2 Technical data PROFINET IO DeviceParameter DescriptionMaximum number of cyclic input data 1440 BytesMaximum number of cyclic output data 1440 BytesMaximum number of submodules 255 submodules per Application Relation at the same time, 1000

submodules can be configuredMultiple Application Relations (AR) The Stack can handle up to 2 IO-ARs, one Supervisor AR and one

Supervisor-DA AR at the same time.Supported protocols RTC – Real Time Cyclic Protocol, Class 1 (unsynchronized), Class 3

(synchronized)RTA – Real Time Acyclic ProtocolDCP – Discovery and configuration ProtocolCL-RPC – Connectionless Remote Procedure CallLLDP – Link Layer Discovery ProtocolSNMP – Simple Network Management ProtocolMRP – MRP Client

Topology recognition LLDP, SNMP V1, MIB2, physical deviceIdentification & Maintenance Read and write of I&M1-4Minimum cycle time 1 ms for RT_CLASS_1

250 µs for RT_CLASS_3IRT Support RT_CLASS_3Media redundancy MRP client is supportedAdditional features DCP, VLAN- and priority-tagging, Shared DeviceBaud rate 100 MBit/sData transport layer Ethernet II, IEEE 802.3PROFINET IO specification V2.2 (legacy startup) and V2.3 (but advanced startup only for RT) are

supported.Limitations RT over UDP not supported.

Multicast communication not supported.DHCP is not supported.FastStartUp is not supported.The amount of configured IO-data influences the minimum cycle time thatcan be reached.Only 1 Input-CR and 1 Output-CR are supported.Using little endian (LSB-MSB) byte order for cyclic process data instead ofdefault big endian (MSB-LSB) byte order may have a negative impact onminimum reachable cycle time.System Redundancy (SR-AR) and Configuration-in-Run (CiR) are notsupported.Max. 255 submodules can be used simultaneously within one specificApplication Relation.Advanced Startup according Profinet specification V2.3 is NOT yet supportedfor IRT.As there is no official certification available for Profinet IO specification V2.3at the time of release of the stack there is no guarantee that thisimplementation will pass such a certification once it is available.

Reference to stack version V3.9Table 67: Technical data PROFINET IO RT IRT Device Protocol


© Hilscher 2018


15.3 Technical data EtherNet/IP AdapterParameter DescriptionMaximum number of input data 504 bytesMaximum number of output data 504 bytesI/O Connection (implicit) 1 Exclusive Owner, 1 Listen Only, 1 Input onlyI/O Connection type 'Cyclic’, minimal 1 ms*

* depending on number of connections and number of input and output dataused

UCMM SupportedPredefined standard objects Identity-Objekt

, Message-Router-Objekt, Assembly-Objekt, Connection-Manager-Objekt, Ethernet-Link-Objekt, TCP/IP-Objekt

Topology Tree, Line, RingDLR (Device Level Ring) Beacon based ’Ring Node’ACD (Address Conflict Detection) SupportedDHCP SupportedBOOTP SupportedBaud rate 10 and 100 MBit/sData transport layer Ethernet II, IEEE 802.3Switch function Supportedintegrated Quick Connect not supported.

The Edge Gateway is designed for cyclic data exchange. Acycliccommunication for user data transfer can not be used.CIP Sync Services are not implemented.TAGs are not supported.

Reference to stack version V2.10Table 68: Technical data EtherNet/IP Adapter protocol


© Hilscher 2018

Decommissioning, dismounting and disposal 204/215

16 Decommissioning, dismounting and disposal

16.1 Putting the device out of operation

Danger of Unsafe System Operation!To prevent personal injury or property damage, make sure that the removalof the device from your plant during operation will not affect the safeoperation of the plant.Ø Disconnect all communication cables from the device.Ø Disconnect the power supply plug.Ø Remove the device from the DIN top hat rail. .

16.2 Removing device from top hat railØ Before dismounting the Edge Gateway from the top hat rail, first remove

the power supply cable and all data cables from the device.Ø Put a screw driver into the slot of the latch at the bottom of the device.Ø To disengage the lock of the hook, pull down the latch with the screw

driver.Ø Take the device off the top hat rail.

16.3 Disposal of waste electronic equipmentImportant notes from the European Directive 2012/16/EU “Waste Electricaland Electronic Equipment (WEEE)”

Waste electronic equipmentArt und Quelle der GefahrThis product must not be treated as household waste.This product must be disposed of at a designated waste electronicequipment collecting point.

Waste electronic equipment may not be disposed of as household waste.As a consumer, you are legally obliged to dispose of all waste electronicequipment according to national and local regulations.


© Hilscher 2018

Appendix 205/215

17 Appendix

17.1 Legal notes

Copyright

© Hilscher Gesellschaft für Systemautomation mbH

All rights reserved.

The images, photographs and texts in the accompanying materials (in theform of a user's manual, operator's manual, Statement of Work documentand all other document types, support texts, documentation, etc.) areprotected by German and international copyright and by international tradeand protective provisions. Without the prior written consent, you do nothave permission to duplicate them either in full or in part using technical ormechanical methods (print, photocopy or any other method), to edit themusing electronic systems or to transfer them. You are not permitted to makechanges to copyright notices, markings, trademarks or ownershipdeclarations. Illustrations are provided without taking the patent situationinto account. Any company names and product designations provided inthis document may be brands or trademarks by the corresponding ownerand may be protected under trademark, brand or patent law. Any form offurther use shall require the express consent from the relevant owner of therights.

Important notes

Utmost care was/is given in the preparation of the documentation at handconsisting of a user's manual, operating manual and any other documenttype and accompanying texts. However, errors cannot be ruled out.Therefore, we cannot assume any guarantee or legal responsibility forerroneous information or liability of any kind. You are hereby made awarethat descriptions found in the user's manual, the accompanying texts andthe documentation neither represent a guarantee nor any indication onproper use as stipulated in the agreement or a promised attribute. It cannotbe ruled out that the user's manual, the accompanying texts and thedocumentation do not completely match the described attributes, standardsor any other data for the delivered product. A warranty or guarantee withrespect to the correctness or accuracy of the information is not assumed.

We reserve the right to modify our products and the specifications for suchas well as the corresponding documentation in the form of a user's manual,operating manual and/or any other document types and accompanyingtexts at any time and without notice without being required to notify of saidmodification. Changes shall be taken into account in future manuals and donot represent an obligation of any kind, in particular there shall be no rightto have delivered documents revised. The manual delivered with theproduct shall apply.


© Hilscher 2018

Appendix 206/215

Under no circumstances shall Hilscher Gesellschaft für SystemautomationmbH be liable for direct, indirect, ancillary or subsequent damage, or forany loss of income, which may arise after use of the information containedherein.

Liability disclaimer

The hardware and/or software was created and tested by HilscherGesellschaft für Systemautomation mbH with utmost care and is madeavailable as is. No warranty can be assumed for the performance orflawlessness of the hardware and/or software under all applicationconditions and scenarios and the work results achieved by the user whenusing the hardware and/or software. Liability for any damage that may haveoccurred as a result of using the hardware and/or software or thecorresponding documents shall be limited to an event involving willful intentor a grossly negligent violation of a fundamental contractual obligation.However, the right to assert damages due to a violation of a fundamentalcontractual obligation shall be limited to contract-typical foreseeabledamage.

It is hereby expressly agreed upon in particular that any use or utilization ofthe hardware and/or software in connection with· Flight control systems in aviation and aerospace;· Nuclear fusion processes in nuclear power plants;· Medical devices used for life support and· Vehicle control systems used in passenger transport

shall be excluded. Use of the hardware and/or software in any of thefollowing areas is strictly prohibited:· For military purposes or in weaponry;· For designing, engineering, maintaining or operating nuclear systems;· In flight safety systems, aviation and flight telecommunications systems;· In life-support systems;· In systems in which any malfunction in the hardware and/or software

may result in physical injuries or fatalities.

You are hereby made aware that the hardware and/or software was notcreated for use in hazardous environments, which require fail-safe controlmechanisms. Use of the hardware and/or software in this kind ofenvironment shall be at your own risk; any liability for damage or loss dueto impermissible use shall be excluded.


© Hilscher 2018

Appendix 207/215

Warranty

Hilscher Gesellschaft für Systemautomation mbH hereby guarantees thatthe software shall run without errors in accordance with the requirementslisted in the specifications and that there were no defects on the date ofacceptance. The warranty period shall be 12 months commencing as of thedate of acceptance or purchase (with express declaration or implied, bycustomer's conclusive behavior, e.g. putting into operation permanently).

The warranty obligation for equipment (hardware) we produce is 36months, calculated as of the date of delivery ex works. The aforementionedprovisions shall not apply if longer warranty periods are mandatory by lawpursuant to Section 438 (1.2) BGB, Section 479 (1) BGB and Section 634a(1) BGB [Bürgerliches Gesetzbuch; German Civil Code] If, despite of alldue care taken, the delivered product should have a defect, which alreadyexisted at the time of the transfer of risk, it shall be at our discretion toeither repair the product or to deliver a replacement product, subject totimely notification of defect.

The warranty obligation shall not apply if the notification of defect is notasserted promptly, if the purchaser or third party has tampered with theproducts, if the defect is the result of natural wear, was caused byunfavorable operating conditions or is due to violations against ouroperating regulations or against rules of good electrical engineeringpractice, or if our request to return the defective object is not promptlycomplied with.

Costs of support, maintenance, customization and product care

Please be advised that any subsequent improvement shall only be free ofcharge if a defect is found. Any form of technical support, maintenance andcustomization is not a warranty service, but instead shall be charged extra.

Additional guarantees

Although the hardware and software was developed and tested in-depthwith greatest care, Hilscher Gesellschaft für Systemautomation mbH shallnot assume any guarantee for the suitability thereof for any purpose thatwas not confirmed in writing. No guarantee can be granted whereby thehardware and software satisfies your requirements, or the use of thehardware and/or software is uninterruptable or the hardware and/orsoftware is fault-free.

It cannot be guaranteed that patents and/or ownership privileges have notbeen infringed upon or violated or that the products are free from third-partyinfluence. No additional guarantees or promises shall be made as towhether the product is market current, free from deficiency in title, or can beintegrated or is usable for specific purposes, unless such guarantees orpromises are required under existing law and cannot be restricted.


© Hilscher 2018

Appendix 208/215

Confidentiality

The customer hereby expressly acknowledges that this document containstrade secrets, information protected by copyright and other patent andownership privileges as well as any related rights of Hilscher Gesellschaftfür Systemautomation mbH. The customer agrees to treat as confidential allof the information made available to customer by Hilscher Gesellschaft fürSystemautomation mbH and rights, which were disclosed by HilscherGesellschaft für Systemautomation mbH and that were made accessible aswell as the terms and conditions of this agreement itself.

The parties hereby agree to one another that the information that eachparty receives from the other party respectively is and shall remain theintellectual property of said other party, unless provided for otherwise in acontractual agreement.

The customer must not allow any third party to become knowledgeable ofthis expertise and shall only provide knowledge thereof to authorized usersas appropriate and necessary. Companies associated with the customershall not be deemed third parties. The customer must obligate authorizedusers to confidentiality. The customer should only use the confidentialinformation in connection with the performances specified in thisagreement.

The customer must not use this confidential information to his ownadvantage or for his own purposes or rather to the advantage or for thepurpose of a third party, nor must it be used for commercial purposes andthis confidential information must only be used to the extent provided for inthis agreement or otherwise to the extent as expressly authorized by thedisclosing party in written form. The customer has the right, subject to theobligation to confidentiality, to disclose the terms and conditions of thisagreement directly to his legal and financial consultants as would berequired for the customer's normal business operation.

Export provisions

The delivered product (including technical data) is subject to the legalexport and/or import laws as well as any associated regulations of variouscountries, especially such laws applicable in Germany and in the UnitedStates. The products / hardware / software must not be exported into suchcountries for which export is prohibited under US American export controllaws and its supplementary provisions. You hereby agree to strictly followthe regulations and to yourself be responsible for observing them. You arehereby made aware that you may be required to obtain governmentalapproval to export, reexport or import the product.

Terms and conditions

Please read the notes about additional legal aspects on our netIOT website under http://www.netiot.com/netiot/netiot-edge/terms-and-conditions/.


© Hilscher 2018

http://www.netiot.com/netiot/netiot-edge/terms-and-conditions/

http://www.netiot.com/netiot/netiot-edge/terms-and-conditions/

List of figures 209/215

List of figuresFigure 1: Edge Gateway communication structure.............................................................. 6Figure 2: Positions of the interfaces of NIOT-E-TIB100-GB-RE.......................................... 7Figure 3: Dimensions........................................................................................................... 9Figure 4: LED label .............................................................................................................. 10Figure 5: NIOT-E-TIB100-GB-RE LED positions................................................................. 14Figure 6: Default settings of the Ethernet network connectors ............................................ 18Figure 7: Device label: Hostname........................................................................................ 20Figure 8: netIOT Edge Gateway in the Windows network ................................................... 21Figure 9: Edge Gateway Manager....................................................................................... 22Figure 10: Edge Gateway Manager - Setting the administrator password ............................ 26Figure 11: Security error message of the Internet Explorer................................................... 28Figure 12: Security error message of the Firefox browser (1) ............................................... 28Figure 13: Security error message of the Firefox browser (2) ............................................... 28Figure 14: Firefox dialog box: Adding exceptional safety rule ............................................... 29Figure 15: Security error message of Google Chrome (1)..................................................... 29Figure 16: Security error message of Google Chrome (2)..................................................... 30Figure 17: Main menu of the Control Panel ........................................................................... 31Figure 18: Page Info Center .................................................................................................. 32Figure 19: License Manager with license for the passive mode of operation ........................ 34Figure 20: License information in window Details.................................................................. 34Figure 21: Message after the transfer of the license file into the Edge Gateway .................. 36Figure 22: Time configuration page ....................................................................................... 37Figure 23: Backup and recovery............................................................................................ 40Figure 24: Warning message................................................................................................. 41Figure 25: Backup in progress............................................................................................... 41Figure 26: Backup and recovery............................................................................................ 42Figure 27: Recovery dialog.................................................................................................... 43Figure 28: Security query prior to system recovery from internal backup file ........................ 43Figure 29: Backup and recovery............................................................................................ 44Figure 30: Recovery dialog (external source)........................................................................ 45Figure 31: Message prior to starting recovery from external backup..................................... 45Figure 32: Backup and restore when backup file is present .................................................. 46Figure 33: Safety query before deletion of local backup........................................................ 46Figure 34: Backup and Restore ............................................................................................. 47Figure 35: Reboot safety query ............................................................................................. 47Figure 36: Warning for consequences of shutdown .............................................................. 48Figure 37: Default LAN configuration..................................................................................... 50Figure 38: LAN configuration (cifx0 activated)....................................................................... 52Figure 39: Hostname ............................................................................................................. 54Figure 40: List of default services .......................................................................................... 55


© Hilscher 2018


Figure 41: Message at overwriting of current NodeRED flow................................................ 56Figure 42: Security request at deletion of current NodeRED flow ......................................... 56Figure 43: Security query for Undo last deploy...................................................................... 57Figure 44: Page for configuring roles..................................................................................... 58Figure 45: User account page ............................................................................................... 60Figure 46: SSL/TLS Certificate page ..................................................................................... 61Figure 47: SSL Certificate – Upload area .............................................................................. 62Figure 48: SSL Certificate – Info area ................................................................................... 63Figure 49: Info page............................................................................................................... 64Figure 50: User profile page .................................................................................................. 64Figure 51: Dialog "Edit user account" .................................................................................... 65Figure 52: Comparison of the physical and logic view........................................................... 67Figure 53: Wiring the nodes................................................................................................... 67Figure 54: Node-RED workspace .......................................................................................... 69Figure 55: Node-RED user interface ..................................................................................... 70Figure 56: Node ..................................................................................................................... 71Figure 57: Menu Deploy ........................................................................................................ 74Figure 58: Dialog "Edit dashboard tab node"......................................................................... 79Figure 59: Dialog "Edit dashboard tab node"......................................................................... 80Figure 60: Dialog "Edit dashboard tab node"......................................................................... 81Figure 61: Dialog "Edit dashboard tab node"......................................................................... 82Figure 62: Dialog "Edit link node" .......................................................................................... 84Figure 63: Dialog "Edit link node" .......................................................................................... 85Figure 64: MQTT input node.................................................................................................. 89Figure 65: Dialog box Edit MQTT in node ............................................................................. 89Figure 66: Dialog box MQTT broker config node – tab Connection ...................................... 90Figure 67: Dialog box MQTT broker config node - tab Security ............................................ 91Figure 68: Dialog box MQTT broker config node - tab Birth Message .................................. 92Figure 69: Dialog box MQTT broker config node - tab Will Message .................................... 93Figure 70: MQTT output node ............................................................................................... 94Figure 71: Dialog box Edit MQTT out node ........................................................................... 94Figure 72: OPC UA input node .............................................................................................. 96Figure 73: Dialog box Edit OPC UA in node – tab Home ...................................................... 96Figure 74: Dialog box „Add new opcua client config node“ ................................................... 97Figure 75: Dialog box „Edit opcua in node“ – tab Home........................................................ 97Figure 76: Dialog box Edit OPC UA in node – tab Browse.................................................... 98Figure 77: Dialog box Edit OPC UA in node – tab Mode - Polling......................................... 99Figure 78: Options of the selection list Payload..................................................................... 99Figure 79: OPC UA in - specific payload ............................................................................... 99Figure 80: Options of the list Repeat ..................................................................................... 100Figure 81: Dialog Box Edit OPC UA in node – tab Mode - Subscribe ................................... 101


© Hilscher 2018


Figure 82: OPC UA output node............................................................................................ 102Figure 83: Dialog box Edit OPC UA output node – tab Home ............................................... 102Figure 84: Dialog box „Add new opcua client config node“ ................................................... 103Figure 85: Dialog box Edit OPC UA out node – tab Browse.................................................. 103Figure 86: MQTT input node.................................................................................................. 106Figure 87: MQTT output node ............................................................................................... 110Figure 88: OPC UA input node .............................................................................................. 114Figure 89: OPC UA output node............................................................................................ 120Figure 90: Fieldbus input node .............................................................................................. 127Figure 91: Message of the fieldbus input node (without error) .............................................. 133Figure 92: Message of the fieldbus input node (with error) ................................................... 133Figure 93: Fieldbus output node ............................................................................................ 134Figure 94: Edit dialog “Edit fieldbus in node” ......................................................................... 144Figure 95: Dialog box “Add new fieldbus interface config node” ........................................... 145Figure 96: Dialog box “Add new fieldbus interface config node” ........................................... 145Figure 97: PROFINET configuration...................................................................................... 146Figure 98: Available IO items (Example in figure: PROFINET) ............................................. 147Figure 99: IO items (Example: PROFINET)........................................................................... 147Figure 100: Dialog box “Add new fieldbus interface config node” ........................................... 149Figure 101: Error message – Firmware mismatch................................................................... 150Figure 102: Reconfigure interface ........................................................................................... 150Figure 103: Fieldbus node ....................................................................................................... 151Figure 104: Dialog Edit fieldbus in node .................................................................................. 151Figure 105: Dialog Edit fieldbus in node .................................................................................. 152Figure 106: Dialog “Edit fieldbus interface config node” .......................................................... 153Figure 107: Button Open fieldbus configurator ....................................................................... 153Figure 108: Start screen of the user interface for fieldbus configuration of the netIOT Edge

Gateway (the example in the figure shows PROFINET) ...................................... 154Figure 109: Dialog Edit fieldbus interface node ....................................................................... 155Figure 110: Error message – Firmware mismatch................................................................... 156Figure 111: Message box firmware already on board ............................................................. 157Figure 112: Warning: Consequences of reconfiguration ......................................................... 157Figure 113: PROFINET user interface..................................................................................... 158Figure 114: Note: Name of station........................................................................................... 161Figure 115: List of the possible input and output modules ...................................................... 162Figure 116: List of the configured input and output modules................................................... 162Figure 117: Selected IO item (module) for which you define signals....................................... 164Figure 118: List of the signal names of an IO item (module) ................................................... 164Figure 119: List of the configured input and output modules................................................... 167Figure 120: List of the send and receive signals ..................................................................... 171Figure 121: EtherNet/IP user interface .................................................................................... 173Figure 122: IP Settings ............................................................................................................ 176


© Hilscher 2018


Figure 123: List of the possible send and receive assemblies ................................................ 177Figure 124: List of the configured send and receive assemblies............................................. 177Figure 125: Selected IO item (assembly) for which you define signals ................................... 179Figure 126: List of the signal names of an IO item (assembly)................................................ 179Figure 127: List of the configured send and receive assemblies............................................. 182Figure 128: List of the send and receive signals ..................................................................... 185Figure 129: Edge Server structure........................................................................................... 189Figure 130: Edge Server environment..................................................................................... 192Figure 131: Internal structure of the Edge Server.................................................................... 192Figure 132: netIOT Edge Server icon within the Edge Gateway Manager .............................. 193Figure 133: Edge Server Control Center ................................................................................. 194Figure 134: Server configuration ............................................................................................. 196Figure 135: Configuration of the scan settings ........................................................................ 197Figure 136: Correct configuration of the scan settings ............................................................ 198Figure 137: Scan protocol configuration .................................................................................. 199


© Hilscher 2018

List of tables 213/215

List of tablesTable 1: List of revisions ....................................................................................................... 5Table 2: Positions of the interfaces of NIOT-E-TIB100-GB-RE ............................................ 8Table 3: Power supply connector ......................................................................................... 10Table 4: Parameters of the serial interface........................................................................... 12Table 5: RS-232 D-Sub ........................................................................................................ 12Table 6: RS-485 D-Sub ........................................................................................................ 12Table 7: Description of gateway status LEDs ....................................................................... 15Table 8: LEDs LAN interface ................................................................................................ 15Table 9: LED states for the PROFINET IO-Device protocol ................................................. 16Table 10: LED state definitions for the PROFINET IO-Device protocol.................................. 16Table 11: LED states for the EtherNet/IP Adapter protocol .................................................... 17Table 12: LED state definitions for the EtherNet/IP Adapter protocol..................................... 17Table 13: Starting applications with the Edge Gateway Manager .......................................... 23Table 14: Functional overview of the Control Panel ............................................................... 31Table 15: Info Center: Area System info................................................................................. 33Table 16: Info Center: Area Monitoring................................................................................... 33Table 17: Info Center: Area Temperature............................................................................... 33Table 18: Setting the system time .......................................................................................... 37Table 19: Table LAN: Meaning of the columns....................................................................... 51Table 20: Operating mode fieldbus interface.......................................................................... 53Table 21: Operating modes in the passive operating mode ................................................... 53Table 22: Operating statuses of the services ......................................................................... 55Table 23: Access rights onto resources.................................................................................. 59Table 24: Access rights to resources...................................................................................... 59Table 25: Information about the security certificate ................................................................ 63Table 26: Node-RED user interface........................................................................................ 70Table 27: Node elements........................................................................................................ 71Table 28: Commands of menu Deploy ................................................................................... 74Table 29: Kinds of widgets for use in dashboards .................................................................. 76Table 30: Areas of the dashboard configuration..................................................................... 77Table 31: List of standard nodes ............................................................................................ 86Table 32: Parameter MQTT input node .................................................................................. 89Table 33: Parameters in the tab Connection .......................................................................... 90Table 34: Parameters in the tab Security ............................................................................... 91Table 35: Parameters in the tab Birth Message ..................................................................... 92Table 36: Parameters in the tab Will Message ....................................................................... 93Table 37: Parameters of the Edit MQTT out node.................................................................. 95Table 38: Parameters of the configuration dialog OPC UA in node ....................................... 96Table 39: Options of the payload list ...................................................................................... 99Table 40: Options of the list Repeat ....................................................................................... 100


© Hilscher 2018

List of tables 214/215

Table 41: Parameters in Subscription Settings and Monitored Items Settings....................... 101Table 42: Parameters of the configuration dialog Edit OPC UA out node .............................. 102Table 43: Standard procedure ................................................................................................ 142Table 44: Configuration steps................................................................................................. 143Table 45: PROFINET configuration user interface ................................................................. 158Table 46: PROFINET configuration tree................................................................................. 161Table 47: Contents of the table “IO items”.............................................................................. 162Table 48: Controls of the table “IO Items”............................................................................... 163Table 49: Contents of table „IO item“...................................................................................... 164Table 50: Contents of the table „Signals“ ............................................................................... 165Table 51: Controls of the table „Signals“ ................................................................................ 165Table 52: Data types for signal names ................................................................................... 166Table 53: Columns of the table of the send and receive signals ............................................ 171Table 54: EtherNet/IP configuration user interface................................................................. 173Table 55: EtherNet/IP configuration tree ................................................................................ 176Table 56: Parameters for setting the IP addresses ................................................................ 176Table 57: Contents of the table „IO items“.............................................................................. 178Table 58: Controls of the table „IO Items“............................................................................... 178Table 59: Contents of the table „IO items“.............................................................................. 179Table 60: Contents of the table „IO items“.............................................................................. 180Table 61: Controls of the table „Signals“ ................................................................................ 180Table 62: Data types for signal names ................................................................................... 181Table 63: Columns of the table of the send and receive signals ............................................ 186Table 64: Functions of the Edge Server ................................................................................ 191Table 65: Symbols for the state of operation in the service list .............................................. 194Table 66: Techncal data NIOT-E-TIB100-GB-RE................................................................... 200Table 67: Technical data PROFINET IO RT IRT Device Protocol.......................................... 202Table 68: Technical data EtherNet/IP Adapter protocol ......................................................... 203


© Hilscher 2018

Contacts 215/215

Contacts

HEADQUARTERSGermanyHilscher Gesellschaft für Systemautomation mbH Rheinstrasse 15 65795 Hattersheim Phone: +49 (0) 6190 9907-0 Fax: +49 (0) 6190 9907-50 E-mail: [email protected]

SupportPhone: +49 (0) 6190 9907-99E-mail: [email protected]

SUBSIDIARIESChinaHilscher Systemautomation (Shanghai) Co. Ltd.200010 ShanghaiPhone: +86 (0) 21-6355-5161E-mail: [email protected]

SupportPhone: +86 (0) 21-6355-5161E-mail: [email protected]

FranceHilscher France S.a.r.l.69500 BronPhone: +33 (0) 4 72 37 98 40E-mail: [email protected]

SupportPhone: +33 (0) 4 72 37 98 40 E-mail: [email protected]

IndiaHilscher India Pvt. Ltd.Pune, Delhi, MumbaiPhone: +91 8888 750 777E-mail: [email protected]

ItalyHilscher Italia S.r.l.20090 Vimodrone (MI)Phone: +39 02 25007068E-mail: [email protected]

SupportPhone: +39 02 25007068E-mail: [email protected]

JapanHilscher Japan KKTokyo, 160-0022Phone: +81 (0) 3-5362-0521E-mail: [email protected]

SupportPhone: +81 (0) 3-5362-0521E-mail: [email protected]

KoreaHilscher Korea Inc.Seongnam, Gyeonggi, 463-400Phone: +82 (0) 31-789-3715E-mail: [email protected]

SwitzerlandHilscher Swiss GmbH 4500 SolothurnPhone: +41 (0) 32 623 6633E-mail: [email protected]

SupportPhone: +49 (0) 6190 9907-99E-mail: [email protected]

USAHilscher North America, Inc. Lisle, IL 60532Phone: +1 630-505-5301E-mail: [email protected]

SupportPhone: +1 630-505-5301E-mail: [email protected]


© Hilscher 2018

















Documents

netIOT Edge Gateway User manual - hilscher.com · 2018-07-11 · 4Connectors and mounting ..... 10 4.1Mounting ... Real-Time Ethernet connectors4.5 The Edge Gateway has 2 RJ45-connectors