netFIELD App PROFINET Tap Operating instruction manual

Table of contents 2/73

Table of contents1 Introduction .............................................................................................................................. 4

1.1 Description of the contents............................................................................................... 41.2 List of revisions ................................................................................................................ 41.3 Conventions in this document .......................................................................................... 5

2 Overview................................................................................................................................... 62.1 Brief description ............................................................................................................... 62.2 Connecting the PROFINET Tap device to PROFINET.................................................... 7

2.2.1 Overview ........................................................................................................... 72.2.2 Connection via netMIRROR.............................................................................. 72.2.3 Connection via mirror port of switch................................................................ 102.2.4 Connection without hardware mirror ............................................................... 11

3 Deploying the container ........................................................................................................ 133.1 Step-by-step instructions................................................................................................ 133.2 Changing default Container settings in netFIELD Portal (experts only)......................... 15

3.2.1 Overview ......................................................................................................... 153.2.2 Container Create Options ............................................................................... 173.2.3 Environment Variables.................................................................................... 183.2.4 Container Twin................................................................................................ 20

4 Configuring the PROFINET Tap in local Device Manager.................................................. 214.1 Overview ........................................................................................................................ 214.2 “Status” tab..................................................................................................................... 224.3 “About” tab ..................................................................................................................... 234.4 “Configuration Backup” tab ............................................................................................ 244.5 “Publisher Management” tab.......................................................................................... 264.6 MQTT Client Settings..................................................................................................... 284.7 OT Interface settings...................................................................................................... 304.8 PROFINET configuration ............................................................................................... 31

4.8.1 Overview ......................................................................................................... 314.8.2 GSDML Management ..................................................................................... 394.8.3 AutomationML Management........................................................................... 424.8.4 How to configure the PROFINET Tap with GSDML file.................................. 464.8.5 How to configure the PROFINET Tap with AutomationML file ....................... 54

5 Good to know... ...................................................................................................................... 605.1 MQTT message format .................................................................................................. 605.2 Restrictions concerning AutomationML export from TIA Portal and mapping in

PROFINET Tap.............................................................................................................. 625.3 Mapping of TIA Portal data types to PROFINET Tap-supported data types.................. 635.4 Using SSL/TLS encryption (optional) ............................................................................. 65

6 Legal notes ............................................................................................................................. 66

List of Figures ........................................................................................................................ 70

List of Tables.......................................................................................................................... 72

netFIELD App PROFINET Tap | Operating instruction manualDOC200502OI02EN | Revision 2 | English | 2020-09 | Released | Public

© Hilscher 2020

Table of contents 3/73

Contacts.................................................................................................................................. 73


© Hilscher 2020

Introduction 4/73

1 Introduction

1.1 Description of the contentsThis document describes the netFIELD App PROFINET Tap from Hilscher.

1.2 List of revisionsIndex Date Author Revision1 2020-06-04 MKE Document created2 2020-09-02 MKE Document revised and updated to netFIELD App

PROFINET Tap version 1.1.xSection “Status” tab [} page 22] added.Section How to configure the PROFINET Tap withAutomationML file [} page 54] added.Section AutomationML Management [} page 42] added.Section Restrictions concerning AutomationML exportfrom TIA Portal and mapping in PROFINETTap [} page 62] added.Section Mapping of TIA Portal data types to PROFINETTap-supported data types [} page 63] added.

Table 1: List of revisions


© Hilscher 2020

Introduction 5/73

1.3 Conventions in this documentNotes, operation instructions and results of operation steps are marked asfollows:

Notes

Important:<important note>

Note:<simple note>

<note, where to find further information>

Operation instructions

1. <operational step>Ø <instruction>Ø <instruction>

2. <operational step>Ø <instruction>Ø <instruction>

Results

<intermediate result>

<final result>


© Hilscher 2020

Overview 6/73

2 Overview

2.1 Brief descriptionPROFINET Tap is a netFIELD application Docker container that monitorsPROFINET traffic and publishes selected machinery process data viaMQTT.The container is to be deployed (i.e. installed) in the Standard Docker or inthe IoT Edge Docker of the netFIELD Operating System (netFIELD OS)running on Hilscher Edge Devices (like e.g. the netFIELD OnPremisedevice).The deployment of the container is described in chapter Deploying thecontainer [} page 13].

After connecting your Edge Device to your PROFINET network, thePROFINET Tap container allows you to “tap into” the process data and torun data analytics applications without interfering neither with your existingnetwork setup nor with your PROFINET data exchange. Because there isno need to change the configuration of your PLC or machinery, it can thusbe easily used in “brown-field” plants/automation networks. Ways of connecting the PROFINET Tap to a network are described insection Overview [} page 7].

PROFINET Tap features a plug-in configuration GUI for the netFIELD OS,which can be easily accessed via web-browser without having to install anyadditional software tools. The included “auto-mapping” function allows youto assign data semantics and symbols from GSDML and/or AutomationMLfiles conveniently to your PROFINET Tap configuration. This configuration GUI is described in chapter Configuring the PROFINETTap in local Device Manager [} page 21].

Note that the PROFINET Tap container publishes the acquired data viaMQTT and thus requires an MQTT Broker for operation. The MQTT Brokercan be running on the same Edge Device, or you can use an “external”Broker if you allow the PROFINET Tap to reach the external Broker viaphysical network.

Note also that publishing data to the netFIELD Platform respectivelynetFIELD Portal requires the netFIELD App Platform Connector (formerlyknown as netFIELD Proxy container) on the same netFIELD OS.


© Hilscher 2020

Overview 7/73

2.2 Connecting the PROFINET Tap device to PROFINET

2.2.1 OverviewThe netFIELD App PROFINET Tap requires a host device that is equippedwith the netFIELD OS, like e.g. the Hilscher netFIELD OnPremise EdgeDevice.This section shows ways of connecting your netFIELD OS device (on whichthe PROFINET Tap container is running) to a PROFINET network, usingthe netFIELD OnPremise device as example.

Note that it is best practice to place the OnPremise device (respectively the“mirror” device [like netMIRROR device or a Switch-Mirror-Port] if you areusing one) between the IO Controller and the first IO Device of thePROFINET, because this usually the position where all process dataframes of all devices will be present for capturing.

2.2.2 Connection via netMIRRORYou can use the Hilscher netMIRROR (NMR-TFE-RE, part no. 7340.100)device as a hardware-based “tap” (test access point) in connection withyour netFIELD OnPremise device. The netMIRROR device “mirrors” theEthernet data traffic with virtually no delay (~1 ns) and without affecting theOT network. It can be placed easily between your IO Controller and the firstIO Device (respectively switch) without further PLC “engineering”. In addition, by using such a hardware mirror, you avoid the risk of trafficdisruption if the OnPremise device is turned off or configured, or if asoftware update is performed on that device.

For technical information about the netMIRROR device, see usermanual netMIRROR – NMR-TFE-RE, DOC161104UMxxEN.


© Hilscher 2020

Overview 8/73

Figure 1: Connection via netMIRROR and OnPremise device

Ø Connect one of the NETWORK ports of the netMIRROR to theController. Connect the other NETWORK port of the netMIRROR to theswitch (respectively to the first PROFINET Device).

Ø Connect both MIRROR OUT ports of the netMIRROR to the Fieldbusports of the OnPremise device.You can use “patch” or “crossover” cables. We recommend you to use apatch cable for MIRROR OUT port A, and a crossover cable forMIRROR OUT port B. (If you change the cable type or the port of the netMIRROR, you mayhave to restart the OnPremise device in order to re-establish theEthernet link with the netMIRROR.)

Ø For accessing the PROFINET Tap configuration GUI with your webbrowser, connect the LAN interface of the OnPremise device to yourlocal IT network. You can login to the local Device Manager (featuringthe configuration GUI) from your local PC (situated within your LAN), orfrom the netFIELD Portal via Remote Device Management (see sectionRemote Control in the netFIELD Portal manual, DOC190701OIxxEN).


© Hilscher 2020

Overview 9/73

Note:Set the port speed of the PROFINET Ethernet interface of theOnPremise device to 100 MBit/s fixed. This can be done in the configuration GUI of the PROFINET Tap inthe local Device Manager (see section OT Interfacesettings [} page 30]).


© Hilscher 2020

Overview 10/73

2.2.3 Connection via mirror port of switchYou can connect the On-Premise device to the mirror port of a switch.

Figure 2: Connection via mirror port of switch

Ø Connect the mirror port of the switch to one of the Fieldbus ports of theOnPremise device.


Note:Set the port speed of the PROFINET Ethernet interface of theOnPremise device (Automatic, 100 MBit/s fixed or 10MBit/s fixed) according to the configuration of the switch mirrorport (typically: Automatic). This can be done in the configurationGUI of the PROFINET Tap in the local Device Manager (seesection OT Interface settings [} page 30]).


© Hilscher 2020

Overview 11/73

2.2.4 Connection without hardware mirrorIn this setup you connect the OnPremise device directly to the IOController, without interposed "hardware mirroring".

Note:This variant may disrupt traffic on the OT network in the followingevents:– If the OnPremise device is turned off or configured– If a firmware update is performed on the device– If the PROFINET Tap container is stopped or restarted– If the OT network settings are changed

Figure 3: Connection without hardware mirror

Ø Connect the Controller to one of the Fieldbus ports of the OnPremisedevice. Connect the other Fieldbus port of the OnPremise device to theswitch (respectively to the first PROFINET Device).



