hilscher netFIELD NIOT-ETPI51-EN-RE/NFLD User manual

User manual
netFIELD Connect
Hilscher Gesellschaft für Systemautomation mbH
www.hilscher.com
DOC191101UM02EN | Revision 2 | English | 2020-05 | Released | Public

Table of contents 2/91
Table of contents
1 Introduction .............................................................................................................................. 4
1.1 Description of the contents...............................................................................................4
1.2 List of revisions ................................................................................................................4
1.3 Conventions in this document ..........................................................................................5
2 Brief description ...................................................................................................................... 6
2.1 Terms and abbreviations..................................................................................................6
2.2 Intended use ....................................................................................................................6
2.3 Key features .....................................................................................................................7
2.4 netFIELD OS: Industrial IoT Operating System ...............................................................8
2.5 Depiction of netFIELD Connect SW architecture ...........................................................11
3 Safety notes............................................................................................................................ 12
3.1 Risk of device destruction by exceeding the allowed supply voltage.............................12
3.2 Limitation of program/erase cycles of SD card ..............................................................12
4 Hardware description ............................................................................................................ 13
4.1 Device drawings.............................................................................................................13
4.1.1 Positions of the interfaces............................................................................... 13
4.1.2 Dimensions ..................................................................................................... 14
4.2 Interfaces .......................................................................................................................15
4.2.1 Power supply .................................................................................................. 15
4.2.2 LAN connector ................................................................................................ 15
4.2.3 Real-Time Ethernet connectors ...................................................................... 15
4.2.4 USB connectors .............................................................................................. 15
4.2.5 Wi-Fi................................................................................................................ 16
4.2.6 HDMI connector .............................................................................................. 16
4.3 LEDs ..............................................................................................................................17
4.3.1 Positions of the LEDs on the device ............................................................... 17
4.3.2 Device status LEDs......................................................................................... 17
4.3.3 LEDs of the LAN interface .............................................................................. 18
4.3.4 LEDs of the Real-Time Ethernet interface ...................................................... 19
5 Commissioning and first steps ............................................................................................ 20
5.1 Overview ........................................................................................................................20
5.1.1 netFIELD Portal user ...................................................................................... 20
5.1.2 Standard Docker user ..................................................................................... 21
5.2 Mounting ........................................................................................................................22
5.3 Establish LAN connection and login to local Device Manager .......................................22
5.4 Set system time..............................................................................................................26
5.5 "Onboard" (register) device in netFIELD Portal .............................................................28
5.5.1 Overview ......................................................................................................... 28
5.5.2 Onboarding using the “Basic” method ............................................................ 29
5.5.3 Onboarding using the “Advanced” method ..................................................... 31
6 Device Manager...................................................................................................................... 37
6.1 Overview ........................................................................................................................37
6.2 System ...........................................................................................................................39
netFIELD Connect | User manual
DOC191101UM02EN | Revision 2 | English | 2020-05 | Released | Public
© Hilscher 2020

