edge gateway niot-e-tijcx-gb-re user manual€¦ · introduction 5/174 introduction1 about this...

Table of contents 2/174

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

1.1 About this document ........................................................................................................ 51.2 List of revisions ................................................................................................................ 51.3 Legal notes....................................................................................................................... 6

1.3.1 Copyright........................................................................................................... 61.3.2 Important notes ................................................................................................. 61.3.3 Exclusion of liability........................................................................................... 61.3.4 Warranty ........................................................................................................... 71.3.5 Export regulations ............................................................................................. 7

2 Brief description ...................................................................................................................... 8

3 Device drawings....................................................................................................................... 93.1 Positions of the interfaces ............................................................................................... 93.2 Dimensions .................................................................................................................... 11

4 Connections and mounting .................................................................................................. 124.1 Mounting ........................................................................................................................ 124.2 LED sticker..................................................................................................................... 124.3 Power supply.................................................................................................................. 134.4 LAN connectors.............................................................................................................. 134.5 Real-Time Ethernet connectors ..................................................................................... 134.6 USB connectors ............................................................................................................. 134.7 Serial interfaces COM1 and COM2................................................................................ 14

4.7.1 RS-232............................................................................................................ 144.7.2 RS-422............................................................................................................ 154.7.3 RS-485............................................................................................................ 15

4.8 Wi-Fi antennas ............................................................................................................... 154.9 Monitor connectors......................................................................................................... 15

5 LEDs........................................................................................................................................ 165.1 Positions of the LEDs on the Gateway........................................................................... 165.2 Gateway status LEDs..................................................................................................... 175.3 LEDs of the LAN interface.............................................................................................. 185.4 LEDs of the PROFINET IO Device interface.................................................................. 195.5 LEDs of the EtherNet/IP Adapter interface .................................................................... 19

6 Commissioning the Edge Gateway ...................................................................................... 216.1 Establishing the IP address communication .................................................................. 216.2 Using the web browser to establish a connection with the Edge Gateway .................... 23

6.2.1 Using the host name ....................................................................................... 236.2.2 Access to the Edge Gateway in the Windows network environment .............. 246.2.3 Using the IP address....................................................................................... 25

7 Edge Gateway manager ........................................................................................................ 267.1 Invocation....................................................................................................................... 267.2 Edge Gateway manager web page................................................................................ 27

Edge Gateway NIOT-E-TIJCX-GB-RE | User manualDOC160402UM01EN | Revision 1 | English | 2016-10 | Released | Public

© Hilscher 2016


8 Control Panel.......................................................................................................................... 298.1 Opening the control panel .............................................................................................. 29

8.1.1 First login ........................................................................................................ 308.1.2 Secure connection .......................................................................................... 31

8.2 Control Panel commands............................................................................................... 348.2.1 Overview and main menu ............................................................................... 348.2.2 System information and system time .............................................................. 358.2.3 Package management .................................................................................... 388.2.4 Network........................................................................................................... 418.2.5 Services .......................................................................................................... 478.2.6 User management .......................................................................................... 508.2.7 Security ........................................................................................................... 528.2.8 Help................................................................................................................. 548.2.9 Session ........................................................................................................... 55

9 Node-RED - The wiring editor ............................................................................................... 569.1 Modelling IoT flows with nodes ...................................................................................... 569.2 Opening Node-RED ....................................................................................................... 589.3 Graphical user interface ................................................................................................. 609.4 Working with Node-RED ................................................................................................ 62

9.4.1 Menu Deploy................................................................................................... 649.5 List of nodes................................................................................................................... 669.6 MQTT input node ........................................................................................................... 689.7 MQTT output node ......................................................................................................... 729.8 OPC UA input node........................................................................................................ 739.9 OPC UA output node ..................................................................................................... 79

10 Examples for Node-RED........................................................................................................ 8110.1 Example 1: Inject and debug node................................................................................. 8110.2 Example 2: MQTT input node ........................................................................................ 8310.3 Example 3: MQTT output node ...................................................................................... 8610.4 Example 4: OPC UA input node..................................................................................... 9010.5 Example 5: OPC UA output node .................................................................................. 9610.6 Example 6: Fieldbus input node................................................................................... 10110.7 Example 7: Fieldbus output node................................................................................. 107

11 Configuring and using the fieldbus node.......................................................................... 11411.1 Overview ...................................................................................................................... 11411.2 Configuring the fieldbus and defining the signals......................................................... 116

11.2.1 Creating a new fieldbus configuration........................................................... 11611.2.2 Changing the existing fieldbus configuration ................................................ 12211.2.3 Loading firmware and configuration.............................................................. 126