© Hilscher 2020

Overview 12/73

Note:Set the port of the PROFINET Ethernet interface of the OnPremisedevice speed (Automatic, 100 MBit/s fixed or 10 MBit/sfixed) according to the configuration of the Ethernet ports of theconnected devices (typically: Automatic). This can be done in the configuration GUI of the PROFINET Tap inthe local Device Manager (see section OT Interfacesettings [} page 30])


© Hilscher 2020

Deploying the container 13/73

3 Deploying the container

3.1 Step-by-step instructionsThis section describes how to deploy (“install”) the netFIELD AppPROFINET Tap on your Edge Device (like e.g. netFIELD OnPremise).

Note:This manual deployment is only necessary if the container has notalready been deployed via Deployment Manifest during deviceonboarding.Check the Installed Containers tab (Device Manager > [yourdevice] > DEVICE NAVIGATION > Containers > InstalledContainers) to see if the container has already been deployed andis running on the device.

Ø Select your device in the Portal’s Device Manager and open theAvailable Containers tab in the DEVICE NAVIGATION (DEVICENAVIGATION > Containers > Available Containers).

Figure 4: Available Containers tab

Ø Scroll through the list and look for the netFIELD App PROFINET Tapcontainer.

Ø Click on the netFIELD App PROFINET Tap entry or on the + button.


© Hilscher 2020


Ê The deployment dialog screen opens:

Figure 5: Deploy container

Ø In the Overview tab, keep the default settings; i.e. Restart Policy =Always and Desired Status = Running. This ensures that thecontainer will be automatically started on the device after deployment.You can ignore the Use device proxy settings option (not relevantbecause the PROFINET Tap container does not establish any HTTP,HTTPS or FTP connections).

Important:We strongly recommend you to keep also the default EnvironmentVariables, Container Create Options and Container IdentityTwin settings.If necessary, these configuration settings can be changed later (i.e.after having deployed the container). The settings are described insection Changing default Container settings in netFIELD Portal(experts only) [} page 15].Note that only expert users should change these settings.

Ø Click Deploy button.Ê The container image is downloaded from the cloud to the device, and

automatically started on the device. This may take a few minutes.After its deployment, the container will from now on be listed in theInstalled Containers tab of your device.

Note:Note that you must also deploy an MQTT Broker on your device.PROFINET Tap is pre-configured for the Mosquitto MQTT Broker,which is also available for deployment in the Available Containerstab.


© Hilscher 2020


3.2 Changing default Container settings in netFIELD Portal(experts only)

3.2.1 OverviewIf you do not want to use the default container configuration settings, youcan change them before deployment, or even retroactively afterdeployment (i.e. if the container has already been installed on the device)by using the Update button. After the new settings have been saved,they are automatically transferred to the container on the device.

Figure 6: Overview tab

Elements DescriptionUse device proxysettings

If your device uses an HTTP or HTTPS proxy server in its local ITnetwork you can choose here that the container should use the sameproxy server settings that are stored for the device in the portal.Note: This option is not applicable for the PROFINET Tab because itdoes not establish any HTTP, HTTPS or FTP connections.

Restart Policy In the drop-down list, you can determine under which conditions thecontainer on the device is to be restarted by the system.Note: This parameter was originally defined in the ContainerManager, but can be changed and adapted here if necessary.Changes here have no effect on the original settings in the ContainerManager.Always The container is always restarted, no matter why it was

deactivated or crashed.Never The container is never restarted.On-Failed The container is restarted when it crashes, but not if it

has been "properly" deactivated.On-Unhealthy The container is restarted when it crashes or is

diagnosed as "unhealthy" by the system.


© Hilscher 2020


Elements DescriptionDesired Status In the drop-down list, you can determine the operating state in which

the container shall be after its deployment.Note: This parameter was originally defined in the ContainerManager, but can be changed and adapted here if necessary.Changes here have no effect on the original settings in the ContainerManager.Stopped The system does not start the container until it

receives the command to do so (locally on the deviceusing CLI or by updating the configuration in theportal).

Running The system starts the container immediately (i.e. assoon as the image has been completely downloadedto the device).

Next Opens the next Update tab. There you can save the changes with theSave button and transfer them to the container on the device.

Cancel Closes the Update tab without saving changes.Table 2: Elements in Overview tab


© Hilscher 2020


3.2.2 Container Create OptionsThe Container Create Options in stringified JSON format contain the initialconfiguration parameters of the container.

Important:Do not change these parameters unless you are an expert user.Wrong settings may lead to malfunctions of the applicationcontainer.

Figure 7: Container Create Options

Element DescriptionNext Opens the next Update tab.Back Opens the previous Update tab.Cancel Closes the Update tab without saving changes.

Table 3: Operating elements for Container Create Options


© Hilscher 2020


3.2.3 Environment VariablesWith the environment variables, you can customize certain containerconfiguration settings for your target device (i.e. the “environment”).

Important:Do not change these parameters unless you are an expert user.Wrong settings may lead to malfunctions of the applicationcontainer.

Figure 8: Environment Variables

Variable DescriptionSERVER_ADDRESS IP address of the internal web server of the container. Set by

default to local host (0.0.0.0). This default setting ensures thatthe container can be accessed only by the local Device Managerof the netFIELD OS.Important: Do not change this parameter unless you are anexpert user.

SERVER_PORT Port of the internal web server of the container. Set by default onport 80.Important: Do not change this parameter unless you are anexpert user.

LOGLEVEL Defines what kind of messages issued by container will be loggedby the netFIELD OS. The preset warn level means that allmessages belonging to the “severity level” Warning and abovewill be logged.Important: Do not change this parameter unless you are anexpert user. Changing to a lower level can lead to the issuing oftoo many messages, which can cause log overflow.


© Hilscher 2020


Variable DescriptionCONTAINER_ID Additional ID for labelling individual containers. The ID is set by

default to nfa-profinet-tap (for “netFIELD App PROFINET Tap”). It can be customized by the user, e.g. to distinguish betweencontainer instances that are to be deployed on different devices.This ID will be used in MQTT topics for distinction. It will also bedisplayed in the Name field of the configuration GUI of thecontainer in the local Device Manager. If the NO_MENU_IDvariable (see below) is set to 0, it will also be displayed in thenavigation panel of the local Device Manager.

NO_MENU_ID If the value is set to 0, the CONTAINER_ID (see above) will bedisplayed behind the netFIELD App PROFINET Tap entry in thenavigation panel of the local Device Manager (see position (1) insection Overview [} page 21]).If the value is 1 (i.e. ≠ 0), the CONTAINER_ID will not bedisplayed in the navigation panel of the local Device Manager.

Table 4: Environment Variables

Element DescriptionSelect this button to change name or value of the variable.Use the button to save your changes for the time being.Deletes the variable.

Adds a new variable. First fill-in the NAME and VALUE fields, then click button to add the variable.

Next Opens the next Update tab.Back Opens the previous Update tab.Cancel Closes the Update tab without saving changes.

Table 5: Operating elements for Environment Variables


© Hilscher 2020


3.2.4 Container TwinContainer Twin options are not applicable for this container.

Figure 9: Container Twin

Element DescriptionEnabled Select the checkbox to edit this field.Save Saves your changes. The changes parameters are then automatically

transferred to the container on the device.Note: The application of the changed parameters requires a restart ofthe container on the device.

Back Opens the previous Update tab.Cancel Closes the Update tab without saving changes.

Table 6: Operating elements for Container Twin Options


© Hilscher 2020

Configuring the PROFINET Tap in local Device Manager 21/73

4 Configuring the PROFINET Tap in local Device Manager

4.1 OverviewThe PROFINET Tap container provides a configuration GUI in the localDevice Manager of the netFIELD OS. This configuration GUI isautomatically plugged-in when the container is deployed. After havingestablished a connection to the local Device Manager (e.g. by RemoteControl from the netFIELD Portal, see section Remote Control in thenetFIELD Portal manual, DOC190701OIxxEN), the configuration GUI canbe selected in the navigation panel (1) of the local Device Manager.Note that it might take a few minutes after deployment before the netFIELDApp PROFINET Tap entry becomes visible in the navigation panel. Youmay also have to reload the web page in your browser by pressing F5 onyour keyboard.

Figure 10: Configuration GUI plugin in local Device Manager

You can navigate through the configuration options by selecting an item inthe navigation tree (2). Further parameters/configuration options can beselected in the tabs in the editor window (3) on the right side of the screen.


© Hilscher 2020


4.2 “Status” tabThe Status tab shows information about the operating state of thePROFINET Tap and of the PROFINET OT network.

To open the Status tab, first select the netFIELD App PROFINET Tap rootelement in the navigation tree, then the Status tab in the Editor window.

Hovering over an entry will display extra information in a tooltip.

Figure 11: Status page


© Hilscher 2020


4.3 “About” tabThe About tab shows general information about the container.

To open the About tab, first select the netFIELD App PROFINET Tap rootelement in the navigation tree, then the About tab in the Editor window.

Figure 12: About tab

Category DescriptionName Container name and Container ID

Note: the Container ID can be customized in the Portal in theEnvironment Variables of the container (see chapter Changing defaultContainer settings in netFIELD Portal (experts only) [} page 15])

Version Container software versionAPI Version Version of the API connecting the GUI to the serverDescription Brief description of the function of the containerDependencies Other containers or components required for proper operation of the