Table of contents 3/91
6.3 Networking .....................................................................................................................42
6.4 Onboarding (and offboarding) ........................................................................................45
6.5 Standard Docker ............................................................................................................48
6.6 IoT Edge Docker ............................................................................................................54
6.7 Accounts ........................................................................................................................59
6.8 Certificate .......................................................................................................................62
6.9 General Settings ............................................................................................................63
6.10 Terminal .........................................................................................................................65
6.11 Operating System Update..............................................................................................66
6.12 Logs ...............................................................................................................................69
7 Good to know... ...................................................................................................................... 70
7.1 Device recovery via USB ...............................................................................................70
7.2 How to change the default Docker network configuration..............................................74
7.3 Useful CLI commands and parameters in Terminal.......................................................77
7.3.1 Network Manager............................................................................................ 77
7.3.2 Connect to Wi-Fi Access Point ....................................................................... 77
7.3.3 Docker Compose Support for Standard Docker environment......................... 77
7.3.4 Manage Standard Docker ............................................................................... 77
7.3.5 Manage IoT Edge Docker ............................................................................... 77
7.3.6 Enable/disable SSH Daemon (release port 22) .............................................. 77
7.3.7 External storage support using iSCSI ............................................................. 78
7.3.8 Follow the system log via terminal CLI ........................................................... 78
8 Technical data ........................................................................................................................ 79
9 Decommissioning, dismounting and disposal ................................................................... 81
9.1 Putting the device out of operation.................................................................................81
9.2 Removing device from top hat rail..................................................................................81
9.3 Disposal of waste electronic equipment.........................................................................81
10 Appendix................................................................................................................................. 82
10.1 Approvals .......................................................................................................................82
10.1.1 Federal Communications Commission (FCC) ................................................ 82
10.1.2 Industry Canada (IC)....................................................................................... 83
10.2 Legal notes.....................................................................................................................84
List of figures ......................................................................................................................... 88
List of tables........................................................................................................................... 90
Contacts.................................................................................................................................. 91
netFIELD Connect | User manual
DOC191101UM02EN | Revision 2 | English | 2020-05 | Released | Public
© Hilscher 2020

Introduction 4/91
1 Introduction
1.1 Description of the contents
This user manual describes the hardware and the web-based management
GUI (local Device Manager) of the netFIELD Connect device (NIOT-E-
TPI51-EN-RE/NFLD) from Hilscher. Instructions on how to commission the
device are also provided in this document.
1.2 List of revisions
Index Date Revision
1 2020-04-17 Document created
2 2020-05-11 Download links for netFIELD OS update/recovery files
changed in sections and Operating System
Update [}page66] and Device recovery via
USB [}page70]
Table1: List of revisions
netFIELD Connect | User manual
DOC191101UM02EN | Revision 2 | English | 2020-05 | Released | Public
© Hilscher 2020

Introduction 5/91
1.3 Conventions in this document
Notes, instructions and results of operating steps are marked as follows:
Notes
Important:
<important note you must follow to avoid malfunction>
Note:
<general note>
<note on further information>
Instructions
1. Operational step
ØInstruction
ØInstruction
2. Operational step
ØInstruction
ØInstruction
Results
Intermediate result
Final result
netFIELD Connect | User manual
DOC191101UM02EN | Revision 2 | English | 2020-05 | Released | Public
© Hilscher 2020

Brief description 6/91
2 Brief description
2.1 Terms and abbreviations
Term Description
IIoT Industrial Internet of Things
IT network Information technology network
OT network Operational technology network
netFIELD OS Cross-platform capable operating system with connection to the
netFIELD Platform
netFIELD Edge Devices or systems running netFIELD OS
netFIELD Platform Internet hosted interface for netFIELD Edge with backend APIs
for any enterprise automation business and basis for the
netFIELD Portal
netFIELD Portal User web front end interface for the netFIELD Platform services
netX Multi-protocol communication controller for OT networks
Table2: Terms and abbreviations
2.2 Intended use
netFIELD Connect is an Edge Device hosting the netFIELD OS for
connecting an OT network – like e.g. PROFINET – with an IT network, the
netFIELD Platform or other custom IIoT services or applications.
netFIELD Connect | User manual
DOC191101UM02EN | Revision 2 | English | 2020-05 | Released | Public
© Hilscher 2020

