netiot edge gateway user manual - hilscher.com · editor. opc ua and mqtt functions address objects...

216
User manual netIOT Edge Gateway NIOT-E-TPI51-EN-RE (connect) Hilscher Gesellschaft für Systemautomation mbH www.hilscher.com DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

Upload: others

Post on 27-Jan-2021

21 views

Category:

Documents


0 download

TRANSCRIPT

  • User manual

    netIOT Edge GatewayNIOT-E-TPI51-EN-RE (connect)

    Hilscher Gesellschaft für Systemautomation mbHwww.hilscher.com

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

  • Table of contents 2/216

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

    4 Connectors and mounting ......................................................................................................  94.1 Mounting .......................................................................................................................... 94.2 Power supply.................................................................................................................... 94.3 LAN connectors................................................................................................................ 94.4 Real-Time Ethernet connectors ....................................................................................... 94.5 USB connectors ............................................................................................................... 94.6 Wi-Fi............................................................................................................................... 104.7 HDMI connector ............................................................................................................. 10

    5 LEDs........................................................................................................................................  115.1 Positions of the LEDs on the gateway ........................................................................... 115.2 Gateway status LEDs..................................................................................................... 125.3 LEDs of the LAN interface.............................................................................................. 135.4 LEDs of the PROFINET IO Device interface.................................................................. 145.5 LEDs of the EtherNet/IP Adapter interface .................................................................... 15

    6 Commissioning the Edge Gateway ......................................................................................  166.1 Establishing the IP address communication .................................................................. 166.2 Using the web browser to establish a connection with the Edge Gateway .................... 17

    6.2.1 Using the host name .......................................................................................  176.2.2 Access to the Edge Gateway in the Windows network environment ..............  18

    7 Edge Gateway Manager.........................................................................................................  197.1 Calling the Edge Gateway Manager .............................................................................. 197.2 Edge Gateway Manager web page................................................................................ 20

    8 Control Panel..........................................................................................................................  228.1 Opening the control panel .............................................................................................. 22

    8.1.1 First login ........................................................................................................  238.1.2 Secure connection ..........................................................................................  25

    8.2 Control Panel commands............................................................................................... 288.2.1 Overview and main menu ...............................................................................  288.2.2 System information and system time ..............................................................  308.2.3 Packet management .......................................................................................  458.2.4 Network...........................................................................................................  468.2.5 Services ..........................................................................................................  588.2.6 User management ..........................................................................................  618.2.7 Security certificates.........................................................................................  64

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Table of contents 3/216

    8.2.8 Help.................................................................................................................  678.2.9 Session ...........................................................................................................  68

    9 Node-RED - The wiring editor ...............................................................................................  709.1 Modelling IoT flows with nodes ...................................................................................... 709.2 Opening Node-RED ....................................................................................................... 729.3 Graphical user interface ................................................................................................. 749.4 Working with Node-RED ................................................................................................ 76

    9.4.1 Menu Deploy...................................................................................................  789.4.2 Dashboard ......................................................................................................  80

    9.5 List of nodes................................................................................................................... 909.6 MQTT input node ........................................................................................................... 939.7 MQTT output node ......................................................................................................... 979.8 OPC UA input node........................................................................................................ 999.9 OPC UA output node ................................................................................................... 105

    10 Examples for Node-RED......................................................................................................  10710.1 Example 1: Inject and debug node............................................................................... 10710.2 Example 2: MQTT input node ...................................................................................... 10910.3 Example 3: MQTT output node .................................................................................... 11210.4 Example 4: OPC UA input node................................................................................... 11610.5 Example 5: OPC UA output node ................................................................................ 12210.6 Example 6: Fieldbus input node................................................................................... 12810.7 Example 7: Fieldbus output node................................................................................. 135

    11 Configuring and using the fieldbus node..........................................................................  14311.1 Overview ...................................................................................................................... 14311.2 Configuring the fieldbus and defining the signals......................................................... 145

    11.2.1 Creating a new fieldbus configuration...........................................................  14511.2.2 Changing the existing fieldbus configuration ................................................  15111.2.3 Loading firmware and configuration..............................................................  157

    12 Configuring PROFINET and defining signals....................................................................  15912.1 User interface............................................................................................................... 15912.2 Menu commands.......................................................................................................... 160

    12.2.1 Project - Save ...............................................................................................  16012.2.2 GSDML Download ........................................................................................  16012.2.3 Printing the configuration ..............................................................................  16112.2.4 Help - Contents .............................................................................................  16112.2.5 Help - Information .........................................................................................  161

    12.3 Configuration tree......................................................................................................... 16212.3.1 PROFINET configuration ..............................................................................  16212.3.2 IO and signal configuration ...........................................................................  16312.3.3 Signal definitions overview............................................................................  17112.3.4 Download of the GSDML file.........................................................................  17212.3.5 Help...............................................................................................................  172

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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Table of contents 4/216

    13.2 Menu commands.......................................................................................................... 17413.2.1 Project - Save ...............................................................................................  17413.2.2 EDS Download..............................................................................................  17513.2.3 Printing the configuration ..............................................................................  17513.2.4 Help - Contents .............................................................................................  17613.2.5 Help - Information .........................................................................................  176

    13.3 Configuration tree......................................................................................................... 17713.3.1 EtherNet/IP configuration..............................................................................  17713.3.2 IO and signal configuration ...........................................................................  17913.3.3 Signal definitions overview............................................................................  18713.3.4 Download of the EDS file ..............................................................................  18813.3.5 Help...............................................................................................................  188

    14 Edge Server ..........................................................................................................................  18914.1 Function principle ......................................................................................................... 189

    14.1.1 Communication with IT-network and mobile devices....................................  18914.1.2 Communication with the OT-network............................................................  19114.1.3 Access rights to the REST API .....................................................................  19114.1.4 Functions of the Edge Server .......................................................................  19214.1.5 Internal structure of the Edge Server ............................................................  193

    14.2 Edge Server Control Center......................................................................................... 19414.2.1 Starting the Edge Server Control Center ......................................................  19414.2.2 Functions ......................................................................................................  19414.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 ...........................................  198

    15 Technical data ......................................................................................................................  20015.1 Technical data NIOT-E-TPI51-EN-RE ......................................................................... 20015.2 Technical data PROFINET IO Device.......................................................................... 20215.3 Technical data EtherNet/IP Adapter............................................................................. 203

    16 FCC authorization ................................................................................................................  204

    17 Decommissioning, dismounting and disposal .................................................................  20517.1 Putting the device out of operation............................................................................... 20517.2 Removing device from top hat rail................................................................................ 20517.3 Disposal of waste electronic equipment....................................................................... 205

    18 Appendix...............................................................................................................................  20618.1 Legal notes................................................................................................................... 206

    List of figures .......................................................................................................................  210

    List of tables.........................................................................................................................  214

    Contacts................................................................................................................................  216

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Introduction 5/216

    1 Introduction

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

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

    Table 1: List of revisions

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Brief description 6/216

    2 Brief descriptionHilscher's netIOT Edge Gateway NIOT-E-TPI51-EN-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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Device drawings 7/216

    3 Device drawings

    3.1 Positions of the interfaces

    1

    2

    3

    Fieldbus

    ERR

    NS

    6

    RUN

    MS APL SYS

    LED1 LED2 ACT POW

    1

    LINK

    L/A

    LINK

    L/A

    ACT

    Rx/TX

    ACT

    Rx/TX

    IN

    CH0

    OUT

    CH1

    --

    +

    7

    8

    9

    10

    11

    54

    12

    Top view Front view Bottom view

    Pos. Interface For details see(1) Connector for digital LCD display (HDMI) HDMI connector [} page 10](2) USB connectors (2x USB 2.0 on top of device) USB connectors [} page 9](3) Antenna (1 x Wi-Fi, for service only) Wi-Fi [} page 10](4) ERR/NS LED LED for communication status

    Bus error (PROFINET) /Network status (EtherNet/IP)

    (5) RUN/MS LED LED for communication statusSystem error (PROFINET)/Module status (EtherNet/IP)

    (6) Gateway status LEDs (6 x) Gateway status LEDs [} page 12](7) USB connectors (2x USB 2.0 on front of device) USB connectors [} page 9](8) LAN connector (RJ45 jacket) port 1 / Eth0 LAN connectors [} page 9](9) Real-Time Ethernet connector (RJ45 jacket) channel 0 Real-Time Ethernet connectors [} page 9]

    (10) Real-Time Ethernet connector (RJ45 jacket) channel 1 Real-Time Ethernet connectors [} page 9]

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Device drawings 8/216

    Pos. Interface For details see(11) +24 V DC supply voltage connector (Mini Combicon) Power supply [} page 9](12) Cover at bottom of device (bolted) -

    Table 2: Positions of the interfaces of NIOT-E-TPI51-EN-RE

    3.2 Dimensions

    Fieldbus

    ERR

    NS

    RUN

    MS APL SYS

    LED1 LED2 ACT POW

    1

    LINK

    L/A

    LINK

    L/A

    ACT

    Rx/TX

    ACT

    Rx/TX

    IN

    CH0

    OUT

    CH1

    --

    +

    12

    0m

    m

    14

    0m

    m

    35 mm

    12

    0m

    m

    100 mm

    Figure 2: Dimensions

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Connectors and mounting 9/216

    4 Connectors and mounting

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

    4.2 Power supplyDC 24V Pin Signal Description

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

    FE Functional earth

    Table 3: Power supply connector

    4.3 LAN connectorsThe Edge Gateway has one LAN connector for connecting it to the cloudnetwork (IT network), position (8) (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 46] describes,how you can set the IP address parameters of the LAN interfaces.

    4.4 Real-Time Ethernet connectorsThe Edge Gateway has 2 RJ45-connectors to connect the fieldbus to aReal-Time Ethernet network (OT network), positions (9) and (10) (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 128] andExample 7: Fieldbus output node [} page 135] describe how to access thecyclic I/O data of the fieldbus in Node-RED.

    4.5 USB connectorsThe Edge Gateway has 4 USB connectors (4 x USB 2.0), positions (2) and(7) (see section Positions of the interfaces [} page 7]).

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Connectors and mounting 10/216

    4.6 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 Configuring wireless communication (WiFi) [} page 49] describeshow you activate the antennas and how to set the Wi-Fi operating mode.

    4.7 HDMI connectorThe Edge Gateway has an HDMI-connection for a monitor (position (1))which is not required for the operation of the Edge Gateway.

    The HDMI interface is inactive by default and just outputs boot informationduring the boot process of the device. If you want to use it, find an exampledocker image with activated HDMI interface and desktop at https://hub.docker.com/r/hilschernetpi/.

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

    https://hub.docker.com/r/hilschernetpi/https://hub.docker.com/r/hilschernetpi/

  • LEDs 11/216

    5 LEDs

    5.1 Positions of the LEDs on the gateway

    Fieldbus

    ERR

    NS

    3

    RUN

    MS APL SYS

    LED1 LED2 ACT POW

    1

    LINK

    L/A

    LINK

    L/A

    ACT

    Rx/TX

    ACT

    Rx/TX

    IN

    CH0

    OUT

    CH1

    --

    +

    4

    5

    6

    8

    9

    7

    1 2

    Figure 3: NIOT-E-TPI51-EN-RE LED positions

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • LEDs 12/216

    5.2 Gateway status LEDsLEDs indicating communication status, system status, application statusand voltage supply. The position of the LEDs is indicated by position (3) insection Positions of the LEDs on the gateway [} page 11].

    ERR

    NS

    RUN

    MS APL SYS

    LED1 LED2 ACT POW

    Figure 4: Gateway state LEDs

    LED Color MeaningERRNS (red)/

    (green)

    LED communication status Real-Time-Ethernet.Name and function depends on used RTE protocol:PROFINET IO Device = ERR (Bus failure) EtherNet/IP Adapter = NS(Network status) See sectionSee section LEDs of the PROFINET IO Device interface [} page 14] and section LEDs of theEtherNet/IP Adapter interface [} page 15].

    RUNMS (red)/

    (green)

    LED communication status Real-Time-Ethernet.Name and function depends on used RTE protocol:PROFINET IO Device = RUN (System failure)EtherNet/IP Adapter = MS (Module status)See section LEDs of the PROFINET IO Device interface [} page 14] and section LEDs of theEtherNet/IP Adapter interface [} page 15].

    APL( yellow)

    Application status

    SYS(yellow)/

    (green)

    System status

    LED1( yellow)

    GPIO12: can be programmed, currently not used.

    LED2(yellow)

    GPIO13: can be programmed, currently not used.

    ACT (green) Activity

    POW (green) Voltage supply is OK

    Table 4: Description of gateway status LEDs

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • LEDs 13/216

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

    LED Color State MeaningLINKPosition in the devicedrawing (3)

    LED green

    (green) On 100 MBit MBit network connection

    (off) off 10 MBit or no network connection

    RX/TXPosition in the devicedrawing (2)

    LED yellow

    (yellow) Flickering(loaddependent)

    The device sends/receives frames

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

    Table 5: LEDs LAN interface

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • LEDs 14/216

    5.4 LEDs of the PROFINET IO Device interfaceLED Color State MeaningRUN (SystemFailure)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 errorERR (Bus Failure)Position in the devicedrawing: (1)

    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 (6) , CH1 (7)

    LED green

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

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

    RX/TXCH0 (8) , CH1 (9)

    LED yellow

    (yellow)Flickering (loaddependent)

    The device sends/receives Ethernet frames.

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

    Table 6: 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 7: LED state definitions for the PROFINET IO-Device protocol

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • LEDs 15/216

    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.

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

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

    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).LINKCH0 (6) , CH1 (7)

    LED green

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

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

    ACTCH0 (8) , CH1 (9)

    LED yellow

    (yellow) Flickering (loaddependent)The device sends/receives Ethernet frames.

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

    Table 8: 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 9: LED state definitions for the EtherNet/IP Adapter protocol

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Commissioning the Edge Gateway 16/216

    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 5: Default settings of the Ethernet network connectors

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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Commissioning the Edge Gateway 17/216

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

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

    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 6: Device label: Hostname

    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 enter https://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 20].

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Commissioning the Edge Gateway 18/216

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

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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Edge Gateway Manager 19/216

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

    ð Your browser displays the Edge Gateway manager.

    Figure 8: Edge Gateway Manager

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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Edge Gateway Manager 20/216

    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 22]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 70]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 189].

    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.

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Edge Gateway Manager 21/216

    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 10: Starting applications with the Edge Gateway Manager

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 22/216

    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.

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 23/216

    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 9: 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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 24/216

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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 25/216

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

    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 10: Security error message of the Internet Explorer

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 26/216

    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 11: 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 12: 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.

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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 27/216

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

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

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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 28/216

    8.2 Control Panel commands

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

    Figure 16: 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 30]

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

    License Manager [} page 32]

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

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

    Backup and restore [} page 38]

    System > Reboot Rebooting the Linux operating system of the EdgeGateway

    Rebooting thesystem [} page 44]

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

    System shutdown [} page 44]

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

    Managing packets [} page 45]

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

    Configuring Ethernetcommunication(LAN) [} page 46]

    Network > WiFi Configuring the WiFi communication Configuring wirelesscommunication(WiFi) [} page 49]

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

    Field [} page 56]

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

    Hostname [} page 57]

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

    Starting, stopping and configuringservices [} page 58]

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

    Managing user roles [} page 61]

    User Management > Accounts Displaying user accounts und assigning userroles.

    Managing useraccounts [} page 63]

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

    Table 11: Functional overview of the Control Panel

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 29/216

    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.

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 30/216

    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 17: Page Info Center

    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-TPI51-EN-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 12: Info Center: Area System info

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 31/216

    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 13: Info Center: Area Monitoring

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

    GatewayTable 14: Info Center: Area Temperature

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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 32/216

    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.Ê The window of the License Manager opens:

    Figure 18: 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:

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 33/216

    Figure 19: License information in window Details

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

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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

    mailto:[email protected]

  • Control Panel 34/216

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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 35/216

    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 15: Setting the system time

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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 36/216

    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 : ()

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 37/216

    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.

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

    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

  • Control Panel 38/216

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

    To back up your system, proceed as follows:Ø Select System > Backup and Restore in the control panel.Ê Der folgende Bildschirm wird angezeigt:

    Figure 22: Backup and Restore

    Ø Click .Ê The following warning will be displayed:

    Figure 23: Warning

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 39/216

    This notice warns of the above-mentioned effects of the backup, e.g.duration, increased system load, no possibility to abort the process.Ø To start the backup, click Yes.Ê The following screen shows the message text Backup in progress to

    indicate that the backup has been started:

    Figure 24: Backup in progress

    ð . After the backup has been completed successfully, the button

    that was disabled (gray) so far is nowactivated and offers you the backup-file for download. The backup ofthe system files is thus completed.

    Restore 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 restore:· 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:

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 40/216

    Figure 25: Backup and restore

    Ø Click at Ê The following restore dialog is displayed:

    Figure 26: Restore dialog

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

    notice that the button is activated.

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

    Figure 27: Security query prior to system restore from internal backup file

    Ê You are informed about the consequences of system restore mentionedabove.

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

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

    in the internal backup. In any way, do not interrupt power supply of theEdge Gateway during system restore!

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 41/216

    Restore 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 restore:· that the former system is fully replaced and overwritten 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:

    Figure 28: Backup and restore

    Ø Click at .Ê The following restore dialog appears:

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 42/216

    Figure 29: Restore dialog (external source)

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

    Figure 30: Message prior to starting restore from external backup

    Ê You are informed about the consequences of system restore mentionedabove.

    Ø 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 restored from externalbackup. In any way, do not interrupt the power supply of the EdgeGateway during system restore!

    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:

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 43/216

    Figure 31: 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 32: 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.

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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 44/216

    8.2.2.5 Rebooting the system

    You have to login as Administrator to use this function.

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

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

    8.2.2.6 System shutdown

    You have to login as Administrator to use this function.

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

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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 45/216

    8.2.3 Packet management

    8.2.3.1 Managing packets

    Open this page with Package Manager > Packages.

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

    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.

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 46/216

    8.2.4 Network

    8.2.4.1 Configuring Ethernet communication (LAN)

    Open this page with Network > LAN.

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

    Access to LAN (Ethernet network)

    On this page you configure the Ethernet interfaces eth0 (on the side of thecloud) 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.

    Figure 36: Default LAN configuration

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 47/216

    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 16: Table LAN: Meaning of the columns

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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 48/216

    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 37: LAN configuration (cifx0 activated)

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 49/216

    8.2.4.2 Configuring wireless communication (WiFi)

    Open this page with Network > WiFi.

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

    Access to WiFI (wireless network)

    On this page you configure the wireless network communication of theEdge Gateway (WiFi / WLAN according to IEEE 802.11).

    The WiFi is deactivated when delivered (factory setting).

    Figure 38: WiFi (default setting)

    The Edge Gateway offers 2 WiFi operating modes. These can be selectedvia the selection list Mode, see following table.

    Figure 39: WiFi modes of operation

    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 17: WiFi modes of operation

    WiFi DescriptionOperating mode displays the active operating mode.Name displays the name of the WiFi interface (wlan0).MAC address displays the MAC address, if WiFi is activated.

    Table 18: WiFi

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 50/216

    Changing the operating mode

    You can change the operating mode via the Mode list.Ø Specify the parameters for the new operation mode.Ø Click at Change mode.Ê A safety query, whether you want to really change the operation mode,

    appearsØ Confirm the message with Ok.ð The message WiFi Settings are successfully changed is displayed.

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 51/216

    Operating mode Access point

    Figure 40: WiFi operating mode: Access point

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 52/216

    The following table describes the parameters of the operating mode Accesspoint.Element DescriptionOperationmode

    Current mode of operation Access point.

    Mode Selection list for changing the mode of operationSelect the new operation mode from the selection list and then click atChange mode.

    Name displays the name of the WiFi interface (wlan0).MAC address displays the MAC address, if WiFi is activated.IP address Specify IP address of Edge Gateway.Subnet mask Specify subnet mask of Edge Gateway.Gateway Specify IP address of network gateway.Channel Mit der Auswahlliste Channel stellen Sie den Funkkanal ein und bestimmen

    damit die im WLAN verwendete Funkfrequenz im 2,4-GHz-Band.Country In the list Country you can select the country in which you operate the radio

    network.SSID Specify Service Set Identifier of wireless network

    Here you enter the SSID to be used in the wireless network (WLAN) of theEdge Gateway.Note: Do not use the preset SSID.To be able to use a WLAN connection, you have to enter the SSID on anyWiFi client.

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

    Edge Gateway. To be able to use a WLAN connection, you have to enterthis key on any WiFi client.Note: Do not use the preset Shared key.

    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 19: Parameters of the operating mode Access point

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 53/216

    Operating mode Client

    Figure 41: WiFi operating mode: Client

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 54/216

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

    Current mode of operation Client.

    Mode Selection list for changing the operation modeSelect the new operation mode from the selection list and then click atChange mode.

    Name displays the name of the WiFi interface (wlan0).MACaddress

    displays the MAC address, if WiFi is activated.

    Receive IP addressthroughDHCPserver

    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.

    Channel Displays the used channel.SSID Displays the SSID (Service Set Identifier) of the Access Points the Edge

    Gateway is connected to.Table 20: Parameters of the operating mode Client

    Table Client

    For each found client, the following data is shown in a separate column ofthe table:· SSID (Service Set Identifier)· MAC Address· Quality (of radio signal)· Encryption· State· Stored connections.

    Scanning for a WLAN clientØ Click at Scan.ð If a WLAN client is found, it will be displayed in a line of the table Client.

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 55/216

    Establishing a connection to a WLAN client foundØ Click a line in the table which shows data of a client found.Ø Click at Connect.ð A dialog to enter the passwort is displayed.Ø Enter the password and click Connect.ð The Edge Gateway tries to establish a WLAN connection with the found

    client. If this does not succeed, an error message is displayed.

    Delete stored connectionØ Click at Delete in the table line of the connection to be deleted..ð The stored connection is deleted and the message WiFi successfully

    disconnected is displayed.

    Saving the WiFi settings

    To save the WiFi settings, you need the access right 'Write' for the WiFipage.Ø Click at Save changes.ð A security request box appears.Ø Click at OK.ð The WiFi settings are saved.

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 56/216

    8.2.4.3 Field

    Open this page with Network > Field.

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

    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.In Node-RED use

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

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

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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 57/216

    8.2.4.4 Hostname

    Open this page with Network > Hostname.

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

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

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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 58/216

    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,· den Betriebszustand jedes Dienstes anzeigen,· display the operating status of each service,· activate/deactivate Autostart, and

    A service can allow you individual settings.

    The list of services is displayed at the left edge:

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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 59/216

    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 44: Message at overwriting of current NodeRED flow

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

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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 60/216

    Undo last deploy in Node-RED

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

    Figure 46: 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 78].

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 61/216

    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 47: 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 192]) is also aresource.

    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 35]Packet managementManaging packets Package Manager >

    PackagesManaging packets [} page 45]

    Network accessAccess to LAN (Ethernetnetwork)

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

    Access onto WiFI (wirelessnetwork)

    Network > WiFi Configuring wirelesscommunication(WiFi) [} page 49]

    Access onto hostname of EdgeGateway

    Network > Hostname Hostname [} page 57]

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 62/216

    Access right / Resource Access to resourceaccomplished via menuentry

    Usage

    Access onto Field network(Ethernet network)

    Network > Field

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

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

    SecurityInstall security certificates Security > SSL/TLS

    CerticateUploading and installing ownsecuritycertificates [} page 65]

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

    Server [} page 192]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

    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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 63/216

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

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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 64/216

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

    It looks like:

    Figure 49: Security submenu

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

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

    Install security certificates

    This page SSL certificate information about the currently used securitycertificate. You also can upload and install a new security certificate here(File type *.pem, File size

  • Control Panel 65/216

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

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

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

  • Control Panel 66/216

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

    Also see about this2 Uploading and installing own security certificates [} 65]

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 67/216

    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 53: Info page

    Edge Gateway | NIOT-E-TPI51-EN-RE (connect)DOC170502UM01EN | Revision 1 | English | 2018-03 | Released | Public

    © Hilscher 2018

  • Control Panel 68/216

    8.2.9 Session

    8.2.9.1 User profile

    Open this page