12 Configuring PROFINET and defining signals.................................................................... 12812.1 User interface............................................................................................................... 12812.2 Menu commands.......................................................................................................... 129

12.2.1 Project - Save ............................................................................................... 12912.2.2 GSDML Download ........................................................................................ 12912.2.3 Printing the configuration .............................................................................. 130


© Hilscher 2016


12.2.4 Help - Contents ............................................................................................. 13012.2.5 Help - Information ......................................................................................... 130

12.3 Configuration tree......................................................................................................... 13112.3.1 PROFINET configuration .............................................................................. 13112.3.2 IO and signal configuration ........................................................................... 13112.3.3 Signal definitions overview............................................................................ 14012.3.4 Download of the GSDML file......................................................................... 14112.3.5 Help............................................................................................................... 141

13 Configuring EtherNet/IP and defining signals .................................................................. 14213.1 User interface............................................................................................................... 14213.2 Menu commands.......................................................................................................... 142

13.2.1 Project - Save ............................................................................................... 14313.2.2 EDS Download.............................................................................................. 14313.2.3 Printing the configuration .............................................................................. 14413.2.4 Help - Contents ............................................................................................. 14413.2.5 Help - Information ......................................................................................... 145

13.3 Configuration tree......................................................................................................... 14513.3.1 EtherNet/IP configuration.............................................................................. 14513.3.2 IO and signal configuration ........................................................................... 14613.3.3 Signal definitions overview............................................................................ 15313.3.4 Download of the EDS file .............................................................................. 15413.3.5 Help............................................................................................................... 155

14 Firmware recovery ............................................................................................................... 15614.1 Overview ...................................................................................................................... 15614.2 Prerequisites ................................................................................................................ 15614.3 Step-by-step instructions.............................................................................................. 157

15 Technical data ...................................................................................................................... 16515.1 Technical data NIOT-E-TIJCX-GB-RE......................................................................... 16515.2 Technical data PROFINET IO Device.......................................................................... 16615.3 Technical data EtherNet/IP Adapter............................................................................. 167

List of figures ....................................................................................................................... 168

List of tables......................................................................................................................... 172

Contacts................................................................................................................................ 174


© Hilscher 2016

Introduction 5/174

1 Introduction

1.1 About this documentThis user manual describes the installation, configuration and functionalityof the Edge Gateway NIOT-E-TIJCX-GB-RE.

1.2 List of revisionsRevision Date Author Revision1 2016-10-12 RG, MK,

HHAll sections created.

Table 1: List of revisions


© Hilscher 2016

Introduction 6/174

1.3 Legal notes

1.3.1 Copyright© Hilscher Gesellschaft für Systemautomation mbH

All rights reserved.

The images, photographs and texts in the accompanying material (usermanual, accompanying texts, documentation, etc.) are protected byGerman and international copyright law as well as international trade andprotection provisions. You are not authorized to duplicate these in whole orin part using technical or mechanical methods (printing, photocopying orother methods), to manipulate or transfer using electronic systems withoutprior written consent. You are not permitted to make changes to copyrightnotices, markings, trademarks or ownership declarations. The includeddiagrams do not take the patent situation into account. The companynames and product descriptions included in this document may betrademarks or brands of the respective owners and may be trademarked orpatented. Any form of further use requires the explicit consent of therespective rights owner.

1.3.2 Important notesThe user manual, accompanying texts and the documentation were createdfor the use of the products by qualified experts, however, errors cannot beruled out. For this reason, no guarantee can be made and neither juristicresponsibility for erroneous information nor any liability can be assumed.Descriptions, accompanying texts and documentation included in the usermanual do not present a guarantee nor any information about proper useas stipulated in the contract or a warranted feature. It cannot be ruled outthat the user manual, the accompanying texts and the documentation donot correspond exactly to the described features, standards or other data ofthe delivered product. No warranty or guarantee regarding the correctnessor accuracy of the information is assumed.

We reserve the right to change our products and their specification as wellas related user manuals, accompanying texts and documentation at alltimes and without advance notice, without obligation to report the change.Changes will be included in future manuals and do not constitute anyobligations. There is no entitlement to revisions of delivered documents.The manual delivered with the product applies.

Hilscher Gesellschaft für Systemautomation mbH is not liable under anycircumstances for direct, indirect, incidental or follow-on damage or loss ofearnings resulting from the use of the information contained in thispublication.

1.3.3 Exclusion of liabilityThe software was produced and tested with utmost care by HilscherGesellschaft für Systemautomation mbH and is made available as is. Nowarranty can be assumed for the performance and flawlessness of thesoftware for all usage conditions and cases and for the results producedwhen utilized by the user. Liability for any damages that may result from the


© Hilscher 2016

Introduction 7/174

