hilscher netFIELD Compact X8M User Manual
  1. Manuals
  2. Brands
  3. hilscher Manuals
  4. Gateway
  5. netFIELD Compact X8M
  6. User manual

hilscher netFIELD Compact X8M User Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
User manual
netFIELD Compact X8M
Hilscher Gesellschaft für Systemautomation mbH
www.hilscher.com
DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the netFIELD Compact X8M and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for hilscher netFIELD Compact X8M

Summary of Contents for hilscher netFIELD Compact X8M

  • Page 1 User manual netFIELD Compact X8M Hilscher Gesellschaft für Systemautomation mbH www.hilscher.com DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 2: Table Of Contents

    Onboarding using the “Basic” method ............ 38 4.5.3 Onboarding using the “Advanced” method .............  40 Local Device Manager ...................... 47 Overview ........................ 47 netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...
  • Page 3 Dismounting ......................... 123 Disposal ........................ 124 Legal notes ...........................  127 List of figures ........................ 132 List of tables.........................  135 Contacts.......................... 136 netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 4: Introduction

    About this document 1.1.1 Description of the contents This user manual describes the netFIELD Compact X8M edge gateway (NFX8M-D2-N32-010) from Hilscher. It contains a description of its hardware, its technical data and a description of its web-based configuration GUI (Local Device Manager).

  • Page 5: Conventions In This Document

    1. Operational step Ø Instruction Ø Instruction 2. Operational step Ø Instruction Ø Instruction Results Intermediate result Final result netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 6: Terms And Abbreviations

    It is the basic framework of the evolved netFIELD device-to-cloud communication infrastructure. netFIELD App netFIELD application Docker container from Hilscher. Runs in the IoT Edge Docker or Standard Docker of the netFIELD OS on the netFIELD Edge. netFIELD Cloud Internet-hosted platform providing APIs for cloud-to-cloud and cloud-to-edge communication.

  • Page 7: Brief Description

    Introduction 7/136 Brief description Overview netFIELD Compact X8M is an edge gateway for running custom software, close-to-machine deployment of workloads and distributing IIoT logic and intelligence. Connecting your netFIELD Compact over the Internet to the netFIELD Cloud (https://www.netfield.io) allows you to manage your device via...
  • Page 8 For more details and information about the netFIELD OS, see section netFIELD OS: Industrial IoT Operating System [} page 9]. “High Assurance Boot”: Only Hilscher-authenticated netFIELD OS core · software can run on the device at any time.

  • Page 9: Netfield Os: Industrial Iot Operating System

    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.

  • Page 10: Figure 2: Netfield Os Container Management

    Device Manager, by the netFIELD OS command line interface or by a web application like portainer.io, which can be deployed as container. Figure 2: netFIELD OS container management netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 11: Figure 3: Netfield Os Inter-Container Communication

    This reduces IoT solution cost in development and operation. Figure 3: netFIELD OS inter-container communication netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...
  • Page 12 Management of Linux services in Local Device Manager · Connectivity check for IoT Edge Docker in Local Device Manager netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 13: Safety

    13/136 2 Safety Intended use netFIELD Compact X8M is an edge gateway for running custom software, close-to-machine deployment of workloads and distributing IIoT logic and intelligence. Additionally it allows you to connect it with netFIELD Cloud in order to control the device itself and the distribution of those applications from remote over the Internet.

  • Page 14: Device Destruction By Exceeding The Allowed Supply Voltage

    The device does not contain any parts that are serviceable by the user. Do not open or damage the housing. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 15: Hardware Description

    USB 2.0 type A connector USB connectors [} page 20] (11) Power button with LED indicator. Table 3: Positions on netFIELD Compact device netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 16: Dimensions

    Hardware description 16/136 Dimensions Figure 5: Dimensions in millimeters netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 17: Interfaces

    Figure 6: Adapter plug When connecting, turn the plug clockwise to lock it to the device (“bajonet”- type mounting). netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 18: Rs-485 Interface

    If you stop the uart1-mode service (e.g. with the systemctl stop uart1-mode command), the ttymxc0 interface will not be available any longer. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...
  • Page 19 If the container is deployed via Docker Compose, you would have to add the following lines in the *.yml file: devices:     - "/dev/ttymxc0:/dev/ttymxc0" group_add:     - dialout netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 20: Usb Connectors

    Value Baud rate 115200 Data bits Stop bits Parity none Flow control none Table 6: Serial port settings of console netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 21: Leds

    For more information on how to control LEDs under Linux, please refer to LED handling under Linux on https://www.kernel.org/doc/html/latest/leds/leds-class.html. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 22: Table 8: Setting Edg Led State In Mqtt Topic

    LED slow blinking green at 1 Hz LED static green on Table 8: Setting EDG LED state in MQTT topic netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 23: Commissioning And First Steps

    Portal, Manifest). DOC190701OIxxEN Table 9: Tasks for commissioning the netFIELD Compact for netFIELD Cloud usage netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 24: Standard Docker User

    Deploy and run containers in the Standard Docker. Table 10: Tasks for commissioning the netFIELD Compact for Standard Docker usage netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 25: Installation

    Ø Hook the upper clamps onto the DIN top hat rail, then release the lower clamps to lock the bracket onto the rail. Figure 9: Device mounted on DIN top hat rail netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 26: Figure 10: Remove Rail Clamp Screws

    Ø Use the Allen wrench/key respectively screwdriver and two M4 cylinder head screws of suitable length to screw the mounting bracket to the wall. Figure 11: Wall mounted netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...
  • Page 27 After connecting the supply voltage, switch on the device by pressing the power button (see position (11) in section Device overview [} page 15]) for approx. one second. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 28: Establish Lan Connection And Login To Local Device Manager

    Via direct (one-to-one) connection at ETH 2 port (eth1 in netFIELD · Figure 12: Factory IP address settings of LAN interfaces Note: The device contains a certificate issued by Hilscher. Therefore, your browser will probably issue an "unsecure connection" warning message when connecting to the device for the first time.

  • Page 29: Using Dhcp Server

    On the Certificate page of the Local Device Manager, you can later upload your own trusted certificate to the device. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 30: Figure 13: Host Name On Device Label (Example)

    Figure 13: Host name on device label (example) Note: Your PC and your device must be located in the same subnet. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 31: Establishing One-To-One Connection To Device (Without Dhcp Server)

    Ø In the General tab, set IP address 192.168.253.2 and subnet mask 255.255.255.0. Figure 14: Setting IP address under Windows for direct LAN connection Ø Click OK and then Close. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 32: Login To Local Device Manager

    User name: admin Password: admin Ø Read the Disclaimer then check the I have read and accept the Disclaimer box. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 33: Figure 16: Enter Current Password Dialog

    You can change the password again later in the Local Device Manager under Accounts > System Administrator > Set Password or under (user menu) > Account Settings. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 34: Figure 18: Re-Authentication Dialog

    Figure 18: Re-Authentication dialog Ø Enter your new password once again, then click Sign In button Ê The Local Device Manager opens. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 35: Set System Time

    (note that the list is searchable). netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...
  • Page 36 Ø To update the display of the system time (to adapt it to the changed time zone), refresh the web page by pressing the F5 key on your keyboard. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 37: Onboard" (Register) Device In Netfield Cloud

    Connecting your device to the netFIELD Cloud requires an account/ subscription for the netFIELD Cloud services https://www.netfield.io. Contact your local Hilscher sales representative for information on terms and conditions. Before your device can be managed from the portal, it must first complete a one-time registration process, called “onboarding”.

  • Page 38: Onboarding Using The "Basic" Method

    Ø In the E-Mail and Password fields, enter the credentials of a user of the portal who possesses createDevices and onboardedDevices permissions. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...
  • Page 39 From now on, the device will be listed in the portal’s Device Manager and can be managed from there. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 40: Onboarding Using The "Advanced" Method

    Onboarding, then open Advanced tab: Figure 22: Research Hardware ID Ø Select the Hardware ID and copy the string to your clipboard. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 41: Figure 23: Add Device Mask In Netfield Portal

    For information on how to configure these parameters, see section Device Navigation: Edit device settings (Update mask) in the netFIELD Portal manual (DOC190701OIxxEN). Ø Click Create button. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 42: Figure 24: Activation Code In Portal

    Activation Code that you will have to enter locally on your device: Figure 24: Activation Code in portal Ø Copy the Activation Code to your clipboard. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 43: Figure 25: Advanced Onboarding Tab In Device

    Ø In the API Endpoint field, enter the URL of the REST-API interface of the portal. For the Hilscher netFIELD Portal, this is: api.netfield.io If you are using a different instance of the portal, ask your portal’s system administrator for the URL.
  • Page 44 For creating a new key, you must have the permission to use the createKeys function of the keys resource. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 45: Figure 26: Example Of An Api Key Permitting To Onboard Devices

    Ø To copy the API Key in order to use it in the Local Device Manager of the device for the advanced onboarding process, change into the General tab. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 46: Figure 27: Copy Key To Clipboard

    Ø Go to the Onboarding > Advanced page in the Local Device Manager of your local device and insert the key into the API KEY field. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 47: Local Device Manager

    In the navigation panel on the left of the screen, you can select the available “standard” management pages. Many Hilscher netFIELD application containers like e.g. netFIELD App Platform Connector or netFIELD App OPC UA Client provide their own configuration GUI, which can be selected here (if deployed on your device).
  • Page 48 See also Accounts [} page 101] section for further information. – Log Out: Logs you out of the Local Device Manager netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 49: System

    Name and version of the installed netFIELD OS. Click on the blue name to open a window showing further details (i.e. the exact firmware version). netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 50: Figure 30: Change Host Name Dialog

    For instructions on how to change the time settings, see section Set system time [} page 35]. Last Reboot Shows date and time of the last reboot (restart) of the netFIELD OS. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...
  • Page 51 Network Traffic link to open the Networking page providing further details about the physical and virtual network interfaces of the device. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 52: Networking

    The graphs in the section on top show the amount of network traffic (sending and receiving) for the last five minutes. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 53: Figure 32: Details Of Lan Interface (Eth0)

    Ø You can click on an interface, e.g. eth0, in order to display further details or to configure its IP settings: Figure 32: Details of LAN interface (eth0) netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 54: Figure 33: Ipv4 Settings

    Ø To change the IP settings, e.g. to set a fixed IP address, click on Automatic (DHCP) next to IPv4. Ê The IPv4 Settings page opens. Figure 33: IPv4 Settings netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 55: Figure 34: Manual Ipv4 Settings

    IoT Edge Docker (Iotedge0), e.g. because it conflicts with other IP addresses in your company network, see section Docker Network Settings [} page 81] for further information. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...
  • Page 56 [} page 66] for more information.) NETWORKING LOGS The NETWORKING LOGS section lists messages issued by the Network Manager of the system. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 57: Firewall

    Local Device Manager and check out the container’s port settings by clicking on the corresponding image or container instance. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 58: Figure 35: Open Firewall Configuration Page

    Ø To open the Firewall configuration page, click the FIREWALL link on the Networking page. Figure 35: Open Firewall configuration page netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 59: Figure 36: Elements On Firewall Configuration Page

    (collapse) to hide the properties of the zone. Zones can be removed from the firewall by clicking the button. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 60: Figure 37: Add Zone Dialog

    + Add Zone button. Ê The Add Zone dialog opens: Figure 37: Add Zone dialog netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 61: Table 12: Elements In Add Zone Dialog

    Ø Click the Add Zone button in the footer. Ê The Add Zone dialog closes and the new interface is added to the zone. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 62: Table 13: Columns/Elements In Allowed Services Table

    (if the interface via which you are connected belongs to such a zone). Table 13: Columns/elements in Allowed Services table netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 63: Figure 38: Add Services

    Ø Select the service(s)/port(s) in the check box, then click Add Services in the footer. Ê The dialog closes and the allowed services/ports are added to the zone. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 64: Figure 39: Add Custom Services Dialog

    To add a new port forwarding definition to a zone, proceed as follows: Ø Click the + button above the Action column. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 65: Figure 40: Add Forward Port Dialog

    (i.e. for a zone that has already been added to your firewall). Table 15: Control elements in main toolbar netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 66: Network Proxy Settings

    The No Proxy entries designate destinations that shall not be addressed via Proxy server. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 67: Figure 42: Proxy Settings Dialog Window

    Ø Click the Edit Proxy button. Ê The Proxy Settings dialog opens: Figure 42: Proxy Settings dialog window netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 68: Figure 43: Using One Proxy Server For All Protocols

    OS that cannot be handled by a proxy server because they are required for internal communication. You can, however, add further exceptions in the Host field. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 69: Figure 44: Separate Http/Https/Ftp Configuration

    Ê This enables separate configuration fields for the HTTP, HTTPS and FTP protocols: Figure 44: Separate HTTP/HTTPS/FTP configuration Ø Enter the parameters of the individual proxy servers. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 70: Figure 45: Restart Dialog After Changing Proxy Server Configuration

    “device twin” in the cloud. To do so, open the Onboarding page of the netFIELD OS. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 71: Figure 46: Synchronize Proxy Settings With Netfield Portal

    OS. If your device is onboarded in the netFIELD Portal, do not forget to synchronize the new settings. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 72: Networking Services

    On the Wi-Fi tab of the Networking Services page, you can configure the Wi-Fi settings of netFIELD Edge Devices that are equipped with a wireless interface. Since the netFIELD Compact X8M device (NFX8M-D2-N32-010) has no Wi-Fi interface, this tab simply says “Wi-Fi hardware is not available or disabled”.

  • Page 73: Connectivity Check

    For more information on the iotedge check tool, see https:// docs.microsoft.com/en-us/azure/iot-edge/troubleshoot? view=iotedge-2020-11 https://github.com/Azure/iotedge/blob/ main/doc/troubleshoot-checks.md Figure 47: Connectivity Check tab netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...
  • Page 74 For more information on the checks that are being performed, see https://github.com/Azure/iotedge/blob/main/doc/troubleshoot- checks.md Note that the current netFIELD OS uses the iotedge check tool version 1.2.5. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 75: Onboarding (And Offboarding)

    “offboarding” the device. By offboarding it, the device will be "deleted" in the portal and removed from the device list of the portal’s Device Manager: netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 76: Figure 49: Offboarding "Basic

    Ø Click Offboard button. Ê After successful offboarding, the following message appears: Success – Device is now deleted. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 77: Figure 50: Offboarding "Advanced

    They can be deleted manually on the IoT Edge Docker page of the Local Device Manager. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 78: General Settings

    For more information about the Remote Control function, see netFIELD Portal operating instructions manual, DOC190701OIxxEN. Ø Click Save button to save your new Web Server Settings. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 79: Default Mqtt Client Settings

    JSON configuration file in the netFIELD OS (/etc/ gateway/mqtt-config.json). By default, all Hilscher netFIELD Apps use this configuration file. Other containers (i.e. non-Hilscher application containers) that do not require their own customized MQTT client settings, can also use these settings here if the configuration file is referenced accordingly in the container image (e.g.

  • Page 80: Table 16: Default Mqtt Client Settings

    (not recommended). Table 16: Default MQTT Client Settings Ø Click Save button to save your new Default MQTT Client Settings. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 81: Docker Network Settings

    Standard Docker and of the IoT Edge Docker. Important: These network address settings are predefined by Hilscher. Change these default addresses only if they are not compatible with your company’s LAN address configuration, i.e. to avoid an address conflict.

  • Page 82: Table 17: Standard Docker Network Settings

    Opens a dialog for adding a new pool of reserved addresses. Deletes the address pool. Table 17: Standard Docker Network Settings netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 83: Table 18: Standard Docker Network Settings

    Deletes the address pool. Table 18: Standard Docker Network Settings Ø Click Save button to save your new Docker Network Settings. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 84: Figure 54: Default Docker Network Configuration

    Local Device Manager 84/136 The following picture illustrates the default Docker network configuration: Figure 54: Default docker network configuration netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 85: Remote Access

    Note that your device must be onboarded in the netFIELD Cloud and connected to the Internet in order to use the remote control functions. Contact your local Hilscher sales representative for information on the terms and conditions of an account/subscription for the netFIELD Cloud services (https://www.netfield.io).

  • Page 86: Figure 55: Remote Access Tab

    Portal to your device. Accessing the netFIELD OS will then be possible via local LAN, SSH or Console connection only. Ø Click Save. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 87: Login

    Ø To remove the message from the Sign In dialog again, go to General Settings > Login and delete the message from the text field, then click Save button. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 88: Standard Docker

    (default). · Everything - All Docker images and containers are displayed (including stopped containers). netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 89: Figure 59: Expand Concise Container Details

    Figure 59: Expand concise container details Ø To manage a container, click on it in the list. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 90: Figure 60: Container Parameters With Terminal Window

    Ø To go back to the Standard Docker overview page, click the blue Show all containers link in the page header. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 91: Figure 61: Image Search Dialog Of Standard Docker

    Ø Select an image in the list, then click Download button. Ê The image is downloaded, extracted and displayed in the Images area. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 92: Figure 62: Run Image Dialog

    For information about the configuration parameters and environment variables that the container requires, consult the documentation or description of the image on Docker Hub. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 93: Figure 63: Expand Image Details

    Figure 63: Expand image details Ø To manage an image, click on it in the list. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 94: Figure 64: Image Details

    Portainer.io provides a well-documented web-based management GUI that can be deployed here in the Standard Docker like any other container from the Docker Hub. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 95: Iot Edge Docker

    The network address settings of the IoT Edge Docker can be managed under General Settings > Docker Network Settings (see section Docker Network Settings [} page 81]). Figure 65: IOT Edge Docker netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...
  • Page 96 The graph in the upper right corner shows the amount of mass storage memory taken by the images and containers (blue bar) and the amount of mass storage left available. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 97: Figure 66: Container Details Expanded

    Figure 66: Container details expanded Ø To display more details of the container, click on it in the list. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 98: Figure 67: Container Parameters

    “deployed” from the portal, the image will be automatically downloaded to the device again. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 99: Figure 68: Iot Image Expanded

    Figure 68: IoT image expanded Ø To show more details of an image, click on it in the list. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 100: Figure 69: Details Of Netfield Proxy Image

    UI) by using docker commands with the CLI in the Terminal. See section Useful CLI commands and parameters in Terminal [} page 119] for examples. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 101: Accounts

    Ê The Create New Account dialog opens: Figure 71: Create new account Ø Fill in the form, then click Create button. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 102: Figure 72: Edit Account

    Manager of the Portal. (If you delete an image only locally on the device without having deleted it in the Portal beforehand, the image will be automatically deployed again). netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...
  • Page 103 OS account name (e.g. “admin”) for authentication when you login. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 104: 5.10 Certificate

    *.pem format to the netFIELD OS. Figure 73: Web Server Certificate page Note: The netFIELD OS contains a certificate issued by Hilscher. Note that the automatically created certificate is valid for one year. You can upload your own certificate to the netFIELD OS here. The corresponding root certificate should be rolled out on each of your PC/devices that you use for connecting to the netFIELD OS.

  • Page 105: 5.11 Terminal

    For working with root privileges in the CLI, use “sudo”. Examples of commands and parameters are provided in section Useful CLI commands and parameters in Terminal [} page 119]. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 106: 5.12 System Update

    Note that it is not possible to “downgrade” your OS; i.e. the installation of an OS version that is “older” than the currently installed OS version will be denied. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 107: Figure 75: Os Update Page

    Portal in the cloud. However, this requires access to the portal (i.e. an account) and the deployment of the netFIELD App Platform Connector on your device. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 108: Figure 76: Selected Os Update Image

    Local Device Manager 108/136 To update the operating system, proceed as follows: 1. Download the update file (or recovery file) from Hilscher to your local PC. Ø Go to the netFIELD Software Overview page https://kb.hilscher.com/x/sSAfBw and navigate to the latest netFIELD OS Releases version.

  • Page 109: Figure 77: Upload Finished Message

    The installation process (i.e. the actual update of the OS) is automatically started. The device reboots and closes the LAN connection. Figure 78: OS update “Disconnected” message netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...
  • Page 110 (see chapter Commissioning and first steps [} page 23]). netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 111: 5.13 Logs

    Severity (type) and Service (i.e. the “service” that issued the message). Ø Click on a message in the list to display the information in full detail. Figure 79: Logs netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 112: 5.14 Services

    In the drop-down list, you can filter the services by their automatic startup setting; i.e. Static, Enabled and Disabled. List of services showing their current states and automatic startup settings. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 113: Figure 81: Service Details And Settings Page

    Requires) are displayed as clickable links. The log messages of the service are displayed under SERVICE LOGS in the footer. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 114: Figure 82: Service Types: Timers

    To remove a timer completely, you have to use the Terminal to delete it manually in the corresponding systemd configuration. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 115: Good To Know

    Windows in FAT32. If you intend to use such a high-capacity stick, use a tool like e.g. HP USB STICK FORMAT to format the stick under Windows. You have downloaded the recovery image from Hilscher to your local · PC (see below for instructions).

  • Page 116: Figure 84: Formatting Usb Stick

    Good to know 116/136 Step-by-step instructions 1. Download the zip archive containing the recovery image from Hilscher to your local PC and unpack it. Ø Go to the netFIELD Software Overview page https://kb.hilscher.com/x/sSAfBw and navigate to the latest netFIELD OS Releases version. On the netFIELD OS Version page, scroll down to the netFIELD Compact section.

  • Page 117: Figure 85: Format Usb Stick Dialog Window

    Ê After formatting is finished, the USB stick is labelled in the Windows Explorer by its new name “RECOVERY”. Figure 86: Formatted USB stick netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 118: Figure 87: Recovery Image On Usb Stick

    DHCP, default administrator password is set to admin). You can now reconnect to the device as described in chapter Establish LAN connection and login to Local Device Manager [} page 28]. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 119: Useful Cli Commands And Parameters In Terminal

    Manage IoT Edge Docker docker-iotedge <docker commands> Example To list all created containers for the IoT Edge Docker instance: docker-iotedge ps -a netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 120: External Storage Support Using Iscsi

    Set serial interface remanently to RS-232: sudo bash -c 'echo "mode=rs232" > /etc/default/uart1' systemctl restart uart1-mode netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 121: Technical Data

    Aluminum Degree of protection IP20 Mounting type DIN top hat rail mounting or wall mounting (with two M4 screws) netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 122: Table 19: Technical Data Netfield Compact

    EN 55032/5, EN 61000-6-2, EN 61000-6-3 compatibility (EMC) Safety EN/UL/IEC 62368-1 Approvals In preparation Conformity declarations UKCA RoHS Table 19: Technical data netFIELD Compact netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 123: Decommissioning, Dismounting And Disposal

    Ø Press down the spring-loaded lower rail clamps at the back of the mounting bracket and lift the device from the top hat rail. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 124: Disposal

    Removing of battery If you do not want to return the device to Hilscher, you have to remove the battery and dispose of it properly prior to the disposal of the device.

  • Page 125: Figure 89: Open Device Housing

    Ø Remove the battery from the device. The position of the battery is marked in the photo below: Figure 90: Position of battery in device netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...
  • Page 126 You are legally obliged to dispose of all waste electronic equipment according to national and local regulations. If desired by the customer, Hilscher takes back this product and disposes of it according to the applicable regulations. Note that transportation costs must be paid by the customer.

  • Page 127: Legal Notes

    Any form of further use shall require the express consent from the relevant owner of the rights. netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...
  • Page 128 Liability disclaimer The hardware and/or software was created and tested by Hilscher Gesellschaft für Systemautomation mbH with utmost care and is made available as is. No warranty can be assumed for the performance or...
  • Page 129 Warranty Hilscher Gesellschaft für Systemautomation mbH hereby guarantees that the software shall run without errors in accordance with the requirements listed in the specifications and that there were no defects on the date of acceptance.
  • Page 130 The customer hereby expressly acknowledges that this document contains trade secrets, information protected by copyright and other patent and ownership privileges as well as any related rights of Hilscher Gesellschaft für Systemautomation mbH. The customer agrees to treat as confidential all of the information made available to customer by Hilscher Gesellschaft für...
  • Page 131 Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 132: List Of Figures

    Add services ......................63 Figure 39: Add custom services dialog.................. 64 Figure 40: Add forward port dialog ..................65 netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...
  • Page 133 OS update “Disconnected” message..............109 Figure 79: Logs........................111 Figure 80: Services page....................... 112 Figure 81: Service details and settings page................. 113 netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...
  • Page 134 Detach device from mounting bracket ..............124 Figure 89: Open device housing.................... 125 Figure 90: Position of battery in device.................. 125 netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...
  • Page 135 Standard Docker Network Settings ................ Table 18: Standard Docker Network Settings ................ Table 19: Technical data netFIELD Compact................. 121 netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

  • Page 136: Contacts

    Phone: +1 630-505-5301 20090 Vimodrone (MI) E-mail: us.support@hilscher.com Phone: +39 02 25007068 E-mail: info@hilscher.it Support Phone: +39 02 25007068 E-mail: it.support@hilscher.com netFIELD Compact X8M | User manual © Hilscher 2022 DOC220302UM01EN | Revision 1 | English | 2022-05 | Released | Public...

This manual is also suitable for:

Nfx8m-d2-n32-010

Table of Contents