Brief description 7/91
2.3 Key features
·Physical separation of OT network and IT network by using two
controllers:
– Primary controller: Edge computing, IIoT functions and cloud
connectivity are processed by the security-enhanced Yocto-Linux-
based netFIELD OS on the main CPU.
– Secondary controller: OT network connectivity (e.g. PROFINET) is
processed by the netX 51 communication controller.
·Applications for data acquisition, analytics, processing or connectivity
(to cloud or other enterprise systems) do not run natively under the
netFIELD OS, but as “containers” in a Docker runtime. netFIELD OS
provides two Docker runtimes that are running simultaneously on the
device:
–IoT Edge Docker for remote and automatic deployment and
maintenance of containers. These containers are deployed (“pulled”)
and managed over the netFIELD Platform. This requires your
netFIELD Connect device to be onboarded in the netFIELD Portal.
Note that you need an account/subscription for the netFIELD Portal
(https://www.netfield.io) for this.
–Standard Docker for manual and local deployment and
maintenance of containers.
Those containers can be pulled from official registries like Docker
Hub (https://hub.docker.com) or any locally hosted Docker registry.
In case you do not participate in the device registration and
onboarding process, the standard Docker is the only way to pull and
run container applications on your device.
·The netFIELD OS features the local Device Manager, which is a web-
based GUI for local device parameterization.
netFIELD Connect | User manual
DOC191101UM02EN | Revision 2 | English | 2020-05 | Released | Public
© Hilscher 2020

Brief description 8/91
2.4 netFIELD OS: Industrial IoT Operating System
The netFIELD OS, as a part of our technology portfolio, supports scalable
field device hardware depending on the customer's use case. In order to
achieve this, applications do not run directly on the host system but instead
as containers in a Docker runtime. Our OS is very lean and only supports
the essential services required by the customer's network infrastructure.
Features
·Run containers: Containers are revolutionizing connected IoT devices,
and netFIELD OS is the perfect match to run them.
·Manage device: Manage your device locally with a web-based
interface. It is easy to administer storage, configure networks, and
more.
·Build to last: Build to survive in harsh environments like unexpected
shutdowns with security in mind.
·Easy to port: Based on Yocto Linux for easy porting to most capable
device types across various CPU architectures.
Architecture
Hilscher netFIELD OS is a secure operating system that makes it easy to
program, deploy, connect and manage Edge Devices. Hilscher netFIELD
OS extends the Linux kernel, with software libraries to securely connect
operation technology like PLC, MES, Historians, Files or other on-premise
systems with IT services like the netFIELD Portal. Our OS lets you innovate
faster embracing container technologies managed by the netFIELD Portal
from a central point or locally at the edge.
Figure1: netFIELD OS architecture
netFIELD Connect | User manual
DOC191101UM02EN | Revision 2 | English | 2020-05 | Released | Public
© Hilscher 2020

Brief description 9/91
Core Services
The netFIELD OS core services include the support of hardware interfaces,
the network environment, secure communication and system logging. In
order to support the customer in setting up the gateway configuration, the
Local Device Manager is coming along with the core services. With the
open plug-in mechanism, the functionality of the Local Device Manager can
be easily extended with the help of containerized applications.
Container Management
Application containers can run in the IoT Edge Docker or Standard Docker
environment and do contain business logic such as for data acquisition,
analytics, processing or connectivity to cloud or enterprise systems.
The container management provides the functionality to pull and run
containers on the device itself. Before a container can be run, its image
needs to be pulled from a certain container registry. After that the container
is created, the application can be then controlled by using the start / stop
commands or by enabling the autostart option. Also, the deletion of
containers and images is a part of container management. In order to
enable the field devices for off- and online scenarios, netFIELD OS
provides two Docker runtime environments at the same time.
The IoT Edge Docker environment is managed by the netFIELD.io platform
remotely. That is why there is no need to have direct access to the
netFIELD Device, as long as the device can hold his connection to
netFIELD.io. Administrators can be anywhere and have full management
access to the device with the stored images and has the ability to control
the application containers remotely. Otherwise, the Standard Docker can
be used locally if the netFIELD device is not connected to netFIELD.io. In
this case, the Standard Docker runtime environment can be managed by
the netFIELD OS command line interface or by a web application like
portainer.io, which is running in a container as well.
Figure2: netFIELD OS container management
netFIELD Connect | User manual
DOC191101UM02EN | Revision 2 | English | 2020-05 | Released | Public
© Hilscher 2020

Brief description 10/91
Inter-Container Communication
Application containers usually focus on the dedicated business logic in
order to avoid the development of unmaintainable software monoliths. In
this scenario, multiple containers need to work together to realize customer
use cases. Our powerful message and container-oriented architecture
provide the highest level of flexibility and reusability when implementing
customer solutions with individual requirements. This reduces IoT solution
cost in development and operation.
Figure3: netFIELD OS inter-container communication
Services supported by netFIELD OS
·Network interface configuration
·Secure communication to the netFIELD Platform services
·Firewall configuration (NAT, TCP/IP port management)
·Proxy settings
·IoT Edge Docker instance for application container managed via
netFIELD Platform
·Additional Docker instance for locally managed containers, including
Docker Compose support
·netFIELD OS update (local/remote) support
·Onboarding in netFIELD Portal
·Network storage (NFS, iSCSI) support
·Resources monitoring
·Access to netFIELD OS and Docker services via a web-terminal or over
SSH
·System and container logging
netFIELD Connect | User manual
DOC191101UM02EN | Revision 2 | English | 2020-05 | Released | Public
© Hilscher 2020

Brief description 11/91
2.5 Depiction of netFIELD Connect SW architecture
Figure4: netFIELD Connect SW architecture
netFIELD Connect | User manual
DOC191101UM02EN | Revision 2 | English | 2020-05 | Released | Public
© Hilscher 2020

Safety notes 12/91
3 Safety notes
3.1 Risk of device destruction by exceeding the allowed supply
voltage
Observe the following notes concerning the voltage supply:
·The device may only be operated with the specified supply voltage of 24
V DC (± 6 V DC). Make sure that the limits of the allowed range for the
supply voltage are not exceeded.
·A supply voltage above the upper limit can cause severe damage to the
device!
·A supply voltage below the lower limit can cause malfunction of the
device.
3.2 Limitation of program/erase cycles of SD card
The Micro SD card (8 GB MLC NAND) supports approximately 3000
program/erase cycles per flash block. Keep this limitation in mind when
planning your application. For e.g. applications involving frequent database
usage on your device, 3000 program/erase cycles may be insufficient.
netFIELD Connect | User manual
DOC191101UM02EN | Revision 2 | English | 2020-05 | Released | Public
© Hilscher 2020

Hardware description 13/91
4 Hardware description
4.1 Device drawings
4.1.1 Positions of the interfaces
Top view:
Front view:
Bottom view:
netFIELD Connect | User manual
DOC191101UM02EN | Revision 2 | English | 2020-05 | Released | Public
© Hilscher 2020

Hardware description 14/91
Pos. Interface For details see
(1) Connector for digital LCD display (HDMI) HDMI connector [}page16]
(2) USB connectors (2x USB 2.0 on top of device) USB connectors [}page15]
(3) Antenna (WiFi/Bluetooth) Wi-Fi [}page16]
(4) ERR/NS LED LED for indicating the communication status of the Real-
Time Ethernet network (OT network at “Fieldbus”
connector).
If PROFINET is used: “Bus failure”
If EtherNet/IP is used: “Network status”
(5) RUN/MS LED LED for indicating the communication status of the Real-
Time Ethernet network (OT network at “Fieldbus”
connector).
If PROFINET is used: “System failure”
If EtherNet/IP is used: “Module status”
(6) Device status LEDs (6 x) Device status LEDs [}page17]
(7) USB connectors (2x USB 2.0 on front of device) USB connectors [}page15]
(8) LAN connector (RJ45 jacket) port 1 / Eth0 LAN connector [}page15]
(9) Real-Time Ethernet connector (RJ45 jacket)
channel 0
Real-Time Ethernet connectors [}page15]
(10) Real-Time Ethernet connector (RJ45 jacket)
channel 1
(11) +24 V DC supply voltage connector (Mini
Combicon)
Power supply [}page15]
(12) Cover of slot for NPIX Extension Modules –
Table3: Positions of the interfaces
4.1.2 Dimensions
Figure5: Device dimensions
netFIELD Connect | User manual
DOC191101UM02EN | Revision 2 | English | 2020-05 | Released | Public
© Hilscher 2020