use of the hardware or software or related documents, is limited to cases ofintent or grossly negligent violation of significant contractual obligations.Indemnity claims for the violation of significant contractual obligations arelimited to damages that are foreseeable and typical for this type of contract.

It is strictly prohibited to use the software in the following areas:· for military purposes or in weapon systems;· for the design, construction, maintenance or operation of nuclear

facilities;· in air traffic control systems, air traffic or air traffic communication

systems;· in life support systems;· in systems in which failures in the software could lead to personal injury

or injuries leading to death.

We inform you that the software was not developed for use in dangerousenvironments requiring fail-proof control mechanisms. Use of the softwarein such an environment occurs at your own risk. No liability is assumed fordamages or losses due to unauthorized use.

1.3.4 WarrantyAlthough the hardware and software was developed with utmost care andtested intensively, Hilscher Gesellschaft für Systemautomation mbH doesnot guarantee its suitability for any purpose not confirmed in writing. Itcannot be guaranteed that the hardware and software will meet yourrequirements, that the use of the software operates without interruption andthat the software is free of errors. No guarantee is made regardinginfringements, violations of patents, rights of ownership or the freedom frominterference by third parties. No additional guarantees or assurances aremade regarding marketability, freedom of defect of title, integration orusability for certain purposes unless they are required in accordance withthe law and cannot be limited. Warranty claims are limited to the right toclaim rectification.

1.3.5 Export regulationsThe delivered product (including the technical data) is subject to export orimport laws as well as the associated regulations of different counters, inparticular those of Germany and the USA. The software may not beexported to countries where this is prohibited by the United States ExportAdministration Act and its additional provisions. You are obligated tocomply with the regulations at your personal responsibility. We wish toinform you that you may require permission from state authorities to export,re-export or import the product.


© Hilscher 2016

Brief description 8/174

2 Brief descriptionHilscher's netIOT Edge Gateway NIOT-E-TIJCX-GB-RE securely connectsReal-Time Ethernet automation networks with a „Cloud“ or any IoT-directedapplication. 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 2016

Device drawings 9/174

3 Device drawings

3.1 Positions of the interfaces

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


© Hilscher 2016


Pos. Interface For details see(1) Antenna (2 x Wi-Fi) Wi-Fi antennas [} page 15](2) Gateway state LEDs (12 x) Gateway status LEDs [} page 17](3) Connector for digital LCD display (DVI-I) Monitor connectors [} page 15](4) Connector for display (DisplayPort)(5) LAN connector (RJ45 jacket) port 2 / Eth1 LAN connectors [} page 13](6) USB connectors (3x USB 2.0) USB connectors [} page 13](7) LAN connector (RJ45 jacket) port 1 / Eth0 LAN connectors [} page 13](8) USB connector (1x USB 3.0) USB connectors [} page 13](9) Serial interface connector COM1 (RS232/422/485, can be

configured)Serial interfaces COM1 and COM2 [} page 14]

(10) Serial interface connector COM2 (RS232/422/485, can beconfigured)

(11) ">+ 24 V DC supply voltage connector (Combicon) Power supply [} page 13](12) Power button -(13) Real-Time Ethernet connector (RJ45 jacket) channel 1 Real-Time Ethernet connectors [} page 13](14) LED communication state of Real-Time Ethernet connection.

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 19]LEDs of the EtherNet/IP Adapterinterface [} page 19]

(15) Real-Time Ethernet connector (RJ45 jacket) channel 0 Real-Time Ethernet connectors [} page 13](16) LED communication state of Real-Time Ethernet connection.

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 19]LEDs of the EtherNet/IP Adapterinterface [} page 19]

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


© Hilscher 2016


3.2 Dimensions

Figure 3: Dimensions


© Hilscher 2016

Connections and mounting 12/174

4 Connections and mounting

4.1 MountingMount the Edge Gateway with 4 screws into the control cabinet. Thefollowing figure shows the distance of the mounting holes.

Figure 4: Drilling template

4.2 LED stickerEach fieldbus system uses own names for the LED displays. Therefore, anLED sticker with the names for the particular fieldbus system is in the scopeof delivery of the Edge Gateway. Stick the sticker of the fieldbus systemyou are using on the cover of the fieldbus interface of your Edge Gateway.

Figure 5: LED sticker


© Hilscher 2016


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

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

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

Section LAN [} page 41] describes, how you can set the IP addressparameters of the LAN interfaces.

4.5 Real-Time Ethernet connectorsThe Edge Gateway has 2 RJ45 jacktes to connect it to a Real-TimeEthernet network (fieldbus network), positions (13) and (15) (see sectionPositions of the interfaces [} page 9]).