containerVendor Vendor of containerLicenses Name of the software license(s), under which the container was

publishedDisclaimer Path/link to the software license(s)

Table 7: About tab


© Hilscher 2020


4.4 “Configuration Backup” tabIn the Configuration Backup tab, you can save the PROFINET Tapconfiguration settings to your local PC. You can also restore a formerlysaved configuration by uploading the configuration file.

To open the Configuration Backup tab, first select the netFIELD AppPROFINET Tap root element in the navigation tree, then the ConfigurationBackup tab in the Editor window.

Figure 13: Configuration Backup

Save configurationØ To save your current configuration, click Save configuration button.Ê The configuration settings are saved to your local PC as ZIP file. (The

download path depends on the settings of your web browser.)The name of the ZIP file is made up by Hardware ID, Container ID anddate/time of the download.

Restore configuration

To restore a formerly saved configuration, you must first select theconfiguration ZIP file by dragging and dropping it from your desktop ontothe grey field (as an alternative, you can open the standard Windows fileselection dialog by clicking into the grey field).

After having selected the file, the Restore configuration button is enabled,and you can now “load” the configuration by clicking the button.


© Hilscher 2020


Important:The Restore configuration function will overwrite the currentconfiguration settings. We recommend you to save your currentconfiguration before using this function.

Figure 14: Restore configuration


© Hilscher 2020


4.5 “Publisher Management” tabThe Publisher Management tab shows the variables that the PROFINETTap container publishes to the MQTT Broker.

Note that you cannot define here which variables are to be published. Forpublishing a variable, you have to select it in the PROFINET Configurationtree and then choose the Publish data option in the PROFINET Variableeditor. You can however delete a variable here if you do not want to publish it anylonger.

To open the Publisher Management tab, first select the netFIELD AppPROFINET Tap root element in the navigation tree, then the PublisherManagement tab in the Editor window.

Figure 15: Publisher Management

Element DescriptionActive Publishers Shows the number of variables that are being published.PROFINET VARIABLE Name of the variable that is being published.ACTION Deletes the variable

Shows details of the variable (see table below)

If the list contains more than ten entries, you can scroll here todisplay the next ten items

Table 8: Elements of Publisher Management tab


© Hilscher 2020


Ø Click the button to open a window showing details of the variablelike its MQTT Topic string and other configuration parameters.

Figure 16: Parameters of PROFINET variable

Element DescriptionThe first line shows the path to the variable (for unique identification) inthe PROFINET network.

Topic Shows the MQTT topic string under which the variable is published. By default, the PROFINET Tap uses the following string:netFIELD/<gateway prefix>/<container id>/<controllername>/<device name>/<slot name>/<subslot name>/<direction>/<variable name>/<node id>

If you do not want to use the default MQTT Topic string, you can defineyour own string when you select the variable in the PROFINETConfiguration tree for publishing (PROFINET Variable > Publish dataoption > Topic field). Note that you are free to define the topic hierarchy and name accordingto your individual needs there. You are only restricted not to use the #and + characters and not to use $ as very first character.

General Shows data formats of the variable.Standardization Shows standardization settings for the variable.Publisher data Shows the MQTT publication settings for the variable.Ok Click this button to close the window.

Table 9: Elements Variable’s details window


© Hilscher 2020


4.6 MQTT Client SettingsOn the MQTT Client Settings page, you can customize the MQTT clientsettings of the PROFINET Tap container. By default, the PROFINET Tapuses the standard MQTT client settings of the netFIELD OS, which can beviewed (and changed) in the local Device Manager under GeneralSettings > Default MQTT Client Settings.

If you want to use different settings for your PROFINET Tap, you canuncheck the Use general settings option and enter your new values in theconfiguration fields that are now displayed:

Figure 17: MQTT Client settings


© Hilscher 2020


Element DescriptionMQTT version MQTT version to be used (depending on the MQTT Broker).Keep alive interval Defines the maximum length of time in seconds that the broker and

client may not communicate with each other.User name User name for authentication at the Broker (if implemented and

required by the Broker).Note that the Mosquitto Broker from the netFIELD Portal does notrequire login authentication.

Password Password for authentication at the Broker (if implemented andrequired by the Broker).Note that the Mosquitto Broker from the netFIELD Portal does notrequire login authentication.

Connect timeout Defines the maximum length of time in seconds that is allowed forcompleting the connection process.

Clean session If Clean session is selected, the client does not want a persistentsession (meaning that if the client disconnects for any reason, allinformation and messages that are queued from a previouspersistent session are lost.If Clean session is unchecked, the broker creates a persistentsession for the client.

Server URIs Server URI of the MQTT BrokerNote: When multiple server URIs are specified, the client will try toconnect to each server one after the other, starting with the firstserver in the list. If a server connection was established successfully, only thisconnection will be used. The client will not open multiple connectionsto multiple servers simultaneously.

Last Will andTestament

Select this option if you want to use the “last will andtestament” (LWT) feature of MQTT. (I.e. to notify other clients aboutan unexpected loss of connection to the broker)Topic name Topic name of LWT messageRetained “Retained” flag of LWT messageQuality of Service QoS of LWT messageMessage Message text, e.g. “unexpected loss of

connection”SSL / TLS Select this option if you want to use SSL/TLS encryption for creating

a secure connection to the MQTT Broker.Note: This option is for expert users only! In the standard use case,in which the Mosquitto Broker and the PROFINET Tap are runningon the same device, a secure SSL/TLS connection is not necessary(the overhead of the secure connection can thus be avoided). If you want to use SSL/TLS encryption anyway, see section UsingSSL/TLS encryption (optional) [} page 65] for further information.File name and path toprivate key in PEMformat

Enter here the complete path to the privatekey on the device; e.g.:/etc/ssl/private/client-key.pem

File name and path tocertificate chains inPEM format

Enter here the complete path to the certificatechains on the device; e.g.:/etc/ssl/services/client-cert.pem

Override the trustedCA certificates inPEM format

Enter here the complete path to override thetrusted CA certificates on the device; e.g.:/etc/ssl/services/ca-cert.pem

Enable verification ofthe server certificate

If this option is disabled, PROFINET Tap willalso accept invalid certificates from theBroker (not recommended).

Table 10: MQTT Client Settings

Ø Click Save button to save your new MQTT Client Settings.


© Hilscher 2020


4.7 OT Interface settingsOn the OT Interface settings page, you can configure the speed of theEthernet port(s) that you are using to connect your device (respectivelyyour “tap”) to the physical PROFINET network.

Figure 18: Physical settings

Ø Use the dropdown-list to select the port speed.Value DescriptionAutomatic Automatic synchronization.

Use this setting if you have connected the netFIELD On-Premisedevice directly to the PROFINET; i.e. if you are not using a“hardware tap” (see section Connection without hardwaremirror [} page 11]).Note that when using automatic link speed negotiation incombination with a netMIRROR TAP, the PROFINET Tap (due to alittle time delay caused by the negotiation process) might miss someof the first frames (and thus some of the configuration data) that areexchanged on the bus during the PROFINET startup phase.

10 MBit/s fixed Not commonly used any longer.100 MBit/s fixed Use this setting if you are using a “hardware TAP” like e.g.

netMIRROR (see section Connection via netMIRROR [} page 7]).Table 11: Port speed settings

Ø Click Save button to save your new settings.


© Hilscher 2020


4.8 PROFINET configuration

4.8.1 OverviewIn order to capture process data and re-publish it via MQTT, thePROFINET Tap must be “acquainted” with the participants, data points andcertain parameters of your actual PROFINET network.

There are two ways to provide the necessary information for the Tap:· Automatically by letting the Tap listen to the communication between IO

Controller and IO Devices during the PROFINET start-up phase and bymapping GSDML and/or AutomationML file(s) to the recognized “raw”PROFINET configuration. .

· Manually by “rebuilding” the structure of your network by adding the IOController, IO Devices and their slots to the PROFINET Configurationtree, and then configure their parameters and variables “by hand”.

The structure of your network and the data points (that the Tap knows of) isrepresented in the navigation tree under PROFINET Configuration:

Figure 19: PROFINET Configuration tree

An arrow symbol in front of an element in the PROFINET navigation treeindicates that the element contains further subordinate elements, like e.g.Submodules under a Module.


© Hilscher 2020


Clicking on an element will open and display the subordinate elements inthe navigation tree. Selecting an element will also display its parameters in the Editor windowon the right side of the screen, where they can be changed if necessary:

Figure 20: Parameters of selected PROFINET element in Editor window

The options in the menu bar on top of the Editor window are contextsensitive and depend on the element that you have selected in thePROFINET navigation tree:

Figure 21: Menu bar


© Hilscher 2020


In the menu bar, you can save changes that you have made to theparameters of the selected element, or you can delete the selected elementaltogether. You can also add further elements on the same level (e.g.another Submodule next to a selected Submodule) or new elements on thesubordinate level (e.g. a Data Item below a selected Submodule). You can also start an “auto-mapping” process of parameters from GSDMLand/or AutomationML files (if available) for the subordinate elements of thecurrently selected element. Note that must import the appropriate GSDMLand AutomationML files in the GSDML Management tab respectivelyAutomationML Management tab before you can use the Auto-mapfunction (see also sections GSDML Management [} page 39] andAutomationML Management [} page 42]).

The following table describes the options and parameters of the elementsbelonging to your PROFINET Configuration. Click on an element in thePROFINET Configuration tree to see the parameters and menu options:

Icon Element Parameter Options in menuPROFINET

Reload button

Reloads the PROFINET configuration tree.Use this button after a new start-up of thePROFINET or of individual devices. Any newdevice information detected during start-up willthus be taken-over into the PROFINETconfiguration.

Add Controller: AddsController to the PROFINETconfiguration.

Auto-map Auto-map all devices fromGSDML: Opens the GSDMLmapping wizard.Auto-map all devices fromAutomationML: Opens theAutomationML mapping wizard.

Info icon

Indicates an event that demands a reactionfrom the user (e.g. the Tap detected a start-upof a new device, which may require you toreload the configuration and/or re-map datasemantics from GSDML or AutomationML). Click on the icon to display the information.In the Info window, click Confirm toacknowledge the message, which makes theInfo icon disappear. If you click Close, the Infowindow closes but the Info icon remainsvisible.

GSDMLManagement

The PROFINET root element displays theGSDML Management [} page 39] tab thatallows you to manage the GSDML files of yourPROFINET Devices.

AutomationMLManagement

The PROFINET root element displays theAutomationML Management [} page 42] tabthat allows you to manage the AutomationMLfiles.

Controller Name Name of the controller. Can be freely definedby the user, but must not be empty(mandatory field). Note: If the configuration was automaticallyretrieved by the app during start-up phase, theapp will use the MAC address as name.

Save: Saves changedparameters of selected Controller.

Add Controller: Adds newController on same level.

Remove Controller: Removesselected Controller.

Add Device: Adds new Deviceunder selected Controller.

Auto-map Auto-map all devices under thiscontroller from GSDML: Opensthe GSDML mapping wizard.Auto-map all devices under thiscontroller from AutomationML:Opens the AutomationML mappingwizard.

MAC address MAC Address of the controller. Mandatoryfield consisting of six groups of twohexadecimal values separated by colons.(E.g. 06:0A:3B:78:05:6C)

IP address IP address of the controller.


© Hilscher 2020


Icon Element Parameter Options in menuDevice Name Name of the device. Can be freely defined by

the user, but must not be empty (mandatoryfield).Note: If the configuration was automaticallyretrieved by the app during start-up phase, theapp will use the “name of station” for thename.

Save: Saves changedparameters of selected Device.

Add Device: Adds new Deviceon same level.

Remove Device: Removesselected Device.

Add Module: Adds new Modulebelow selected Device.

Auto-map Auto-map all slots under thisdevice from GSDML: Opens theGSDML mapping wizard.Auto-map all slots under thisdevice from AutomationML:Opens the AutomationML mappingwizard.

MAC Address MAC address of the device. Mandatory fieldconsisting of six groups of two hexadecimalvalues separated by colons. (E.g.06:0A:3B:78:05:6C)

IP address MAC address of the device. Assigned by thecontroller.

Name of station PROFINET “name of station” of the device.Vendor ID ID containing the manufacturer-specific part of

the device’s PROFINET identification numberaccording to the rules specified in PNOdocument 2.712 “Application Layer Services”.Mandatory field. Must be a value between 0and 65535.

Device ID ID containing the device-specific part of thePROFINET identification number of thePROFINET device. It is defined for eachindividual device by the manufacturer anduniquely identifies a device amongst alldevices of this manufacturer. Mandatory field.Must be a value between 0 and 65535.

Module Name Name of the module. Can be freely defined bythe user, but must not be empty (mandatoryfield).

Save: Saves changedparameters of selected Module.

Add Module: Adds new Moduleon same level.

Remove Module: Removesselected Module.

Add Submodule: Adds newSubmodule below selectedModule.

Auto-map Auto-map all subslots under thisslot from GSDML: Opens theGSDML mapping wizard.Auto-map all subslots under thisslot from AutomationML: Opensthe AutomationML mapping wizard.

Slot number Number of the slot this module is plugged in.Mandatory field. Must be unique within thescope of the project and must be a valuebetween 0 and 4294967295

Module identnumber

Identification number of the module.Mandatory field. Must be a value between 0and 4294967295.


© Hilscher 2020


Icon Element Parameter Options in menuSubmodule Name Name of the submodule. Can be freely

defined by the user, but must not be empty(mandatory field).

Save: Saves changedparameters of selectedSubmodule.

Add Submodule: Adds newSubmodule on same level.

Remove Submodule: Removesselected Submodule.

Add Data Item: Adds new DataItem (output or input) belowselected Submodule.

Auto-map Auto-map this subslot fromGSDML: Opens the GSDMLmapping wizard.Auto-map this subslot fromAutomationML: Opens theAutomationML mapping wizard.

Subslot number Number of the subslot this submodule isplugged in. Mandatory field. Must be uniquewithin the scope of the project and must be avalue between 0 and 65535.

Submoduleident number

Identification number of the submodule.Mandatory field. Must be a value between 0and 4294967295.

Data Item(Output/Input)

Name Name of the PROFINET data item. Can befreely defined by the user, but must not beempty (mandatory field).

Save: Saves changedparameters of selected Data Item

Add Data Item: Adds new DataItem on same level

Remove Data Item: Removesselected Data Item

Add Variable: Adds newvariable below selected Data Item

Direction IO direction of the data item. Select Output for the data that the submodulereceives from the Controller in order toforward it to an actor.Select Input for the data that the submodulereceives from a sensor in order to forward it tothe Controller.

Frame ID Identification number of the cyclic PROFINETframe which carries the data item. Mandatoryfield. Must be a value between 0 and 65535.

Byte offset Byte offset of the data item within the cyclicPROFINET frame relative to the Ethernetpayload start. Mandatory field. Must be avalue between 0 and 65535.

Data length Length of the PROFINET data item in bytes.


© Hilscher 2020


Icon Element Parameter Options in menuVariable Name Name of the variable. Can be freely defined by

the user, but must not be empty (mandatoryfield). This is the name of the PROFINETVariable that will be published via MQTT. Itwill also be added to the PROFINET Variablelist in the Publisher Management tab (seesection “Publisher Management”tab [} page 26]). Note: Not to be confused with the MQTTTopic name (see Topic field under Publishdata).

Save: Saves changedparameters of selected variable

Add Variable: Adds newvariable on same level

Remove Variable: Removesselected variable

Clone Variable: Adds a copy ofthe selected variable on samelevel, which you can use as a“template” for editing a newvariableData type Supported types: Bit

length:Description/Value range:

Boolean 1 ‘0’: FALSE‘1’: TRUE

Signed 8 BitInteger

8 -128 … 127

Signed 16 BitInteger

16 -32768 …32767


32 -231 … +231-1


64 -263 … +263-1

Unsigned 8 BitInteger

8 0 … 255


16 0 … 65535


32 0 … +232-1


64 0 … +264-1

32 Bit FloatingPoint

32 Single precisionfloating pointrange

64 Bit FloatingPoint

64 Doubleprecisionfloating pointrange

Visible String 8*n UTF-8 / ASCIIencoded string

Octet String 8*n Stringcontaining asequence ofhex encodedoctets in format01ABF7

Byte offset Offset (in bytes) of the variable relative to thebeginning of the Data Item. Must be a valuebetween 0 and 99.

Bit offset Number of bits the variable is shifted at thebyte offset of the Data Item. Must be a valuebetween 0 and 7.


© Hilscher 2020


Icon Element Parameter Options in menuVariable Bit length Number of bits of the variable according to

the selected data type. Corresponds bydefault to the maximum length allowed bythe data type. You may specify a lowervalue.If this bit length is shorter than the abovespecified data type, the upper bits will bepadded. For signed data types, a signextension will be done in such a case.




Clone Variable: Adds a copy ofthe selected variable on samelevel, which you can use as a“template” for editing a newvariable

Byte order Byte order in a data word:SwappedNot swapped

Standardizationtype

Allows scaling of analog values. You caneither Keep original value and do notstandardize or select the Scale linear by factor andoffset option.Selecting the Scale linear… option enablesthe Factor and Offset fields. The standardization value will be computedaccording to the formula: raw value *factor + offsetNote: Standardization is supported only forinteger data types.


© Hilscher 2020


Icon Element Parameter Options in menuVariable Publish data Select this option to publish the variable via MQTT. It

will also be added to the PROFINET Variable list in thePublisher Management tab (see section “PublisherManagement” tab [} page 26]). You can configure the following parameters forpublishing the variable:




Clone Variable: Adds a copyof the selected variable onsame level, which you can useas a “template” for editing a newvariable

Topic Enter here the MQTT Topic namestring under which the variable willpublished. If left empty, the Tap usesthe default string (see section MQTTmessage format [} page 60]).Note that you are free to define thetopic hierarchy and name according toyour individual needs. You are onlyrestricted not to use the # and +characters and not to use $ as thevery first character.

Quality ofservice

Select the MQTT QoS from the drop-down list. Note: For performance reasons it isrecommended to use QoS0 wheneverpossible. Using QoS1 or QoS2 willincrease performance requirements ofthe application container.

Publish interval Define the publish interval in· Milliseconds· Seconds· Minutes· HoursNote: MQTT messages will bepublished approximately at thisinterval. If more than one process datasample has been acquired in this time-span, the message will contain anarray of process data points. Keep inmind that messages should not growendlessly in size. Therefore, choosethis value according to your use caseand in a way that provides a goodtrade-off between the publish intervaland the number of samples comingfrom the data source in that time.