Hardware description 15/91
4.2 Interfaces
4.2.1 Power supply
See position (11) in section Positions of the interfaces [}page13].
DC 24V Pin Signal Description
- GND Ground (Reference potential)
+ +24 V DC +24 V DC
FE Functional earth
Table4: Power supply connector
4.2.2 LAN connector
The RJ45 LAN connector (see position (8) in section Positions of the
interfaces [}page13]) allows you to connect your device to your IT
network, respectively to the cloud (e.g. the netFIELD Portal).
The MAC address of the LAN interface is printed on the device label.
Note that the “factory setting” for the IP address of the LAN port (eth0) is
DHCP mode.
You can set its IP address manually in the local Device Manager (see
section Networking [}page42]).
4.2.3 Real-Time Ethernet connectors
The two RJ45 connectors (see positions (9) and (10) in section Positions of
the interfaces [}page13]) allow you to connect your device to a Real-Time
Ethernet network (OT network) as slave device.
The MAC addresses of the RTE interfaces are printed on the device label
(“Fieldbus MAC addr.”).
Note that you must deploy software containers featuring the appropriate
applications (e.g. netFIELD PROFINET IO Connector) on the device in
order to use the Real-Time Ethernet interface.
Note:
The RTE interface can also be used like a standard Ethernet
interface with limited data through-put. (In this case, multicasts are
not supported.) In order to use the RTE interface as standard TCP/
IP interface, you must deploy the netFIELD PROFINET IO
Connector container.
4.2.4 USB connectors
The device is equipped with four USB 2.0 ports (see positions (2) and (7) in
section Positions of the interfaces [}page13]).
For maximum allowed output current, see section Technical
data [}page79].
netFIELD Connect | User manual
DOC191101UM02EN | Revision 2 | English | 2020-05 | Released | Public
© Hilscher 2020