Use the fieldbus input node and the fieldbus output node in Node-RED forexchanging data on the fieldbus. Sections Example 6: Fieldbus inputnode [} page 101] and Example 7: Fieldbus output node [} page 107]describe, how you can access the cyclic I/O data of the fieldbus with Node-RED.

4.6 USB connectorsThe Edge Gateway has 4 USB connectors (3x USB 2.0 and 1x USB 3.0),positions (6) and (8) (see section Positions of the interfaces [} page 9]).You do not need the USB connectors for „normal“ operation of the EdgeGateway. You need the USB connector if you connect a keyboard in orderto change settings in the BIOS or if you do a firmware recovery with a USBstick.


© Hilscher 2016


4.7 Serial interfaces COM1 and COM2The Edge Gateway has two configurable serial interfaces COM1 (Position(9)) and COM2 (Position (10)). You can use each serial interface asRS-232, RS-422 or RS-485 interface.

Prerequisites

You have to set the interface type in the BIOS. For this, you nned akeyboard with USB connector and a monitor with DVI-I or DP connector.

Important:Use only 1:1 DVI or DP connectors. Adapters like DVI-I to VGA orDP to VGA are not supported by the gateway.

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 1 (COM1): IO=248h; IRQ=5Serial Port 2 (COM2): IO=2F8h; IRQ=3

Onboard Serial Port Mode RS232 RS422 RS485 (do not use this setting)RS485 Auto (use this setting for RS-485only, because RTS control 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


© Hilscher 2016



1 Tx‑ Send signal negative2 Tx+ Send signal positive3 Rx‑ Receive signal negative4 Rx+ Receive signal positive5 ISO_GND Ground (reference potential)6 n.c. -7 n.c. -8 n.c. -9 n.c. -



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


4.8 Wi-Fi antennasYou 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 a mobile device in order to configure the Edge Gateway from a mobiledevice.

Section WiFi [} page 42] describes, how you activate the antennas andhow to set the Wi-Fi operating mode.

4.9 Monitor connectorsThe Edge Gateway has a DVI-I and a DP connector to connect a monitor.You do not need a monitor for „normal“ operation of the Edge Gateway. Ifyou want to change settings in the BIOS or want to do a firmware recovery,you need a monitor.

Important:Use only 1:1 DVI or DP connectors. Adapters like DVI-I to VGA orDP to VGA are not supported by the gateway.


© Hilscher 2016

LEDs 16/174

5 LEDs

5.1 Positions of the LEDs on the Gateway

Figure 6: Positions of the LEDs on NIOT-E-TIJCX-GB-RE


© Hilscher 2016

LEDs 17/174

5.2 Gateway status LEDsLEDs indicating voltage supply, hard disk access, battery state and activityof operating system, serial interfaces and GPIOs. The position of the LEDsis indicated by pos. (1) in section Positions of the LEDs on theGateway [} page 16].

LED Color MeaningGreen Voltage supply is OK

Yellow Hard disk drive is accessed

Yellow State of CMOS-RAM (BIOS) battery

PG0 Yellow GPIO 4: can be programmed, currently not used.

TX1 Green Transmission of data at serial interface COM1

RX1 Yellow Receiving data at serial interface COM1

TX2 Green Transmission of data at serial interface COM2

RX2 Yellow Receiving data at serial interface COM2

PG1 Green GPIO 0: blinks when data is being copied from USB stick into gateway during firmware recovery




Table 8: Description of gateway status LEDs


© Hilscher 2016

LEDs 18/174

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

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) Flickering(loaddependent)

The device sends/receives frames

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

Table 9: LEDs LAN interface


© Hilscher 2016

LEDs 19/174

5.4 LEDs of the PROFINET IO Device interfaceLEDs indicating state of the PROFINET IO communication. For thepositions of the PROFINET IO LEDs on the gateway, see section Positionsof the LEDs on the Gateway [} page 16].

LED Color State MeaningSF (system failure)see position (10)

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 errorBF (bus failure)see position (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 linkLINKsee positions (8) and(11)

LED green

(green) On The device is linked to the Ethernet

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

RX/TXsee positions (6) and(9)

LED gelb

(yellow)Flickering (loaddependent)

The device sends/receives Ethernet frames

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

Table 10: LEDs PROFINET IO Device

5.5 LEDs of the EtherNet/IP Adapter interfaceLEDs indicating state of the EtherNet/IP communication. For the positionsof the EtherNet/IP LEDs on the gateway, see section Positions of the LEDson the Gateway [} page 16].

LED Color State MeaningMS (Module status)See position (10)

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.

(red) Flashing (1 Hz)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.


© Hilscher 2016

LEDs 20/174

LED Color State MeaningNS (Network status)See position (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.

(red) Flashing (1 Hz)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).LINKSee positions (8) and(11)

LED green

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

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