Data sampling Define the conditions for the sampling:· Only take data if the data source

value has changed· Take data directly as acquired from

data source:Note that this option means OTnetwork cycle accurate data samplingand may result in very high amount ofdata samples in a short time.· Sample the acquired data from data

source by a fixed sample rate:Opens the Sample rate inmilliseconds field in which you canspecify the sample rate (between 1and 1000 ms)

Retained “Retained” flag of MQTT messageTable 12: Elements PROFINET Configuration


© Hilscher 2020


4.8.2 GSDML ManagementThe GSDML Management tab allows you to upload the device descriptionfiles to the PROFINET Tap. The device descriptions contained in these filescan be mapped to the devices of your PROFINET configuration (by auto-mapping function).

To open the GSDML Management tab, select the PROFINETConfiguration element in the navigation tree.

Figure 22: GSDML Management

Element DescriptionGSDML Files Shows the number of GSDML files that have been imported and

are available for mapping.Opens dialog for uploading GSDML files.

Name Name of the GSDML file.ACTION Deletes the GSDML file.

If the list contains more than ten entries, you can scroll here todisplay the next ten items.

Table 13: GSDML Management tab


© Hilscher 2020


Uploading GSDML file(s)Ø Click the button to open the Upload dialog window.

Figure 23: Upload GSDML file dialog

Ø Drag and drop your GSDML file from your PC onto the grey area of thedialog window, then click Ok button to start the upload.

Ø If you want to upload several files at once, click into the grey area toopen the file upload dialog of your browser.

Ø In the File Upload dialog, select all files you want to upload, then clickOpen button.

Figure 24: Multiple selection in File upload dialog


© Hilscher 2020


Ê The three dots in the Upload GSDML file dialog indicate that you haveselected multiple files for upload:

Figure 25: Upload GSDML file dialog

Ø Click Ok button to start the upload.ð The uploaded GSDML files are listed in the GSDML Management tab

and can now be mapped to your PROFINET Configuration.


© Hilscher 2020


4.8.3 AutomationML ManagementThe AutomationML Management tab allows you to upload projectengineering file(s) from the TIA Portal in AutomationML format (AutomationMarkup Language) to the PROFINET Tap. The information contained inthe .aml file can then be mapped to the PROFINET configuration by usingthe Auto-map function.

Note:If your PROFINET line features more than one IO Controller/PLC,you can, of course, import several AutomationML files – eachcontaining the corresponding engineering project of an individual IOController/PLC – and map them later to the corresponding IOController element in the PROFINET Configuration tree.

To open the AutomationML Management tab, select the PROFINETConfiguration element in the navigation tree, then click on the tab in theEditor window.

Figure 26: AutomationML Management


© Hilscher 2020


Element DescriptionAutomationML Files Shows the number of .aml files that were imported and are

available for mapping.Opens dialog for uploading .aml files.

Name Name of the .aml file.ACTION Deletes the .aml file.

If the list contains more than ten entries, you can scroll here todisplay the next ten items.

Table 14: AutomationML Management tab

Exporting PROFINET project as AutomationML file from TIA Portal

Before you can upload your AutomationML file to the PROFINET Tap, youmust first export it from the TIA Portal.Ø To do so, open your PROFINET engineering project in the TIA Portal ,

then choose Tools > Export CAx data... from the menu:

Figure 27: Export AutomationML file from Tia Portal

Note:You must be logged in as member of the “Siemens TIA Openness”group in order to be allowed to use the Export CAx data... functionin the TIA Portal.


© Hilscher 2020


Uploading AutomationML file(s) to the PROFINET TapØ Click the button to open the Upload dialog window.

Figure 28: Upload AutomationML file dialog

Ø Drag and drop your .aml file from your PC onto the grey area of thedialog window, then click Ok button to start the upload.

Ø If you want to upload several files at once, click into the grey area toopen the file upload dialog of your browser.

Ø In the File Upload dialog, select all files you want to upload, then clickOpen button.

Figure 29: Multiple selection in File upload dialog


© Hilscher 2020


Ê The three dots in the Upload AutomationML file dialog indicate thatyou have selected multiple files for upload:

Figure 30: Upload AutomationML file dialog

Ø Click Ok button to start the upload.ð The uploaded files are listed in the AutomationML Management tab

and can now be mapped to your PROFINET Configuration.


© Hilscher 2020


4.8.4 How to configure the PROFINET Tap with GSDML fileThis section provides step-by-step instructions for creating a PROFINETConfiguration by using GSDML file(s) and for defining a variable to bepublished via MQTT.

Requirements· The Edge Device on which the PROFINET Tap is running is connected

to your PROFINET network.· You have access to the GSDML files of the IO Devices of your

PROFINET network.

Step-by-step instructions1. Set port speed according to your Tap’s connection type (hardware vs.

software tap).Ø In the OT Interface Settings, select the port speed.

Warning of unsafe system operation!When using a “software TAP”, changing this setting may lead to atemporary loss of the bus link and thus of the PROFINETcommunication. Take precautions that the temporary loss of the buscommunication will not affect the safe operation of your plant!

· Select 100 MBit/s fixed if you are using a “hardware TAP” like e.g.netMIRROR (see section Connection via netMIRROR [} page 7]).

· Select Automatic if you have connected the Edge Device directly to thePROFINET; i.e. if you are using the built-in “software TAP” of theOnPremise device (see section Connection without hardwaremirror [} page 11]).

2. Gather information from PROFINET start-up.Ø Trigger a start-up of your PROFINET.

Warning of unsafe system operation!If you have to stop a running PROFINET bus communication for this,take precautions that stopping the bus communication will not affect thesafe operation of your plant!


© Hilscher 2020


Ê PROFINET Tap listens to the “configuration” messages that are nowexchanged between Controller and Devices during the PROFINETstart-up phase, and extracts information from it. After a few seconds, all recognized PROFINET participants and theirsubordinate elements (Modules, Submodules etc.) are listed in thePROFINET Configuration tree:

Figure 31: PROFINET configuration recognized during start-up

Note:You may have to reload the page by clicking the icon next to thePROFINET Configuration element in order to display the recognizeddevices in PROFINET Configuration tree.

Note the following about the automatic device recognition during start-up:· The order in which the devices and elements are represented in the

PROFINET Configuration tree relates to the time sequence in whichthey were recognized; i.e. the first device in the tree is the device thatwas first recognized during start-up, and so forth. This means that theorder of the devices in the tree does not reflect the actual positioning ofthe devices in the real PROFINET topology.

· The Controller’s name is represented in the tree by its MAC address,because its name is not part of the configuration information that isexchanged during start-up (and can thus not be picked up by the Tap).You can manually change its name later.

· The Tap adds “raw output/input data” as default variables belowrecognized Data items (i.e. outputs/inputs).


© Hilscher 2020


3. Enter name of Controller (optional)

Ø Select the Controller element in the tree ( followed by MAC Address).Ê The parameters of the selected Controller are displayed in the

PROFINET Controller tab in the Editor screen.

Figure 32: Change name of Controller

Ø Enter a name, e.g. “IO Controller 1A”, then click Save button.Ê The ”Succeeded to save data” message appears and the tree now

displays the new name of the controller:

Figure 33: New Controller name


© Hilscher 2020


4. Map data semantics from GSDML file(s)Ø Upload GSDML file(s) to the PROFINET Tap (see section GSDML

Management [} page 39] for instructions).Ø In the PROFINET Configuration tree, select the element that you want

to map to your GSDML file(s). In this example, select the PROFINETConfiguration root element, so that all devices will be mapped in one go.

Note:Note that the mapping process is hierarchical: All sub-elements of achosen element will also be mapped. This means that if you selecte.g. the PROFINET Configuration root element, the auto-mappingwizard will try to map all devices of your PROFINET network to theGSDML files that you have uploaded (respectively to thedescriptions it finds in the GSDML files). If you select a Controller inthe tree (in case you have more than one Controller in yourPROFINET line), all devices under this Controller will be mapped. Ifyou select a Device, all Modules and Submodules of this Device willbe mapped, and so forth.

Ø In the menu, select Auto-map > Auto-map all devices fromGSDML.

Ê The Auto-map wizards opens and maps the Submodule (a.k.a. Subslot)definitions and variables it finds in the GSDML files to the Submodulesof your PROFINET Configuration. Successfully mapped Submodules/Subslots are marked with the green check mark symbol :

Figure 34: Auto-mapping in progress


© Hilscher 2020


Ê Submodules for which the wizard cannot find the correspondingdescriptions in the GSDML file(s) are marked with the No matchedsubslot symbol: . (If necessary, you can edit the Submodule and itsvariables manually later, after the auto-mapping process has beenfinished.)

Note:The message “There are no data items defined for this submodule,mapping is not possible” could be caused e.g. by an IO-Link Masterthat has no IO-Link sensor attached to it.

Ê If the wizards cannot map a Submodule (e.g. because a GSDML filecontains different Submodule descriptions that have the sameSubmodule ID), it prompts you to select the applicable Submoduledescription from a list:

Figure 35: Select definition


© Hilscher 2020


Ø Click the Apply button to select the appropriate GSDML Submoduledescription for mapping. If you do not know which description to choose, you can select the Skipoption and edit the Submodule and its variables manually later (after theauto-mapping process has been finished).

Ê After finishing, the wizard shows a summary of the mapping process:

Figure 36: Finished