Hardware description 16/91
4.2.5 Wi-Fi
The device is equipped with a Wi-Fi interface according to IEEE 802.11.
(For the position of the antenna, see position (3) in section Positions of the
interfaces [}page13].)
The Wi-Fi MAC address is printed on the device label.
Note that the Wi-Fi interface is deactivated by default, but can be activated
by software.
The Wi-Fi interface supports two operating modes: Access Point and
Client. In Access Point mode, the device acts as server allowing other Wi-
Fi devices (e.g. smartphones or tablets) to connect to the device in order to
configure it. The Client mode allows the device to connect to any available
Wi-Fi Access Point.
4.2.6 HDMI connector
The device is equipped with an HDMI connector (see position (1) in section
Positions of the interfaces [}page13]).
Note that connecting a monitor here is optional and not required for the
“normal” operation of the device.
Note also that the HDMI interface by default is deactivated during runtime,
which means that it outputs only “boot information” during device booting.
However, you can activate and use the HDMI interface if you deploy a
software container featuring an appropriate application.
netFIELD Connect | User manual
DOC191101UM02EN | Revision 2 | English | 2020-05 | Released | Public
© Hilscher 2020

Hardware description 17/91
4.3 LEDs
4.3.1 Positions of the LEDs on the device
Figure6: LED positions on device
4.3.2 Device status LEDs
LEDs indicating communication status, system status, application status
and voltage supply (see position (3) in section Positions of the LEDs on the
device [}page17]).
E
R
R
N
S
R
U
N
M
S
APL SYS
LED1 LED2 ACT POW
Figure7: Gateway state LEDs
netFIELD Connect | User manual
DOC191101UM02EN | Revision 2 | English | 2020-05 | Released | Public
© Hilscher 2020