ACTSee positions (6) and(9)

LED yellow

(yellow)Flickering (loaddependent)

The device sends/receives Ethernet frames.

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

Table 11: LEDs EtherNet/IP Adapter

LED state DefinitionOn The indicator is constantly on.Off The indicator is constantly off.Flashing (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 (loaddependant)

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


© Hilscher 2016

Commissioning the Edge Gateway 21/174

6 Commissioning the Edge Gateway

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

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

Figure 7: Default settings of the Ethernet network connections

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

Network 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 (7) in Positions of the interfaces [} page 9]) with a network inwhich 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 23] to find out how to access the Edge Gateway.


© Hilscher 2016


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 Positions of the interfaces [} page 9]).

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 Network and Sharing Center.Ø Click 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 Properties.Ø Double click 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 Ok and then click Close.ð Now you can access the Edge Gateway from your PC or notebook.

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

Also see about this2 Positions of the interfaces [} 9]2 LAN [} 41]


© Hilscher 2016


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 23])2. by access via the Windows network (see section Access to the Edge

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

address [} page 25]).

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.

20

00

0

1321.300 1

1321.300Article No.:

www.hilscher.com

Fieldbus MAC ID: 0002A2344D0B

Hilscher Gesellschaft für Systemautomation mbH Rheinstr. 15 - D 65795 Hattersheim

7C5CF88F1AA6

7C5CF88F1AAA

16/19Date code:

Default log in:

Wifi MAC ID:

Bluetooth MAC ID:

DHCP:

Static IP:

1

2

https://NT0002A233E559

https://192.168.253.1

user: "admin"password: "admin"

Edge Gateway sticker: Host name

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

https://Example: For the device with the host name NT0002A233E559 enterhttps://NT0002A233E559

ð 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 27].


© Hilscher 2016


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.

Figure 9: Properties of the Edge Gateway

Ê The menu provides information on the Edge Gateway, e.g. serialnumber, 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.



© Hilscher 2016


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://Example: https://10.11.5.61

ð The Edge Gateway manager opens.



© Hilscher 2016

Edge Gateway manager 26/174

7 Edge Gateway manager

7.1 InvocationThe 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://orhttps://

ð Your browser displays the Edge Gateway manager.

Figure 10: Edge Gateway Manager

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

Also see about this2 Commissioning the Edge Gateway [} 21]


© Hilscher 2016


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 29]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 56] describes howto create applications for the Edge Gateway.

Opens the wiring editor Node-RED.

Opens the Hilscher homepage in the Internet.Requires a connection to the Internet.

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

Opens the Edge Gateway documentation stored in the device.


© Hilscher 2016


Icon FunctionOpens legal information concerning the Edge Gateway.

Table 13: Starting applications with the Edge Gateway manager


© Hilscher 2016

Control Panel 29/174

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.ð The Control Panel will be displayed.

Also see about this2 Overview and main menu [} 34]


© Hilscher 2016


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 11: Edge Gateway Manager - Setting the administrator password

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

commissioning, the password is: admin

Ø Now enter the new administrator password. Minimum length: 7characters. For reasons of safety, Hilscher recommends usingconsiderably more characters.

Ø Click Change Password.ð Thus, the new administrator password for the user account Admin is

set.ð Now, you can work with the control panel as an administrator, you can

create further users in the user management, and assign access rights.

Also see about this2 User management [} 50]


© Hilscher 2016


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 53]).


© Hilscher 2016


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 12: 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 13: 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 14: 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 2016


Figure 15: 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.


© Hilscher 2016


8.2 Control Panel commands

8.2.1 Overview and main menu

Figure 16: Main menu of the Control Panel

Menu Submenu Description Details in sectionSystem Info Center Displaying the system information, the

monitoring of the processor core temperature,and a system monitor for the usage of CPU,main memory, and SSD.

Info Center [} page 35]

Time Settings of system time and timesynchronization.

Time [} page 36]

PackageManager

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

Packagemanagement [} page 38]

Network LAN Configuring the Ethernet interfaces to the field orcloud.

LAN [} page 41]

WiFi Configuring the WiFi communication. WiFi [} page 42]Hostname Displaying and configuring the host name under

which the Edge Gateway can be identified in thenetwork.

Host name [} page 46]

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

Services [} page 47]

UserManagement

Roles Displaying and configuring the permissions foruser roles.

Managing user roles [} page 50]

Accounts Displaying user accounts und assigning userroles.

Managing useraccounts [} page 51]

Security SSL certificate Installing the SSL safety certificate. Security [} page 52]Help Info Displaying the current software version. Help [} page 54]Session User Profile Displaying the permissions of the user. User profile [} page 55]

Logout Logout Logout [} page 55]Table 14: Functional overview of the Control Panel