Ø Click OK button to close the wizard.Ê The Devices in the PROFINET Configuration now contain the mapped

information/parameters from the GSDML file(s).


© Hilscher 2020


5. Select Variables for publishing.Ø In the PROFINET Configuration tree, select the variable that you want

to publish.Ø In the Editor screen of the selected variable, select the Publish data

option and set the MQTT publication parameters, like Topic, MQTTQuality of Service, sampling rate etc.

Note:If you do not enter a Topic here, the PROFINET Tap will use thefollowing default string: netFIELD/<gateway prefix>/<container id>/<controller name>/<device name>/<slot name>/<subslot name>/<direction>/<variable name>/<nodeid>Note also that you are free to define the topic hierarchy and nameaccording to your individual needs. You are only restricted not touse the # and + characters and not to use $ as the very firstcharacter in the string.

Figure 37: Publish variable

Ø You may also want to change the name of the variable into somethingthat will be more intelligible for the subscribers who will consume theMQTT message, like e.g. “Temperature T1”.


© Hilscher 2020


Ø After having finished setting the publisher parameters, click Save inthe menu.

Figure 38: Publisher created

ð PROFINET Tap immediately starts to publish the variable to the MQTTBroker according to your settings.


© Hilscher 2020


4.8.5 How to configure the PROFINET Tap with AutomationML fileThis section provides step-by-step instructions for creating a PROFINETConfiguration by using an AutomationML file and for defining a variable tobe published via MQTT.

Requirements· The Edge Device on which the PROFINET Tap is running is connected

to your PROFINET network.· You have exported your PROFINET engineering project as

AutomationML file from the TIA Portal und you have access to the file.

Step-by-step instructions1. Set port speed according to your Tap’s connection type (hardware vs.

software tap).Ø In the OT Interface Settings, select the port speed.

Warning of unsafe system operation!When using a “software TAP”, changing this setting may lead to atemporary loss of the bus link and thus of the PROFINETcommunication. Take precautions that the temporary loss of the buscommunication will not affect the safe operation of your plant!

· Select 100 MBit/s fixed if you are using a “hardware TAP” like e.g.netMIRROR (see section Connection via netMIRROR [} page 7]).

· Select Automatic if you have connected the Edge Device directly to thePROFINET; i.e. if you are using the built-in “software TAP” of theOnPremise device (see section Connection without hardwaremirror [} page 11]).

2. Gather information from PROFINET start-up.Ø Trigger a start-up of your PROFINET.

Warning of unsafe system operation!If you have to stop a running PROFINET bus communication for this,take precautions that stopping the bus communication will not affect thesafe operation of your plant!


© Hilscher 2020


Ê PROFINET Tap listens to the “configuration” messages that are nowexchanged between Controller and Devices during the PROFINETstart-up phase, and extracts information from it. After a few seconds, all recognized PROFINET participants and theirsubordinate elements (Modules, Submodules etc.) are listed in thePROFINET Configuration tree:

Figure 39: PROFINET configuration recognized during start-up

Note:You may have to reload the page by clicking the icon next to thePROFINET Configuration element in order to display the recognizeddevices in PROFINET Configuration tree.

Note the following about the automatic device recognition during start-up:· The order in which the devices and elements are represented in the

PROFINET Configuration tree relates to the time sequence in whichthey were recognized; i.e. the first device in the tree is the device thatwas first recognized during start-up, and so forth. This means that theorder of the devices in the tree does not reflect the actual positioning ofthe devices in the real PROFINET topology.

· The Controller’s name is represented in the tree by its MAC address,because its name is not part of the configuration information that isexchanged during start-up (and can thus not be picked up by the Tap).You can manually change its name later.

· The Tap adds “raw output/input data” as default variables belowrecognized Data items (i.e. outputs/inputs).


© Hilscher 2020


3. Map data semantics from AutomationML file.Ø Upload the AutomationML file to the PROFINET Tap (see section

AutomationML Management [} page 42] for instructions).Ø In the PROFINET Configuration tree, select the element that you want

to map to your AutomationML file. In this example, select thePROFINET Configuration root element, so that all devices will bemapped in one go.

Note:Note that the mapping process is hierarchical: All sub-elements of achosen element will also be mapped. This means that if you selecte.g. the PROFINET Configuration root element, the auto-mappingwizard will try to map all devices of your PROFINET network to theAutomationML file that you have uploaded (respectively to thedescriptions it finds in the file). If you select a Controller in the tree(in case you have more than one Controller in your PROFINETline), all devices under this Controller will be mapped. If you select aDevice, all Modules and Submodules of this Device will be mapped,and so forth.

Ø In the menu, select Auto-map > Auto-map all devices fromAutomationML.

Ê The Auto-map wizards opens and maps the Submodule (a.k.a. Subslot)definitions and variables it finds in the AutomationML file to thePROFINET Configuration. Successfully mapped variables and subslotsthat do not have variables are marked with the green check marksymbol :

Figure 40: Auto-mapping in progress


© Hilscher 2020


Ê Submodules for which the wizard cannot find the correspondingdescriptions in the AutomationML file are marked with the No matchingsubmodule found symbol: . (If necessary, you can edit theSubmodule and its variables manually later, after the auto-mappingprocess has been finished.)

Ê After finishing, the wizard shows a summary of the mapping process:

Figure 41: Mapping finished

Ø Scroll down to the bottom of the wizard, then click OK button to closethe wizard.

Ê The Devices in the PROFINET Configuration now contain the mappedinformation/parameters from the AutomationML file.


© Hilscher 2020


4. Select Variables for publishing.Ø In the PROFINET Configuration tree, select the variable that you want

to publish.Ø In the Editor screen of the selected variable, select the Publish data

option and set the publication parameters, like Topic, MQTT Quality ofService, sampling rate etc.

Note:If you do not enter a Topic here, the PROFINET Tap will use thefollowing default string: netFIELD/<gateway prefix>/<container id>/<controller name>/<device name>/<slot name>/<subslot name>/<direction>/<variable name>/<nodeid>Note also that you are free to define the topic hierarchy and nameaccording to your individual needs. You are only restricted not touse the # and + characters and not to use $ as the very firstcharacter in the string.

Figure 42: Publish variable

Ø You may also want to change the name of the variable into somethingthat will be more intelligible for the subscribers who will consume theMQTT message, like “TriangulationValue03”


© Hilscher 2020


Ø After having finished setting the publisher parameters, click Save inthe menu.

Figure 43: Publisher created

ð PROFINET Tap immediately starts to publish the variable to the MQTTBroker according to your settings.


© Hilscher 2020

Good to know... 60/73

5 Good to know...

5.1 MQTT message format

Structure of MQTT Topic (default)

Note:This is the structure of the MQTT Topic string that will be used bydefault if you do not specify your own Topic string when you selecta variable in the PROFINET Configuration tree for publishing(PROFINET Variable > Publish data option > Topic field).

Syntax:netFIELD/<gateway prefix>/<container id>/<controller name>/<devicename>/<slot name>/<subslot name>/<direction>/<variable name>/<nodeid>

Elements in topic:Element in topic Description<gateway prefix> Identifier according to global MQTT settings of the netFIELD OS.

(General Settings > Default MQTT Client Settings > Gatewaysettings > Gateway prefix). Note: By default, the gateway prefixis identical with the Hardware ID of the Edge Device.

<container id> Identifier according to CONTAINER_ID environment variable. Note: By default, the Container ID is nfa-profinet-tap, butcan be changed by the user (see section EnvironmentVariables [} page 18]).

<controller name> Name of the IO Controller (may be represented by default by itsMAC address)

<device name> Name of the IO Device<slot name> Name of the PROFINET Module<subslot name> Name of the PROFINET Submodule<direction> Specifies “inputs” or “outputs”<variable name> Name of the variable<node id> Unique number assigned to the variable when it was created in

the configuration tree. Stays the same until deletion of theelement (will not be changed by changing the name of thevariable in the configuration GUI, or of any other element whichis contained in the topic)

Table 15: Descriptions of elements in topic

Example:netfield/000000000000-TSBH06005551/nfa-profinet-tap/28:63:36:d5:e8:cb/wago-765-1104/Slot 1/Subslot 1/outputs/rawoutput data/251


© Hilscher 2020


Structure of message content{ "schemaVersion": 1, "nodeId": "251", "messageType": "processdata", "dataType": "octetString", "data": [ { "timestamp": "2020-05-28T13:28:55.514890874", "state": "valid", "value": "0000" }, { "timestamp": "2020-05-28T13:28:55.522859992", "state": "valid", "value": "0100" }, { "timestamp": "2020-05-28T13:28:55.530893872", "state": "valid", "value": "00AB" }, { "timestamp": "2020-05-28T13:28:55.538880191", "state": "valid", "value": "FF00" }, { "timestamp": "2020-05-28T13:28:55.546894711", "state": "valid", "value": "0123" } ]}

Element NoteschemaVersion Identifies the version of the JSON structure of the message (as

depicted in the example above). The current structure version is “1”.If the structure changes in future, the schemaVersion will beincremented.

nodeId Is the same node ID as in the topic.messageType Is always “processdata”.dataType Is the data type of the variable as specified in the configuration GUI

(“octetString” in this example).data Is the array of one or multiple process data samples contained in this

message. The amount may vary according to the sample and publishintervals.Each data element consists of:timestamp Point in time (in nanosecond resolution and in ISO

8601 format) when the data sample was acquired fromthe network.