Hardware description 18/91
LED Color Meaning
ERR
NS (red)/ (green) Communication status LED of the Real-Time-Ethernet network (OT network). Name and function depend on the used RTE protocol:
If PROFINET is used: “Bus failure”
If EtherNet/IP is used: “Network status”
Note: This LED is controlled by the netX communication controller and is independent
from the netFIELD OS operating system. This means that – as long as the device is
powered – the LED might be active, even if the netFIELD OS has been shut down.
Note also that the LED will be showing red light until the device has been properly
configured for Real-Time Ethernet communication (which requires the deployment of
the appropriate software containers on the device).
RUN
MS (red)/ (green) Communication status LED of the Real-Time-Ethernet network (OT network). Name and function depend on the used RTE protocol:
If PROFINET is used: “System failure”
If EtherNet/IP is used: “Module status”
Note: This LED is controlled by the netX communication controller and is independent
from the netFIELD OS operating system. This means that – as long as the device is
powered – the LED might be active, even if the netFIELD OS has been shut down.
APL (yellow) Application status (of the netX)
Note: This LED is controlled by the netX communication controller and is independent
from the netFIELD OS operating system. This means that – as long as the device is
powered – the LED might be active, even if the netFIELD OS has been shut down.
SYS (yellow)/ (green) System status (of the netX)
Note: This LED is controlled by the netX communication controller and is independent
from the netFIELD OS operating system. This means that – as long as the device is
powered – the LED might be active, even if the netFIELD OS has been shut down.
LED1 (yellow) GPIO12: can be programmed, currently not used.
LED2 (yellow) GPIO13: can be programmed, currently not used.
ACT (green) Activity (of the Linux OS)
POW (green) Voltage supply is OK
Table5: Description of device’s status LEDs
4.3.3 LEDs of the LAN interface
LEDs indicating state of the LAN communication (see positions (4) and (5)
in section Positions of the LEDs on the device [}page17]).
LED Color State Meaning
ACT / RX/TX
Position in the device
drawing (4)
LED yellow
(yellow) Flickering
(load
dependent)
The device sends/receives frames
(off) off The device does not send/receive frames.
LINK
Position in the device
drawing (5)
LED green
(green) On 100 MBit network connection
(off) off 10 MBit or no network connection
Table6: LEDs LAN interface
netFIELD Connect | User manual
DOC191101UM02EN | Revision 2 | English | 2020-05 | Released | Public
© Hilscher 2020

Hardware description 19/91
4.3.4 LEDs of the Real-Time Ethernet interface
LEDs (1), (2), (6), (7), (8) and (9) in section Positions of the LEDs on the
device [}page17] relate to the Real-Time Ethernet protocol (OT network).
They are not described here in detail, because they depend on your use
case and the Real-Time Ethernet container that you have deployed on your
device.
For detailed descriptions of the meaning of these LEDs, see the
documentation of the RTE container.
netFIELD Connect | User manual
DOC191101UM02EN | Revision 2 | English | 2020-05 | Released | Public
© Hilscher 2020

Commissioning and first steps 20/91
5 Commissioning and first steps
5.1 Overview
5.1.1 netFIELD Portal user
The following table shows the steps that you must perform in order to
commission the netFIELD Connect device if you are a user of the netFIELD
Portal.
# Step For details see
0 Requirements:
·You have a netFIELD Portal account
·DHCP service is available in your
Ethernet LAN (IT network)
-
1 Mount netFIELD Connect device Section Mounting [}page22]
2 Establish LAN connection and login to local
Device Manager
Section Establish LAN connection and
login to local Device
Manager [}page22]
3 Set local system time Section Set system time [}page26]
4 “Onboard” (register) device in netFIELD
Portal
Section "Onboard" (register) device in
netFIELD Portal [}page28]
5 Optional: Deploy application container(s)
from netFIELD Portal (if not already
deployed through Deployment Manifest)
Section Deploying containers on your
device in the operating instruction
manual netFIELD Portal,
DOC190701OIxxEN
Table7: Tasks for commissioning the netFIELD Connect (netFIELD Portal user)
netFIELD Connect | User manual
DOC191101UM02EN | Revision 2 | English | 2020-05 | Released | Public
© Hilscher 2020