Also see about this2 Opening the control panel [} 29]


© Hilscher 2016


8.2.2 System information and system time

8.2.2.1 Info Center

Open this page with System > Info Center. This page shows e.g. thefirmware version and the serial number of the Edge Gateway.

Figure 17: Page Info Center

The Info Center displays the following information:System info DescriptionSerial Number Serial number of the Edge GatewayModel name Model designation of the Edge Gateway (NT IJCX-GB)Firmware version Version of the firmware loaded 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: System info

Monitoring DescriptionCPU usage Average utilization of each micro processor core in the Edge GatewayMemory utilization Average utilization of the main memory in the Edge Gateway


© Hilscher 2016


Monitoring DescriptionStorage space Display of the memory that is currently utilized on the integrated

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

Temperature DescriptionCPU temperature Display of the temperature of each processor core im Edge Gateway

Table 17: Info Center: Temperature

8.2.2.2 Time

Open this page with System > Time. On this page you can set the systemtime and the time zone this time relates 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 18: 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 Save changes.ð The system time is set.


© Hilscher 2016


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 theinput field NTP server.

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

successively, the following information will be displayed under Status:Synchronized to time server ()

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.

Observe the following notes:

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


© Hilscher 2016


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.

8.2.3 Package management

8.2.3.1 Packages

Open this page with Package Manager > Packages. This page containsthe package management of the Linux-based operating system of the EdgeGateway. This page· lists the installed packages including version,· adds new packages or· updates already installed packages.

Table of the installed packages

The area Packages of the table Installed shows you the list of the installedpackages.

Figure 19: Package page

Each line of the list of the installed packages contains the name and theversion of the package. With the button Details you can display a summaryof the contents of a package.


© Hilscher 2016

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


Deleting packages from the list of available packages

Risk of losing the data and the operational safety of the Edge GatewayDelete packages only if you have profound knowledge of the operatingsystem LINUX and if you are absolutely sure that the package in questioncan be deleted without any risk for the function of the Edge Gateway and itsoperating system.

Ø Select the package to be deleted in table Installed.Ø Click at Delete.

Ø The package is deleted from the Edge Gateway’s file system.ð If the package file could be successfully deleted, the following message

box is displayed:

ð

Table of available but not yet installed packages

The table Available displays the packages that are available for installation,but which are not yet installed. You first have to select and add thepackages to be installed.

Figure 20: Table of the packages that are available for installation

Selecting and installing the package fileØ Click on Explorer.

Ê A dialog for file selection will be displayed.


© Hilscher 2016


Ø Select the package file to be loaded. Package files have the endingdeb.

ð If the Edge Gateway accepts the package, the name, creation date, andfile size of the package will be displayed in a line of the table Available.

Ø Click Install.

ð If the Edge Gateway accepts the file, it will be installed, removed fromthe table Available, and displayed in the table Installed.

ð If the package cannot be installed, the message dialog Upload Errorappears.

Delete package file from list of available but not yet installed filesØ Select the package file to be deleted. Package files have the ending

deb.Ø Click Clear.

ð The line containing the package file is removed from the list of availablebut not yet installed files.


© Hilscher 2016


8.2.4 Network

8.2.4.1 LAN

Open this page with Network > LAN.

On this page you configure the Ethernet interfaces eth0, eth1 (both onthe side of the cloud) and cifx0 (on the side of the fieldbus). For eachEthernet 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 addresses.

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 port 2 is 192.168.253.1with the subnet mask 255.255.255.0.

Figure 21: Default LAN configuration

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 enter the subnet mask andthe 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


© Hilscher 2016


8.2.4.2 WiFi

Open this page with Network > WiFi. On this page you configure thewireless network communication of the Edge Gateway (WLAN according toIEEE 802.11).

The WiFi is deactivated when delivered (factory setting).

Figure 22: WiFi (default setting)

The Edge Gateway offers 2 WiFi operating modes.

Figure 23: WiFi operating modes

Operating mode DescriptionDisabled WiFi is deactivated.Access point In the operating mode Access point the Edge Gateway enables other

WiFi-capable devices to establish a connection with the Edge Gatewayand its peripheral devices.

Client In the operating mode Client the Edge Gateway acts as WLANEthernet adapter. This allows the integration of the Edge Gateway intoan already existing WLAN (Wireless Area Network).

Table 20: WiFi operating modes

WiFi DescriptionOperating mode displays the active operating mode. You can change the operating

mode via the Mode list.Changing the operating mode:1. Enter the valid parameters of the new operating mode.2. Click Save changes.

Name displays the name of the WiFi interface (wlan0).Mac address displays the MAC address, if WiFi is activated.

Table 21: WiFi