state Shows if the data value is ensured to be valid, or maybe invalid due to invalid provider state of thePROFINET data item.

value Actual data value according to data type, either asnumber, bool or string.

Table 16: Notes on message content


© Hilscher 2020


5.2 Restrictions concerning AutomationML export from TIA Portaland mapping in PROFINET Tap

This section lists the known restrictions concerning the export of projectengineering data in AutomationML format from the TIA Portal, and itssubsequent import and mapping in the PROFINET Tap.· The PROFINET Tap supports only AutomationML files exported from

the TIA Portal. Support of AutomationML files exported from EPLANhas not been tested or verified.

· You must be logged in as member of the “Siemens TIA Openness”group in order to be allowed to use the Export CAx data... function (=export in AutomationML format) in the TIA Portal.

· The TIA Portal does not support the Export CAx data... function for thefollowing devices/items (therefore auto-mapping of variables for thesedevices/items by the PROFINET Tap is not possible):– Port-Port connections– Connections to and between extension racks– Multi-CPUs– H-devices– HMI devices except push button panels and key panels– Drives– Output mode and range of analog channels– Packed addresses

· The TIA Portal does not export the structure of complex data types likethe PLC data type “256ByteModuleStructured”. Therefore mappingof complex data types is currently not supported.

· The PROFINET Tap does not support the mapping of variables whichexceed the defined address range of a submodule


© Hilscher 2020


5.3 Mapping of TIA Portal data types to PROFINET Tap-supported data types

The following table shows the mapping of data types from the TIA Portal todata types supported by the PROFINET Tap.

Note:For channels where no explicit data type is specified, PROFINETTap will automatically select an unsigned integer data type ofmatching size. For example, a channel of size 8 bit will be selectedas unsigned8, a channel of 32 bit size as unsigned32, and soon.

Category TIA Portal datatypes

PROFINET Tap data types

Binary BOOL booleanBit sequences BYTE unsigned8

WORD unsigned16DWORD unsigned32LWORD unsigned64

Integers SINT integer8INT integer16DINT integer32USINT unsigned8UINT unsigned16UDINT unsigned32LINT integer64ULINT unsigned64

Floating pointnumbers

REAL real32LREAL real64

Times S5TIME octetStringTIME octetStringLTIME octetString

Date and time DATE octetStringTOD(TIME_OF_DAY)

octetString

LTOD(LTIME_OF_DAY)

octetString

DT(DATE_AND_TIME)

not supported

LDT octetStringDTL not supported

Strings CHAR visibleStringWCHAR octetStringSTRING not supportedWSTRING not supported


© Hilscher 2020


Category TIA Portal datatypes

PROFINET Tap data types

Hardware data types REMOTE not supportedHW_ANY unsigned16HW_DEVICE unsigned16HW_DPMASTER unsigned16HW_DPSLAVE unsigned16HW_IO unsigned16HW_IOSYSTEM unsigned16HW_SUBMODULE unsigned16HW_MODULE unsigned16HW_INTERFACE unsigned16HW_IEPORT unsigned16HW_HSC unsigned16HW_PWM unsigned16HW_PTO unsigned16EVENT_ANY unsigned32EVENT_ATT unsigned32EVENT_HWINT unsigned32OB_ANY integer16OB_DELAY integer16OB_TOD integer16OB_CYCLIC integer16OB_ATT integer16OB_PCYCLE integer16OB_HWINT integer16OB_DIAG integer16OB_TIMEERROR integer16OB_STARTUP integer16PORT unsigned16RTM unsigned16PIP unsigned16CONN_ANY unsigned16CONN_PRG unsigned16CONN_OUC unsigned16CONN_R_ID unsigned32DB_ANY unsigned16DB_WWW unsigned16DB_DYN unsigned16

Table 17: Mapping of data types from TIA Portal


© Hilscher 2020


5.4 Using SSL/TLS encryption (optional)Please note the following if you intend to use SSL/TLS encryption:The certificates and key files that the MQTT Client in the PROFINET Tapcontainer needs for establishing a secure SSL/TLS connection to theMQTT Broker are not managed by the PROFINET Tap container itself.Instead, they are to be stored on the Edge Device and mapped into thecontainer from the netFIELD OS. For this mapping, the following standard directories are mapped into thecontainer if you use the default Container Create Options in the netFIELDPortal:/etc/ssl//usr/share/ca-certificates/

Note:If you require different directories for your use case, you maychange the mapping of these “bind mounts” in the netFIELD Portalbefore deploying the container (see section Container CreateOptions [} page 17]).

As a user, you can store your required keys and certificates in thesedirectories. By selecting the SSL / TLS option on the MQTT ClientSettings page, you can allow the MQTT Client in the PROFINET Tapcontainer to use these files for establishing its secure SSL/TLS connection. Note that these keys and certificates must be stored in PEM format (aspecific file format for storing this kind of data) and that you have to specifythe full path to the appropriate PEM file in the corresponding fields of theMQTT Client Settings page. For example:

File name and path to private key in PEM format:/etc/ssl/private/client-key.pem

File name and path to certificate chains in PEM format:/etc/ssl/services/client-cert.pem

Override the trusted CA certificates in PEM format:/etc/ssl/services/ca-cert.pem

Note also that if you intend to use more than one “secure” MQTT Broker(as listed in the Server URIs field), and thus require several differentcertificates, you have to store them in one single PEM file. This is becauseit is not possible to specify a list of multiple paths to separate PEM files forindividual Brokers.


© Hilscher 2020

Legal notes 66/73

6 Legal notesCopyright

© Hilscher Gesellschaft für Systemautomation mbH

All rights reserved.

The images, photographs and texts in the accompanying materials (in theform of a user's manual, operator's manual, Statement of Work documentand all other document types, support texts, documentation, etc.) areprotected by German and international copyright and by international tradeand protective provisions. Without the prior written consent, you do nothave permission to duplicate them either in full or in part using technical ormechanical methods (print, photocopy or any other method), to edit themusing electronic systems or to transfer them. You are not permitted to makechanges to copyright notices, markings, trademarks or ownershipdeclarations. Illustrations are provided without taking the patent situationinto account. Any company names and product designations provided inthis document may be brands or trademarks by the corresponding ownerand may be protected under trademark, brand or patent law. Any form offurther use shall require the express consent from the relevant owner of therights.

Important notes

Utmost care was/is given in the preparation of the documentation at handconsisting of a user's manual, operating manual and any other documenttype and accompanying texts. However, errors cannot be ruled out.Therefore, we cannot assume any guarantee or legal responsibility forerroneous information or liability of any kind. You are hereby made awarethat descriptions found in the user's manual, the accompanying texts andthe documentation neither represent a guarantee nor any indication onproper use as stipulated in the agreement or a promised attribute. It cannotbe ruled out that the user's manual, the accompanying texts and thedocumentation do not completely match the described attributes, standardsor any other data for the delivered product. A warranty or guarantee withrespect to the correctness or accuracy of the information is not assumed.

We reserve the right to modify our products and the specifications for suchas well as the corresponding documentation in the form of a user's manual,operating manual and/or any other document types and accompanyingtexts at any time and without notice without being required to notify of saidmodification. Changes shall be taken into account in future manuals and donot represent an obligation of any kind, in particular there shall be no rightto have delivered documents revised. The manual delivered with theproduct shall apply.

Under no circumstances shall Hilscher Gesellschaft für SystemautomationmbH be liable for direct, indirect, ancillary or subsequent damage, or forany loss of income, which may arise after use of the information containedherein.


© Hilscher 2020

Legal notes 67/73

Liability disclaimer

The hardware and/or software was created and tested by HilscherGesellschaft für Systemautomation mbH with utmost care and is madeavailable as is. No warranty can be assumed for the performance orflawlessness of the hardware and/or software under all applicationconditions and scenarios and the work results achieved by the user whenusing the hardware and/or software. Liability for any damage that may haveoccurred as a result of using the hardware and/or software or thecorresponding documents shall be limited to an event involving willful intentor a grossly negligent violation of a fundamental contractual obligation.However, the right to assert damages due to a violation of a fundamentalcontractual obligation shall be limited to contract-typical foreseeabledamage.

It is hereby expressly agreed upon in particular that any use or utilization ofthe hardware and/or software in connection with· Flight control systems in aviation and aerospace;· Nuclear fission processes in nuclear power plants;· Medical devices used for life support and· Vehicle control systems used in passenger transport

shall be excluded. Use of the hardware and/or software in any of thefollowing areas is strictly prohibited:· For military purposes or in weaponry;· For designing, engineering, maintaining or operating nuclear systems;· In flight safety systems, aviation and flight telecommunications systems;· In life-support systems;· In systems in which any malfunction in the hardware and/or software

may result in physical injuries or fatalities.

You are hereby made aware that the hardware and/or software was notcreated for use in hazardous environments, which require fail-safe controlmechanisms. Use of the hardware and/or software in this kind ofenvironment shall be at your own risk; any liability for damage or loss dueto impermissible use shall be excluded.


© Hilscher 2020

Legal notes 68/73

Warranty