© Hilscher 2016


Operating mode Access point

Figure 24: WiFi operating mode: Access point

The following table describes the parameters of the operating mode Accesspoint.Element DescriptionChannel In the list Channel you can select the radio channel and, thus, determine the

WLAN radio frequency in the 2.4 GHz band.Country In the list Country you can select the country in which you operate the radio

network.IP address to enter the IP address of the Edge Gateway.Subnet mask to enter the subnet mask of the Edge Gateway.Gateway IP address of the network Gateway.SSID to enter the Service Set Identifier.

Here you enter the SSID to be used in the radio network (WLAN) of theEdge Gateway. To be able to use a WLAN connection, you have to enterthe SSID on any WiFi client.

Encryption displays the encryption method used in the radio network.Shared key Here you enter the key to be used by the radio network (WLAN) of the Edge

Gateway. To be able to use a WLAN connection, you have to enter this keyon any WiFi client.

DHCP server to activate/deactivate the DHCP serverCheck this box whenever the Edge Gateway is to provide a DHCP server.

Start IPaddress

Here you have to enter the start IP address of the IP address range for theDHCP server if you have checked the box DHCP server.

End IPaddress

Here you have to enter the end IP address of the IP address range for theDHCP server if you have checked the box DHCP server.

Table 22: Parameters of the operating mode Access point


© Hilscher 2016


Operating mode Client

Figure 25: WiFi operating mode: Client

The following table describes the parameters of the operating mode Client.Element DescriptionOperatingmode

to set the operating mode to Client.

Channel In the list Channel you can select the radio channel and, thus, determine theWLAN radio frequency in the 2.4 GHz band.

Country In the list Country you can select the country in which you operate the radionetwork.

DHCP to obtain the IP address parameters from a DHCP server.Activated: The DHCP server will send the IP address parametersautomatically.Deactivated: You have to enter the IP address parameters manually.

IP address to enter the IP address of the client manually.Subnetmask

to enter the subnet mask of the client manually.

Gateway to enter the IP address of the Gateway manually for the client.DNSserver 1and 2

to enter the IP address of the 1st and 2nd DNS server manually for the client.

SSID Here you enter the SSID (Service Set Identifier) to be used in the radio network(WLAN) of the Edge Gateway. To be able to use a WLAN connection, youhave to enter the SSID on any WiFi client.

Table 23: Parameters of the operating mode Client

Table Client

For a client found, the following data is shown in a separate column of thetable:


© Hilscher 2016


· SSID (Service Set Identifier)· MAC address· Quality· Encryption· State· Delete.

Scanning for a WLAN clientØ Click Scan.

ð The Edge Gateway will scan for a WLAN client.ð If a WLAN client is found, it will be displayed in a line of the table Client.

Establishing a connection to a WLAN client foundØ Click a line of the table which shows data of a client found.Ø Click Connect.

ð The WLAN connection will be established.

Saving the WiFi settings

To save the WiFi settings, you need the access right 'Write' for the WiFipage.Ø Click Save changes.

ð A safety query appears (“Do you want to save the changes”).Ø Click at OK,ð The WiFi settings are saved.


© Hilscher 2016


8.2.4.3 Host name

Open this page with Network > Hostname. On this page you configure thehost 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 23]).

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 26: Host name

Input field Hostname

An arbitrary long String of ASCII characters can be entered into the inputfield Hostname.

Saving the host name

The hostname is saved by clicking at

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

If your access rights do not enable you to save the host name in the LANtable, the message box Permission denied will be displayed at the upperedge of the control panel window.

Figure 27: Message box Permission denied


© Hilscher 2016


8.2.5 Services

8.2.5.1 List of 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,· stop and start individual services,· activate/deactivate Autostart, and· download, upload and delete the flow of the Node-RED service.

The list of services is displayed at the left edge:

Figure 28: 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.

Table 24: Operating statuses of the services

The following services can be started and stopped for any service:

Start a serviceØ In order to start a service, click at button Start.

Ê A security query appears:Ø Confirm it by clicking at OK.ð The displayed operating state changes from Stop to Running .

Simultaneously, the color of the icon left of the service you stopped,changes to yellow. Finally, the button Start is replaced by the buttonStop.

Stop a running serviceØ In order to stop a currently running service, click at button Stop.

Ê A security query appears:Ø Confirm it by clicking at OK.


© Hilscher 2016


ð The displayed operating state changes from Running to Stop.Simultaneously, the color of the icon left of the service you stopped,changes to yellow. Finally, the button Start is replaced by the buttonStop.

Activate autostart for a serviceØ In order to activate Autostart for a service, click at radio button enabled.

Ø Click at the button with the hook symbol .Ê A security query box appears:Ø Click at OK.ð Autostart is activated.