Hilscher Gesellschaft für Systemautomation mbH hereby guarantees thatthe software shall run without errors in accordance with the requirementslisted in the specifications and that there were no defects on the date ofacceptance. The warranty period shall be 12 months commencing as of thedate of acceptance or purchase (with express declaration or implied, bycustomer's conclusive behavior, e.g. putting into operation permanently).

The warranty obligation for equipment (hardware) we produce is 36months, calculated as of the date of delivery ex works. The aforementionedprovisions shall not apply if longer warranty periods are mandatory by lawpursuant to Section 438 (1.2) BGB, Section 479 (1) BGB and Section 634a(1) BGB [Bürgerliches Gesetzbuch; German Civil Code] If, despite of alldue care taken, the delivered product should have a defect, which alreadyexisted at the time of the transfer of risk, it shall be at our discretion toeither repair the product or to deliver a replacement product, subject totimely notification of defect.

The warranty obligation shall not apply if the notification of defect is notasserted promptly, if the purchaser or third party has tampered with theproducts, if the defect is the result of natural wear, was caused byunfavorable operating conditions or is due to violations against ouroperating regulations or against rules of good electrical engineeringpractice, or if our request to return the defective object is not promptlycomplied with.

Costs of support, maintenance, customization and product care

Please be advised that any subsequent improvement shall only be free ofcharge if a defect is found. Any form of technical support, maintenance andcustomization is not a warranty service, but instead shall be charged extra.

Additional guarantees

Although the hardware and software was developed and tested in-depthwith greatest care, Hilscher Gesellschaft für Systemautomation mbH shallnot assume any guarantee for the suitability thereof for any purpose thatwas not confirmed in writing. No guarantee can be granted whereby thehardware and software satisfies your requirements, or the use of thehardware and/or software is uninterruptable or the hardware and/orsoftware is fault-free.

It cannot be guaranteed that patents and/or ownership privileges have notbeen infringed upon or violated or that the products are free from third-partyinfluence. No additional guarantees or promises shall be made as towhether the product is market current, free from deficiency in title, or can beintegrated or is usable for specific purposes, unless such guarantees orpromises are required under existing law and cannot be restricted.


© Hilscher 2020

Legal notes 69/73

Confidentiality

The customer hereby expressly acknowledges that this document containstrade secrets, information protected by copyright and other patent andownership privileges as well as any related rights of Hilscher Gesellschaftfür Systemautomation mbH. The customer agrees to treat as confidential allof the information made available to customer by Hilscher Gesellschaft fürSystemautomation mbH and rights, which were disclosed by HilscherGesellschaft für Systemautomation mbH and that were made accessible aswell as the terms and conditions of this agreement itself.

The parties hereby agree to one another that the information that eachparty receives from the other party respectively is and shall remain theintellectual property of said other party, unless provided for otherwise in acontractual agreement.

The customer must not allow any third party to become knowledgeable ofthis expertise and shall only provide knowledge thereof to authorized usersas appropriate and necessary. Companies associated with the customershall not be deemed third parties. The customer must obligate authorizedusers to confidentiality. The customer should only use the confidentialinformation in connection with the performances specified in thisagreement.

The customer must not use this confidential information to his ownadvantage or for his own purposes or rather to the advantage or for thepurpose of a third party, nor must it be used for commercial purposes andthis confidential information must only be used to the extent provided for inthis agreement or otherwise to the extent as expressly authorized by thedisclosing party in written form. The customer has the right, subject to theobligation to confidentiality, to disclose the terms and conditions of thisagreement directly to his legal and financial consultants as would berequired for the customer's normal business operation.

Export provisions

The delivered product (including technical data) is subject to the legalexport and/or import laws as well as any associated regulations of variouscountries, especially such laws applicable in Germany and in the UnitedStates. The products / hardware / software must not be exported into suchcountries for which export is prohibited under US American export controllaws and its supplementary provisions. You hereby agree to strictly followthe regulations and to yourself be responsible for observing them. You arehereby made aware that you may be required to obtain governmentalapproval to export, reexport or import the product.


© Hilscher 2020

List of Figures 70/73

List of FiguresFigure 1: Connection via netMIRROR and OnPremise device............................................ 8Figure 2: Connection via mirror port of switch ..................................................................... 10Figure 3: Connection without hardware mirror..................................................................... 11Figure 4: Available Containers tab....................................................................................... 13Figure 5: Deploy container................................................................................................... 14Figure 6: Overview tab......................................................................................................... 15Figure 7: Container Create Options..................................................................................... 17Figure 8: Environment Variables ......................................................................................... 18Figure 9: Container Twin ..................................................................................................... 20Figure 10: Configuration GUI plugin in local Device Manager............................................... 21Figure 11: Status page .......................................................................................................... 22Figure 12: About tab .............................................................................................................. 23Figure 13: Configuration Backup ........................................................................................... 24Figure 14: Restore configuration ........................................................................................... 25Figure 15: Publisher Management......................................................................................... 26Figure 16: Parameters of PROFINET variable ...................................................................... 27Figure 17: MQTT Client settings............................................................................................ 28Figure 18: Physical settings................................................................................................... 30Figure 19: PROFINET Configuration tree.............................................................................. 31Figure 20: Parameters of selected PROFINET element in Editor window ............................ 32Figure 21: Menu bar .............................................................................................................. 32Figure 22: GSDML Management........................................................................................... 39Figure 23: Upload GSDML file dialog .................................................................................... 40Figure 24: Multiple selection in File upload dialog ................................................................. 40Figure 25: Upload GSDML file dialog .................................................................................... 41Figure 26: AutomationML Management ................................................................................ 42Figure 27: Export AutomationML file from Tia Portal............................................................. 43Figure 28: Upload AutomationML file dialog.......................................................................... 44Figure 29: Multiple selection in File upload dialog ................................................................. 44Figure 30: Upload AutomationML file dialog.......................................................................... 45Figure 31: PROFINET configuration recognized during start-up ........................................... 47Figure 32: Change name of Controller .................................................................................. 48Figure 33: New Controller name............................................................................................ 48Figure 34: Auto-mapping in progress .................................................................................... 49Figure 35: Select definition .................................................................................................... 50Figure 36: Finished ................................................................................................................ 51Figure 37: Publish variable .................................................................................................... 52Figure 38: Publisher created.................................................................................................. 53Figure 39: PROFINET configuration recognized during start-up ........................................... 55Figure 40: Auto-mapping in progress .................................................................................... 56


© Hilscher 2020

List of Figures 71/73

Figure 41: Mapping finished .................................................................................................. 57Figure 42: Publish variable .................................................................................................... 58Figure 43: Publisher created.................................................................................................. 59


© Hilscher 2020

List of Tables 72/73

List of TablesTable 1: List of revisions ....................................................................................................... 4Table 2: Elements in Overview tab ....................................................................................... 15Table 3: Operating elements for Container Create Options ................................................. 17Table 4: Environment Variables............................................................................................ 18Table 5: Operating elements for Environment Variables ...................................................... 19Table 6: Operating elements for Container Twin Options..................................................... 20Table 7: About tab ................................................................................................................ 23Table 8: Elements of Publisher Management tab................................................................. 26Table 9: Elements Variable’s details window........................................................................ 27Table 10: MQTT Client Settings ............................................................................................. 29Table 11: Port speed settings ................................................................................................. 30Table 12: Elements PROFINET Configuration ....................................................................... 38Table 13: GSDML Management tab ....................................................................................... 39Table 14: AutomationML Management tab............................................................................. 43Table 15: Descriptions of elements in topic ............................................................................ 60Table 16: Notes on message content ..................................................................................... 61Table 17: Mapping of data types from TIA Portal ................................................................... 63


© Hilscher 2020

Contacts 73/73

Contacts

HEADQUARTERSGermanyHilscher Gesellschaft für Systemautomation mbH Rheinstrasse 15 65795 Hattersheim Phone: +49 (0) 6190 9907-0 Fax: +49 (0) 6190 9907-50 E-mail: [email protected]: +49 (0) 6190 9907-99E-mail: [email protected]

SUBSIDIARIESChinaHilscher Systemautomation (Shanghai) Co. Ltd.200010 ShanghaiPhone: +86 (0) 21-6355-5161E-mail: [email protected]: +86 (0) 21-6355-5161E-mail: [email protected]

FranceHilscher France S.a.r.l.69500 BronPhone: +33 (0) 4 72 37 98 40E-mail: [email protected]: +33 (0) 4 72 37 98 40 E-mail: [email protected]

IndiaHilscher India Pvt. Ltd.Pune, Delhi, MumbaiPhone: +91 8888 750 777E-mail: [email protected]

ItalyHilscher Italia S.r.l.20090 Vimodrone (MI)Phone: +39 02 25007068E-mail: [email protected]: +39 02 25007068E-mail: [email protected]

JapanHilscher Japan KKTokyo, 160-0022Phone: +81 (0) 3-5362-0521E-mail: [email protected]: +81 (0) 3-5362-0521E-mail: [email protected]

KoreaHilscher Korea Inc.Seongnam, Gyeonggi, 463-400Phone: +82 (0) 31-789-3715E-mail: [email protected]

SwitzerlandHilscher Swiss GmbH 4500 SolothurnPhone: +41 (0) 32 623 6633E-mail: [email protected]: +49 (0) 6190 9907-99E-mail: [email protected]

USAHilscher North America, Inc. Lisle, IL 60532Phone: +1 630-505-5301E-mail: [email protected]: +1 630-505-5301E-mail: [email protected]


© Hilscher 2020

mailto:[email protected]
















netFIELD App PROFINET Tap Operating instruction manual

Documents

Transcript of netFIELD App PROFINET Tap Operating instruction manual