Deactivate Autostart for a serviceØ In order to deactivate Autostart for a service, click at radio button

disabled.

Ø Click at the button with the hook symbol.Ê A security query appears:Ø Click at OK.ð Autostart is deactivated.

The following actions can only be performed for the NodeRED service:

Download of the current NodeRED Flow

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

Ø Click at button Download.Ê 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 Store (as) and select the file path.ð The NodeRED flow is stored for further use with the file name

mentioned above within the selected path.

Upload of the current NodeRED Flow

Important:During upload of a stored NodeRED flow the currently loaded flowis overwritten. Afterwards, this flow cannot be restored anymore. Ifyou still need the currently loaded flow in future, first store it viaDownload.

Ø Click at button Upload.Ê A file selection dialog appears.Ø Select the file with a stored NodeRED flow, which you want to upload.Ê A security query informing about the risk of overwriting the current

NodeRED flow appears:


© Hilscher 2016


Ø If you are sure no longer to need the current NodeRED flow, click atOK.

ð The selected flow is uploaded now. Thereby, the previously loaded flowis overwritten. The message NodeRED flow has been overridden isdisplayed.

Figure 29: Message at overwriting of current NodeRED flow

Deleting the current NodeRED flowØ Click at button Delete.Ê The following security query is displayed:

Figure 30: Security query at deletion of current NodeRED flow.

Ø Click at OK.ð The current NodeRED flow is deleted. Afterwards, this flow cannot be

restored any more.

Undo last deploy in NodeREDØ Click at button Undo deploy.Ê A security query warns for danger of data loss due to undo of deploy.

Figure 31: Security query for Undo last deploy

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

ð The last deploy is undone.


© Hilscher 2016


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

On the side of the user account, a predefined role is assigned to each 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.

The roles Administrator and View are standard and cannot be deleted. Youcan set the access rights for newly added roles only.

Figure 32: 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 is also a resource.

Each resource may obtain one of the following access rights:· No access (option None)· Read access only (option Read)· Read and write access (option Read&Write)

Adding a new roleØ Click Create new role.

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

Ø Enter a name for the role, e.g. User.


© Hilscher 2016


Ø Click Add.ð The role will be 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 Save changes.

The following figure shows the access rights of the administrator.

Figure 33: Resources and access rights

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 34: User account page


© Hilscher 2016


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

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

It looks like:

Figure 35: Security submenu

On selection of menu entry SSL certificate the page SSL certificate isopened.

This page displays information about the currently used security certificate.You also can upload and install a new security certificate here.

Figure 36: Page SSL Certificate


© Hilscher 2016


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 37: SSL Certificate – Upload area

Uploading and installing the certificate

In order to upload and install the certificate, proceed as follows:Ø Select your certificate to be uploaded and installed with the Browse

button right of the field Certificate.Ø Select the private key associated with your certificate with the Browse

button right of the field Private Key.Ø Click at Upload and install certificates.ð The security certificate is uploaded and installed.

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.


© Hilscher 2016


Figure 38: SSL Certificate – Info area

The single lines have the following meanings:

Information about the security certificateLine Abbre-

viationMeaning

Identity/verified by

CN Identity/verified by

country C Countrystate ST Statelocality L Localityorganization O OrganizationOrganizationunit

OU Organization unit

mail CN E-mail addressValidity starts - Start of validity duration of certificateValidity ends - End of validity duration of 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 (see Uploading and installing ownsecurity certificates [} page 53]).

8.2.8 HelpOpen this page with Help > Info.

This page displays the firmware version of the Edge Gateway.


© Hilscher 2016


Figure 39: Info page

8.2.9 Session

8.2.9.1 User profile

Open this page with Session > User Profile.

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

Figure 40: User profile page

8.2.9.2 Logout

To log out from the Edge Gateway, use Session > Logout.


© Hilscher 2016

Node-RED - The wiring editor 56/174

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

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


© Hilscher 2016

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


Figure 42: 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.

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


© Hilscher 2016


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 Invocation [} page 26])Ø In the Edge Gateway manager click on the tile Node-RED.

Ê The Node-RED start screen will be displayed.Ø Enter your user name and password.

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

Figure 43: Node-RED workspace

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


© Hilscher 2016


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

Connection without certificate with Firefox [} page 32]


© Hilscher 2016


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 44: 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 25: Node-RED user interface


© Hilscher 2016


Nodes

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

57

1 2 3 4

6

Figure 45: 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 26: Node elements


© Hilscher 2016


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.

2. Configuring node parametersØ Double-click on the node.


© Hilscher 2016


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

edge gateway niot-e-tijcx-gb-re user manual€¦ · introduction 5/174 introduction1 about this...

Documents