Document history 1

Safety Notes 2

Introduction 3
MindSphere
Overview of MindConnect
Elements 4
Getting Connected to MindSphere User roles and scopes in
"Getting Connected to 5
MindSphere"

Mounting and installing

Getting Started
MindConnect Elements 6
Connecting MindConnect
Elements 7
Onboarding MindConnect
Elements 8
Configuring data in Asset
Manager 9

Configuring protocols 10
Firmware update for
Mindconnect Nano / IOT 11
2040

Remote functions 12
Visual analysis of assets in
Fleet Manager 13

Appendix A

08/2022
Legal information
Warning notice system
This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent damage
to property. The notices referring to your personal safety are highlighted in the manual by a safety alert symbol, notices
referring only to property damage have no safety alert symbol. These notices shown below are graded according to
the degree of danger.

DANGER
indicates that death or severe personal injury will result if proper precautions are not taken.

WARNING
indicates that death or severe personal injury may result if proper precautions are not taken.

CAUTION
indicates that minor personal injury can result if proper precautions are not taken.

NOTICE
indicates that property damage can result if proper precautions are not taken.
If more than one degree of danger is present, the warning notice representing the highest degree of danger will be
used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to property
damage.
Qualified Personnel
The product/system described in this documentation may be operated only by personnel qualified for the specific
task in accordance with the relevant documentation, in particular its warning notices and safety instructions.
Qualified personnel are those who, based on their training and experience, are capable of identifying risks and
avoiding potential hazards when working with these products/systems.
Proper use of Siemens products
Note the following:

WARNING
Siemens products may only be used for the applications described in the catalog and in the relevant technical
documentation. If products and components from other manufacturers are used, these must be recommended or
approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and maintenance
are required to ensure that the products operate safely and without any problems. The permissible ambient
conditions must be complied with. The information in the relevant documentation must be observed.

Trademarks
All names identified by ® are registered trademarks of Siemens AG. The remaining trademarks in this publication may
be trademarks whose use by third parties for their own purposes could violate the rights of the owner.
Disclaimer of Liability
We have reviewed the contents of this publication to ensure consistency with the hardware and software described.
Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the information in this
publication is reviewed regularly and any necessary corrections are included in subsequent editions.

Siemens AG Copyright © Siemens AG 2022.

Digital Industries Ⓟ 08/2022 Subject to change All rights reserved
Postfach 48 48
90026 NÜRNBERG
GERMANY
Table of contents

1 Document history .................................................................................................................................. 9

2 Safety Notes......................................................................................................................................... 13
2.1 General safety instructions................................................................................................. 13
2.2 Notes on usage .................................................................................................................. 16
3 Introduction ......................................................................................................................................... 17
3.1 Getting Started .................................................................................................................. 17
3.2 Purpose of this document .................................................................................................. 17
3.3 Functional overview of MindSphere ................................................................................... 18
3.4 Working with MindSphere.................................................................................................. 19
3.5 Data model in "Asset Manager"........................................................................................... 20
4 Overview of MindConnect Elements ................................................................................................... 23
5 User roles and scopes in "Getting Connected to MindSphere" ............................................................ 27
6 Mounting and installing MindConnect Elements................................................................................ 29
6.1 Checking package upon delivery ........................................................................................ 29
6.2 Mounting MindConnect Nano ............................................................................................ 30
6.2.1 Permitted mounting positions and surrounding temperature .............................................. 31
6.2.2 Connecting the protective earth ......................................................................................... 32
6.3 Mounting MindConnect IoT2040........................................................................................ 32
6.3.1 Permitted mounting positions and surrounding temperature .............................................. 32
6.3.2 Mounting types ................................................................................................................. 33
6.4 LED lights of MindConnect Elements .................................................................................. 34
6.4.1 LED lights of MindConnect Nano ........................................................................................ 34
6.4.2 LED lights of MindConnect IoT2040.................................................................................... 35
6.4.3 Troubleshooting................................................................................................................. 38
6.5 USB commands.................................................................................................................. 41
7 Connecting MindConnect Elements .................................................................................................... 51
7.1 Commissioning MindConnect Element ............................................................................... 51
7.2 Firewall/Proxy rules for MindSphere.................................................................................... 55
7.3 Connecting MindConnect Nano to MindSphere network ..................................................... 56
7.4 Connecting MindConnect IoT2040 to MindSphere network................................................. 59
7.5 Connecting Port X2 P1 for MindConnect Element ............................................................... 60
7.6 MindConnect network plan ................................................................................................ 61

Getting Connected to MindSphere

Getting Started, 08/2022 3
Table of contents

8 Onboarding MindConnect Elements ................................................................................................... 65

8.1 Overview of onboarding MindConnect Element.................................................................. 65
8.2 Logging in to MindSphere .................................................................................................. 66
8.3 Creating an asset ............................................................................................................... 67
8.4 Enable connection to MindConnect Element ...................................................................... 68
8.5 Configuring network and diagnostic settings ...................................................................... 70
8.5.1 Configuring network settings ............................................................................................. 70
8.5.2 Configuring diagnostic settings .......................................................................................... 73
8.6 Transferring configuration to MindConnect Elements Mindconnect Nano and
Mindconnect IoT2040 ........................................................................................................ 75
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere........ 77
8.7.1 Overview of MindConnect Software Agent ......................................................................... 77
8.7.2 User interface of MindConnect Software Agent .................................................................. 80
8.7.3 Onboarding and Installing MindConnect Software Agent ................................................... 82
8.7.3.1 Onboarding and installing MindConnect Software Agent in Windows ................................. 82
8.7.3.2 Installing MCSA in Docker .................................................................................................. 90
8.7.4 Diagnosing MindConnect Software Agent .......................................................................... 94
8.7.5 Device Maintenance........................................................................................................... 98
8.7.6 Settings in MindConnect Software Agent ......................................................................... 100
8.7.7 Using MindConnect Software Agent's Hyper-V VM ............................................................ 105
8.7.8 Managing or maintaining the virtual machines or instances in MindConnect Software
Agent .............................................................................................................................. 106
8.7.9 Configuring MCSA in Docker............................................................................................. 110
8.7.10 Differentiating MCSA between Windows and Linux ........................................................... 119
8.7.11 Known restrictions of MindConnect Software Agent ......................................................... 122
8.7.12 Troubleshooting............................................................................................................... 124
9 Configuring data in Asset Manager ................................................................................................... 127
9.1 Creating an aspect and variables ...................................................................................... 128
9.2 Creating a type in Asset Manager ..................................................................................... 130
9.3 Adding a data source and data points............................................................................... 132
9.3.1 Adding a data source ....................................................................................................... 132
9.3.2 Adding data points........................................................................................................... 134
9.4 Mapping an aspect to a data source ................................................................................. 136
9.5 Importing data source configurations for MindConnect Nano/IoT2040 .............................. 140
9.6 Importing data source configurations with datapoint mapping for MindConnect Software
Agent .............................................................................................................................. 142
9.7 Configuring MindConnect element using API .................................................................... 145
10 Configuring protocols ........................................................................................................................ 149
10.1 Overview of supported protocols for MindConnect Elements ............................................ 149
10.2 Overview of S7 protocol................................................................................................... 150
10.3 Overview of OPC UA protocol ........................................................................................... 155
10.4 Overview of Modbus TCP protocol .................................................................................... 160

Getting Connected to MindSphere

4 Getting Started, 08/2022
 Table of contents

10.5 Overview of Modbus RTU protocol.................................................................................... 166

10.6 Overview of SIMATIC I/O Shield ........................................................................................ 172
10.7 Overview of SYSTEM protocol........................................................................................... 174
10.8 Overview of Rockwell protocol ......................................................................................... 184
10.9 Overview of S7+ protocol................................................................................................. 187
10.10 Overview of Fanuc Focas protocol .................................................................................... 190
10.11 Overview of Sinumerik protocol ....................................................................................... 195
10.12 Overview of IEC61850 protocol ........................................................................................ 197
10.13 Overview of MTConnect protocol ..................................................................................... 200
11 Firmware update for Mindconnect Nano / IOT 2040 ......................................................................... 203
11.1 Manual firmware update of MindConnect Element ........................................................... 203
11.2 Firmware update in Asset Manager................................................................................... 204
11.3 Automatic firmware update of MindConnect Element ....................................................... 207
12 Remote functions............................................................................................................................... 209
12.1 Remote restart ................................................................................................................. 209
12.2 Send commands .............................................................................................................. 209
13 Visual analysis of assets in Fleet Manager ........................................................................................ 215
13.1 Overview visual analysis................................................................................................... 215
13.2 Selecting assets ............................................................................................................... 215
13.3 Viewing aspects ............................................................................................................... 217
13.4 Viewing events ................................................................................................................ 219
A Appendix............................................................................................................................................ 221
A.1 Data center locations ....................................................................................................... 221
A.2 Quality code settings ....................................................................................................... 221
A.2.1 Using quality code ........................................................................................................... 221
A.2.2 Quality codes OPC UA and S7 protocol.............................................................................. 222
A.2.3 Quality codes Modbus protocol ........................................................................................ 224
A.2.4 Quality codes SIMATIC I/O Shield ...................................................................................... 224
A.2.5 Quality codes SYSTEM protocol ........................................................................................ 225
A.2.6 Quality codes Rockwell protocol ....................................................................................... 225
A.2.7 Quality codes S7+, Fanuc Focas, Sinumerik, IEC61850 and MTConnect ............................. 226
A.3 Technical specifications of MindConnect Nano.................................................................. 226
A.4 Technical specifications of MindConnect IoT2040 ............................................................. 229
A.5 Offline buffer.................................................................................................................... 232
A.6 Read performance MindConnect Elements ....................................................................... 232
A.7 Firewall Settings .............................................................................................................. 234
A.8 ESD guideline .................................................................................................................. 236

Getting Connected to MindSphere

Getting Started, 08/2022 5
Table of contents

A.9 Return of defect hardware................................................................................................ 238

A.10 List of abbreviations......................................................................................................... 239
A.11 MindConnect EthernetIP - CIP Communication path (route parameters) settings ............... 239
A.11.1 Case 1 – Accessing data inside an Allen- Bradley PLC......................................................... 240
A.11.2 Case 2 – Accessing the Allen- Bradley PLC via integrated Ethernet port .............................. 241
A.11.3 Case 3 – Accessing the Allen- Bradley PLC via the ControlNet interface .............................. 242
A.12 MindConnect general security principles .......................................................................... 242
Glossary ............................................................................................................................................. 245

Getting Connected to MindSphere

6 Getting Started, 08/2022
 This document provides an overview of the MindConnect devices to connect your assets to
MindSphere.
For a quick installation guide, see:
• MindConnect Nano (https://documentation.mindsphere.io/resources/pdf/
MCN_Quick_Start.pdf)
• MindConnect IoT2040 (https://documentation.mindsphere.io/resources/pdf/
MC_IoT2040_Quick_Start.pdf)

Getting Connected to MindSphere

Getting Started, 08/2022 7
 Getting Connected to MindSphere
8 Getting Started, 08/2022
Document history 1
Date Changes Link
2022-08-05 Updated OPC UA protocol with OPC UA Overview of OPC UA protocol (Page 155)
Server Address
2022-07-02 Updated topic "Configuring network set‐ Configuring network settings (Page 70)
tings" with router gateways
2022-06-04 Updated topic "Send commands" with Send commands (Page 209)
Commanding Device via API
2022-05-07 Updated OPC UA protocol with event Overview of OPC UA protocol (Page 155)
type
2022-04-09 Added new chapter for "Using MCSA in Using MCSA in Docker (Page 77)
Docker"
Updated topic "USB commands" for USB commands (Page 41)
Change log file upload configuration
Updated topic "Configuring diagnostic Configuring diagnostic settings
settings" with diagnostic settings (Page 73)
2022-01-22 Updated topic Overview of Modbus TCP Overview of Modbus TCP protocol
protocol with the new data pointer "In‐ (Page 160)
teger Byte Order" parameter
Updated topic Overview of Modbus RTU Overview of Modbus RTU protocol
protocol with the new data pointer "In‐ (Page 166)
teger Byte Order" parameter
2021-12-22 Updated topic Firmware update in Asset Firmware update in Asset Manager
Manager with "Firmware updates for (Page 204)
multiple devices"
2021-12-09 Updated topic Diagnosing MindConnect Diagnosing MindConnect Software
Software Agent with "Network analysis" Agent (Page 94)
Updated topic Firmware update in Asset Firmware update in Asset Manager
Manager with "Firmware updates for (Page 204)
multiple devices"
2021-10-30 Added new topic Configuring MindCon‐ Configuring MindConnect element us‐
nect element using API ing API (Page 145)
Updated topic Configuring diagnostic Configuring diagnostic settings
settings (Page 73)

Getting Connected to MindSphere

Getting Started, 08/2022 9
Document history

Date Changes Link

2021-10-02 Added new chapter for roles and scopes User roles and scopes in "Getting Con‐
nected to MindSphere" (Page 27)
Updated topic USB commands. USB commands (Page 41)
Updated chapter Configuring network Configuring network and diagnostic set‐
and diagnostic settings tings (Page 70)
Updated topic Overview of MindCon‐ Overview of MindConnect Software
nect Software Agent Agent (Page 77)
Updated topic Onboarding and installing Onboarding and installing MindConnect
MindConnect Software Agent Software Agent (Page 82)
Updated topic Diagnosing MindConnect Diagnosing MindConnect Software
Software Agent Agent (Page 94)
Updated file transfer information in topic Settings in MindConnect Software
Settings in MindConnect Software Agent Agent (Page 100)
Updated topic Known restrictions of Known restrictions of MindConnect Soft‐
MindConnect Software Agent ware Agent (Page 122)
Updated topic Firmware update in Asset Firmware update in Asset Manager
Manager (Page 204)
2021-09-04 Updated the Introduction topic in chap‐ Configuring data in Asset Manager
ter Configuring data in Asset Manager (Page 127)
2021-07-16 Updated the chapter for importing data Importing data source configurations
source configurations (Page 140)
2021-07-10 Added S7+ protocol section. Overview of S7+ protocol (Page 187)
Added Fanuc Focas protocol section. Overview of Fanuc Focas protocol
(Page 190)
Added Sinumerik protocol section. Overview of Sinumerik protocol
(Page 195)
Added IEC61850 protocol section. Overview of IEC61850 protocol
(Page 197)
Added MTConnect protocol section. Overview of MTConnect protocol
(Page 200)
Added of quality codes for S7+, Fanuc Quality codes S7+, Fanuc Focas, Sinu‐
Focas, Sinumerik, IEC61850 and MTCon‐ merik, IEC61850 and MTConnect
nect (Page 226)
Updated Settings in MindConnect Soft‐ Settings in MindConnect Software
ware Agent Agent (Page 100)
2021-06-12 Updated Rockwell protocol section. Overview of Rockwell protocol
(Page 184)
2021-05-15 Updated the chapter for Known restric‐ Known restrictions of MindConnect Soft‐
tions of MindConnect Software Agent ware Agent (Page 122)
2021-04-15 Added new chapter for "Managing or Managing or maintaining the virtual ma‐
maintaining the virtual machines or in‐ chines or instances in MindConnect Soft‐
stances in MindConnect Software Agent" ware Agent (Page 106)
Updated the chapter for importing data Importing data source configurations
source configurations (Page 140)
2021-03-27 Added new chapter for importing data Importing data source configurations
source configurations (Page 140)

Getting Connected to MindSphere

10 Getting Started, 08/2022
 Document history

Date Changes Link

2021-02-27 Updated chapter for MindConnect Soft‐ Using MindConnect Software Agent to
ware Agent. connect industrial data sources to Mind‐
Sphere (Page 77)
2021-01-30 Added new chapter for MindConnect Using MindConnect Software Agent to
Software Agent. connect industrial data sources to Mind‐
Sphere (Page 77)
2020-10-31 Update of Modbus TCP protocol. Overview of Modbus TCP protocol
(Page 160)
2020-09-29 Update of configuring protocols. Configuring protocols (Page 149)
Update of Manual firmware update. Manual firmware update of MindCon‐
nect Element (Page 203)
Update of chapter USB commands. USB commands (Page 41)
Added new commanding functionality Send commands (Page 209)
chapter for send commands.
2020-06-16 Added new chapter remote restart. Remote restart (Page 209)
2020-04-18 Updated of configuring protocols. Configuring protocols (Page 149)
Updated of quality codes. Quality code settings (Page 221)
2020-02-20 Updated USB commandos. Added new USB commands (Page 41)
command restricted device configura‐
tion.
Updated OPC UA protocol. You can now Overview of OPC UA protocol (Page 155)
activate events and alarms.
Updated Modbus TCP protocol. Added Overview of Modbus TCP protocol
optional data source parameter. (Page 160)
Updated Modbus RTU protocol. Added Overview of Modbus TCP protocol
optional data source parameter. (Page 160)
2020-01-08 Added Rockwell protocol section. Overview of Rockwell protocol
(Page 184)
Updated quality codes for Rockwell pro‐ Quality codes Rockwell protocol
tocol. (Page 225)
2019-12-02 Update of Connecting MindConnect Connecting MindConnect Nano to Mind‐
Nano to MindSphere network. Sphere network (Page 56)
Added note for Proxy IP address. Configuring network settings (Page 70)
Added note for limitations for data Adding data points (Page 134)
points.
Update of Modbus TCP protocol. Overview of Modbus TCP protocol
(Page 160)
Update of SYSTEM protocol. Overview of SYSTEM protocol
(Page 174)
2019-10-02 Update of SYSTEM protocol. Overview of SYSTEM protocol
(Page 174)
2019-08-07 You can now use NTLM Authentication Configuring network settings (Page 70)
in the proxy configuration.
2019-06-13 Update of S7 protocol chapter. Overview of S7 protocol (Page 150)
Update of Modbus protocol chapter. Overview of Modbus TCP protocol
(Page 160)
You can now use hysteresis in the data Adding data points (Page 134)
point configuration.

Getting Connected to MindSphere

Getting Started, 08/2022 11
Document history

Date Changes Link

2019-05-15 Added new chapter "MindConnect net‐ MindConnect network plan (Page 61)
work plan".
Update of Read performance of Mind‐ Read performance MindConnect Ele‐
Connect Elements ments (Page 232)
Added Modbus protocol section for Mod‐ Configuring protocols (Page 149)
bus TCP and Modbus RTU.
2019-03-18 Added note for Firmware update. Firmware update for Mindconnect
Nano / IOT 2040 (Page 203)
2019-02-11 Added health status to data point sec‐ Adding data points (Page 134)
tion.
Added SYSTEM protocol section. Overview of SYSTEM protocol
(Page 174)
Update of S7 protocol section. Overview of S7 protocol (Page 150)
Update of OPC UA section. Overview of OPC UA protocol (Page 155)
2019-01-14 Update of S7 protocol section. Overview of S7 protocol (Page 150)
Update of technical specifications. Technical specifications of MindConnect
Nano (Page 226)
2018-12-17 Added new topic Regions in MindSphere. Data center locations (Page 221)
Added chapter Firmware update. Firmware update for Mindconnect
Nano / IOT 2040 (Page 203)
Added chapter Return of defect hard‐ Return of defect hardware (Page 238)
ware.
Update of Notes on usage. Notes on usage (Page 16)
Added section Calculation of buffer time. Read performance MindConnect Ele‐
ments (Page 232)
Added chapter USB commandos. USB commands (Page 41)
2018-12-03 Updated section configuring protocols. Configuring protocols (Page 149)
Added new chapter Read performance Read performance MindConnect Ele‐
of MindConnect Elements. ments (Page 232)
2018-11-13 Added new protocols Modbus and SI‐ Configuring protocols (Page 149)
MATiC I/O Shield.

Getting Connected to MindSphere

12 Getting Started, 08/2022
Safety Notes 2
2.1 General safety instructions

WARNING
Life-threatening voltages are present with an open control cabinet
When you install the device in a control cabinet, some areas or components in the open control
cabinet may be carrying life-threatening voltages.
If you touch these areas or components, you may be killed by electric shock.
Switch off the power supply to the cabinet before opening it.

System expansions

NOTICE
Damage through system expansions
Device and system expansions may be faulty and can affect the entire machine or plant.
The installation of expansions can damage the device, machine or plant. Device and system
expansions may violate safety rules and regulations regarding radio interference suppression.
If you install or exchange system expansions and damage your device, the warranty becomes
void.

Note the following for system expansions:

Only install system expansion devices designed for this device. Contact your technical support
team or the team where you have purchased your PC to find out which system expansion devices
may safely be installed.
Observe the information on electromagnetic compatibility (EMC). Refer to the chapter Technical
specifications of MindConnect Nano (Page 226)/Technical specifications of MindConnect
IoT2040 (Page 229).

NOTICE
"Open Type" UL508
Note that the device is classified as "Open Type" for use in the area of Industrial Control
Equipment (UL508).
Installation of the device in an enclosure complying with UL508 is a prerequisite for approval
or operation in accordance with UL508.

Getting Connected to MindSphere

Getting Started, 08/2022 13
Safety Notes
2.1 General safety instructions

Battery and rechargeable battery

WARNING
Risk of explosion and release of harmful substances
Improper handling of lithium batteries can result in an explosion of the batteries.
Explosion of the batteries and the released pollutants can cause severe physical injury.
Worn batteries jeopardize the function of the device.
Note the following when handling lithium batteries:
• Replace used batteries in good time; see the section "Replacing the backup battery" in the
operating instructions.
• Replace the lithium battery only with an identical battery or types recommended by the
manufacturer.
• Do not throw lithium batteries into fire, do not solder on the cell body, do not recharge, do
not open, do not short-circuit, do not reverse polarity, do not heat above 100°C and protect
from direct sunlight, moisture and condensation.

Strong high-frequency radiation

NOTICE
Observe immunity to RF radiation
The device has an increased immunity to RF radiation according to the specifications on
electromagnetic compatibility in the technical specifications.
Radiation exposure in excess of the specified immunity limits can impair device functionality
resulting in malfunctions and therefore injuries or damages.
Read the information on immunity to RF radiation in the technical specifications.

ESD Guideline
Electrostatic sensitive devices can be labeled with an appropriate symbol.

Getting Connected to MindSphere

14 Getting Started, 08/2022
 Safety Notes
2.1 General safety instructions

NOTICE
Electrostatic sensitive devices (ESD)
When you touch electrostatic sensitive components, you can destroy them through voltages
that are far below the human perception threshold.
If you work with components that can be destroyed by electrostatic discharge, observe the ESD
Guideline. Refer to the chapter ESD guideline (Page 236).

Open Source Software

Siemens will identify the open source software components contained in MindConnect Nano
and MindConnect IoT2040, including the applicable license text and will include such license
text(s) in or provide them together with MindConnect Nano/ Iot2040. Should the license(s)
applicable to any part of the open source software require the distribution of the open source
software’s source code and build scripts together with MindConnect Nano/IoT2040 (or,
alternately, an offer to make the source code and build scripts available upon request), then
Siemens will provide such source code or such offer to customer together with MindConnect
Nano. No license fee is charged to customer for the use of such open source software. Customer
acknowledges and agrees that Siemens provides no warranties, express or implied, and no
indemnification for the open source software itself. Customer hereby accepts that the open
source software is subject to the specific license terms included in or provided together with
MindConnect Nano. To the extent there is a conflict between these terms and the open source
specific license terms, such terms shall prevail with regard to the open source software.

Industrial Security
Siemens provides products and solutions with industrial security functions that support the
secure operation of plants, systems, machines and networks. In order to protect plants, systems,
machines and networks against cyber threats, it is necessary to implement – and continuously
maintain – a holistic, state-of-the-art industrial security concept. Siemens’ products and
solutions only form one element of such a concept. Customer is responsible to prevent
unauthorized access to its plants, systems, machines and networks. Systems, machines and
components should only be connected to the enterprise network or the internet if and to the
extent necessary and with appropriate security measures (e.g. use of firewalls and network
segmentation) in place.
Additionally, Siemens’ guidance on appropriate security measures should be taken into account.
For more information about industrial security, please visit http://www.siemens.com/
industrialsecurity.
Siemens’ products and solutions undergo continuous development to make them more secure.
Siemens strongly recommends to apply product updates as soon as available and to always use
the latest product versions. Use of product versions that are no longer supported, and failure to
apply latest updates may increase customer’s exposure to cyber threats.
For MindConnect Software Agent in Docker MindSphere provides an automatic update process
through the Firmware Update Mechanism only of functionality and libraries. To update the base
image a new version is provided for manual download. The customer has to install it manually
according to the initial installation process.

Getting Connected to MindSphere

Getting Started, 08/2022 15
Safety Notes
2.2 Notes on usage

To stay informed about product updates, subscribe to the Siemens Industrial Security RSS Feed
under: http://www.siemens.com/industrialsecurity.

2.2 Notes on usage

NOTICE
Possible functional restrictions in case of non-validated plant operation.
The device is tested and certified on the basis of the technical standards. In rare cases,
functional restrictions can occur during plant operation.
Validate the correct functioning of the plant to avoid functional restrictions.
Mindsphere provides a highly reliable system, however the MindConnect can be affected by
system internal incidents.

Note
Use in an industrial environment without additional protective measures.
This device was designed for use in a normal industrial environment according to IEC 60721-3-3.

Note
Firmware MiniWeb versions
The connection to a SIMOCODE, SIMOTION, SINAMICS OPC UA Server cannot reestablish
automatic if the used Firmware has a MiniWeb version is less than V5.1. It's recommended to
upgrade to a new Firmware version of the SIMOCODE, SIMOTION, SINAMICS device.

Getting Connected to MindSphere

16 Getting Started, 08/2022
Introduction 3
3.1 Getting Started
This manual gives you an overview of MindConnect Elements, enabling you to commission
these devices.

Basic knowledge requirements

• General knowledge about personal computers is required.
• General knowledge in the field automation control engineering is recommended.

Scope of validity of this document

This manual is valid for MindSphere and MindConnect Elements:
• MindConnect Nano
• MindConnect IoT2040
• MindConnect Software Agent

Convention
The term “device” is used to refer to MindConnect Nano, MindConnect IoT2040 and
MindConnect Software Agent.
The configuration parameters should be extracted out of the text or tables
and depend respectively on the needs and constellation of the individual system.

See also
MindSphere Documentation Area (http://documentation.mindsphere.io)

3.2 Purpose of this document

This Getting Started provides you with information to become familiar with commissioning the
devices MindConnect Elements and working with MindSphere.
By using the examples given in this manual, you will be able to develop or change your service.
You will know how to access and configure the data from your assets as well as create and answer
requests.
You will work through typical steps involved in configuring MindConnect Elements and your
asset data. You will become familiar with the tools that MindSphere provides for configuration
and visualization of assets and aspects.

Getting Connected to MindSphere

Getting Started, 08/2022 17
Introduction
3.3 Functional overview of MindSphere

3.3 Functional overview of MindSphere

This part of Getting Started outlines the functional overview of MindSphere.
MindSphere offers the means to monitor asset status as well as support maintenance and
services. This requires sensor data, the tools to collect and transfer data as well as intelligent
software that offers the monitoring and support functions.
MindConnect Elements provide the hardware for collecting data from assets and transferring it
into MindSphere, which includes hosting via a web user interface.

MindSphere - The open IoT operating system

MindSphere
MindSphere components Your applications

send data

MindConnect

collect data

Your system

With MindSphere and MindConnect Elements you can:

• Create and manage users and customers
• Create, manage and change assets in MindSphere
• Onboard MindConnect Elements to MindSphere in order to collect data from your assets and
transfer it to MindSphere
• Collect data from data sources (S7, OPC UA) via MindConnect Elements
• Visualize the uploaded data (timeseries)
• Display datapoints and open events of an asset
• Manage the connected assets and automate rules

Getting Connected to MindSphere

18 Getting Started, 08/2022
 Introduction
3.4 Working with MindSphere

3.4 Working with MindSphere

This part of the Getting Started provides you with a brief summary of instructions described in
detail in this manual.

Requirements
• Internet connection and newest version of your internet browser (e. g. Google chrome or
Firefox) for online user interface
• Internet connection for MindConnect Element devices.
• Provide standard HTTPS capabilities for MindConnect Elements - outbound HTTPs
connection(s) on port 443
• Link to the online Launchpad with user and password data as supplied by Siemens
• Device (PC, tablet etc.) with minimum screen resolution of 1024x768

Configuring steps

Prepare MindConnect Elements for MindSphere

1. Mount MindConnect Nano/IoT2040 on your physical asset.
2. Connect MindConnect Elements to power supply and the Internet.

Onboard MindConnect Elements

1. Log in to your MindSphere account.
2. Configure your asset and MindConnect Element which is mounted to your physical asset.
3. Configure network settings of MindConnect Elements and proxy as needed to establish
Internet connection to MindSphere.
4. Upgrade to the newest firmware version.
5. Establish the initial connection (onboarding) by transferring the configuration manually by
USB stick.

Configure data collection with Asset Manager

1. Log in to MindSphere with your account.
2. Create an asset in Asset Manager.
3. Configure the data points you want to use.
4. MindConnect Elements receives the configuration from MindSphere via an existing Internet
connection.
5. MindConnect Elements starts the data acquisition.
6. The timeseries can be displayed in Fleet Manager.

Visual analysis of assets with Fleet Manager

1. Monitor assets in different views.
2. Monitor aspects and events.

Getting Connected to MindSphere

Getting Started, 08/2022 19
Introduction
3.5 Data model in "Asset Manager"

3.5 Data model in "Asset Manager"

This chapter describes the data model of Asset Manager within MindSphere. The data model will
show you what processes are necessary to connect and use your asset data in MindSphere.

Definition asset
An asset is a digital representation of a machine or an automation system with one or multiple
automation units (e.g. PLC) connected to MindSphere.
MindSphere data collection and data provisioning is based on so called (virtual) assets. This can
be anything like a pump, motor, PLC, an entire tool machine, a production line, a robot, a crane,
a car, a wind turbine and so on. The data of an asset is collected and sent to MindSphere to make
that data available for further processing and analytics.

Definition aspect
Aspects are a data modeling mechanisms for assets. Aspects group related data points based on
their logical association. For example: The pump skid has an aspect e.g. "Energy_consumption"
that contains the data points: "power", "current", "voltage" etc. Aspect is specified in Asset
Manager and its name can be freely chosen, but should have conjunction to datapoints and a
physical asset. An aspect can consist of several variables.

Getting Connected to MindSphere

20 Getting Started, 08/2022
 Introduction
3.5 Data model in "Asset Manager"

Data model
The following graphic shows the data model in Asset Manager:

MindSphere - Data model

Asset Manager

MindConnect Element Physical Asset Virtual Asset

Onboarding Data mapping

Data source configuration Asset based on a type and

with data points aspects with variables

MindConnect plugin Type

S 7 PLC OPC UA Aspect 1 Aspect 2

-Data point -Data point -Variable -Variable
-Data point -Data point -Variable -Variable
-Data point -Data point -Variable -Variable

In Asset Manager devices like MindConnect Nano are defined as the data source. The device
sends data points to MindSphere. These data points must be connected to the aspects and
variables. Asset Manager uses aspects and variables as data containers.
Within MindSphere you add data points to a data source to collect the data, for example from a
control unit. In the next step you have to link the data points to the respective variables of an
aspect.
To enable data connecting and in order to use your data in MindSphere you have to fulfill the
following processes:
• Onboarding (Page 65): Onboarding is the process of attaching a MindConnect Element to
MindSphere.
• Data mapping (Page 136): Data mapping matches variables of an aspect with the respective
data points of a data source.

Getting Connected to MindSphere

Getting Started, 08/2022 21
Introduction
3.5 Data model in "Asset Manager"

Getting Connected to MindSphere

22 Getting Started, 08/2022
Overview of MindConnect Elements 4
MindConnect Elements, MindConnect Nano and MindConnect IoT2040 are embedded
industrial PCs whereas MindConnect Software Agent is a software agent that can be installed on
your system fulfilling requirements. For more information, see Using MindConnect Software
Agent to connect industrial data sources to MindSphere. (Page 77) They are able to connect to
MindSphere, collect data from the field and transfer it encrypted to MindSphere.

MindConnect Nano
MindConnect Nano is a preconfigured Industrial PC that allows connectivity to MindSphere. The
device supports the transmission of data encrypted through a secured Internet connection to
MindSphere. MindConnect Nano allows fast and easy IoT connectivity of machines and systems.
For more information refer to chapter Technical specifications of MindConnect Nano (Page 226).
The following graphic shows the MindConnect Nano:

Getting Connected to MindSphere

Getting Started, 08/2022 23
Overview of MindConnect Elements

MindConnect IoT2040
MindConnect IoT2040 has a compact design and can also be used for collecting and transferring
data to MindSphere in smaller production environments. The device supports the transmission
of encrypted data over a secured Internet connection to enable cloud-based applications and
services. For more information refer to chapter Technical specifications of MindConnect IoT2040
(Page 229). The following graphic shows the MindConnect IoT2040:

Getting Connected to MindSphere

24 Getting Started, 08/2022
 Overview of MindConnect Elements

MindConnect Software Agent

MindConnect Software Agent is a virtual representation of the MindConnect firmware which
can be installed on Windows 10 system which supports Hyper-V and also can be installed on
Linux systems which supports Docker. The following graphic shows the MindConnect Sofwatre
Agent:

Getting Connected to MindSphere

Getting Started, 08/2022 25
Overview of MindConnect Elements

Getting Connected to MindSphere

26 Getting Started, 08/2022
User roles and scopes in "Getting Connected to
MindSphere" 5
There are multiple roles that are available for MindConnect device controlling. A device can be
configured and can send the command to the device by an “Admin” user. If you want to ensure
that a user cannot configure but can send a command, then you can use “DeviceCommander”
role. If you want to ensure that a user can configure but cannot send a command, then you can
use “DeviceConfigurator” role.
The following table shows the list of MindConnect device roles and scopes:

User role Functionality or Scope

StandardUser (uipluginassetmanagermcna‐ This role grants the permission to visualize the MindCon‐
no:user) nect device plugin, but cannot change the device config‐
uration and cannot send commands to the device.
DeviceConfigurator (uipluginassetmana‐ This role grants the permission to visualize the MindCon‐
germcnano:deviceconfigurator) nect device plugin and update the device configuration,
but cannot send commands to the device.
DeviceCommander(uipluginassetmana‐ This role grants the permission to visualize the MindCon‐
germcnano:devicecommander) nect device plugin and can send the commands to the
device, but cannot update the device configuration.
Admin (uipluginassetmanagermcnano:ad‐ This role grants the permission to configure and com‐
min) mand the MindConnect device.

By default, these roles are not enabled on the tenant. To enable these roles you need to navigate
to the "Settings" app.
In "Settings" app, click on "Roles" tab and click to enable the new roles. For more information,
refer to the "Roles" chapter in the "Settings" documentation.

Note
In case of role change, you need to logout and login. It might take up to 15 minutes for the
current configuration to be effective depending on the system.

Getting Connected to MindSphere

Getting Started, 08/2022 27
User roles and scopes in "Getting Connected to MindSphere"

Getting Connected to MindSphere

28 Getting Started, 08/2022
Mounting and installing MindConnect Elements 6
6.1 Checking package upon delivery
1. When accepting a delivery, please check the package for visible transport damage.
2. If any transport damage is present at the time of delivery, submit a complaint at the shipping
company in charge. Have the shipper confirm the transport damage immediately.
3. Unpack the device at its installation location.
4. Keep the original packaging in case you have to transport the unit again.
Note
Damage to the device during transport and storage
If a device is transported or stored without packaging, shocks, vibrations, pressure and
moisture may impact the unprotected unit. Damaged packaging indicates that ambient
conditions may have already had a massive impact on the device.
The device may be damaged.
Do not dispose of the original packaging. Pack the device during transportation and
storage.

5. Check the content of the packaging and any accessories you may have ordered for
completeness and damage.

Getting Connected to MindSphere

Getting Started, 08/2022 29
Mounting and installing MindConnect Elements
6.2 Mounting MindConnect Nano

6. If the content of the package is incomplete, damaged or does not match your order, inform
the responsible delivery service immediately.

WARNING
Electric shock and fire hazard due to damaged device
A damaged device can be under hazardous voltage and trigger a fire in the machine or plant.
A damaged device has unpredictable properties and states.
Death or serious injury could occur.
Make sure that the damaged device is not inadvertently installed and put into operation.
Label the damaged device and keep it locked away. Return the device for immediate repair.

NOTICE
Damage from condensation
If the device is subjected to low temperatures or extreme fluctuations in temperature during
transportation, for example in cold weather, moisture could build up on or inside the HMI
device.
Moisture causes a short circuit in electrical circuits and damages the device. In order to
prevent damage to the device, proceed as follows:
• Store the device in a dry place.
• Bring the device to room temperature before starting it up.
• Do not expose the device to direct heat radiation from a heating device.
• If condensation develops, wait approximately 12 hours or until the device is completely
dry before switching it on.

7. Please keep the enclosed documentation in a safe place. It belongs to the device. You will
need the documentation when you commission the device for the first time.
8. Write down the identification data of the device.

Note
Mounting and installing process is applicable for MindConnect Nano and MindConnect IoT2040.

6.2 Mounting MindConnect Nano

Note
Security of MindConnect Elements
In order to ensure the security of your MindConnect Element, you should mount it in a restricted
access location e. g. lockable cabinet.
This reduces the possibility of manipulations on the device/customer data.

Getting Connected to MindSphere

30 Getting Started, 08/2022
 Mounting and installing MindConnect Elements
6.2 Mounting MindConnect Nano

6.2.1 Permitted mounting positions and surrounding temperature

The following mounting positions and surrounding conditional temperature are permitted:
• Horizontal mounting position: The horizontal mounting position is the preferred position.
Maximum surrounding temperature is 60°C.
• Vertical mounting position: Maximum surrounding temperature is 50°C.

Note
> 50 °C: Install in RAL
RAL = Restricted Access Location - e.g. a lockable cabinet

Free space around the device

Please make sure there’s enough empty space around the device
• Above the device: ≥ 50 mm
• Below the device: ≥ 100 mm

Note
Maximum height
The maximum altitude to install MindConnect Nano is 4000 m.

Getting Connected to MindSphere

Getting Started, 08/2022 31
Mounting and installing MindConnect Elements
6.3 Mounting MindConnect IoT2040

6.2.2 Connecting the protective earth


0

PPt

7

Figure 6-1 Connecting protective earth

6.3 Mounting MindConnect IoT2040

6.3.1 Permitted mounting positions and surrounding temperature

The following mounting positions and surrounding conditional temperature are permitted:
• Horizontal mounting position: The horizontal mounting position is the preferred position.
Maximum surrounding temperature is 50°C.
• Vertical mounting position: Maximum surrounding temperature is 50°C.

Note
> 50 °C: Install in RAL
RAL = Restricted Access Location - e.g. a lockable cabinet

Getting Connected to MindSphere

32 Getting Started, 08/2022
 Mounting and installing MindConnect Elements
6.3 Mounting MindConnect IoT2040

Free space around the device

Please make sure there’s enough space around the device
• Above the device: ≥ 50 mm
• Below the device: ≥ 50 mm

6.3.2 Mounting types

Note
Ensure that the mounting surface on the wall can bear four times the total weight of the device,
including attached elements.
Use only the anchors and screws specified in the operating instructions.

The following mounting types of the device are possible:

Mounting on rails

Figure 6-2 Mounting on rails

Getting Connected to MindSphere

Getting Started, 08/2022 33
Mounting and installing MindConnect Elements
6.4 LED lights of MindConnect Elements

Wall mounting

Figure 6-3 Wall mounting

6.4 LED lights of MindConnect Elements

6.4.1 LED lights of MindConnect Nano

LED lights
The LED lights status provide information on efficient self-diagnostics. The following graphics
show the LED lights of the MindConnect Nano:

Figure 6-4 LED lights - bottom view 1

Getting Connected to MindSphere

34 Getting Started, 08/2022
 Mounting and installing MindConnect Elements
6.4 LED lights of MindConnect Elements

Figure 6-5 LED lights - bottom view 2

The following table shows the meanings of the LED lights:

LED-Name Status Description

PC ON/WD GREEN Power on
ORANGE System restart
L1-RUN/STOP ORANGE • No connection to proxy·
• No connection to MindSphere
For explanation of possible problems and respective solution, please refer
to the chapter “Troubleshooting”.
Blinking ORANGE Connection to MindSphere is being established.
Blinking GREEN Onboarding is in progress.
GREEN MindConnect Nano is onboarded to MindSphere.
L2 - ERROR Blinking ORANGE Firmware update active.
ORANGE • No connection to the data sources
For explanation of possible problems and respective solution, please refer
to the chapter “Troubleshooting”.
Blinking RED • Data loss
For explanation of possible problems and respective solution, please refer
to the chapter “Troubleshooting”.
RED Firmware update error
L3 - MAINT Blinking ORANGE USB stick is active:
• Installing USB configuration
ORANGE Onboarding failed:
• Configuration file on the USB stick is not valid
Blinking RED • USB stick Error
For explanation of possible problems and respective solution, please refer
to the chapter “Troubleshooting”.

You can find more information about LED error codes in section Troubleshooting (Page 38).

6.4.2 LED lights of MindConnect IoT2040

LED lights
The LED lights provide information on the status of the device for efficient self-diagnostics.

Getting Connected to MindSphere

Getting Started, 08/2022 35
Mounting and installing MindConnect Elements
6.4 LED lights of MindConnect Elements

MindConnect IoT2040 features the following LED lights:

LED-Name Status Description

PWR GREEN Power on
SD GREEN Micro SD card active
USB GREEN USB Power (5V) is available
OC RED Overcurrent
USER GREEN/RED/ORANGE Programmed for MindSphere, see details below

The USER LED light is only programmed for MindSphere.

Figure 6-6 USER LED light

Getting Connected to MindSphere

36 Getting Started, 08/2022
 Mounting and installing MindConnect Elements
6.4 LED lights of MindConnect Elements

The following table describes the device behavior associated when a different USER LED status
is displayed

Name Status Description

USER LED Fast OR‐ USB STICK ACTIVE
ANGE Blink‐ • Network diagnostics are running
ing
• Configuration file is being read
USER LED RED Blinking USB STICK ERROR
• Read error, USB flash drive is damaged
• Configuration file is invalid (damaged, illegible or configured for a different asset)
• Write error, USB flash drive is write-protected or its memory is full.
For explanation of possible problems and respective solution, please refer to the chapter “Trou‐
bleshooting”.
ORANGE FIRMWARE UPDATE ACTIVE
Blinking
RED FIRMWARE UPDATE ERROR
For explanation of possible problems and respective solution, please refer to the chapter “Trou‐
bleshooting”
ORANGE NO CONNECTION TO PROXY
• Network cable is missing or damaged
• Ethernet port on MindConnect IoT2040 is damaged
• “ipconfig” of MindConnect IoT2040 is incorrect
• Firewall of MindConnect IoT2040 blocks
• Your company’s router is damaged
• Proxy is offline
• No authentication on Proxy
• Proxy configuration is invalid
ORANGE NO CONNECTION TO CLOUD
• Proxy is invalid
• Server is offline
• An addressed server cannot be accessed
• Network problems of a provider
• No authorization
ORANGE CONNECTION TO CLOUD ESTABLISHED
Blinking LED light flashes green for a short time to indicate the onboarding process - otherwise is orange
GREEN ONBOARDING IN PROGRESS
Blinking

Getting Connected to MindSphere

Getting Started, 08/2022 37
Mounting and installing MindConnect Elements
6.4 LED lights of MindConnect Elements

Name Status Description

USER LED ORANGE ONBOARDING FAILED
Flashing LED flashes red for a short time to indicate onboarding is falling
Possible reason:
• Server error
• OBT is no longer valid
For explanation of possible problems and respective solution, please refer to the chapter “Trou‐
bleshooting”.
GREEN ONBOARDED
ORANGE NO CONNECTION TO DATA SOURCE
• Problem with network connection of your machine
• Network cable is not plugged in or is damaged
• Machine is offline
RED Blinking MindConnect IoT2040 IS LOSING DATA
• MindConnect IoT2040 is offline and the data buffer is full
• Slow data transfer
For explanation of possible problems and respective solution, please refer to the chapter “Trou‐
bleshooting”.

You can find more information about LED error codes in section Troubleshooting (Page 38).

6.4.3 Troubleshooting

Error Problem Possible cause Possible remedy

MCN L1-RUN/STOP MindConnect Element can‐ Network connection problem: • Check your configuration
IoT2040 USER LED not onboard to MindSphere • Either IP address is not val‐ connection: If configured
ORANGE No Internet connection id or configured IP address IP and Proxy are valid
already exists in the net‐ • Check physical connec‐
work of MindConnect tion: your company’s rout‐
Nano er, Ethernet cables etc.
• Either disabled or invalid
configured Proxy
• Proxy is offline
• Interrupted connection
• IP address is configured
via DHCP, but there is no
internet connection.
• Firewall blocks MindCon‐
nect Elements
• Your company’s router is
damaged

Getting Connected to MindSphere

38 Getting Started, 08/2022
 Mounting and installing MindConnect Elements
6.4 LED lights of MindConnect Elements

Error Problem Possible cause Possible remedy

MCN L2 - ERROR LED Although an asset is onboar‐ No connection to data source Check the connection be‐
IoT2040 USER LED ded, no time series are uploa‐ tween MindConnect Nano
ded to Fleet Manager and Vis‐ and data sources (Plant Net‐
ORANGE
ual Analyzer. work ports and cables - S7/
OPC UA Server)
The address of the data point • Check the connection be‐
configuration can be incorrect tween MindConnect
Nano and data sources
(Plant Network ports and
cables - S7/OPC UA server)
• Check data sources config‐
uration.
• Check configuration of
each data point.
MindConnect Nano/IoT2040 • Incorrect asset configura‐ Check configuration of your
cannot onboard to Mind‐ tion asset (Network Configura‐
Sphere tion).
• Not accomplished asset
configuration (Network
Connection)
Invalid ID of MindConnect Check if MindConnect Nano
Nano ID is correct.
MCN L2- ERROR LED Data loss MindConnect Nano/IoT2040 • Check outbound connec‐
blinking RED was too long offline, so it tion
could not send data to Mind‐
IoT2040 USER LED • Check Ethernet cables
Sphere and the storage is full.
blinking RED • Check Proxy (IP address,
User Authentication can
be required)
MCN L2- ERROR LED Firmware update error • Technical problems with a • Make sure that you are us‐
RED new version of firmware ing the correct firmware
IoT2040 USER LED • Incorrect firmware type type (MindConnect Nano/
IoT2040).
• Certificate problems, Au‐
thentication problems etc. • MindConnect Nano/
IoT2040 will automatical‐
ly restart and then firm‐
ware update will be car‐
ried out after a while.
• If MindConnect Nano/
IoT2040 does not restart
automatically, then re‐
start it manually: by
switching on and off the
“power button” on Mind‐
Connect Nano and by
switching off/on the pow‐
er supply for MindCon‐
nect IoT2040.

Getting Connected to MindSphere

Getting Started, 08/2022 39
Mounting and installing MindConnect Elements
6.4 LED lights of MindConnect Elements

Error Problem Possible cause Possible remedy

MCN L3- MAINT LED Onboarding failed • Configuration file on the • Make sure that the data
ORANGE USB stick is invalid on the USB stick still is val‐
IoT2040 USER LED • Internal error id. (The data, which you
exported to the USB stick,
blinking
is still valid only for 7
days.). If it is expired, use
the asset configuration to
export a new valid config‐
uration to your USB stick.
• Check asset configuration
and reconfigure, if it is re‐
quired and export a new
configuration to USB stick

Getting Connected to MindSphere

40 Getting Started, 08/2022
 Mounting and installing MindConnect Elements
6.5 USB commands

Error Problem Possible cause Possible remedy

MCN L3-MAINT LED Problems with USB stick • Incorrect formatting of • Check format and parti‐
blinking RED USB stick (no FAT or tion of the USB stick. It
IoT2040 USER LED FAT32) must be FAT or FAT32 for‐
• USB stick is damaged matted and may only con‐
blinking
tain a single partition.
• Write error, USB stick is
write-protected or its • Try a new USB stick
memory is full.
• Configuration file is inva‐
lid (damaged, illegible)
• See also below
Although no LED lights are Problems with USB stick: • Remove and plug an USB
shown (except PC ON/WD • Configuration file in USB stick into MindConnect
with constant GREEN) and in‐ Nano
stick cannot be read or ac‐
ternet connection is OK,
cepted by MindConnect • Check the diagnosis file on
MindConnect Nano still can‐
Nano: the USB stick.
not be onboarded to Mind‐
Sphere • Problems with configura‐ • Check the name of the
tion file configuration file. It must
• Configuration file is loca‐ have MindConnect Nano
ted in an incorrect directo‐ ID. Do not change the
ry. name of the downloaded
file.
• Expired configuration file
on the USB stick • Check whether the direc‐
tory is valid. (Configura‐
• The configuration file is in‐
tion file must be in the
valid or not copied to the
root directory of the USB
USB stick
stick.)
• Make sure that the data
on the USB stick is still val‐
id. (The data, which you
exported to the USB stick,
is still valid only for 7
days.) If it is expired, use
the asset configuration to
export a new valid config‐
uration to your USB stick.
System Error Unknown • Switch MindConnect
Nano off and on again.
• If the problem persists,
contact your Siemens Sup‐
port/„Expert Center“.

6.5 USB commands

You can run diagnostic and maintenance USB commands on your MindConnect Element.
The following lists various USB commands and the respective JSON format:

Getting Connected to MindSphere

Getting Started, 08/2022 41
Mounting and installing MindConnect Elements
6.5 USB commands

Prerequisites
• A MindConnect device e.g. MindConnect Nano or MindConnect IoT2040
• A fat32 formatted USB stick

Procedure
To use a USB command, proceed as follows:
1. Make sure your USB stick is fat32 formatted.
2. Create a file named “ConBox_Commands.json” directly on the USB stick.
3. Open the “ConBox_Commands.json” file in a text editor.
4. Enter one of the "JSON Code" commands that you want to execute.
5. Save the changes to the "ConBox_Commands.json".
6. Plug the USB STick into the MindConnect device.
The LEDs should directly indicate that it is reading the USB. You can find more information in
the LED lights of MindConnect Elements (Page 34) chapter.

The following list shows various USB commands:

Copy extended logs to USB stick

The following command will collect all agent logs & system files, put them into
ConBox_<UID>_Logs.tar.gz and ConBox_<UID>_SystemFiles.tar.gz files and copy them to the
USB stick.
JSON Code:
{
"Commands": [
{
"Cmd":"CopySystemFilesToUsbStick",
"TypeOfFiles": "AllSystemFiles"
},
{
"Cmd":"CopyAgentLogsToUsbStick"
}
]
}

Getting Connected to MindSphere

42 Getting Started, 08/2022
 Mounting and installing MindConnect Elements
6.5 USB commands

Note
For the MindConnect IoT2040 it can take up to 15 minutes to collect all files.

Copy archived logs to USB stick

Some Logs arrive every day at approx. 0 UTC. The extended logs therefore only contain the data
of the current day. To get those logs for past days you need to run this command.
The following command will copy all archived log files to a sub directory on the USB stick and
delete the copied log files from the archive folder optionally. The USB stick should be larger than
200 MB.
Sub directories on the USB stick will have following structure: ConBox_<BOX ID>/
<CurrentTime>Sample:ConBox_J47110815/20180318T191647
JSON Code:
{
"Commands": [
{
"Cmd":"CopyArchivedLogsToUsbStick",
"DeleteAfterCopy":"false"
}
]
}

Note
To store the file locally, disable the log file upload.

Change system time

For the case that the system time should have been changed so that agent runtime is no longer
able to connect to MindSphere, you can retrieve the backend time to correct the system time.
The following command provides the possibility to change the system time manually
via ConBox_Commands.json file on the USB stick.
JSON Code:
{
"Commands": [
{
"Cmd": "SetSystemTime",

Getting Connected to MindSphere

Getting Started, 08/2022 43
Mounting and installing MindConnect Elements
6.5 USB commands

"NewTime": "2017-09-19T12:34:56"
}
]
}

Note
You have to set to the current UTC (Coordinated Universal Time) time.

Change log file upload configuration

You can activate or deactivate the upload of log files via the ConBox_Commands.json file with
the ChangeLogFileUploadConfiguration command on a USB stick. This reduces the amount of
data that is stored for a tenant on the backend side and reduces the mobile data costs for
uploading data to MindSphere.
If log file upload is disabled, the log files are saved locally. This local space is limited (200 MB). The
files are written and after reaching this limit the oldest files are overwritten.
After the log file upload has been reactivated, previously saved MERS log files are uploaded to
MindSphere (max. 200 MB).
JSON Code:
{
"Commands": [
{
"Cmd": "ChangeLogFileUploadConfiguration",
"EnableUpload": "true"
}
]
}
You can set the following command parameters:

Parameter Description
EnableUpload true: enable log file upload
false: disable log file upload

Note
Changing log upload by USB command will not be synchronized with the asset’s device
configuration on MindSphere side.

Perform factory reset

For factory reset a ConBox_Commands.json file can be provided by using the USB stick.

Getting Connected to MindSphere

44 Getting Started, 08/2022
 Mounting and installing MindConnect Elements
6.5 USB commands

The network and BoxMgr settings will be reset to their initial state on MindConnect Nano/
IoT2040. All BoxMgr and MERS logging files and temporary files will be then deleted. At the end
the MindConnect device will be restarted automatically.

Note
Offboard the asset and device before factory reset execution and perform the factory reset. After
the execution, the asset and device should be onboarded again.

The factory reset command will be available on MindConnect Nano/IoT2040 version

03.01.00.00 b00x or later.
JSON Code:
{
"Commands": [
{
"Cmd": "DoFactoryReset",
"DeviceID": "_MindConnect_ID_"
}
]
}

Note
The Unique ID has to be replaced with the serial number of the device

You can find more information on how to set a MindConnect Element to factory settings in
chapter Manual firmware update of MindConnect Element (Page 203)

Restricted device configuration

The RestrictDeviceConfiguration command allows you to enable or disable online device
configuration changes via MindSphere user interface after the MindConnect device has been
successfully onboarded.
If you need to adapt the configuration, you have to create a new onboarding file with new e.g.
network parameter and insert this data again via USB.

Note
Make sure that all parameters are valid before exporting the configuration file to prevent
unwanted changes that can lead to invalid network settings, for example.

Getting Connected to MindSphere

Getting Started, 08/2022 45
Mounting and installing MindConnect Elements
6.5 USB commands

Note
Effects on online device configuration
There is no indication in the MindSphere asset configuration user interface that the device
configuration has been restricted on MindConnect Nano/IoT2040 device.
If you try to change restricted device settings online, a message is logged in the diagnostic file
on the MindConnect Nano / IoT2040 device that this setting could not be applied.

JSON Code:
{
"Commands": [
{ "Cmd":"RestrictDeviceConfiguration",
"networkInterfaces": [
{
"name": "WebInterface",
"DHCP": "true",
"IPv4": "true",
"SubnetMask": "true",
"Gateway": "true",
"DNS": "true"
},
{
"name": "ProductionInterface",
"DHCP": "true",
"IPv4": "true",
"SubnetMask": "true",
"Gateway": "true",
"DNS": "true"
}
]
}
]
}

Getting Connected to MindSphere

46 Getting Started, 08/2022
 Mounting and installing MindConnect Elements
6.5 USB commands

To prevent changes of network interface settings, the following parameters can be specified in
the JSON command:

Parameter Description
name Name of the network interface.
Possible values:
• WebInterface
• ProductionInterface
DHCP • true: DHCP setting can not be changed
• false: DHCP setting can be changed (default)
IPv4 • true: IP address can not be changed
• false: IP address can be changed (default)
SubnetMask • true: Subnet mask can not be changed
• false: Subnet mask can be changed (default)
Gateway • true: Gateway address can not be changed
• false: Gateway address can be changed (default)
DNS • true: DNS address can not be changed
• false: DNS address can be changed (default)

Note
• If you only provide some of the above mentioned parameters, then the omitted parameters
will be ignored. This means that either the last restricted device configuration of these
parameters will be used, or they will be treated as not set.
• To enable device configuration changes of specific parameters again, a JSON command
containing those parameters with value "false" can be provided via USB stick.
• To turn it off a new JSON command file needs to be provided with "false" for all parameters.

Check network

Command description
To find out, if the MindConnect device is successfully connected to MindSphere using the current
onboarding configuration, a ConBox_Commands.json file containing "CheckNetwork"
command on an USB stick can be used. After the network analysis has been performed, the
analysis result will be written to the USB stick.
Depending on the current network situation, it might be possible that the execution of all
internally executed tests will take some minutes.

Note
This command is available from the version MindConnect Nano/IoT2040 firmware V03.04.02.10
b003.

Getting Connected to MindSphere

Getting Started, 08/2022 47
Mounting and installing MindConnect Elements
6.5 USB commands

CheckNetwork command
Using following JSON command in a ConBox_Commands.json file, a network analysis will be
performed and the result will be written to the USB stick:
{
"Commands": [
{
"Cmd": "CheckNetwork",
"NetworkChecks": [
{
"CheckCloudConnection": "true"
}
]
}
]
}

Parameter Description
CheckCloudConnection • true: Cloud connection check will be executed.
• false: Cloud connection check will not be exe‐
cuted.
NetworkChecks • List of checks that have to be executed.
• Currently CheckCloudConnection check is avail‐
able only.

Result of CheckCloudConnection file

After the CheckCloudConnection network check has been executed, a result file will be copied
to the USB stick.
The name of the result file has the following format:
• ConBox_<serial number>_<time stamp>_CloudConnectionCheck.log

Getting Connected to MindSphere

48 Getting Started, 08/2022
 Mounting and installing MindConnect Elements
6.5 USB commands

The result file contains following sections:

• Test output
– Contains detailed information about the executed test steps according to the current
network configuration of the MindConnect device.
• Test summary
– Contains following information.
– Start and end time of the test.
– Current IP addresses of web and production interfaces.
– Result of trying to connect to MindSphere directly without proxy.
– Result of trying to connect to MindSphere via proxy server, if a proxy server had been
configured.
– Information about the current proxy configuration.

Getting Connected to MindSphere

Getting Started, 08/2022 49
Mounting and installing MindConnect Elements
6.5 USB commands

Getting Connected to MindSphere

50 Getting Started, 08/2022
Connecting MindConnect Elements 7
This chapter shows you how to connect MindConnect Elements to the power supply and to the
Internet (for MindSphere).

7.1 Commissioning MindConnect Element

This section describes about commissioning MindConnect Nano and MindConnect IoT2040.

Objective
The MindConnect Elements should be connected to the power supply and commissioned.

Requirements
• The protective conductor is connected (valid only for MindConnect Nano). Refer to the
chapter Connecting the protective earth (Page 32).
• A two-core cable with a cable cross-section of 0.75 mm² to 2.5 mm².
• A slotted screwdriver with a 3 mm blade.

NOTICE
Power supply requirements
MindConnect Nano should only be connected to a 24 V DC to power supply which satisfies the
requirements of safety extra low voltage (SELV) according to IEC/EN/DIN EN/UL 60950-1.
MindConnect IoT2040 should only be connected to a 9...36 V DC power supply which meets
the requirements of safe extra low voltage (SELV) according to IEC/EN/DIN EN/UL 60950-1.
The power supply must meet the NEC class 2 or LPS requirement in accordance with IEC/EN/DIN
EN/UL 60950-1.

Note
The MindConnect Nano/IoT2040 package does not include power supply. The appropriate
power supply product from Siemens with the name SITOP can be used.

Getting Connected to MindSphere

Getting Started, 08/2022 51
Connecting MindConnect Elements
7.1 Commissioning MindConnect Element

Procedure

CAUTION
Danger of burns
The surface of the device can reach temperatures of over 70 °C. Any unprotected contact may
cause burns.
Avoid direct contact during operation of the device. Touch the device only with appropriate
protective gloves.

1. Switch off the power supply on the device.

2. Connect the cores of the power supply.

Getting Connected to MindSphere

52 Getting Started, 08/2022
 Connecting MindConnect Elements
7.1 Commissioning MindConnect Element

3. Insert the terminal at the indicated position.

– The graphic shows how to connect the power supply for MindConnect Nano:

Figure 7-1 Connecting the power supply for MindConnect Nano

Getting Connected to MindSphere

Getting Started, 08/2022 53
Connecting MindConnect Elements
7.1 Commissioning MindConnect Element

– The graphic demonstrates the steps how to connect the power supply for MindConnect
IoT2040:

Figure 7-2 Connecting the power supply for MindConnect IoT2040

4. Power on the power supply.

– For MindConnect Nano, set the on/off switch to position "I" (ON). The "PC ON/WD" LED
lights up green.

Getting Connected to MindSphere

54 Getting Started, 08/2022
 Connecting MindConnect Elements
7.2 Firewall/Proxy rules for MindSphere

– For MindConnect IoT2040, switch on the power supply. The graphic shows the “PWR” LED
lights up green.

3:5

Figure 7-3 Power on a power supply for MindConnect IoT2040

Result
MindConnect Nano/IoT2040 is now prepared and you can onboard it to MindSphere.
If the green light does not appear, refer to section Troubleshooting (Page 38) for more
information about LED messages.

7.2 Firewall/Proxy rules for MindSphere

MindConnect Element require open HTTPS and DNS ports for communication with MindSphere.
You can open port 443 to enable this.
MindConnect Element will connect to the following DNS names:
<region>.mindsphere.io
For <region> enter the area that was defined in your contract, example "*.eu1".
Mindsphere uses modern cloud principles (such as content delivery networks) to achieve high
availability/scalability. The above mentioned DNS names can be resolved to a large range of IP
addresses based on the context of the caller and the state of the backend.

Getting Connected to MindSphere

Getting Started, 08/2022 55
Connecting MindConnect Elements
7.3 Connecting MindConnect Nano to MindSphere network

If you are trying to login from the firewall backend, you need *.eu1.mindsphere.io and in
addition a MindSphere Interactive Login Page URL is required, example
"diswlogin.siemens.com". The below given links are the examples for interactive logins in the
browser for agents or application starting with *.eu1.mindsphere.io:
• https://*.industrysoftware.automation.siemens.com
• https://identity.industrysoftware.automation.siemens.com
• https://www2.industrysoftware.automation.siemens.com
• https://content.industrysoftware.automation.siemens.com
• https://identityapi.industrysoftware.automation.siemens.com
• https://ws-apip.industrysoftware.automation.siemens.com
• https://cdn.auth0.com
• https://diswlogin.siemens.com
• https://static.mentor-cdn.com
To communicate agent only, you will only need the “southgate.eu1.mindsphere.io.

Port exceptions
For region eu2, please add the following port exception to enable the online firmware download:
• https://resources.edge-prod.eu2.mindsphere.io/

7.3 Connecting MindConnect Nano to MindSphere network

The following options are available for integrating the device in existing or planned system
environments and networks.

  

① X63 port
② PN/IE LAN X1 P1 port
③ PN/IE LAN X2 P1 port
Figure 7-4 Connections of MindConnect Nano

Getting Connected to MindSphere

56 Getting Started, 08/2022
 Connecting MindConnect Elements
7.3 Connecting MindConnect Nano to MindSphere network

Note
The two network adapters are separated from each other. There is no direct connection between
the two networks possible to ensure network security. Therefore, you can not create any
configuration from the cloud to the field level (e.g. OPC UA server).

The following table explains each connection port in detail:

Port Description
X63 USB 2.0 port, high current. Configuration file on USB stick.
Required during onboarding process.
PN/IE LAN X1 P1 RJ45 Ethernet connection 1 for 10/100/1000 Mbps. Access to the Internet (to MindSphere).
Required to start onboarding process.
PN/IE LAN X2 P1 RJ45 Ethernet connection 2 for 10/100/1000 Mbps. Access to the plant network or asset (e.g. S7, OPC
UA).
Required to complete onboarding process.

Prerequisite
For 250 datapoints read per second, the upload bandwidth should be at least 0.5 Mb/s.

Procedure
Before you start onboarding, connect MindConnect Nano to MindSphere, as follows:
Insert Ethernet cable into the port labeled with X1 P1 to connect MindConnect Nano to
MindSphere.

Note
MindConnect Nano MAC address
The type plate on of the MindConnect Nano shows 2 MAC addresses. The first MAC address
belongs to port X1 P1.

Getting Connected to MindSphere

Getting Started, 08/2022 57
Connecting MindConnect Elements
7.3 Connecting MindConnect Nano to MindSphere network

Figure 7-5 Connecting the port X1 P1 for Internet (MindSphere)

Getting Connected to MindSphere

58 Getting Started, 08/2022
 Connecting MindConnect Elements
7.4 Connecting MindConnect IoT2040 to MindSphere network

7.4 Connecting MindConnect IoT2040 to MindSphere network

The following options are available for integrating the device in existing or planned system
environments and networks.

  

① X60 port
② PN/IE LAN X1 P1 port
③ PN/IE LAN X2 P1 port
Figure 7-6 Interfaces of MindConnect IoT2040

The following table explains each connection port in detail:

Port Description
X60 USB 2.0 port, high current. Configuration file on USB stick.
Required during onboarding process.
PN/IE LAN X1 P1 RJ45 Ethernet connection 1 for 10/100/1000 Mbps. Access to the Internet (to MindSphere).
Required to start onboarding process
PN/IE LAN X2 P1 RJ45 Ethernet connection 2 for 10/100/1000 Mbps. Access to the plant network (e.g. S7, OPC UA).
Required to complete onboarding process.

Procedure
Before you start onboarding, connect MindConnect IoT2040 to MindSphere, as follows:
Insert Ethernet cable for Internet into the port labeled with X1 P1.

Getting Connected to MindSphere

Getting Started, 08/2022 59
Connecting MindConnect Elements
7.5 Connecting Port X2 P1 for MindConnect Element

Figure 7-7 Connecting the port X1P1 for internet (MindSphere)

Note
During the onboarding process, only one USB stick is supported. Do not plug in more than one
USB stick. The recommended USB port is the USB port with label X60.

7.5 Connecting Port X2 P1 for MindConnect Element

Objective
The MindConnect Element can now be connected to the plant network or asset.

Requirements
• An asset has been created in Asset Manager.
• The configuration has been transferred via USB stick to the MindConnect Element.

Procedure
To connect the MindConnect Element to your plant network or asset, insert the Ethernet cable
into the port labeled with X2 P1.

Getting Connected to MindSphere

60 Getting Started, 08/2022
 Connecting MindConnect Elements
7.6 MindConnect network plan

The following graphic shows the connecting port of the MindConnect Nano:

Figure 7-8 Connecting Ethernet Port X2 P1 MindConnect Nano

The following graphic shows the connecting port of the MindConnect IoT2040:

Figure 7-9 Connecting Ethernet Port X2 P1 MindConnect IoT2040

7.6 MindConnect network plan

You can set up the network plan for your MindConnect Elements in two ways. The following
scenarios show them with IP address examples:

Note
In both scenarios it is important that you set X1 and X2 in different (and not overlapping)
subnets.

Getting Connected to MindSphere

Getting Started, 08/2022 61
Connecting MindConnect Elements
7.6 MindConnect network plan

Scenario A
The following scenario shows a setup example where each network-port of the MindConnect is
connected to another switch or router.

MindConnect ; ;
Elements

'DWDVRXUFH

Internet Switch / Router Switch

The following table shows possible setups:

Port Exemplary configuration

X1 • IP address: 192.168.1.10
• Mask: 255.255.255.0
X2 • IP address: 192.168.3.110
• Mask: 255.255.255.0
Data source • IP address: 192.168.3.120
• Mask: 255.255.255.0

Note
• Make sure that X1 is in another and not overlapping subnet then X2.
• If you have a DHCP master in both network, you can use DHCP in both. In this case, make sure
that the DHCP masters are set up so that X1 and X2 are in another subnet.

Getting Connected to MindSphere

62 Getting Started, 08/2022
 Connecting MindConnect Elements
7.6 MindConnect network plan

Scenario B
This following scenario shows a setup example where both network-ports of the MindConnect,
are connected to the same switch or router.

MindConnect Element ; ;

'DWDVRXUFH

Internet Switch / Router

The following table shows possible configuration setups:

Port Exemplary configuration

X1 • IP address: 192.168.1.10
• Mask: 255.255.255.0
X2 • IP address: 192.168.3.110
• Mask: 255.255.255.0
Data source • IP address: 192.168.3.120
• Mask: 255.255.255.0

Note
• Make sure that X1 is in another and not overlapping subnet then X2.
• You can only use DHCP for one port or subnet. The other has to be set up as static IP address.
In this case, make sure that the DHCP master is set up so that X1 and X2 are in another subnet.

Getting Connected to MindSphere

Getting Started, 08/2022 63
Connecting MindConnect Elements
7.6 MindConnect network plan

Getting Connected to MindSphere

64 Getting Started, 08/2022
Onboarding MindConnect Elements 8
8.1 Overview of onboarding MindConnect Element
This chapter describes the initial configuration of an asset and MindConnect Nano/IoT2040 in
order to onboard MindConnect Nano/IoT2040 to MindSphere. Onboarding is the process of
attaching a MindConnect Element to MindSphere. And also, it describes the process of
connecting industrial data sources to MindSphere using MindConnect Software Agent.
To establish the initial connection between MindConnect Nano/IoT2040 and MindSphere
(onboarding), you have to configure the essential asset and MindConnect Nano/IoT2040 data.
For onboarding the full configuration is not required, although you can accomplish all steps
using Asset Manager.
The respective data to be configured for onboarding is described in the following procedure.

Requirements
• MindConnect Elements is connected to the Internet and powered on.
• The connection cable for the Internet is correctly plugged into the Ethernet port for the
Internet (MindSphere).
• MindConnect Elements is connected to asset or plant network.
• You have received the link to the MindSphere UI with credentials (user and password data).
• A customer account is created.
• A standard USB device with a single partition in FAT or FAT32 is formatted for MindConnect
Nano/IoT2040 only.
• You have the role "mdsp:core:TenantAdmin". The user roles are set in Settings.
• MindConnect Software Agent is installed on Windows 10 system which supports Hyper-V.

Note
Prepare MindConnect Elements
To prepare your MindConnect Element for MindSphere V3, you have to update the firmware for
boxes that were already connected to MindSphere V2 (SAP). For devices connecting to
MindSphere region China 1, the MindConnect Nano or IoT2040 firmware should be V3.3.0.4 or
higher.
You can find more information in chapter Manual firmware update of MindConnect Element
(Page 203).

Getting Connected to MindSphere

Getting Started, 08/2022 65
Onboarding MindConnect Elements
8.2 Logging in to MindSphere

Onboarding Procedure
In order to onboard MindConnect Nano/IoT2040, you must perform the following steps:
1. Login to MindSphere. (Page 66)
2. Create an asset in Asset Manager. (Page 67)
3. Enable connection to MindConnect Element in Asset Manager. (Page 68)
4. Configuring network settings (Page 70)
5. Transfer configuration to MindConnect Element (Page 75).

8.2 Logging in to MindSphere

To log in to MindSphere, proceed as follows:
1. Click the link provided via mail by the Siemens AG.
– The MindSphere landing page for login will appear.
2. Log in to MindSphere using the configured Authentication Provider (WebKey by default).
– You will be redirected to your personal MindSphere Launchpad.
– Depending on your offering the Launchpad Icons will be displayed.

Note
MindSphere supports English, German and Chinese languages. Therefore it is recommended to
set the browser default to English, if you use a different language.

Getting Connected to MindSphere

66 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.3 Creating an asset

8.3 Creating an asset

To connect your MindConnect Element in Asset Manager, you need to create an asset. This
process is the same for different types of MindConnect Elements that includes the Physical Asset
type, and the Virtual Asset type.
For information on creating a Virtual Asset type, refer "Creating a type in Asset Manager
(Page 130)".

Procedure
To create an asset proceed as follows:
1. Select Asset Manager from the Launchpad.
2. Click "Assets" in the navigation area.
3. To create a new asset click .
The asset type overview window is opened.

4. Select the respective asset type for your MindConnect Element, e. g. MindConnect Nano.
5. Enter a name and the data for the asset, e. g. "Wind turbine"
6. Confirm the entries with "Save".

Getting Connected to MindSphere

Getting Started, 08/2022 67
Onboarding MindConnect Elements
8.4 Enable connection to MindConnect Element

Result
The new asset is available at the asset list.
The following graphic shows the created asset:

8.4 Enable connection to MindConnect Element

To use a MindConnect Element with MindSphere you have to enable the connection. Within
enabling the connection you can assign a MindConnect Element to an asset.

Getting Connected to MindSphere

68 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.4 Enable connection to MindConnect Element

Procedure
To enable the connection to the MindConnect Element proceed as follows:
1. Select the asset in the "Asset" tab.
2. In the "Connectivity" area click on the MindConnect Element plugin icon, e. g. "MindConnect
Nano".
The "Create MindConnect" screen appears.

3. Enter the unique ID from your hardware.

Result
You have enabled the connection to the MindConnect Element.

Getting Connected to MindSphere

Getting Started, 08/2022 69
Onboarding MindConnect Elements
8.5 Configuring network and diagnostic settings

8.5 Configuring network and diagnostic settings

8.5.1 Configuring network settings

Network configuration of MindConnect Nano/IoT2040 requires information on the ethernet
interfaces for data acquisition (ethernet labeled with X2P1) and MindSphere (ethernet labeled
with X1P1). If your company uses a proxy server, it must also be configured to connect
MindConnect Nano/IoT2040 to MindSphere.
It is also possible to do routing between the networks by creating a routing table for up to 20
gateways. The routing table provides access to other devices in different subnets.
Contact your IT administrator for details on your local network settings.
After enabling the connection to the MindConnect Element you can edit the network
configuration. You can enter either a static IP address or use DHCP. The last option is possible, if
there is a DHCP server available in your company network.

Procedure
To configure the network setting, follow these steps:
1. Select the asset in the "Asset" tab.
2. Click on the asset icon, e. g. "MindConnect Nano".

Getting Connected to MindSphere

70 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.5 Configuring network and diagnostic settings

3. Click next to "Status" on the button .

The following graphic shows the "Edit MindConnect" screen:

Getting Connected to MindSphere

Getting Started, 08/2022 71
Onboarding MindConnect Elements
8.5 Configuring network and diagnostic settings

4. Activate DHCP, if a DHCP server is available in your company network or enter the respective
information for static IP address.
The following graphic shows the IP address input fields:

5. Enter the proxy data area "Communication Settings" if necessary and click "Save".
– In this case, contact your network administrator to get the proxy data. For Proxy IP address
input field, it is also possible to define the port number e.g. 127.0.0.1:8080.
– For proxy authentication type NTLM: The domain and the username have to be provided
as "username@domain" or as "domain/username".

Note
If nothing else is configured manually, MindConnect Nano/IoT2040 will try to obtain IP
addresses for both adapters via DHCP.

6. Enter the available router gateways used in your company network.

Note
• Router gateways can only be added after firmware installation.

7. Click on "Save", to complete the configuration.

Getting Connected to MindSphere

72 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.5 Configuring network and diagnostic settings

8.5.2 Configuring diagnostic settings

Buffer Mechanism
In buffer mechanism, there are two options:
• Default Buffer Mechanism: It provides parallel upload from cache and real time data. It
prioritises newest data to old data while storing (works as a last in, first out (LIFO))
• Chronological Buffer Mechanism: It is chronological upload of data. If "Chronologic Upload"
is selected, the buffer mechanism will prioritise oldest data to new data (works as first in,
first out (FIFO)).
You can configure the buffer behavior from "Network and Diagnostic Settings" screen.

Note
• If the buffer behavior is changed, it will restart the data collection process and this process
will take few minutes.
• Buffer mechanism restricted to MindConnect Nano and IoT 2040.

Note
Data loss
The data collection will be stopped during the time of buffer behavior change. The amount of
data collection is stopped for few minutes, it depends on restart of the device. It may take longer
time on slow devices like, IoT2040.

To perform a buffer behavior change proceed as follows:

1. In "Asset" tab, select the asset.
2. Open "MindConnect" plugin.
3. Click , next to "Onboarding Status".
4. In "Buffer Behavior" section, select "Chronological Upload".
5. Click “Save”.

Getting Connected to MindSphere

Getting Started, 08/2022 73
Onboarding MindConnect Elements
8.5 Configuring network and diagnostic settings

Note
Chronologic Upload Specification
• If there is a bad network connection or no connection at all, the data is going to be stored in
cache memory. In "Chronologic Upload", overwritten of cache memory is not possible. Only
if there is any space on cache memory, the data is going to be written to it. If the cache
memory reaches out it's limit and filled with data, then the data is not going to be saved on
cache memory. It will cause data loss until some data is uploaded.
• As chronological upload the flow of real data to cloud will take longer time comparing to
default behavior.
• The events are not cached in any case of the disconnection. Therefore, "Chronologic Upload"
is not applicable for the event upload.

Diagnostic Settings
This section contains the configurations related with logging. To perform a diagnostic settings
change, follow these steps:
1. In "Asset" tab, select the asset.
2. Open MindConnect plugin.
3. Click , next to "Onboarding Status".
4. In “Diagnostic Settings” section, make the changes in Auto Log Upload or Log Level.

5. Click “Save”.

Auto Log Upload

If Auto Log Upload is enabled, the device is going to upload all generated logs to MindSphere
periodically.
Log upload functionality for the device is enabled by default.

Note
If Auto Log Upload is disabled, MindConnect device stops logging and uploading log files.
However, there are some third party applications that keep logging on device. These logs will be
uploaded when Auto Log Upload is enabled again.

Log Levels
Log level represents the log level of MindConnect device. There are five possible log levels, and
the hierarchy is as follows in lowest (TRACE) to highest (ERROR) priority. In “TRACE” mode, the
device will log extensively and in “ERROR” mode device will only log error messages.

Getting Connected to MindSphere

74 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.6 Transferring configuration to MindConnect Elements Mindconnect Nano and Mindconnect IoT2040

The selected log level and logging mechanism works as logging only selected level and the
higher levels.
Log level is set to “INFO” by default.

Note
Auto Log Level Change
• “TRACE/DEBUG” log levels provide more verbose logs which will be helpful to troubleshoot
issues, however they produce more files. If the log level is set to “TRACE/DEBUG”. It will be
automatically changed to INFO after one day.
• Auto log level change operation will not be synchronized with the asset’s device
configuration.

8.6 Transferring configuration to MindConnect Elements

Mindconnect Nano and Mindconnect IoT2040

Requirement
• A standard USB device with a single partition in FAT or FAT32 is formatted.
• You have enabled the connection to the MindConnect Element.
• You have configured the network settings.

Procedure

WARNING
USB stick information
The configuration created in this step includes security relevant information. You can encrypt
and sign the information. Take care of the USB stick and the information flow from MindSphere
to USB stick and from USB stick to the MindConnect Element. Delete the USB stick after use.

Getting Connected to MindSphere

Getting Started, 08/2022 75
Onboarding MindConnect Elements
8.6 Transferring configuration to MindConnect Elements Mindconnect Nano and Mindconnect IoT2040

To export the configuration, follow these steps:

1. In the MindConnect settings click .
The following graphic shows the "Edit MindConnect" screen:

2. In order to encrypt the onboarding key data, activate the "Encrypted" checkbox.
3. Click on "Download Onboarding Key".
4. Save the downloaded file to the root directory of your USB stick.

Getting Connected to MindSphere

76 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

5. Insert the USB stick into the USB port of the MindConnect Element, e. g. "MindConnect Nano"
Note
During the import of the configuration, the following LED-states are to be expected:
1. MAINT LED flashes orange
2. RUN LED blinks green
3. On-boarding result
– RUN LED green: MindConnect onboarded successfully
– MAINT LED orange: onboarding failed
The process can take up to 30 minutes. Please do not remove the USB stick during this time.

6. After successfully importing the configuration, remove the USB stick from the MindConnect
Element.
7. Check the status of the MindConnect Element at the Overview.

Result
The connection status in Asset Manager at the overview has changed to "Onboarded". The
configuration of the asset has been transferred to the MindConnect Element. The connection
between the MindConnect Element and MindSphere is established.
Once MindConnect Nano/IoT2040 is onboarded, the connection to your asset is permanent and
your asset for data collection can be configured. This requires configuration of machine data to
be monitored. Any additional configuration (except network configuration) of the connected
asset will automatically be synchronized with your onboarded MindConnect Nano/IoT2040.
The connection to the asset is permanent and can only be cancelled by offboarding. For this
purpose, refer to the Asset Manager documentation.

8.7 Using MindConnect Software Agent to connect industrial data

sources to MindSphere

8.7.1 Overview of MindConnect Software Agent

MindConnect Software Agent is a virtual representation of the MindConnect firmware which
can be installed on Windows 10 system which supports Hyper-V and also can be installed on
Linux systems which supports Docker.

Note
The online and offline firmware updates from V3.5 to V3.6 for MindConnect Software Agent are
not supported. To update the firmware, you need to uninstall MindConnect Software Agent V3.5
current version and install MindConnect Software Agent V3.6 latest version manually using
MindConnect Software Agent InstallShield setup.

Getting Connected to MindSphere

Getting Started, 08/2022 77
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Prerequisites
The following prerequisites apply to install MindConnect Software Agent on a Windows PC or IPC
and Docker in Linux:

Operating system Windows Linux

Supported versions Windows 10 with Hyper-V support (e.g. Linux (Debian 10.8 (buster))
Windows 10 Professional or Enterprise)
Supported architecture Intel 64 (amd64)
Disk space 8.5 GB 1.5 GB
Necessary applications • dialog
• docker
• docker-compose
• xz
Time synchronization Automatic time synchronization of the
host should be switched off so that the
MCSA Docker container can synchronize
the system time with MindSphere server
time.
MCSA Docker containers
RAM 2 GB 4 GB
CPU cores 2
Disk space 2 GB

Note
From the version MindConnect Software Agent V03.06.00.00, the following are the
recommended requirements:
• Memory: mininum 4GB RAM.
• Disk space needed: 15GB.

Getting Connected to MindSphere

78 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Features
The following features are supported with MindConnect Software Agent:

Windows Linux
• Install Shield based setup • Shell script based Linux installer
• MindConnect Nano core functionality, except USB stick • Dialog based configuration script for managing MCSA
support Docker containers
• Local web UI • MindConnect Edge Analytics
– Onboarding support • Local web UI
– Shows current device status and information – Onboarding support
– Diagnosis support includes download of diagnosis, – Shows current device status and information
log, and system files – Diagnosis support includes the download of diagnosis,
– Manual firmware update logs and system files and cloud connection check
– Factory reset – Manual firmware update
– Log file upload control – Factory reset
– Change system time support – Log file upload control
– Localization in English and German – Change system time support
• Supported protocols – Localization in "English" and "German"
– S7 • Supported protocols
– OPC UA – S7
– Modbus TCP – OPC UA
– Rockwell (Ethernet/IP CIP) – Modbus TCP
– System information – Rockwell (Ethernet/IP CIP)
– S7+ * – System information
– Fanuc Focas * – S7+ *
– Sinumerik * – Fanuc Focas *
– IEC61850 * – Sinumerik *
– MTConnect * – IEC61850 *
– MTConnect *

Note
• To use these (*) protocols, you need version MindConnect Software Agent V03.06.00.00
b008 and "MC Advanced package".
• Currently Google Chrome or Microsoft Edge web browsers are supported only.

Getting Connected to MindSphere

Getting Started, 08/2022 79
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

8.7.2 User interface of MindConnect Software Agent

You manage the MindConnect Software Agent using the main navigation menu of the
"MindConnect Software Agent" UI.

      

① Navigation menu
② Serial number of the device
③ MindConnect Software Agent overview area
④ Onboarding status
⑤ Network status
⑥ Data source connection status after a data source configuration has been applied in the Mind‐
Sphere asset manager and downloaded to the device
⑦ Current firmware version

Note
Onboarding, network, and data connection statuses shows the current status of the device like
they are shown by the LED states of MindConnect Nano device (This information is not same as
shown in MindSphere Asset Manager).

Navigation menu
On the left side of the UI, there is a menu to navigate between the different tabs:
• Overview
• Onboarding
• Diagnosis

Getting Connected to MindSphere

80 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

• Maintenance
• Settings

Overview area
The overview area provides following information:
• Onboarding status pane with direct link to onboarding area (only visible if device is not
onboarded).
• Current network status pane.

Supported browser languages

MindConnect Software Agent's web UI supports following browser languages:
• English (default)
• German

Onboarding area
Open the onboarding area by clicking the "Onboard your device" link in the overview area, or by
using the "Onboarding" tab in the navigation menu.

Getting Connected to MindSphere

Getting Started, 08/2022 81
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

8.7.3 Onboarding and Installing MindConnect Software Agent

8.7.3.1 Onboarding and installing MindConnect Software Agent in Windows

MindConnect Software Agent device is required to onboard using Asset Manager. For more
information, see Asset Manager (https://documentation.mindsphere.io/resources/html/asset-
manager/en-US/index.html) document.

Getting Connected to MindSphere

82 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Procedure to onboard
To onboard the device, you need to create an asset in the Asset Manager. To create an asset for
your in Asset Manager, see Create Asset (https://documentation.mindsphere.io/resources/html/
asset-manager/en-US/113537813003.html). Once the asset is created, open the UI plugin in
Asset Manager to follow these steps:
1. In Asset Manager, click the MindConnect Software Agent plugin.

① Connects and onboards the MindConnect Software Agent

2. In MindConnect Software Agent plugin page:

Getting Connected to MindSphere

Getting Started, 08/2022 83
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

① MindConnect Software Agent firmware installation details

② Configure the asset with the serial number
③ Start the configuration with the serial number

– Download firmware: Click download and install the MindConnect Software Agent
firmware.
3. Install and run the MindConnect Software Agent firmware.

Note
• Start MCSA setup.exe, only once at a time.
• The downloaded “setup.exe” file for MCSA installation can be opened with any archiver but
the suggested archiver is “7z”.

Getting Connected to MindSphere

84 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Installing MindConnect Software Agent

MindConnect Software Agent can be installed on Windows system and IPCs running a Windows
10 version that supports Hyper-V feature, for example Windows 10 Professional or Enterprise.

Note
HyperV has to be activated on the local host PC.

Procedure to install MindConnect Software Agent

To install MindConnect Software Agent, follow these steps:
1. Double click "MindConnect Software Agent setup.exe".

2. Click "Yes" and click "Next".

Getting Connected to MindSphere

Getting Started, 08/2022 85
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

3. Select the network interfaces for MindConnect Software Agent.

① Connects to MindSphere
② Connects to the field devices like PLCs

Note
Ensure to use the correct adapter for each connection.

4. Select "Custom" setup type to install(recommended) and click "Next".

5. Configure the virtual machine settings and click "Next".

Note
Maximum RAM must be higher than the minimum RAM specification. Recommended is 8GB
as maximum RAM and 4GB as minimum RAM.

6. Change "Destination Folder", if required and click "Next".

7. Review the settings and click "Next".
8. Click "Install".

Getting Connected to MindSphere

86 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Installation completed
After installing MindConnect Software Agent firmware, follow these steps:
1. Restart your PC.
2. Open Hyper-V Manager.
3. Click on virtual machine (MindConnect Software Agent) and click "Connect".
In VM console, information will be displayed (IP Address and Serial Number).

In this sample, MindConnect Software Agent's web server URL is http://

192.168.75.129/.
For more information using Hyper-V Manager, see Using MindConnect Software Agent's
Hyper-V VM. (Page 105)
Note
• Currently, http protocol is supported.
• At least one of the connected networks must provide DHCP support, so that the system
will receive an IP address that can be used to open the local web UI in a browser.
• If a connected network does not provide DHCP support, the values for IP address and
subnet mask will be empty and the device has to be onboarded first.

Procedure to uninstall MindConnect Software Agent

MindConnect Software Agent can be uninstalled either by executing MindConnect Software
Agent's setup.exe file again, or via Windows Control Panel.

Note
To uninstall MindConnect Software Agent using Windows Control Panel is available from the
version MCSA V03.05.00.01 b004.

Procedure to access the web server URL and onboard the device
To access the web server URL and onboard the device, follow these steps:
1. In browser, open new tab and enter web server URL.
2. In MindConnect Software Agent overview page, copy the "Serial Number (UID)".
3. In MindConnect Software Agent plugin page, paste the "Serial Number" and click "Start
Configuration" and then click to initiate the onboarding process.

Getting Connected to MindSphere

Getting Started, 08/2022 87
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

4. In Edit MindConnect page, check the settings and download the onboarding key file.

5. In MindConnect Software Agent's overview page, click "Onboard your device".

Getting Connected to MindSphere

88 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

6. In MindConnect Software Agent onboarding page, follow the either step:

① Uploads the downloaded onboarding key file

② Inserts the JSON content from the onboarding key file

– Click "Select file" to upload the downloaded onboarding key file with the filename
constructed form of serial number.
or
– Copy the text from the onboarding key file and click "Insert JSON content" to paste.
7. Click "Start onboarding".
8. In Edit MindConnect page, click "Save" after the device is onboarded.
9. After the device is succesfully onboarded, you can add data sources and data point mapping.

For more information on adding a data source and data points, see Adding a data source and
data points (Page 132).
To manage and maintain multiple virtual machines (VM's) in MindConnect Software Agent, see
Managing or maintaining the virtual machines or instances in MindConnect Software Agent
(Page 106).

Getting Connected to MindSphere

Getting Started, 08/2022 89
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Serial number
The serial number section provides the serial number to copy and paste it to the serial number
field during the asset configuration in MindSphere asset manager.

Onboard with file

In “Onboarding” page, the exported configuration file from MindSphere asset manager can be
selected and click "Start onboarding" button to start onboarding.

Onboard with JSON content

It is also possible provide the configuration data directly as JSON input by clicking "Insert JSON
input" and paste the JSON configuration data into the opened dialog. Thereafter, start the
onboarding by clicking the "Start onboarding" button.

Configuration status
The status of the onboarding/configuration process will be shown in the "Configuration status"
section.

Note
If the network settings are changed by the new configuration data like a new IP address is
updated, then the MindConnect Software Agent's web browser must be opened again by using
the new IP address of the system. In that case, it might be possible that the diagnosis messages
will be displayed twice in the diagnosis messages section. To resolve the issue, restart the virtual
machine.

8.7.3.2 Installing MCSA in Docker

Downloading MCSA Linux installer

To download MCSA in Docker, follow these steps:
1. Click "MCSA Linux installer" to download the file.
Note
You can download "MCSA Linux installer" during MindConnect Software Agent asset creation
in MindSphere Asset Manager.

2. After the "McsaInstallerLinux.zip" file is downloaded successfully, extract the file on the target
Linux system.
Note
It is recommended to extract it directly on a Linux system so that the file permissions of the
extracted mcsa-installer.sh will remain

Getting Connected to MindSphere

90 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Prerequisites
Before installing MCSA Linux installer, check these components are installed on the target
system. Following additional components are currently required to install, configure and run
MCSA on Linux:
• dialog
• docker
• docker-compose
• xz
Furthermore, check if the Docker engine is already running.
If one of these components is not installed or the Docker engine is not running, the installer will
show a message which components are missing and provides the option to exit the installation:
• To install the required components manually, or
• To continue the installation and to install the missing components later
In the latter case, the MSCA components will be extracted to the installation folder, so that the
MCSA installation can be started manually after installing the required components.

Note
Installation of required components
• dialog belongs to ncurses and can be installed by using the Linux package manager (e.g. apt).
• docker should be installed by following the steps described on the Docker installation (https://
docs.docker.com/engine/install/debian/#install-using-the-repository) page.
• docker-compose installation is also described in the Docker documentation (https://
docs.docker.com/compose/install/). Because docker compose plugin is currently not
supported. The docker-compose "Linux Standalone binary" needs to be installed.
• xz can be installed by installing xz-utils using the Linux package manager (e.g. apt).

Installing MCSA Linux installer

To install "MCSA Linux installer", follow these steps:
1. Open “Linux terminal” window as root.
2. Navigate to the folder where the “mcsa-installer.sh” file had been extracted.
Note
It is mandatory to execute the MCSA installation with root privileges
• Either, directly as root, or
• By getting root rights using “su” command.
• "mcsa-installer.sh" can be started using "sudo" command to execute it with root rights.
If the installer is not started as root, a message will be shown to start as root and the script
will be terminated.

Getting Connected to MindSphere

Getting Started, 08/2022 91
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

3. Enter the file path "/opt/siemens/mindsphere/mcsa" and click "Enter".

Note
By default, MCSA installer offers the possibility to install MCSA components in following
folder:
• /opt/siemens/mindsphere/mcsa
This folder will be used, if "enter" is being pressed without entering a file path.

– After entering the file path click "enter", then the installer checks if the folder already
exists. If the folder is already existing, it will offer the possibility to select another folder
or to delete the folder, so that the new MCSA components can be installed there.
– It is also possible to exit the installer at this point to manually remove the already existing
MCSA installation folder, and to start the installer later again.

4. Extract the "mcsa-installer.sh" file to the selected installation folder for MCSA components.
Note
While installing, the Docker engine should not be running, or docker, docker-compose, or xz
should not be installed on the target system, the MCSA installer will end after extracting
MCSA components. After the required components are installed, the “mcsa-install.sh” can be
called manually to load the MCSA Docker image afterwards.

Getting Connected to MindSphere

92 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

5. Load the Docker image into the local Docker repository.

– If docker and/or docker-compose had to be installed manually, “mcsa-install.sh” script

should be executed manually with root privileges - either directly as root, or by getting
root rights using “su” command. "mcsa-install.sh" can be started using "sudo" command
to execute it with root rights.
– If the installer is not started as root, a message will be shown to start as root and the script
will be terminated.
– It is also necessary to start "mcsa-install.sh" script directly in the MCSA installation folder
to make sure that the internally used files will be available during script execution.
– If the MCSA Docker image is already loaded, the installer will offer the option to load it
again or to skip this step.
– In case that the MCSA Docker image is required to load again, installer will check for the
MCSA Docker containers exist and offer the possibility to automatically delete the existing
containers or they will remain, but the Docker image will be untagged.
– After removing the previously loaded image, the MCSA Docker image will be loaded again.

6. Add a first MCSA Docker container.

Note
• After loading the MCSA Docker image, the MCSA configuration (Page 110)will be started
automatically to add a first MCSA Docker container.
• If application dialog is not available for the target system, the installer will end after
loading the MCSA Docker image. After it has been installed, “mcsa-config.sh” can be
called manually to load the MCSA Docker image later.

Getting Connected to MindSphere

Getting Started, 08/2022 93
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Result
After MCSA installation is finished, the MCSA configuration dialog exits.

After the installation, a message is displayed that “mcsa-config.sh” can be called later again to
create new or maintain existing MCSA Docker containers.

8.7.4 Diagnosing MindConnect Software Agent

The MindConnect Software Agent's web UI provides a diagnosis tab to display diagnosis
messages and download diagnosis, log and system files.

Getting Connected to MindSphere

94 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Diagnosis tab
In the navigation menu, click "Diagnosis" tab to open the "Diagnosis" area. It provides following
features:

  

① Diagnosis messages
② Diagnosis files
③ Network analysis

Diagnosis messages
The "Diagnosis messages" section provides a list of currently stored diagnosis messages in the
web UI of the following components in separate sub-tabs:
• Box manager: Shows current states like onboarding, network connection, or data source
connection states.
• Data provider: Shows diagnosis messages of Modbus TCP, Rockwell and system information
data sources.
Note
Diagnosis messages of OPC UA and S7 data sources are currently not available.

• MCSA: Shows diagnosis information of the internal MindConnect Software Agent.

Note
Currently unexpected errors and file transfer settings related messages will be shown.

Getting Connected to MindSphere

Getting Started, 08/2022 95
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

In “Diagnosis messages” section, the last diagnosis message will be displayed. You can download
the previous diagnosis messages from the “Diagnosis files” section.
If the diagnosis messages section is open for a long time, the last 50 diagnosis messages will be
displayed.
With the "Delete messages" button, the internal buffer of the currently visible component's
diagnosis buffer will be deleted.

Diagnosis files
In “Diagnosis files” section, you can download the following kind of diagnosis files:





① Log files
② System files
③ Diagnostic files

To download the diagnosis files, select the checkbox. Thereafter, click "Get files" button to start
the collection and preparation process. When the preparation process completed, the download
buttons will be enabled, and you can the download the created diagnosis file packages by
clicking download buttons.

Note
If the files are not downloaded by the browser, check the download is blocked by the browser and
enable the download for MindConnect Software Agent.

Getting Connected to MindSphere

96 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Network analysis

Cloud connection check

In “Network Analysis” section, a cloud connection check can be executed to verify the connection
to MindSphere cloud is possible. By clicking the "Start" button an automatic cloud connection
check will be executed by MindConnect Software Agent.

After the test has been executed the following test results will be shown:
• Start and end time of the test in UTC format.
• Current IP addresses of web and production interfaces.
• Result of direct connection test.
• Result of connection test via proxy server if the proxy server is configured in asset manager.
• Proxy server and proxy authentication info if they are configured in asset manager.
After clicking the "Details" button the result log of the executed cloud connection check will be
shown in a dialog. The result log can also be downloaded as a file by clicking the "Result file"
button.

Getting Connected to MindSphere

Getting Started, 08/2022 97
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Cloud connection check status

The current status and the final status at the end of the command execution will be shown in the
cloud connection check status area.

Note
• It might be possible that the execution of the cloud connection check will take some time
depending on the current network configuration.
• This feature is available with MindConnect Software Agent V03.06.00.04 b006 or higher.

Cloud connection status messages are also available in the MCSA tab in the diagnosis messages
section.

8.7.5 Device Maintenance

The maintenance activities for the device can be performed in "Maintenance" area.

Maintenance area
In the navigation menu, click "Maintenance" tab to open the "Maintenance" area. It provides
following features:
• Firmware update
• Factory reset

Firmware update
In “Firmware update” section, a new firmware version can be updated to MindConnect Software
Agent.

Note
Make sure to download the correct fw.tar file from SIOS.

Getting Connected to MindSphere

98 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Manual firmware update

To select the new fw.tar file of the new MindConnect Software Agent firmware version, click
"Select file" button.
To upload the firmware update package to the device, click "Start firmware update" button to
start the firmware update process.

Firmware update status

The status of the firmware update process will be displayed in the "Firmware update status"
section.

Note
• After the new firmware version has been updated, MindConnect Software Agent system will
be rebooted. It is recommended to close the current browser window or to reload the page
after the reboot.
• It might be possible that the firmware update status does not switch from "started" to
"succeeded" because, the reboot of the system was too fast and the UI did not get success
message. Therefore, in this case the current browser window should be closed or reloaded
after a couple of minutes.

Factory reset

Start factory reset

In “Factory reset” section, a factory reset of MindConnect Software Agent can be performed. This
will delete all customer data like collected time series data and asset data. Furthermore, the
network settings will be reset.

Getting Connected to MindSphere

Getting Started, 08/2022 99
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

After clicking the "Start" button, a confirmation dialog will be shown before the factory reset will
be executed.

Factory reset status

The status of the factory reset process will be displayed in the "Factory reset status" section.

Note
• After the factory reset has been executed, MindConnect Software Agent system will be
rebooted, and it is recommended to close the current browser window or to reload the page
after the reboot.
• Because the network settings will also be reset, it might be possible that the device will get
new IP addresses from the DHCP server. The current IP addresses can be found by opening the
MindConnect Software Agent VM in Hyper-V-Manager or in Docker.
• If the device is onboarded before factory reset execution, the asset needs to be offboarded in
Asset Manager and the device has to be onboarded again.

8.7.6 Settings in MindConnect Software Agent

You can change the log file upload settings and system time using “Settings” area in
MindConnect Software Agent.

Getting Connected to MindSphere

100 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Settings area
In the navigation menu, click "Settings" tab to open the "Settings" area. It provides following
features:
• Diagnosis
• System

Diagnosis settings

Log files upload

The log files upload section displays the current status log file upload setting. To enable or disable
the log file upload functionality, click the "Upload log files" toggle button.

Note
While changing the log upload setting, it will overwrite the log upload settings of the asset’s
device configuration. This change will not be synchronized with the asset’s device configuration.

Change settings status

The status of changing the log files upload settings process is displayed in the "Change settings
status" section.

Diagnostic settings
This section has the configurations related with diagnostics setting such as level of logging.

Getting Connected to MindSphere

Getting Started, 08/2022 101
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Log Level
MindConnect Software Agent log level can be set from diagnostic configuration. The five
different values of log levels are
• TRACE
• DEBUG
• INFO
• WARNING
• ERROR.
The behaviour of the logging on the device will be included to the selected level and the upper
log levels only. The lower log levels will not be logged.

Log Upload
Log upload: It means, the device is going to upload logs generated to MindSphere. The log
upload on the device is enabled by default and it is possible to disable this feature. “Upload Logs
Now” triggers the upload of the device log files immediately. This feature triggers the log upload
regardless of the auto log upload status.

Getting Connected to MindSphere

102 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

System settings

Change system time

In “Change system time” section, the current Windows host system time will be displayed in UTC
format. A new system time can be updated using the time edit field.
To start the change system time process, click "Change time" button.

Note
• It is recommended to use Google Chrome for changing the system time, so that the new time
can be updated by using date and time picker which is not supported by all browsers (e.g.
Firefox).
• If you change the system time, this may lead to some abrupt behavior on the data ingested.

Change system time status

The status of changing the system time process is displayed in the "Change system time status"
section.

Getting Connected to MindSphere

Getting Started, 08/2022 103
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

File transfer

In "File transfer" section, click "Get state" button to get the current state of the file transfer
service. In this section, following actions can be executed:
• Functionality to transfer files to MindSphere can be enabled or disabled.
• Password can be changed.
• Shared "filetransfer" folder can be cleaned up manually.
Click "Apply changes" button to execute selected actions.

Note
File transfer functionality is available from the version MindConnect Software Agent
V03.06.00.03 b001.

Service enablement
• File transfer service can be enabled or disabled by checking or unchecking the "File transfer
active" check-box.
• By default, this feature is disabled and needs to be enabled first before it can be used.
• First enablement will take some time because further components will be installed on the
system.

Getting Connected to MindSphere

104 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Note
• Before disabling the file transfer service, it is recommended to disconnect all network
mappings to the shared "filetransfer" folder.
• File transfer service needs to be enabled and re-configured after the firmware update, if it had
been configured before.

Prerequisites
During first enablement of file transfer feature, it is necessary that following URLs can be
accessed:
• http://ftp.debian.org/debian
• http://security.debian.org/debian-security

Changing password
To access MindConnect Software Agent shared folder, it is necessary to provide a password.
Afterwards, the shared "filetransfer" folder can be mapped as a network drive. For example,
using MindConnect Software Agent's IP address and the user "mindsphere" and the provided
password as credentials.
Example: \\192.168.0.47\filetransfer

Clean folder
If some files cannot be transferred to the upload folder, it is important to clean the shared
"filetransfer" folder manually.

File transfer status

• While getting current file transfer state or changing file transfer configuration the current
process and execution result will be shown in the file transfer status section.
• Furthermore, these execution results will also be available in the MCSA tab on the diagnosis
messages pane.

8.7.7 Using MindConnect Software Agent's Hyper-V VM

This chapter will give some information about MindConnect Software Agent's Hyper-V VM and
how to use it in Windows Hyper-V-Manager.

Opening the VM
To open MindConnect-SoftwareAgent VM , start Windows Hyper-V-Manager and connect
MindConnect-SoftwareAgent VM.

Autostart
MindConnect Software Agent's VM will be configured during installation process and
automatically restarts after the restart of Windows host.

Getting Connected to MindSphere

Getting Started, 08/2022 105
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

System restart
In Windows Hyper-V Manager, restart the MindConnect Software Agent manually. To restart the
VM, click the following button:

System shutdown
In Windows Hyper-V Manager, shut down the MindConnect Software Agent manually. To shut
down the VM, click the following button:

Troubleshooting

Black screen is shown

If the system is running for a while with a black screen, click into the VM or press any key to view
system information.

System gets stuck during start-up

If the system is stuck after starting the Hyper-V VM, restart the VM as described above.

MindConnect Software Agent's VM is shut down, before the restart of Windows host
If MindConnect Software Agent's VM is shut down before the restart of Windows host, then the
VM must be started manually again.

8.7.8 Managing or maintaining the virtual machines or instances in MindConnect

Software Agent
MindConnect Software Agent can manage and maintain the multiple virtual machines or
instances by using the setup program manually or via Windows "Control Panel" → "Programs and
Features".

Note
Installation of multiple MindConnect Software Agent instances is supported from the version
MCSA V03.05.00.03 b005.

Getting Connected to MindSphere

106 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Procedure to create multiple virtual machines or instances

To create the multiple instances in MindConnect Software Agent, follow these steps:
1. Open "setup.exe" file, click "Yes" to make the changes to the device.
2. In "Maintenance" dialog, select "Create" and then click "Next":

① Modifies the existing feature or instance

② Reinstalls all program features installed by the previous setup
③ Uninstalls or removes all the installed feature or the selected instance
④ Creates a additional product instance

3. Select the network interfaces and click "Next".

Note
• The setup will create external Hyper-V switches for MindConnect Software Agent to get
its own IP address in the network and can be reached from outside of the Windows PC/IPC.
• The setup automatically detects the available network adapters and attempts to make a
suitable pre-selection if it finds network adapters with X1 and X2 in their names (which
should be the case on SIMATIC IPCs).
• If only one network adapter is available in PC, select a network adapter for the web
interface only.

4. Select "Custom" setup type to install(recommended) and click "Next".

5. Configure the virtual machine settings and click "Next".
For the virtual machine settings, see Onboarding and installing MindConnect Software
Agent.
6. Change "Destination Folder", if required and click "Next".
7. Review the settings and click "Next".
8. Click "Install".
9. After the installation, restart your PC.

Getting Connected to MindSphere

Getting Started, 08/2022 107
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Result
The second instance is succesfully installed.

Procedure to modify multiple virtual machines or instances

A MindConnect Software Agent virtual machine can be modified by starting the setup program
manually or via Windows "Control Panel" → "Programs and Features".

Note
Multi instances
Only one instance can be modified at a time. If you want to modify another MindConnect
Software Agent instance setup must be started again.

To modify the multiple instances in MindConnect Software Agent, follow these steps:
1. Open "setup.exe" file, click "Yes" to make the changes to the device.
2. In "Maintenance program", select "Modify" and click "Next".
3. Select the installed virtual machine (VM) to be modified from the list and click "Next".
4. Select the generated virtual switches to be modified and click "Next".
5. Configure the virtual machine settings and click "Next".
6. Click "Finish" to modify the virtual machine in MindConnect Software Agent.

Result
The selected virtual machine instance is succesfully modified.

Procedure to repair multiple virtual machines or instances

A MindConnect Software Agent virtual machine can be repaired by starting the setup program
manually or via Windows "Control Panel" → "Programs and Features".

Note
Multi instances
• Only one instance can be repaired at a time! If you want to repair another MindConnect
Software Agent instance setup must be started again.
• During the repair process, the selected MindConnect Software Agent instance's virtual
machine will be configured using the settings which had been applied during its installation
process. Furthermore, the virtual hard disk will be replaced by the original hard disk i.e., all
customer data and settings will be lost and MindConnect Software Agent instance needs to
be onboarded again.

To repair the multiple instances in MindConnect Software Agent, follow these steps:
1. Open "setup.exe" file, click "Yes" to make the changes to the device.
2. In "Maintenance program", select "Repair" and click "Next".

Getting Connected to MindSphere

108 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

3. Select the installed virtual machine (VM) to be modified from the list click "Next".
4. Select the generated virtual switches to be modified and click "Next".
5. Configure the virtual machine settings and click "Next".
6. Click "Finish" to modify the virtual machine in MindConnect Software Agent.

Result
The selected virtual machine instance is succesfully repaired.

Procedure to removing multiple virtual machines or instances

A MindConnect Software Agent virtual machine can be removed by using setup program
manually or via Windows "Control Panel" → "Programs and Features".

Note
Multi instances
Only one instance can be deleted at a time. If you want to delete the "MindConnect Software
Agent " completely, then every single instance must be deleted. The last instance will deletes the
complete folder structure.

To remove or unistall MindConnect Software Agent, follow these steps:

1. Open "setup.exe" file, click "Yes" to make the changes to the device.
2. In "Maintenance program", select "Remove" and click "Next".
3. Click "Yes" to confirm and remove the installed virtual machines (VM's).
4. Select the generated virtual switches to be removed and click "Next".
Note
If the virtual switches are still needed, click "Next" without selecting a virtual switch.

5. Select the list of all installed virtual machines (VM's) to be removed and click "Next".
6. Click "Finish" to remove the virtual machines (VM's) completely from the PC.

Result
The virtual machines (VM's) is succesfully removed or uninstalled.

Getting Connected to MindSphere

Getting Started, 08/2022 109
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

8.7.9 Configuring MCSA in Docker

The MCSA configuration will be automatically started during MCSA installation, but it can also
be started manually by executing the “mcsa-config.sh” script with admin privileges in the MCSA
installation folder.

Note
It is mandatory to execute the MCSA installation with root privileges
• Either, directly as root, or
• By getting root rights using “su” command.
• "mcsa-config.sh" can be started using "sudo" command to execute it with root rights.
If the configuration script is not started as root, a message will be shown to start as root and the
script will be terminated.
It is also necessary to start "mcsa-config.sh" script directly in the MCSA installation folder to make
sure that the internally used files will be available during script execution.

MCSA configuration
After the installation, select the network adapters of the host system which are used by the
MCSA containers as web and production interfaces, if the MCSA configuration is started for the
first time.
These settings are necessary for the static network settings need to be applied via MindSphere
asset manager UI.

Note
• Be aware that MCSA containers directly use the Linux host's network interfaces and selecting
web and production interfaces is only necessary for applying network interface settings via
device configuration in MindSphere asset manager.
• If the Linux host is having further network interfaces, it might be possible that MCSA Docker
containers will communicate with MindSphere and the data sources using these network
interfaces.
• Therefore, it is recommended that only the host's network interface, which is selected as web
interface provided with internet access.

Getting Connected to MindSphere

110 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

To configure the MCSA in Docker, follow these steps:

1. In Web interface dialog, select web interface and click "OK".

Note
It is mandatory to select Web interface.

2. In Production interface dialog, select production interface and click "OK".

MCSA configuration main menu

The MCSA configuration will display a menu to perform following tasks:
• Add new MCSA Docker container.
• Show informations of running MCSA Docker containers.
• Start exited/stopped MCSA Docker containers.
• Stop up/started MCSA Docker containers.
• Delete MCSA Docker containers.
• Exit

Getting Connected to MindSphere

Getting Started, 08/2022 111
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

You can select a task by using “Up/Down” keys and pressing “Enter” key and you can close the
main menu by selecting "Exit" task.

Add new MCSA Docker container

For adding a new MCSA Docker container, provide the following values:
• Container name
• HTTP port
• MQTT port
• WinCC OA PMON port
• WinCC OA data port
• WinCC OA event port
• WinCC OA SNMP port

Note
TCP Ports
• Providing unique TCP ports for every MCSA Docker container is necessary because MCSA
Docker containers run in host network mode of Docker.
• Therefore, after entering the TCP port number value it will be checked, if the port is already
in use on the system.
• Although it is checked, if the entered port number is already in use, it is recommended to
check the currently used ports of the already existing MCSA Docker containers beforehand,
because it might be possible that the already used port is currently not active and therefore,
it is not detected automatically.
• TCP port numbers should be entered in the allowed range (1 ... 65535).
• Because many ports are already standardized and used by other applications and protocols,
port numbers in the upper number range is considered to be used.
• Information about already used and allowed port numbers can be found on following page:
List of TCP and UDP (https://en.wikipedia.org/wiki/List_of_TCP_and_UDP_port_numbers)
port numbers.

Getting Connected to MindSphere

112 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Container name

Note
During creation of the MCSA Docker container an "mcsa_1" postfix will be added to the name of
the container automatically (example: c1_mcsa_1), it is not necessary to add "mcsa" to the name
in this dialog.

HTTP port
MCSA Docker containers are running in host network mode, it is mandatory to define a system
unique TCP port which will be used to access the local web server in the Docker container.

MQTT port
It is also necessary to define a unique MQTT port for every MCSA Docker container.

Getting Connected to MindSphere

Getting Started, 08/2022 113
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

WinCC OA PMON port

In following dialog, the WinCC OA PMON port can be entered:

WinCC OA data port

In following dialog, the WinCC OA data port can be entered:

WinCC OA event port

In following dialog, the WinCC OA event port can be entered:

Getting Connected to MindSphere

114 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

WinCC OA SNMP port

In following dialog, SNMP port for WinCC OA can be configured:

Confirmation
After all settings are entered and the confirmation to create the new MCSA container is given,
then a new container will be created.

Getting Connected to MindSphere

Getting Started, 08/2022 115
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

The main menu is displayed again after the new MCSA Docker container is created.

Note
• After creation of an MCSA Docker container, the system will set up internally be which takes
some time. Hence, it is recommended to wait for 2 minutes before trying to onboard the
system, or to create another MCSA container.
• MCSA Docker containers will automatically be restarted after the system restart.

Show container info

In the main menu, select the "Show container info" task information will display about currently
up/running MCSA container.
In the first dialog, the MCSA Docker container can be selected:

After selecting an MCSA container and click “OK”, following information is displayed:

Getting Connected to MindSphere

116 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Start Docker container

In the main menu, select the "Start containers" task to display a list of all exited/stopped MCSA
Docker containers:

Select the containers to be started and click “OK” to start the containers.
The start progress is displayed by the following dialog:

After all the selected containers are started, the main menu is displayed again.

Getting Connected to MindSphere

Getting Started, 08/2022 117
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Stop Docker container

In the main menu, a list of all up/running MCSA Docker containers are displayed, after selecting
the "Stop containers" task:

While stopping the containers, following dialog is displayed:

After all the selected containers are stopped, the main menu is displayed again.

Delete Docker container

In the main menu, MCSA Docker containers can be deleted after selecting the "Delete
containers" task and select the containers to be deleted from the following dialog:

Getting Connected to MindSphere

118 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

A dialog is displayed to confirm the containers to be deleted:

The deletion progress is displayed by following dialog:

After all the containers are deleted, the main menu is displayed again.

8.7.10 Differentiating MCSA between Windows and Linux

Network settings
All MCSA Docker containers are running in host network mode only, one MCSA container is
chosen to have static IP addresses in the device configuration, if it is necessary that the IP
addresses of the Linux host system is to be configured by the asset of the chosen MCSA Docker
container.

Note
Requirement
It is necessary that the host network interfaces are configured by the MCSA Docker containers
which are configured with the static IP addresses, otherwise it is possible that another IP address
will be assigned by DHCP during runtime.

Getting Connected to MindSphere

Getting Started, 08/2022 119
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Onboarding
In case of MCSA in Docker, the Docker container ID is being used as serial number, because the
ID is quite long to be displayed and reduced in the status area of local MCSA UI.
But for onboarding the complete Docker container ID is displayed as a serial number:

Getting Connected to MindSphere

120 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

System settings
In the system settings, the file transfer is currently not available, therefore the local MCSA UI will
provide the possibility to change the system time only.

Datasource protocols

System protocol
Following system protocol variables are not supported in MCSA Docker containers:
kernel
• /kernel/osrelease
• /kernel/ostype
• /kernel/version
memory
• /memory/cmafree
• /memory/cmatotal
• /memory/available
network
• /network/pawspassive
• /network/tcpdirectcopyfrombacklog
• /network/tcpdirectcopyfromprequeue

Getting Connected to MindSphere

Getting Started, 08/2022 121
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

• /network/tcpfackreorder
• /network/tcpforwardretrans
• /network/tcphphitstouser
• /network/tcpprequeued
• /network/tcpprequeuedropped
• /network/tcpschedulerfailed
disk
Affected sub categories:
• persistent
• persistent_appconfig
• persistent_massdata

8.7.11 Known restrictions of MindConnect Software Agent

This page provides some information about already known restrictions and provides
workarounds to handle them.

Local UI

One browser window/tab only

It is highly recommended to open MindConnect Software Agent's local UI in one browser
window/tab only, due to an already known issue diagnosis messages would be shown several
times.

Diagnosis messages are shown twice

If the network settings are changed during onboarding or offboarding, it might be possible that
the diagnosis messages will be displayed twice. To resolve the issue, restart the VM.

Date & Time picker is not shown to select new system time
Date & Time picker input fields are not supported in all web browsers (e.g. Mozilla Firefox). Use
chromium based browsers like Google Chrome or Microsoft Edge.

Onboarding

Encrypted onboarding key

If the current encrypted onboarding key is not working, then the unencrypted onboarding data
should be used for onboarding and offline configuration in MindConnect Software Agent UI.

Re-onboarding
If the asset has been offboarded in the Asset manager and the device is being onboarded again,
it might be possible that the new onboarding configuration has to be applied twice because the

Getting Connected to MindSphere

122 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

system will internally offboard first and reboot later. Therefore, the new onboarding
configuration has to be applied again in the local MindConnect Software Agent UI.

Firmware update

Update status does not change

If the firmware update status is not updated from "started" to “succeeded” because the reboot of
the system was too fast, and the UI did not get the success message. In this case, the current
browser window should be closed or reloaded after a couple of minutes.

Start For Free

The following are the known restriction for the Start for Free tenant:
1. Maximum six data-points are available.
2. Maximum two data-sources are available.
3. Minimum data-ingest rate for agents of Start for Free tenant should be less than 0.1kbps. This
is applicable for MindConnect Software Agent also.
4. Start for Free restrictions in MindSphere are applicable for MCSA agent also.
5. In Start for Free, the lower reading cycles may lead to performance issues.

Multi MindConnect Software Agent VMs Installation

Multi MindConnect Software Agent VM installation

While adding, modifying, or removing a multiple VM in MindConnect Software Agent setup, all
running MindConnect Software Agent VMs will be stopped and re-started after the setup
process is completed.

MSI package cannot be found

If the .msi package is not found, search for the alternate path in the “C:\Users\..\AppData” folder
and enter the path containing installation package "MindConnect-SoftwareAgent.msi":

Getting Connected to MindSphere

Getting Started, 08/2022 123
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Installing new MindConnect Software Agent version

In case of an upgrade setup will show a message and abort afterwards, then uninstall the old
MindConnect Software Agent version before installing new MindConnect Software Agent
version by using the InstallShield setup.

8.7.12 Troubleshooting

Hyper-V not enabled on IPC

If Hyper-V feature is not installed and enabled on IPC, following dialog appears:

In this case the setup will end, and the Hyper-V Windows feature has to be enabled in Windows
control panel.
Thereafter restart your Windows, open MindConnect Software Agent setup again.

Hyper-V not enabled on PC

If Hyper-V feature is not installed and enabled on PC, following dialog appears:

In this case the setup will end and Windows has to be restarted before MindConnect Software
Agent can be started again.

Getting Connected to MindSphere

124 Getting Started, 08/2022
 Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Windows Hyper-V is switched off

If the Windows Hyper-V is switched off, following dialog appears:

In this case the setup will end and the hypervisor has to be enabled manually using following
command in a command prompt with adminstrative rights:
bcdedit /set hypervisorlaunchtype auto
Afterwards, Windows has to be restarted before MindConnect Software Agent setup can be
started again.

Getting Connected to MindSphere

Getting Started, 08/2022 125
Onboarding MindConnect Elements
8.7 Using MindConnect Software Agent to connect industrial data sources to MindSphere

Getting Connected to MindSphere

126 Getting Started, 08/2022
Configuring data in Asset Manager 9
After onboarding a MindConnect Element, you need to configure the data in Asset Manager. You
have to set up a data connection to receive data from your MindConnect Element.
In order to use the data from your MindConnect Element in MindSphere you need to map the
received data to the Asset Manager data model:

MindSphere - Data model

Asset Manager

MindConnect Element Physical Asset Virtual Asset

Onboarding Data mapping

Data source configuration Asset based on a type and

with data points aspects with variables

MindConnect plugin Type

S 7 PLC OPC UA Aspect 1 Aspect 2

-Data point -Data point -Variable -Variable
-Data point -Data point -Variable -Variable
-Data point -Data point -Variable -Variable

Asset Manager uses the following areas:

• Assets
• Types
• Aspects

Getting Connected to MindSphere

Getting Started, 08/2022 127
Configuring data in Asset Manager
9.1 Creating an aspect and variables

In order to configure data in Asset Manager you need to fulfill the following steps:
• Creating an aspect and variables (Page 128)
In this step you create aspects and variables you want to use in MindSphere.
• Creating a type in Asset Manager (Page 130)
In this step you create an asset type to enable data mapping.
• Adding a data source (Page 132)
The data source defines the reading of the data from the MindConnect Element.
• Mapping an aspect to a data source (Page 136)
In this final step you map the data of the MindConnect Element to the aspects and variables
in MindSphere.

Note
You will need to sign-out and resign in case of role changes, depending on the system it might
take up to 15 minutes for the current configuration to be effective.

9.1 Creating an aspect and variables

To use the data of your MindConnect Element in MindSphere you need to create aspects and
variables in Asset Manager.
Aspects are combined, pre-configured data and form the context for the evaluation of industrial
processes. An aspect can consist of several variables. Within the industry process, assets transfer
the aspects as time series data in MindSphere.
In Asset Manager you can create aspect types. Aspect types are pre-configured templates for
aspects. The advantage of aspects types is to use one type for several assets. For example, you
can create one aspect type for all generators of a wind farm with the variable rotation speed.
For information on creating an asset, refer "Creating an asset (Page 67)".

Procedure
To add an aspect type in Asset Manager, e. g. "Generator", follow these steps:
1. On the start screen click "Aspects".
2. To create a new aspect click .
3. Enter your Tenant ID for the aspect, e. g. "idevdoc.generator".
Note
All custom aspects and types must be named as "<TenantID>.xxx"

4. Enter a name and description for the aspect e. g. "Generator".

Getting Connected to MindSphere

128 Getting Started, 08/2022
 Configuring data in Asset Manager
9.1 Creating an aspect and variables

5. Follow these steps for each variable, e. g. "RotationSpeed":

– Enter variable data.
Note
• The units and data types specified here will need to match exactly(also case sensitive)
with the physical data source.

Figure 9-1 Variable data

– Click "Add variable".

6. Confirm with "Save".

Getting Connected to MindSphere

Getting Started, 08/2022 129
Configuring data in Asset Manager
9.2 Creating a type in Asset Manager

Result
The new aspect type with its variables is available in the aspect list.

9.2 Creating a type in Asset Manager

To enable data mapping, you first have to create an asset type. An asset type is a pre-configured
template for an asset. The asset type predefines which aspects are integrated into the template.
You have to link aspects to an asset type to enable the connection to a data point.
For information on creating an asset, refer "Creating an aspect and variables (Page 128)".

Requirement
• You have created an aspect.

Getting Connected to MindSphere

130 Getting Started, 08/2022
 Configuring data in Asset Manager
9.2 Creating a type in Asset Manager

Procedure
To create an asset type proceed as follows:
1. Click on the "Types" tab in Asset Manager.
2. Click on "BasicDevice".
3. To create a new asset type click .
4. Enter ID and name for asset type, e. g. "Wind turbine".
Note
The ID must be named as "TenantID.xxx".

5. Select an aspect type from the dropdown menu, e. g. "Generator". You can find additional
information on aspects in the chapter Creating an aspect and variables (Page 128)
6. Enter an aspect name and click "Add".
7. To save the asset type click "Save".

Getting Connected to MindSphere

Getting Started, 08/2022 131
Configuring data in Asset Manager
9.3 Adding a data source and data points

Result
You created a new asset type. The new asset type is now available in the presets. The following
graphic shows the new available asset type "Wind turbine" in assets.

9.3 Adding a data source and data points

9.3.1 Adding a data source

To receive the data of your MindConnect Element you need to add a data source. The data source
specifies the protocol and reading cycle that is used to transfer the data from your asset to the
MindConnect Element. Within the data source, you enter the IP address of the asset inside of
your network.

Getting Connected to MindSphere

132 Getting Started, 08/2022
 Configuring data in Asset Manager
9.3 Adding a data source and data points

Requirement
• You have created an asset and an aspect.
• You have enabled the connection to the MindConnect Element.
• You have the IP address of the asset inside of your network.

Procedure
To add a data source to an asset of type MindConnect, e. g. "Generator", follow these steps:
1. Click on the asset in the "Assets" tab, e. g. "Wind turbine".
2. Click on the asset icon, e. g. "MindConnect Nano".
3. Click "Add new data sources".
– The window to enter the protocol data is opened

Note
• The default reading cycle is 86400 seconds, which is one day.
• You can find additional information on supported protocols in the chapter Configuring
protocols (Page 149).

4. Enter data source data and confirm with "Accept".

5. To save the data source click "Save".

Getting Connected to MindSphere

Getting Started, 08/2022 133
Configuring data in Asset Manager
9.3 Adding a data source and data points

Result
You have now created a new data source. The new data source is available at the asset details of
your MindConnect Element.
The following graphic shows the added data source:

9.3.2 Adding data points

A data point is a measurable value of an asset that can be represented numerically and
graphically. Examples of a data point are temperature or pressure. Within MindSphere you add
data points to a data source to collect the data for example from a control unit. In the next step
you have to link the data points of a data source with the respective variables of an aspect.
You can find more information about how to send data in chapter Send commands (Page 209).

Note
Limitations
One data point cannot be mapped to two variables in the same aspect.

Note
Health status
The health status shows the quality of the connection of the data point. You can click on the
status to get further information. You can find additional information about quality code in
chapter Quality code settings (Page 221).

Getting Connected to MindSphere

134 Getting Started, 08/2022
 Configuring data in Asset Manager
9.3 Adding a data source and data points

Requirement
• You have created a data source.

Procedure
To add a data point to a data source, e. g. "RotationSpeed", follow these steps:
1. Click on the asset in the "Assets" tab, e. g. "Wind turbine".
2. Click on the asset icon, e. g. "MindConnect Nano".
3. To edit the data source you have to click on "Enter Edit Mode".
– Edit functions appear next to the data source.
4. Click on "Add Datapoint".
5. Enter data point data.

Note
• The units and data types specified here will need to match exactly with the aspects and
variables. If they are different, the aspect cannot be connected to the data point.
• The protocol datatypes specify the Datapoint Address. You can find additional information
on protocol datatypes in the chapter Configuring protocols (Page 149).
• It is possible to use hysteresis value in this field. This reduces the number of read events.
The hysteresis filters signals and reduces the response to short-term signal fluctuations.
The maximum value for hysteresis can be 99999 to minimum as 0.001.

Getting Connected to MindSphere

Getting Started, 08/2022 135
Configuring data in Asset Manager
9.4 Mapping an aspect to a data source

6. Confirm with "Accept".

7. To save the added data point in "Edit Mode" click "Save".

Result
The new data point is available at the data source.
In order to send the changes to the device, you have to click "Apply Changes" in the MindConnect
plugin.
The following graphic shows the health status of the new data point:

9.4 Mapping an aspect to a data source

Data mapping means matching variables of an aspect with the respective data points of a data
source.
• Variables of an aspect represent the MindSphere data.
• Data points of a data source represent the data of the MindConnect Element.
To use the data of your MindConnect Element you have to map them to the respective variables
of an aspect.

Requirement
You have created an asset based on your desired aspect and asset type.

Note
Browser compatibility
Microsoft Edge browser do have some issues with the user interface (e.g. Mapping). Please use
another browser e. g. Chrome or Firefox.

Getting Connected to MindSphere

136 Getting Started, 08/2022
 Configuring data in Asset Manager
9.4 Mapping an aspect to a data source

Procedure
To map a variable to a data point, e. g. "RotationSpeed", follow these steps:
1. Click on the asset in the "Assets" tab, e. g. "Wind turbine1".
2. Click on the MindConnect Element Plugin icon, e. g. "MindConnect Nano".
3. Click "View data mapping".
4. Select the aspect, e. g. "Generator".
5. Select the variable you want to map to the data point, e. g. "RotationSpeed".
6. Select the data point you want to map and click "Link Variable".
The following graphic shows the "Link Variable" option:

Getting Connected to MindSphere

Getting Started, 08/2022 137
Configuring data in Asset Manager
9.4 Mapping an aspect to a data source

7. Select the previously created asset type and click "Accept", e. g. "Wind turbine".
Note
You can find additional information on asset types in the chapter Creating a type in Asset
Manager (Page 130).

Wind Turbine Nano

Wind Turbine Nano

Wind Turbine Nano

Wind Turbine Nano

Wind Turbine Nano

Getting Connected to MindSphere

138 Getting Started, 08/2022
 Configuring data in Asset Manager
9.4 Mapping an aspect to a data source

8. Select the variable you want to link, e. g. "RotationSpeed".

Wind Turbine Nano

Note
Only units and data types that match exactly with the aspects and variables are available. If
they are different, the aspect can’t be connected to the data point (also case sensitive).

9. To link the variable click "Accept".

Result
The data point is now mapped to the variable.
The following graphic shows a mapped variable:

:LQG7XUELQH1DQR

Getting Connected to MindSphere

Getting Started, 08/2022 139
Configuring data in Asset Manager
9.5 Importing data source configurations for MindConnect Nano/IoT2040

9.5 Importing data source configurations for MindConnect Nano/

IoT2040
To receive the data from MindConnect Nano/IoT2040, add a data source with corresponding
datapoints. You can also upload a file for faster import of the configuration or download the
template file.

Prerequisites
The prerequisites to configure the data sources are:
• Asset and aspect are created.
• MindConnect Nano/IoT2040 is connected.
• Prepare a file to import according to the following guidelines.
• Check the structure in the template file. It differs for each plugin type, but similar with its basic
format. The below given example is a basic structure in the template file:
DS; datasource-nameX;datasource-description
DP; dp-name1;dp-description;LONG;dp-unit
DP; dp-name2;dp-description;LONG;dp-unit
DP; dp-name3;dp-description;LONG;dp-unit
DS; datasource-nameX;datasource-description
DP; dp-name1;dp-description;LONG;dp-unit
DP; dp-name2;dp-description;LONG;dp-unit
DP; dp-name3;dp-description;LONG;dp-unit

Procedure
To import the data source configuration for an asset of the type MindConnect Nano/IoT2040,
follow these steps:
1. In the "Assets" tab, click asset. For example, "Wind turbine".
2. In "Connectivity" section, click MindConnect Nano/IoT2040 plugin. For example,
"MindConnect Nano".
3. To configure the data source, click "Configure your data sources" or "Enter edit mode" if the
data source is already created.

Getting Connected to MindSphere

140 Getting Started, 08/2022
 Configuring data in Asset Manager
9.5 Importing data source configurations for MindConnect Nano/IoT2040

4. To import a file, click "Import configuration".

Note
• To check the format of the data configuration file before importing the configuration,
download the template file by clicking download template.
• The template file consists of an example data configuration. In the below given
screenshot, the information related to data source and datapoint declarations for S7 and
it can switch to each protocol from the bottom of the file (e.g S7, OPC UA, modbus-tcp,
etc).
• The supported protocols for import and export configurations are S7, OPC UA, Modbus-
TCP, Rockwell and System.

5. To save and configure MindConnect Nano/IoT2040, click "Save".

Note
• Track the errors or warnings from “Import Configuration” or “Export Configuration”.

Getting Connected to MindSphere

Getting Started, 08/2022 141
Configuring data in Asset Manager
9.6 Importing data source configurations with datapoint mapping for MindConnect Software Agent

Result
Data source configuration are imported. The new data sources will be available at the asset
details of MindConnect Nano/IoT2040.

9.6 Importing data source configurations with datapoint mapping for

MindConnect Software Agent
To receive the data from MindConnect Software Agent, add a data source with corresponding
datapoint mapping. You can also upload a file for faster import of the configuration or download
the template file.

Prerequisites
The prerequisites to configure the data sources are:
• Asset and aspect are created.
• MindConnect Software Agent is connected.
• Prepare a file to import according to the following guidelines.
• Check the structure in the template file. It differs for each plugin type, but similar with its basic
format. The below given example is a basic structure in the template file:
DS; datasource-nameX;datasource-description
DP; dp-name1;dp-description;LONG;dp-unit;asset
name1;aspectname1;variablename1
DP; dp-name2;dp-description;LONG;dp-unit;asset
name2;aspectname2;variablename2
DP; dp-name3;dp-description;LONG;dp-unit;asset
name3;aspectname3;variablename3
DS; datasource-nameX;datasource-description
DP; dp-name1;dp-description;LONG;dp-unit;asset
name4;aspectname4;variablename4
DP; dp-name2;dp-description;LONG;dp-unit;asset
name5;aspectname5;variablename5
DP; dp-name3;dp-description;LONG;dp-unit;asset
name6;aspectname6;variablename6

Getting Connected to MindSphere

142 Getting Started, 08/2022
 Configuring data in Asset Manager
9.6 Importing data source configurations with datapoint mapping for MindConnect Software Agent

Procedure
To import the data source configuration for an asset of the type MindConnect Software Agent,
follow these steps:
1. In the "Assets" tab, click asset. For example, "Wind turbine".
2. In "Connectivity" section, click MindConnect Software Agent plugin. For example,
"MindConnect Software Agent".
3. To configure the data source, click "Configure your data sources" or "Enter edit mode" if the
data source is already created.
4. To import a file, click "Import configuration".

Note
• To check the format of the data configuration file before importing the configuration,
download the template file by clicking download template.
• The template file consists of an example data configuration with datapoint mappings. In
the below given screenshot, the information related to data source and datapoint
declarations for S7 and it can switch to each protocol from the bottom of the file (e.g S7,
OPC UA, modbus-tcp, etc).
• The supported protocols for import and export configurations are S7, OPC UA, Modbus-
TCP, Rockwell and System.

 

① Data source configuration information

② Datapoint mapping information (optional)

5. To save and configure MindConnect Software Agent, click "Save".

Note
• Track the errors or warnings from “Import Configuration” or “Export Configuration”.

Getting Connected to MindSphere

Getting Started, 08/2022 143
Configuring data in Asset Manager
9.6 Importing data source configurations with datapoint mapping for MindConnect Software Agent

Result
Data source configuration are imported with mapped datapoints. The new data sources will be
available at the asset details of MindConnect Software Agent.

To view the mapped datapoints, click "View Datamapping".

Note
Limitations of importing datapoint mappings
• Asset name needs to be unique in the tenant. If multiple assets are with the same name in the
tenant, then datapoint mappings may have discrepancy.
• Asset needs to be available before importing the configuration. Asset will not be created
during import configuration.
• Datapoint name needs to be unique in excel sheet across data sources and protocols.
• Datapoint mapping of a datapoint with multiple variables of multiple assets is not supported.
• Importing of datapoint mappings is an async process.

Getting Connected to MindSphere

144 Getting Started, 08/2022
 Configuring data in Asset Manager
9.7 Configuring MindConnect element using API

9.7 Configuring MindConnect element using API

AgentManagement API
You can configure MindConnect elements via api calls with public API’s that are offered from
MindSphere. To update the data source configuration of AgentManagement api, refer to the
endpoint "Data Source Configuration Operations" in Agent Management Service – API
Specification (https://developer.mindsphere.io/apis/connectivity-agentmanagement/api-
agentmanagement-api-swagger-v3-4-0.html).
For more information on how to authenticate and how to get the information related with the
MindConnect element from Mindsphere, refer to Develop for MindSphere (https://
developer.mindsphere.io/).
This below information will show, how to structure the configuration part for the above api
request for specific industrial protocols.

Protocol configurations
You can configure the device to AgentManagement using the below protocol specific
configurations that needs to be configured in the api call.

Note
In case the body structure is not as expected, the configuration might be rejected or may lead to
corrupt configuration on MindSphere. Always verify the operation from MindConnect Element
UI.

The json configuration in body part of the request consists of below key-value pairs. All the
documented key-value pairs given below are important. The customData child fields of
dataPoints and dataSource items are free formatted fields and should be a valid json. Below
is the configuration body:
{
"name": "DataSource Name",
"customData": {
"protocol": "Name of the protocol",
"protocolData": { },
"readCycleInSeconds": "Value"
},
"description": "",
"dataPoints": [
{
"id": "a37d9e1fee6b4",
"name": "DatapointName",
"description": "-",

Getting Connected to MindSphere

Getting Started, 08/2022 145
Configuring data in Asset Manager
9.7 Configuring MindConnect element using API

"unit": "Unit",
"type": "Type",
"customData": {
"dataPointData": { }
}
}
]
}

Note
The above key-value pairs are important for the body, if missing any key-value pair will result in
configuration failure.

Each protocol has it's unique protocolData representing its protocol specific fields and
dataPointData field for representing it's unique datapoint configuration. In order to get the
successful configuration for each one of the protocol, the free formatted parts of the body needs
to be a valid json. Otherwise, the configuration will be failed.
The below given an example of how to configure a datasource with one datapoint for S7
protocol:

Note
• The below json content can be changed as required, do not depend on it strictly.
• The free formatted fields "protocolData" and "dataPointData" has a specific configuration to
S7 protocol.

{
"name": "S7DS",
"customData": {
"protocol": "S7",
"protocolData": {
"ipAddress": "192.168.0.1",
"manualRackAndSlot": "Automatic",
"rackNumber": "0",
"slotNumber": "2"
},
"readCycleInSeconds": "1"
},
"description": "",
"dataPoints": [

Getting Connected to MindSphere

146 Getting Started, 08/2022
 Configuring data in Asset Manager
9.7 Configuring MindConnect element using API

{
"id": "a37d9e1fee6b4",
"name": "DatapointName",
"description": "-",
"unit": "%",
"type": "LONG",
"customData": {
"dataPointData": {
"address": "DB1.DBWORD0",
"hysteresis": "0",
"onDataChanged": false,
"acquisitionType": "WRITE"
}
}
}
]
}

Getting Configuration Details of Protocols

To get the configurations details for other protocols such as Modbus, Ethernet IP etc, the API of
AgentManagement can be used to get the configuration details. The initial configuration can be
done via UI and then using the below API config, it can be extracted and used for API calls and
later for structuring.

Note
The json content of each protocol varies and should be extracted after an initial UI configuration.

To get the data source configuration of AgentManagement api, refer to the endpoint "Data
Source Configuration Operations" in Agent Management Service – API Specification (https://
developer.mindsphere.io/apis/connectivity-agentmanagement/api-agentmanagement-api-
swagger-v3-4-0.html).

Getting Connected to MindSphere

Getting Started, 08/2022 147
Configuring data in Asset Manager
9.7 Configuring MindConnect element using API

Getting Connected to MindSphere

148 Getting Started, 08/2022
Configuring protocols 10
10.1 Overview of supported protocols for MindConnect Elements
The following table shows the supported protocols for MindConnect Elements:

Protocols MindConnect Nano MindConnect IoT2040 MindConnect

Software Agent
S7 Yes Yes Yes
OPC UA Yes Yes Yes
Modbus TCP IP Yes Yes Yes
Modbus RTU Yes Yes No
Simatic I/O No Yes No
System Yes Yes Yes
Rockwell Yes Yes Yes
S7+ No No Yes
Fanuc Focas No No Yes
Sinumerik No No Yes
IEC61850 No No Yes
MTConnect No No Yes

Getting Connected to MindSphere

Getting Started, 08/2022 149
Configuring protocols
10.2 Overview of S7 protocol

10.2 Overview of S7 protocol

The following image shows the data source input window for the S7 protocol:

You can choose between automatic and manual connection type.

• Automatic: This mode tries to find slot and rack number automatically.
• Manual: In this mode you can enter the rack and slot number manually.
For S7 connection type the PG type-programmer-type-connection is used thus you will not be
able to make use of PG connection.

Note
Symbolic access
This solution does not allow full symbolic access.

Requirements for S7-1200 and S7-1500

• Put/Get communication must be permitted (can be found e.g. S7-1500 -> Properties ->
Protection & Security -> Connection mechanisms).
• The “Optimized block access” of the data blocks that you want to read must be deactivated
(can be found in the data block properties).

Getting Connected to MindSphere

150 Getting Started, 08/2022
 Configuring protocols
10.2 Overview of S7 protocol

Address format examples

Detailed examples:
Example address format DB15.DBX6.3:

DB15.DBX6.3
Area indicator Data type Offset address
DB15 - DB X 6 - 3
Datablock ad‐ Separator Datablock Bool Offset Byte Separator Offset Bit
dress
Reads 3rd bit of byte 6 of datablock 15

Example address format IW10:

IW10
Area indicator Data type Offset address
I W 10
Process Input Word Offset Byte
Reads a word of input starting from offset 10

Overview
If you want to read data out of other areas, please replace “DB15.DB“ from the examples with the
area indicator from the list below. Attention: only certain address examples work with Inputs and
Outputs (see 2)).

S7 MindSphere
Data type Length / unsigned/ Data type Address example Description
signed (length)
Bool 1 bit BOOLEAN DB15.DBX6.3 2) Reads 3rd bit of byte 6 of dat‐
(1 bit) ablock 15.
Byte 1 byte / unsigned DB15.DBB4 2) Reads an unsigned byte start‐
USInt DB15.DBBYTE4 ing from offset 4 out of data‐
block 15.
SInt 1 byte / signed
Char 1 byte / signed DB15.DBCHAR6 Reads a char starting from off‐
set 6 of datablock 15.
INT (4
Word 2 bytes / unsigned DB15.DBW10 2) Reads an unsigned word start‐
bytes)
UInt DB15.DBWORD10 ing from offset 10 of data‐
LONG (8 block 15.
bytes)
Int 2 bytes / signed DB15.DBINT12 Reads a signed integer start‐
DOUBLE ing from offset 12 out of dat‐
(8 bytes) 1) ablock 15.
DINT 4 bytes / signed DB15.DBDINT28 Reads a signed double integer
starting from offset 28 of dat‐
ablock 15.
DWord 4 bytes / unsigned LONG (8 DB15.DBDW24 2) Reads an unsigned double
UDInt bytes) DB15.DBDWORD24 word starting from offset 24
DOUBLE of datablock 15.
(8 bytes) 1)

Getting Connected to MindSphere

Getting Started, 08/2022 151
Configuring protocols
10.2 Overview of S7 protocol

S7 MindSphere
Data type Length / unsigned/ Data type Address example Description
signed (length)
Real 4 bytes / signed DOUBLE DB15.DBD32 2) Reads a floating-point num‐
(8 bytes) DB15.DBREAL32 ber starting from offset 32 of
datablock 15.
String Length of variable, DB15.DBSTRING10 The maximum string length
max. 254 bytes (Byte10) is read first. Then the
number of bytes that Byte10
indicates are read. After that
the number of bytes that
Byte11 indicates are extrac‐
ted from the byte array that is
the result of second read op‐
eration.
STRING For example:
(max. 254
bytes) • (Byte10)- 30
• (Byte11)-4
• (Byte12-Byte15)-TEST
First read result: 30
Second read result: 4TEST
We will extract TEST from the
second read result by consid‐
ering Byte11's value.
String Min. 100 bytes , max. DB15.DBSTRING10,100 Reads 100 bytes of string
254 bytes starting from offset 10.
1)
When DOUBLE is used for integers, they are converted to a floating-point number.
2)
For the areas Inputs and Outputs only certain address examples work.

Note
Signed values
If you want to read a signed value, you have to use the respective signed datablock.
Example:
DB1831.DBW508 is unsigned. You can use DB1831.DBINT508 instead.

Area Types
S7 datapoint addresses must contain an area type.

Area indicator Area types Description

C Counter Reads Counter value of hardware.
DB Datablock Reads datablock value from hardware.
DI Instance Data Reads data directly from hardware.
I Process Input Reads Input value of Process image.
M Memory Reads Memory value of hardware.

Getting Connected to MindSphere

152 Getting Started, 08/2022
 Configuring protocols
10.2 Overview of S7 protocol

Area indicator Area types Description

PI Peripheral Input Reads Input value directly from hardware.
PQ Peripheral Output Reads Output value directly from hardware.
Q Process Output Reads Input value of Process image.
T Timer Reads Timer value of hardware.

Area Number
S7 datapoint addresses must contain area number.
E.g.: DB10 (10. datablock)

Data Types
The following table shows the MindSphere data types:

MindSphere data types

Data type Length Data range
From To
BOOLEAN 1 bit True False
INT 4 bytes −2147483648 2147483647
LONG 8 bytes −9223372036854775808 9223372036854775807
DOUBLE 8 bytes -9.9999999999999999999999999 9.9999999999999999999999999
999999999999E+125 999999999999E+125
STRING 1 - 255 bytes

The following table shows the S7 data types:

S7 data types
Data type Length Data range
From To
Bool 1 bit False True
Byte (unsigned) 1 byte 0 255
Word (unsigned) 2 bytes 0 65.535
DWord (unsigned) 4 bytes 0 4294967295
Char (signed) 1 byte −128 127
Int (signed) 2 bytes −32768 32767
DINT (signed) 4 bytes −2147483648 2147483647
Real 4 bytes +/-1,18e-38 +/-3.40e+38
String 1- 254 bytes

Offset
Variable types must have an offset. Offset is the starting byte number.
E.g. DW4 (a double word starting from byte 4)

Getting Connected to MindSphere

Getting Started, 08/2022 153
Configuring protocols
10.2 Overview of S7 protocol

String

Data type Length in bytes Format

STRING[n] or STRING n+2 ASCII character of any length.
n specifies the length of the
character string. A maximum
length of 254characters is
permitted. If no length is
specified, the default setting
is 254 characters.

Data type Examples of format used

STRING[2] 'AB'
STRING[55] 'The character string can consist of up to 55 characters'

Note
You must enclose your character string in single quotation marks.

The following example shows the byte order when specifying the datatype STRING[4] with the
output value 'AB'.

* Tod

TIME_OF_DAY (Time) 32 Time is in steps of 1 ms TOD#0.0.0.0 to L TOD#1:10:3.3

TOD#23:59:59.999 L TIME_OF_DAY#1:10:3.3

* Time
Returns milliseconds.
Format
The DT (DATE_AND_TIME) datatype saves the information on date and time of day in BCD format.
The following table shows the properties of datatype DT:

Length (bytes) Format Range of values Example of value input

8 Date and time
(year-month-day

Getting Connected to MindSphere

154 Getting Started, 08/2022
 Configuring protocols
10.3 Overview of OPC UA protocol

10.3 Overview of OPC UA protocol

OPC UA data parameter

Note
MindConnect IoT2040 connection establishment
Due to the extensive and detailed logging, system slowdowns can occur during the connection
establishment phase. It depends on the work, the device has to do.

The following image shows the data source input window for the OPC UA protocol:

For the OPCUA protocol, the data source input supports the following parameters:

Parameter Description
Protocol Shows the selected protocol type.
Name Name of the data source.
Description Add a description for data source.
Reading Cycle Enter a reading cycle for the data source.
OPC UA Server Name Enter the name of the OPC UA Server Name.
OPC UA Server Address Enter the OPC UA Server Address.
OPC UA Server IP Ad‐ Enter the OPC UA Server IP Address.
dress

Getting Connected to MindSphere

Getting Started, 08/2022 155
Configuring protocols
10.3 Overview of OPC UA protocol

Parameter Description
OPC UA Authentication You can choose between the following types:
Type • NONE: No authentication enabled.
• BASIC: Enables the OPC UA BASIC authentication.
OPC UA Security Mode You can choose between the following modes:
• NONE: No security mode
• CERTIFICATE: Enables to upload a certificate in the following formats: *.pfx, *.pf12, *.cer, *.crt,
*.der, *.p7b, *.p7r, *.spc
Enable OPC UA Events You can enable the transfer and takeover of events and alarms in the OPC UA protocol to MindSphere.
Fleet Manager shows all events and alarms in the "Events" extension of the agent asset.
LImits:
• For Nanobox the proposed limit is 25 events/alarms per second.
• For IoT2040 the proposed limit is 10 events/alarms per second.

OPC UA Data Access Specification

OPC UA Data Access Specification does not specify a certain representation for OPC UA Addresses
(NodeId). A NodeId is represented by a combination of:
• NamespaceIndex
• IdentifierType
• Identifier
OPC UA Client Driver addresses have the following syntax: ns=;=.

Note
OPC browsing is not supported.

For more information refer to the table below:

Field Description
NamespaceIndex The index of the OPC UA Server namespace in which the address resides. If the index is 0, the entire
ns=;= clause is omitted.
IdentifierType The type of address. OPC UA supports the following four address types:
i A numeric address represented with 32-bit unsigned integer
s A string address containing characters that can be encoded using UTF-8
g A GUID address in the format of XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
b An opaque address (such as a byte string)
Identifier The address that is formatted as a string. This address may be numeric, string, GUID, or opaque.

Examples NodeId
Below you can see examples of an OPC UA Addresses (NodeId) representation:

Getting Connected to MindSphere

156 Getting Started, 08/2022
 Configuring protocols
10.3 Overview of OPC UA protocol

String

String IdentifierType Example

ns=[id];s=[string] ns=5;s=Counter1

Attribute NodeId Value NodeId

NamespaceIndex 5
IdentifierType String
Identifier Counter1

Note
String for Identifier
The string you enter at the four Identifier will be case sensitive.

Numeric

Numeric Identifier‐ Example

Type
ns=[id];i=[number] ns=0;i=3190 OR

Attribute NodeId Value NodeId

NamespaceIndex 0
IdentifierType Numeric
Identifier 3190 [BaseEventType_LocalTime]

Guid

Guid IdentifierType Example

ns=[id];g=[guid] ns=1;g=0d4e10fa-b9e1-4842-bca6-887c7d8c31f0

Base64(Opaque)

Base64(Opaque) Example
IdentifierType
ns=[id];b=[base64] ns=2;b=M/RbKBsRVkePCePcx24oRA==

Datatypes Conversion
The following table shows the Datatype Conversion:

IEC61131 elementary datatypes OPC UA built-in datatypes MindSphere Type

BOOL Boolean boolean
SINT SByte int
USINT Byte int

Getting Connected to MindSphere

Getting Started, 08/2022 157
Configuring protocols
10.3 Overview of OPC UA protocol

IEC61131 elementary datatypes OPC UA built-in datatypes MindSphere Type

INT Int16 int
UINT UInt16 int
DINT Int32 int
UDINT UInt32 int
LINT Int64 long
ULINT UInt64 long
BYTE Byte int
WORD UInt16 int
DWORD UInt32 int
LWORD UInt64 long
REAL Float double
LREAL Double double
STRING String string
CHAR Byte int
WSTRING String string
WCHAR UInt16 int
DT DateTime n/a
DATE_AND_TIME
DATE DateTime n/a
TOD DateTime n/a
TIME_OF_DAY
TIME Double double

Note
“NodeID“ is not a valid part of the OPC string anymore.

OPC UA Event Type

You can choose default event type or one of the custom event types created in tenant.

OPC UA Event Types

OPC UA plugins supports custom event types to be uploaded to MindSphere. Select the correct
event type from the below drop-down menu, to get those events on MindSphere. In the drop-
down menu, the events owned by the specific tenant and the default event type
“DataSourceEvent” is shown only.

Getting Connected to MindSphere

158 Getting Started, 08/2022
 Configuring protocols
10.3 Overview of OPC UA protocol

The event types are summarized as below:

Data Source Event Type It is the default event type which can collect some static fields
of events from OPC UA server.
Custom Event Type These types can be created by user/owner of tenant, and they
can collect both static and extra fields from OPC UA server.

A new event type must be created from “AgentBaseEvent” type with required extra fields and
then, it can be selected from the event drop-down list which is shown during OPC UA server
configuration.

Note
• If there is no created custom event type in tenant, "Data Source Event Type" will be selected
by default.
• Both, data source events and custom events will be uploaded to MindSphere. They can be
displayed on fleet manager regarding to their types. For more information on displaying
events, see Viewing events (Page 219).

Create custom event type via API

It is possible to create custom event types with extra fields via Event Management API. For more
information on the service, see Event Management - API Overview (https://
documentation.mindsphere.io/MindSphere/apis/advanced-eventmanagement/api-
eventmanagement-api.html).
Below is the api to call using a technical user /api/eventmanagement/v3/eventTypes
The following template shows the payload of the call:
{
"name": "SomeCustomEventType",
"parentId": "core.connectivity.event.type.AgentBaseEvent",
"ttl": 35,
"scope": "LOCAL",
"fields": [
{
"name": "Message",
"filterable": false,
"required": false,
"updatable": true,
"type": "STRING"
},
{
"name": "testField1",
"filterable": false,
"required": false,
"updatable": true,
"type": "STRING"
},
{
"name": "testField2",
"filterable": false,
"required": false,

Getting Connected to MindSphere

Getting Started, 08/2022 159
Configuring protocols
10.4 Overview of Modbus TCP protocol

"updatable": true,
"type": "STRING"
},
{
"name": "testField3",
"filterable": false,
"required": false,
"updatable": true,
"type": "STRING"
}
]
}

Note
• The “name” field in body must be same as the “browseName” of the field which will be
collected in the OPC UA Server. It is case-sensitive.
• Name for "Event Type" needs to be unique
• The “type” field must be “STRING” for all data types.
• The “scope” field should always be given as “Local” unless a particular reason is required to
make it "Public".
• The field with name “Message” is the static field and it is not included to custom event types.
It is needed to be added as an extra field.

10.4 Overview of Modbus TCP protocol

MindSphere supports the Modbus protocol for the MindConnect IoT2040, MindConnect Nano
plugin and MindConnect Software Agent. You can select the protocol type Modbus TCP while
adding a new data source in Asset Manager.

Note
Modbus configuration
The Modbus configuration view is only visible after a successful onboarding of the MindConnect
IoT2040/Nano. The MindConnect Nano Version must be higher than V3.3.0.2.

The following picture shows the protocol selection in Asset Manager:

Getting Connected to MindSphere

160 Getting Started, 08/2022
 Configuring protocols
10.4 Overview of Modbus TCP protocol

Figure 10-1 Modbus

For more information about how to create a new data source see chapter Adding a data source
and data points (Page 132).

Modbus TCP data source parameter

In order to connect a Modbus TCP device, you need to select the Modbus TCP protocol and enter
the following data source parameters:

Parameter Description
IP Address IP address of the Modbus device
Port Port number of the Modbus device (default: 502)

Getting Connected to MindSphere

Getting Started, 08/2022 161
Configuring protocols
10.4 Overview of Modbus TCP protocol

The following parameters are optional and can be adjusted for collecting data from slow Modbus
devices:

Parameter Description
byteTimeout You can set the timeout interval between two consecutive bytes of the same message received
from the Modbus device. If the delay between is longer than the given timeout, an error will be
generated.
Range:
500ms (default) … 2000ms
responseTimeout You can set the timeout interval used to wait for a response from the Modbus device. If the waiting
before receiving the response is longer than the given timeout, an error will be generated.
Range:
500ms (default) … 60000ms
responseSuspension‐ If a byte timeout or a response timeout was detected, then this waiting time is added before the next
Time request is started. During this time any response from the Modbus device will be flushed.
Range:
0ms (default) … 45000ms
requestDelay You can set the time between the response from the Modbus device and the next request to this
Modbus device.
Range:
0ms (default) … 10000ms

Modbus TCP data point parameter

In order to collect the data of your Modbus TCP device, you must add new data points.
The following picture shows the data point parameter window:

Getting Connected to MindSphere

162 Getting Started, 08/2022
 Configuring protocols
10.4 Overview of Modbus TCP protocol

The following table shows the parameter of the Modbus RTU data point window:

Parameter Description
Data Type Data type supported by backend (e.g. INT).
Function Type Function type - depends on the type of the data (see manual of the Modbus device).
1: Read Coils
2: Read Inputs
3: Read Holding Registers
4: Read Input Registers
Currently function codes 1..4 are supported.
Slave Number Address/Slave number of the Modbus device.
Start Address Start address (offset) of the data.
Quantity Quantity of data to be read.

Getting Connected to MindSphere

Getting Started, 08/2022 163
Configuring protocols
10.4 Overview of Modbus TCP protocol

Parameter Description
VariableType You can choose the following variable types of the Modbus data to be read:
1: char : 8 bits
2: unsigned char : 8 bits
3: short : 16 bits
4: unsigned short : 16 bits
5: long : 32 bits
6: unsigned long : 32 bits
7: float : 32 bits
8: double : 64 bits
9: ascii-text : 8 bits / char
Real Type Real type - determines, if the registers of real values have to be processed in reversed order
0: Normal order
1: Reversed order
2: Byte swap order
3: Word swap order
Real types 2 and 3 are available from V03.04.02.01.
Integer Byte Order It determines in which byte order format the read value will be processed (default: 0)
0: Normal order (big-endian)
1: Reversed order (little-endian byte swap)
2: Byte swap order (big-endian byte swap)
3: Word swap order (little-endian)
Note:
Integer byte order is available for 16 bits and 32 bits variable types only, and it is supported for the
version starting from MindConnect Nano/IoT2040 V03.04.02.13.
Response Address Off‐ Offset of the data to return in register units.
set
Response Quantity Quantity of the returned data. Only for string data a value greater than 1 is supported.

Note
TCP Gateway slave number
If you are using a TCP Gateway, you must select the appropriate slave number for the
configuration of the data points.

Addressing
The information is stored in the Modbus Slave device in 4 different tables. 2 tables store on/off
discrete values (coils) and two store numerical values (registers). Each coil is 1 bit long and
assigned a data address between 0 and 65535.

Getting Connected to MindSphere

164 Getting Started, 08/2022
 Configuring protocols
10.4 Overview of Modbus TCP protocol

Each register has the size of 1 word(16 bits/ 2 bytes) and has a data address between 0 and
65535.

Coil/ Register numbers Data addresses Function type Table name

1-9999 0 to 65535 1 Read Coils
10001-19999 0 to 65535 2 Read Inputs
30001-39999 0 to 65535 4 Read Input Registers
40001-49999 0 to 65535 3 Read Holding Registers

The coil/register number can be considered a location name as stated in the device
documentation; otherwise, the data address can be used as Start Address.

Data Types
MindSphere data types:

Data type Length Data range

BOOLEAN 1 bit True to False
INT 4 bytes −2147483648 to 2147483647
LONG 8 bytes −9223372036854775808 to
9223372036854775807
DOUBLE 8 bytes -9.99999999999999999999999999999999999
99E+125 to
9.99999999999999999999999999999999999
99E+125
STRING 1 - 255 bytes

Modbus data types:

Data type Length Data type number Data range

char 8 bits 1 -128 to 127
unsigned char 8 bits 2 0 to 255
short 16 bits 3 -32768 to 32767
unsigned short 16 bits 4 0 to 65535
long 32 bits 5 −2147483648 to
2147483647
unsigned long 32 bits 6 0 to 4294967295
float 32 bits 7 -3.402823e+38 to
-1.175 495e-38
+1.175 495e-38 to
+3.402823e+38
double 64 bits 8 -1.797693134862
3158e+308 to
-2.225073858507
2014e-308
+2.22507385850
72014e-308 to
+1.79769313486
23158e+308
ascii-text String length depends 9
on Modbus device.

Getting Connected to MindSphere

Getting Started, 08/2022 165
Configuring protocols
10.5 Overview of Modbus RTU protocol

Examples

Example Data type Function type Start ad‐ Variable Response Response Quan‐
dress type Address tity
Offset
Reading the first Holding Register, int Read Holding 0 unsigned 0 1
number 40001, has the start ad‐ Registers short
dress 0. or short
VariableType: 4 or 3 (unsigned short int Read Input Regis‐ 1 unsigned 0 1
or short)Reading the second Input ters short
Register, number 30002, has the or short
start address 1.
Reading a float (32 bits) from Input double Read Input Regis‐ 107 float 0 1
Register 30108 / 30109, has the ters (reads
start address 107. two regis‐
ters)
Reading a string. This example de‐ string Read Holding 5 unsigned 0 2 (registers)
scribes to read four letters from reg‐ Registers short
ister 40006 and 40007. Each regis‐
ter contains two characters.
Reading a Boolean from the Holding Boolean Read Holding 10 unsigned 0 1
Register 40011, has the start ad‐ Registers short or
dress 10. If the hole Holding Register short
has the value 0 then it is displayed as
0. If one bit(or more) has the value 1
then it will be displayed as 1.

10.5 Overview of Modbus RTU protocol

MindSphere supports the Modbus protocol for the MindConnect IoT2040 and MindConnect
Nano plugin. You can select the protocol type Modbus RTU while adding a new data source in
Asset Manager.

Note
Modbus configuration
The Modbus configuration view is only visible after a successful onboarding of the MindConnect
IoT2040/Nano. The MindConnect Nano Version must be higher than V3.3.0.2.

The following picture shows the protocol selection in Asset Manager:

Getting Connected to MindSphere

166 Getting Started, 08/2022
 Configuring protocols
10.5 Overview of Modbus RTU protocol

For more information about how to create a new data source see chapter Adding a data source
and data points (Page 132)

Modbus RTU data source parameter

In order to connect a Modbus RTU device, you need to select the Modbus RTU protocol and enter
the following data source parameters:

Parameter Description
Serial Port Available serial ports:
• COM1
• COM2
Serial Type Supported serial communication standards:
• RS232
• RS422
• RS485
Baud rate Baud rate for serial communication:
• 9600
• 2400
• 4800
• 19200
• 38400
• 57600
• 115200

Getting Connected to MindSphere

Getting Started, 08/2022 167
Configuring protocols
10.5 Overview of Modbus RTU protocol

Parameter Description
Data bits Data bits for serial communication:
• 5
• 6
• 7
• 8
Stop bits You can select the number of stop bits for serial communication:
• 1
• 2
Parity Parity for serial communication:
• Odd
• None
• Even
Termination Onboard termination:
• On
• Off

The following parameters are optional and can be adjusted for collecting data from slow Modbus
devices:

Parameter Description
byteTimeout You can set the timeout interval between two consecutive bytes of the same message received
from the Modbus device. If the delay between is longer than the given timeout, an error will be
generated.
Range:
500ms (default) … 2000ms
responseTimeout You can set the timeout interval used to wait for a response from the Modbus device. If the waiting
before receiving the response is longer than the given timeout, an error will be generated.
Range:
500ms (default) … 60000ms
responseSuspension‐ If a byte timout or a response timeout was detected, then this waiting time is added before the next
Time request is started. During this time any response from the Modbus device will be flushed.
Range:
0ms … 45000ms. (default: 1000ms)
For Modbus RTU it is recommended to set the value to 10000 ms. If the default value 0 ms is set, any
incoming incorrect responses will not be destroyed.
requestDelay You can set the time between the response from the Modbus device and the next request to this
Modbus device.
Range:
0ms (default) … 10000ms

Getting Connected to MindSphere

168 Getting Started, 08/2022
 Configuring protocols
10.5 Overview of Modbus RTU protocol

Pin assignment of Modbus protocols

The following table shows the pin assignment for the Modbus RTU protocol:

Pin RS 485 RS 422 RS 232

1 Data- Transmit / receive data - (I/O) TX- Transmitted data - (O) for full- Not supported
for half-duplex mode duplex mode
2 Data+ Transmit / receive data+ (I/O) TX+ Transmitted data + (O) for full- RxD Received data (I)
for half-duplex mode duplex mode
3 - RX+ Receive data + (I) for full-duplex TxD Transmitted data (O)
mode
4 - RX- Receive data - (I) for full-duplex Not supported
mode
5 M Signal ground M Signal ground M Ground
6 - - Not supported
7 - - Not supported
8 - - Not supported
9 - - Not supported

Modbus RTU data point parameter

In order to collect the data of your Modbus RTU device, you must add new data points.
The following picture shows the data point parameter window:

Getting Connected to MindSphere

Getting Started, 08/2022 169
Configuring protocols
10.5 Overview of Modbus RTU protocol

The following table shows the parameter of the Modbus RTU data point window:

Parameter Description
Data Type Data type supported by backend (e.g. INT).
Function Type Function type - depends on the type of the data (see manual of the Modbus device).
1: Read Coils
2: Read Inputs
3: Read Holding Registers
4: Read Input Registers
Currently function codes 1..4 are supported.
Slave Number Address/Slave number of the Modbus device.
Start Address Start address (offset) of the data.
Quantity Quantity of data to be read.
VariableType You can choose the following variable types of the Modbus data to be read:
1: char
2: unsigned char
3: short
4: unsigned short
5: long
6: unsigned long
7: float
8: double
9: ASCII-Text
Real Type Real type - determines, if the registers of real values have to be processed in reversed order
0: Normal order
1: Reversed order
2: Byte swap order
3: Word swap order
Real types 2 and 3 are available from V03.04.02.01.
Integer Byte Order It determines in which byte order format the read value will be processed (default: 0)
0: Normal order (big-endian)
1: Reversed order (little-endian byte swap)
2: Byte swap order (big-endian byte swap)
3: Word swap order (little-endian)
Note:
Integer byte order is available for 16 bits and 32 bits variable types only, and it is supported for the
version starting from MindConnect Nano/IoT2040 V03.04.02.13.
Response Address Off‐ Offset of the data to return in register units.
set
Response Quantity Quantity of the returned data. Only for string data a value greater than 1 is supported.

Addressing
The information is stored in the Modbus Slave device in 4 different tables. 2 tables store on/off
discrete values (coils) and two store numerical values (registers). Each coil is 1 bit long and
assigned a data address between 0 and 65535.

Getting Connected to MindSphere

170 Getting Started, 08/2022
 Configuring protocols
10.5 Overview of Modbus RTU protocol

Each register has the size of 1 word(16 bits/ 2 bytes) and has a data address between 0 and
65535.

Coil/ Register numbers Data addresses Function type Table name

1-9999 0 to 65535 1 Read Coils
10001-19999 0 to 65535 2 Read Inputs
30001-39999 0 to 65535 4 Read Input Registers
40001-49999 0 to 65535 3 Read Holding Registers

Coil / register numbers can be considered as location names since they do not appear in the
configuration. The Data Addresses (Start Address) are used in the configuration.

Data Types
MindSphere data types:

Data type Length Data range

BOOLEAN 1 bit True
INT 4 bytes −2147483648
LONG 8 bytes −9223372036854775808
DOUBLE 8 bytes -9.9999999999999999999999999999999999999E+125
STRING 1 - 255 bytes

Modbus data types:

Data type Length Data type number

char 8 bits 1
unsigned char 8 bits 2
short 16 bits 3
unsigned short 16 bits 4
long 32 bits 5
unsigned long 32 bits 6
float 32 bits 7
double 64 bits 8
ascii-text 8 bits / char 9

Getting Connected to MindSphere

Getting Started, 08/2022 171
Configuring protocols
10.6 Overview of SIMATIC I/O Shield

Examples

Example Data type Function type Start ad‐ Variable Response Response Quan‐
dress type Address tity
Offset
Reading the first Holding Register, int Read Holding 0 unsigned 0 1
number 40001, has the Data Ad‐ Registers short
dress 0. or short
VariableType: 4 or 3 (unsigned short int Read Input Regis‐ 1 unsigned 0 1
or short)Reading the second Input ters short
Register, number 30002, has the Da‐ or short
ta Address 1.
Reading a float (32 bits) from Input double Read Input Regis‐ 107 float 0 1
Register 30108 / 30109, has the Da‐ ters (reads
ta Address 107. two regis‐
ters)
Reading a string. This example de‐ string Read Holding 5 unsigned 0 2 (registers)
scribes to read four letters from reg‐ Registers short
ister 400006 and 400007. Each reg‐
ister contains two characters.

Technical specification

Protocol Description Value Data rate

Modbus RTU - RS485 Data provider 32
Max cable length 1200 m max. 115,2 kBd
Modbus RTU - RS422 Data provider 10
Max cable length 1200 m max. 115,2 kBd
Modbus RTU - RS232 Data provider 1
Maximum cable length 900 m 2,4 kBd
300 m 4,8 kBd
152 m 9,6 kBd
15 m 19,2 kBd
5m 57,6 kBd
<2m 115,2 kBd

10.6 Overview of SIMATIC I/O Shield

SIMATIC I/O Shield device has been plugged-in to MindConnect IoT2040 and set up according to
I/O Shield operating instructions. Analog and digital input signals are connected to SIMATIC I/O
Shield connectors.
You can find more information about the SIMATIC I/O Shield Modul in the SIMATIC IOT IOT2000
Extension Modules manual (https://support.industry.siemens.com/cs/document/109745681/
iot2000-extension-modules?dti=0&lc=en-WW). The following picture shows the SIMATIC
IOT2000 Input/output Modul:

Getting Connected to MindSphere

172 Getting Started, 08/2022
 Configuring protocols
10.6 Overview of SIMATIC I/O Shield

You can select the protocol type SIMATIC I/O Shield while adding a new data source in Asset
Manager.
The following picture shows the protocol selection in Asset Manager:

After selecting the protocol you can enter the parameter Name, Description and Reading Cycle.

Getting Connected to MindSphere

Getting Started, 08/2022 173
Configuring protocols
10.7 Overview of SYSTEM protocol

SIMATIC I/O Shield data point parameter

In order to collect the data of your SIMATIC I/O Shield device, you must add new data points.
The signal that has to be recorded can be configured by specifying pin type (analog/digital) and
the pin number as it is printed on SIMATIC I/O shield device. For the analog inputs, the read value
corresponds to a percentage value between 0 and 1. The percentage value refers to the
permissible voltage range between 0-10 V. The read value must be converted accordingly for the
connected sensor.
Following inputs can be chosen:

Input Pin type Pin number Recommended data type

AI0 Analog 0 DOUBLE
AI1 Analog 1 DOUBLE
AI2 Analog 2 DOUBLE
AI3 Analog 3 DOUBLE
DI0 Digital 0 BOOLEAN
DI1 Digital 1 BOOLEAN
DI2 Digital 2 BOOLEAN
DI3 Digital 3 BOOLEAN
DI4 Digital 4 BOOLEAN

10.7 Overview of SYSTEM protocol

You can use the protocol SYSTEM to implement a system information adapter for analysis
purposes. The SYSTEM protocol can collect the following information from MindConnect
devices:
• Overall CPU load
• Overall memory consumption
• Network traffic
• Application specific data
– CPU load memory consumption
• Disk usage
You can choose the SYSTEM protocol as a data source without configuring specific system
parameters, except the reading cycle.
After creating the data source you can configure the following categories in a new data point:
• CPU
• Memory
• Network
• Disk

Getting Connected to MindSphere

174 Getting Started, 08/2022
 Configuring protocols
10.7 Overview of SYSTEM protocol

The following image shows the data point input window for the SYSTEM protocol:

Each category has its own set of variables which will be described in the following.

Application information
Application provides the following available applications:
• MindEdgeRuntimeSystem/java
• DataProvider
• BoxManager
• S7 Plugin
• OPCUA Plugin
• XTools
• Mosquitto
The following table shows the available variables for the applications:

Variable Data type Address

Name string /application/<subcategory>/name
State string /application/<subcategory>/state
Tgid int /application/<subcategory>/tgid
Ngid int /application/<subcategory>/ngid
Pid int /application/<subcategory>/pid

Getting Connected to MindSphere

Getting Started, 08/2022 175
Configuring protocols
10.7 Overview of SYSTEM protocol

Variable Data type Address

PPid int /application/<subcategory>/ppid
TracerPid int /application/<subcategory>/tracerpid
Uid string /application/<subcategory>/uid
Gid string /application/<subcategory>/gid
FDSize int /application/<subcategory>/fdsize
Groups string /application/<subcategory>/groups
NStgid int /application/<subcategory>/nstgid
NSpid int /application/<subcategory>/nspid
NSpgid int /application/<subcategory>/nspgid
NSsid int /application/<subcategory>/nssid
VmPeak long /application/<subcategory>/vmpeak
VmSize long /application/<subcategory>/vmsize
VmLck long /application/<subcategory>/vmlck
VmPin long /application/<subcategory>/vmpin
VmHWM long /application/<subcategory>/vmhwm
VmRSS long /application/<subcategory>/vmrss
VmData long /application/<subcategory>/vmdata
VmStk long /application/<subcategory>/vmstk
VmExe long /application/<subcategory>/vmexe
VmLib long /application/<subcategory>/vmlib
VmPTE long /application/<subcategory>/vmpte
VmPMD long /application/<subcategory>/vmpmd
VmSwap long /application/<subcategory>/vmswap
HugetlbPages long /application/<subcategory>/hugetlbpages
Threads int /application/<subcategory>/threads
SigQ string /application/<subcategory>/sigq
SigPnd string /application/<subcategory>/sigpnd
ShdPnd string /application/<subcategory>/shdpnd
SigBlk string /application/<subcategory>/sigblk
SigIgn string /application/<subcategory>/sigign
SigCgt string /application/<subcategory>/sigcgt
CapInh string /application/<subcategory>/capinh
CapPrm string /application/<subcategory>/capprm
CapEff string /application/<subcategory>/capeff
CapBnd string /application/<subcategory>/capbnd
CapAmb string /application/<subcategory>/capamb
Seccomp int /application/<subcategory>/seccomp
Speculation_Store_By‐ string /application/<subcategory>/speculation_store_bypass
pass
Cpus_allowed int /application/<subcategory>/cpus_allowed
Cpus_allowed_list string /application/<subcategory>/cpus_allowed_list
Mems_allowed int /application/<subcategory>/mems_allowed
Mems_allowed_list string /application/<subcategory>/mems_allowed_list

Getting Connected to MindSphere

176 Getting Started, 08/2022
 Configuring protocols
10.7 Overview of SYSTEM protocol

Variable Data type Address

volunta‐ int /application/<subcategory>/voluntary_ctxt_switches
ry_ctxt_switches
nonvolunta‐ int /application/<subcategory>/nonvoluntary_ctxt_switches
ry_ctxt_switches

CPU information
The following table shows the available variables for the category CPU information:

Variable Data type Description

LoadAvg1 double Number of processes in state R(runnable) or D(disk sleep) averaged over 1
minute.
LoadAvg5 double Number of processes in state R(runnable) or D(disk sleep) averaged over 5
minutes.
LoadAvg10 double Number of processes in state R(runnable) or D(disk sleep) averaged over 15
minutes .
ProcessCount string String containing number of currently runnable processes/threads and
number of scheduling processes/threads that currently exist on the system.
LastPidUsed long Pid of the process that was most recently created.
CurrentProcessCount long Number of currently runnable processes/threads.
ScheduledProcess‐ long Number of scheduling processes/threads that currently exist on the system.
Count

Disk information
Disk collects information about disk usage and provides the following subcategories:
• persistent_massdata
• persistent_appconfig
• persistent
• root
The following table shows the available variables for the category Disk information:

Variable Data type Address Description

Available long /disk/dev/<subcategory>/available Partition size in bytes.
Size long /disk/dev/<subcategory>/size Used space in bytes.
Used long /disk/dev/<subcategory>/used Available space in bytes.

Getting Connected to MindSphere

Getting Started, 08/2022 177
Configuring protocols
10.7 Overview of SYSTEM protocol

KERNEL information
The following table shows the available variables for the category KERNEL information:

Variable Data type Address

OsRelease string /kernel/osrelease
OsType string /kernel/ostype
Version string /kernel/version

Memory information
The following table shows the available variables for the category Memory information:

Variable Data type Address Restrictions

Active long /memory/active
Active(Anon) long /memory/active(anon)
Active long /memory/active
Active(Anon) long /memory/active(anon)
Active(File) long /memory/active(file)
AnonPages long /memory/anonpages
Available long /memory/available
Bounce long /memory/bounce
Buffers long /memory/buffers
Cached long /memory/cached
CommitLimit long /memory/commitlimit
Committed_As long /memory/committed_as
DirectMap4K long /memory/directmap4k
DirectMap4M long /memory/directmap4m
Dirty long /memory/dirty
AnonHugePages long /memory/anonhugepages Only supported by MindConnect
Nano.
CmaTotal long /memory/cmatotal Only supported by MindConnect
Nano.
CmaFree long /memory/cmafree Only supported by MindConnect
Nano.
HugePages_Total long /memory/hugepages_total Only supported by MindConnect
Nano.
HugePages_Free long /memory/hugepages_free Only supported by MindConnect
Nano.
HugePages_Rsvd long /memory/hugepages_Rsvd Only supported by MindConnect
Nano.
HugePages_Surp long /memory/hugepages_surp Only supported by MindConnect
Nano.
Hugepagesize long /memory/hugepagesize Only supported by MindConnect
Nano.
HighFree long /memory/highfree Only supported by MindConnect
IoT 2040.

Getting Connected to MindSphere

178 Getting Started, 08/2022
 Configuring protocols
10.7 Overview of SYSTEM protocol

Variable Data type Address Restrictions

HighTotal long /memory/hightotal Only supported by MindConnect
IoT 2040.
LowFree long /memory/lowfree Only supported by MindConnect
IoT 2040.
LowTotal long /memory/lowtotal Only supported by MindConnect
IoT 2040.
Inactive long /memory/inactive
Inactive(Anon) long /memory/inactive(anon)
Inactive(File) long /memory/inactive(file)
KernelStack long /memory/kernelstack
LowFree long /memory/lowfree
LowTotal long /memory/lowtotal
Mapped long /memory/mapped
MemFree long /memory/memfree
MemTotal long /memory/memtotal
MLocked long /memory/mlocked
NFS_Unstable long /memory/nfs_unstable
PageTables long /memory/pagetables
SHMem long /memory/shmem
SLab long /memory/slab
SReclaimable long /memory/sreclaimable
SUnreclaim long /memory/sunreclaim
SwapCached long /memory/swapcached
SwapFree long /memory/swapfree
SwapTotal long /memory/swaptotal
Unevictable long /memory/unevictable
VMAllocChunk long /memory/vmallocchunk
VMAllocTotal long /memory/vmalloctotal
VMAllocUsed long /memory/vmallocused
WriteBack long /memory/writeback
WriteBackTmp long /memory/writebacktmp

Network information
The following table shows the available variables for the category Network information:

Variable Data type Address Description

ArpFilter long /network/arpfilter
BusyPollRxPackets long /network/busypollrxpackets
BytesReceived long /network/bytesreceived Alias for InOctets.
BytesSend long /network/bytessend Alias for OutOctets.
DelayedAckLocked long /network/delayedacklocked Number of delayed acks further de‐
layed because of locked socket.

Getting Connected to MindSphere

Getting Started, 08/2022 179
Configuring protocols
10.7 Overview of SYSTEM protocol

Variable Data type Address Description

DelayedAckLost long /network/delayedacklost Number of times that quick ack
mode was activated.
DelayedAcks long /network/delayedacks Number of delayed acks sent.
EmbryonicRsTs long /network/embryonicrsts Number of resets received for em‐
bryonic SYN_RECV sockets.
InBcastOctets long /network/inbcastoctets
InBcastPkts long /network/inbcastpkts
IncePkts long /network/incepkts
IncSumErrors long /network/incsumerrors
Inect0Pkts long /network/inect0pkts
Inect1Pkts long /network/inect1pkts
InMcastOctets long /network/inmcastoctets
InMcastPkts long /network/inmcastpkts
InNoEctPkts long /network/innoectpkts
InNoRoutes long /network/innoroutes
InOctets long /network/inoctets Bytes received.
InTruncatedPkts long /network/intrucatedpkts Number of truncated packets re‐
ceived.
IpReversePathFilter long /network/ipreversepathfilter
ListenDrops long /network/listendrops Number of SYNs to LISTEN sockets
that were dropped.
ListenOverflows long /network/listenoverflows Number of times the listen queue of
a socket overflowed.
LockDroppedIcmps long /network/lockdroppedicmps ICMP packets dropped because sock‐
et was locked.
OfoPruned long /network/ofopruned Packets dropped from out-of-order
queue because of socket buffer over‐
run.
OutBcastOctets long /network/outbcastoctets
OutBcastPkts long /network/outbcastpkts
OutMcastOctets long /network/outmcastoctets
OutMcastPkts long /network/outmcastokts
OutOctets long /network/outoctets Bytes sent.
OutOfWindowIcmps long /network/outofwindowicmps ICMP packets dropped because they
were out-of-window.
PAWSActive long /network/pawsactive Active connections rejected because
of timestamp.
PAWSEstab long /network/pawsestab Packets rejected in established con‐
nections because of timestamp.
PAWSPassive long /network/pawspassive Passive connections rejected be‐
cause of timestamp.
PruneCalled long /network/prunecalled Packets pruned from receive queue
because of socket buffer overrun.
RcvPruned long /network/rcvpruned Packets pruned from receive queue.
SyncookiesFailed long /network/syncookiesFailed Number of invalid SYN cookies re‐
ceived.

Getting Connected to MindSphere

180 Getting Started, 08/2022
 Configuring protocols
10.7 Overview of SYSTEM protocol

Variable Data type Address Description

SyncookiesRecv long /network/syncookiesrecv Number of SYN cookies received.
SyncookiesSent long /network/syncookiessent Number of SYN cookies sent.
TCPAbortFailed long /network/tcpabortfailed Number of times unable to send RST
due to no memory.
TCPAbortOnClose long /network/tcpabortonclose Connections reset due to early user
close.
TCPAbortOnData long /network/tcpabortondata Connections reset due to unexpec‐
ted data.
TCPAbortOnLinger long /network/tcpabortonlinger Connections aborted after user
close in linger timeout.
TCPAbortOnMemory long /network/tcpabortonmemory Connections aborted due to memo‐
ry pressure.
TCPAbortOnSyn long /network/tcpabortonsync Connections reset due to unexpec‐
ted SYN.
TCPAbortOnTimeout long /network/tcpabortontimeout Connections aborted due to time‐
out.
TCPAckSkippedChal‐ long /network/tcpackskippedchallenge
lenge
TCPAckSkippedFin‐ long /network/tcpackskippedfinwait2
Wait2
TCPAckSkippedPAWS long /network/tcpackskippedpaws
TCPAckSkippedSEQ long /network/tcpackskippedseq
TCPAckSkippedSYN‐ long /network/tcpackskippedsynrecv
Recv
TCPAckSkippedTime‐ long /network/tcpackskippedtimewait
Wait
TCPAutoCorking long /network/tcpautocorking
TCPBacklogDrop long /network/tcpbacklogdrop
TCPChallengeAck long /network/tcpchallengeack
TCPDeferAcceptDrop long /network/tcpdeferacceptdrop
TCPDirectCopyFrom‐ long /network/tcpdirectcopyfrombacklog Bytes directly in process context
Backlog from backlog.
TCPDirectCopyFrom‐ long /network/tcpdirectcopyfrompre‐ Bytes directly received in process
Prequeue queue context from prequeue.
TCPDSACKIGNoRed‐ long /network/tcpdsackignorednoundo
NoUndo
TCPDSACKIGNoRedOld long /network/tcpdsackignoredold
TCPDSACKOfoRecv long /network/tcpdsackoforecv DSACKs for out of order packets re‐
ceived.
TCPDSACKOfoSent long /network/tcpdsackofosent DSACKs sent for out of order packets.
TCPDSACKOldSent long /network/tcpdsackoldsent DSACKs sent for old packets.
TCPDSACKRecv long /network/tcpdsackrecv DSACKs received.
TCPDSACKUndo long /network/tcpdsackundo Congestion window recovered with‐
out slow start using DSACK.
TCPFACKReorder long /network/tcpfackreorder Number of times reordering was de‐
tected using FACK.
TCPFastOpenActive long /network/tcpfastopenactive

Getting Connected to MindSphere

Getting Started, 08/2022 181
Configuring protocols
10.7 Overview of SYSTEM protocol

Variable Data type Address Description

TCPFastOpenActive‐ long /network/tcpfastopenactivefail
FailL
TCPFastOpenCookieR‐ long /network/tcpfastopencookiereqd
eqD
TCPFastOpenListenO‐ long /network/tcpfastopenlistenoverflow
verflow
TCPFastOpenPassive long /network/tcpfastopenpassive
TCPFastOpenPassive‐ long /network/tcpfastopenpassivefail
Fail
TCPFastRetrans long /network/tcpfastretrans Fast retransmits.
TCPForwardRetrans long /network/tcpforwardretrans Forward retransmits.
TCPFromZeroWindo‐ long /network/tcpfromzerowindowadv
wAdv
TCPFullUndo long /network/tcpfullundo Congestion windows fully recov‐
ered without slow start.
TCPHPAcks long /network/tcphpacks Predicted acknowledgments.
TCPHPHits long /network/tcphphits Packet headers predicted.
TCPHPHitsToUser long /network/tcphphitstouser Packet headers predicted and direct‐
ly queued to user.
TCPHYStartDe‐ long /network/tcphystartdelaycwnd
layCWND
TCPHYStartDelayDe‐ long /network/tcphystartdelaydetect
tect
TCPHYStartTrainCWND long /network/tcphystarttraincwnd
TCPHYStartTrainDetect long /network/tcphystarttraindetect
TCPKeepAlive long /network/tcpkeepalive Number of ACK packets sent to keep
TCP flow alive.
TCPLossFailures long /network/tcplossfailures Timeouts in loss state.
TCPLossProbeRecovery long /network/tcplossproberecovery
TCPLossProbes long /network/tcplossprobes
TCPLossUndo long /network/tcplossundo Congestion windows recovered
without slow start after partial ack.
TCPLostRetransmits long /network/tcplostretransmits Retransmits lost.
TCPMD5NotFound long /network/tcpmd5notfound
TCPMD5Unexpected long /network/tcpmd5unexpected
TCPMemoryPressures long /network/tcpmemorypressures Number of times TCP ran low on
memory.
TCPMINTTLDrop long /network/tcpminttldrop
TCPMTUPFail long /network/tcpmtupfail
TCPMTUPSuccess long /network/tcpmtupsuccess
TCPOfoDrop long /network/tcpofodrop
TCPOfoMerge long /network/tcpofomerge
TCPOfoQueue long /network/tcpofoqueue
TCPOrigDataSent long /network/tcporigdatasent
TCPPartialUndo long /network/tcppartialundo Congestion windows partially recov‐
ered using Hoe heuristic.

Getting Connected to MindSphere

182 Getting Started, 08/2022
 Configuring protocols
10.7 Overview of SYSTEM protocol

Variable Data type Address Description

TCPPrequeued long /network/tcpprequeued Packets directly queued to recvmsg
prequeue.
TCPPrequeueDropped long /network/tcpprequeuedropped Packets dropped from prequeue.
TCPPureAcks long /network/tcppureacks Acknowledgments not containing
data payload received.
TCPRcvCoalesce long /network/tcprcvcoalesce
TCPRcvCollapsed long /network/tcprcvcollapsed Packets collapsed in receive queue
due to low socket buffer.
TCPRenoFailures long /network/tcprenofailures Timeouts after reno fast retransmit.
TCPRenoRecovery long /network/tcprenorecovery Times recovered from packet loss
due to fast retransmit.
TCPRenoRecoveryFail long /network/tcprenorecoveryfail Classic Reno fast retransmits failed.
TCPRenoReorder long /network/tcprenoreorder
TCPReqQFullDoCoo‐ long /network/tcpreqqfulldocookies
kies
TCPReqQFullDrop long /network/tcpreqqfulldrop
TCPRetransFail long /network/tcpretransfail
TCPSACKDiscard long /network/tcpsackdiscard
TCPSACKFailures long /network/tcpsackfailures Timeouts after SACK recovery.
TCPSACKMerged long /network/tcpsackmerged
TCPSACKRecovery long /network/tcpsackrecovery Times recovered from packet loss by
selective acknowledgements.
TCPSACKRecoveryFail long /network/tcpsackRecoveryFails SACK retransmits failed.
TCPSACKReneging long /network/tcpsackreneging Bad SACK blocks received.
TCPSACKReorder long /network/tcpsackreorder Number of times reordering was de‐
tected using SACK.
TCPSACKShifted long /network/tcpsackshifted
TCPSACKShiftFallback long /network/tcpsackshiftfallback
TCPSchedulerFailed long /network/tcpschedulerfailed Times receiver scheduled too late for
direct processing.
TCPSlowStartRetrans long /network/tcpslowstartretrans Retransmits in slow start.
TCPSpuriousRTOS long /network/tcpspuriousrtos
TCPSpuriousRTXHost‐ long /network/tcpspuriousrtxhostqueues
Queues
TCPSYNChallenge long /network/tcpsynchallenge
TCPSYNRetrans long /network/tcpsynretrans
TCPTimeouts long /network/tcptimeouts Other TCP timeouts.
TCPTimeWaitOverflow long /network/tcptimewaitoverflow
TCPToZeroWindowAdv long /network/tcptozerowindowadv
TCPTSReorder long /network/tcptsreorder Number of times reordering was de‐
tected using timestamp.
TCPWantZeroWindo‐ long /network/tcpwantzerowindowadv
wAdv

Getting Connected to MindSphere

Getting Started, 08/2022 183
Configuring protocols
10.8 Overview of Rockwell protocol

Variable Data type Address Description

TCPWinProbe long /network/tcpwinprobe Number of ACK packets to be sent at
regular intervals to make sure a re‐
verse ACK packet opening back a
window has not ben lost.
TW long /network/tw
TWKilled long /network/twkilled TCP sockets finished time wait in
slow timer.
TWRecycled long /network/twrecycled Time wait sockets recycled by time‐
stamp.

10.8 Overview of Rockwell protocol

The following image shows the data source input window for the Rockwell protocol:

Getting Connected to MindSphere

184 Getting Started, 08/2022
 Configuring protocols
10.8 Overview of Rockwell protocol

Rockwell data source parameter

In order to connect a Rockwell device, you need to select the Rockwell protocol and enter the
following data source parameters:

Parameter Description
CPU type Shows available CPU types:
• COMPACT_LOGIX
• CONTROL_LOGIX
• MICRO_800
• OTHER_CPU
Currently not available:
• FLEX_LOGIX
• MICRO_LOGIX
• SOFT_LOGIX
• PLC5
• SLC500
Note: The CONTROL_LOGIX and MICRO_800 CPU types are
supported from the version MindConnect Nano/IoT2040
V03.04.02.06 b002.
IP address IP address of the Rockwell controller.
Route parameters Here you can define the routing path parameters - like rack,
slot, node, and/or ControlNet port numbers - needed to access
the controller (default: 1,0).

Rockwell data point parameter

In order to collect the data of your Rockwell device, you must add new data points.

Getting Connected to MindSphere

Getting Started, 08/2022 185
Configuring protocols
10.8 Overview of Rockwell protocol

The following table shows the data point parameter:

Parameter Description
Data Type Data type supported by backend (e.g. INT).
STRING data type is currently not supported.
Tag Name of the tag that has to be recorded.

The following table shows the recommended data type selection:

Rockwell data type Length Data range1) MindSphere data type

BOOL 1 bit 0 or 1 BOOLEAN
SINT 1 byte -128…+127 INT
INT 2 bytes -32,768…+32,767 INT
DINT 4 bytes -2,147,483,648… INT
+2,147,483,647
REAL 4 bytes • -3.40282347E38…-1.175 DOUBLE
49435E-38 (negative val‐
ues)
• 0
• -1.17549435E-38-…
3.40282347E38 (positive
values)
1)
Values have been taken from Logix 5000 Controllers I/O and Tag Data Programming Manual

Note
PCL data types
Currently only these PLC data types are supported.

Getting Connected to MindSphere

186 Getting Started, 08/2022
 Configuring protocols
10.9 Overview of S7+ protocol

10.9 Overview of S7+ protocol

The following image shows the data source input window for the S7+ protocol:

In order to connect a S7+ device, you need to select the S7+ protocol and enter the following
data source parameters:

Parameter Description
IP Address IP address or hostname of the S7+ device
PLC Type The following PLCs are supported:
• S7-1200
• S7-1500
• S7-1500 Software Controller
• ET200SP
• PLCSIM (Advanced)

Note
Maximum limit for the number of connections is 8.

S7+ data point parameter

In order to collect the data of your S7+ device, you must add new data points.
The following image shows the data point parameter window:

Getting Connected to MindSphere

Getting Started, 08/2022 187
Configuring protocols
10.9 Overview of S7+ protocol

The following table shows the parameter of the S7+ data point window:

Parameter Description
Datapoint type The following datapoint types are supported:
• int
• long
• double
• boolean
• string
Datapoint Address The PLC connection must be available (symbolic
addressing is used).

Getting Connected to MindSphere

188 Getting Started, 08/2022
 Configuring protocols
10.9 Overview of S7+ protocol

Parameter Description
Type Transformation The transformation type is the interpretation of da‐
ta of the peripheral device.
For the datatypes above the following transforma‐
tion types are available (see also table below):
• int: UINT, USINT, UDINT, SINT, INT, DINT, WORD,
BYTE, DWORD
• long: UINT, USINT, UDINT, ULINT, SINT, INT,
DINT, LINT, WORD, BYTE, DWORD, LWORD,
DATE, DATETIME, TIME, TIME_OF_DAY, LDATE‐
TIME, LTIME, LTOD, DTL, S5TIME
• double: REAL, LREAL
• boolean: BOOL
• string: STRING, WSTRING, DATE, DATETIME,
TIME, TIME_OF_DAY, LDATETIME, LTIME, LTOD,
DTL, S5TIME
Data Acquisition Mode The following modes are supported:
• READ
• WRITE
• READ and WRITE

The following table shows the transformation type of the S7+ data point window:

Transformation type Description

BOOL Boolean
BYTE 8 bit integer unsigned
WORD Bit field (16 bit)
DWORD Bit field (32 bit)
LWORD Bit field (64 bit)
USINT 8 bit integer unsigned
UINT 16 bit integer unsigned
UDINT 32 bit integer unsigned
ULINT 64 bit integer unsigned
SINT 8 bit integer signed
INT 16 bit integer signed
DINT 32 bit integer signed
LINT 64 bit integer signed
REAL 32 bit float
LREAL 64 bit float
DATE Date, number of days since 1.1.1970
DATETIME Date and time
TIME Time in milliseconds (32 bit), value range from
-24d 20h 31m 23s 648ms to +24d 20h 31m 23s
647ms

Getting Connected to MindSphere

Getting Started, 08/2022 189
Configuring protocols
10.10 Overview of Fanuc Focas protocol

TIME_OF_DAY Number of milliseconds since start of the day (32

bit)
LDATETIME Date and time
LTIME Time in nanoseconds (64 bit), value range from
-106751d 23h 47m 16s 854ms 775us 808ns to
+106751d 23h 47m 16s 854ms 775us 807ns
LTOD Number of milliseconds since start of the day (64
bit)
DTL 12 Byte struct, value range from
1970-01-01-00:00:00.0 to
2554-12-31-23:59:59.999999999 (steps in nano‐
seconds)
S5TIME Time in milliseconds (16 bit), value range from 0h
0m 0s 0ms to 2h 46m 30s 0ms
STRING String (8 bit characters)
WSTRING String (16 bit characters)

10.10 Overview of Fanuc Focas protocol

The following image shows the data source input window for the Fanuc Focas protocol:

The following device types are supported:

• FS31i-A
• FS35i-B
• FS0i-D
• FS32i-B

Getting Connected to MindSphere

190 Getting Started, 08/2022
 Configuring protocols
10.10 Overview of Fanuc Focas protocol

• PMi-A
• FS30i-B
• FS0i-F Plus iHMI
• FS0i-F
• FS0i-F Plus
• FS30i-B 32AX
• FS30i-B 48AX
• FS30i-B iHM
• FS30i-B Plus
• FS31i-B Plus
• FS31i-B
• FS31i-B5 Plus
• FS31i-B5
• FS31i-LB
• FS31i-PB
• FS31i-WB
• FS32i-B Plus
In order to connect a Fanuc Focas device, you need to select the Fanuc Focas protocol and enter
the following data source parameter:

Parameter Description
IP Address The IP address (and optional port – separated by ‘:’ )
of the device must be filled in Datasource.

Getting Connected to MindSphere

Getting Started, 08/2022 191
Configuring protocols
10.10 Overview of Fanuc Focas protocol

Fanuc Focas data point parameter

The following image shows the Fanuc Focas data point parameter window:

Follow the simple rules to fill the parameters for the Fanuc Focas:
1. Choose a predefined component for the Datapoint Address.
2. For every “*” or “?” in the listed item an extra field is displayed, which must be filled as per
above example screenshot.
3. The field “Datapoint Address” is the final address string and displayed read only. It is the result
of selected address with combo boxes and user defined parts.
4. The fields “Type” and “Type Transformation” are limited to the possible types, depending on
the selection of the address component.

The following table shows the parameter of the all components, including possible datatype,
explanation and example:

Address Data type Comment

position.<axisnumber> • int32 The function can read the posi‐
Example: position. *(0...99) tion of a defined axis or of all axis.
• default supported
Note: When reading ALL_AXIS
the output structure is model de‐
pendent.
programblock.<number> • string(1) The function reads always both
number values: items.
• int32(2)
1…Program name • default supported
2…Block number

Getting Connected to MindSphere

192 Getting Started, 08/2022
 Configuring protocols
10.10 Overview of Fanuc Focas protocol

alarmstring • string These two alarm functions are

mapped to a string.
• default supported
pmcdata.<adr_type>. <startad‐ Depends on transformation: With this function you can read
dress> • int8 different type of data from PMC
Example: pmcdata. *(0...99; address range.
• int16
0...65535) The "adrtype" specifies different
• int32 address ranges. For the various
• float models of CNC machines differ‐
ent ranges of different size exist.
• double
It is the responsibility of the user
to configure the address in the
correct range. The driver will not
check range depending on the
model.
modal.<blocknumber>.<num‐ • int32(1) This function call is rather com‐
ber> plex and comprises a lot or varia‐
• uint8(2)
number values: tion. The Fanuc Focas driver only
• uint8(3) supports the type = 108 variant
1…data, *(0...3)
• default supported for current active T code. The re‐
2…flag1, *(0...3) sulting data comprises a "4-
3…flag2, *(0...3) byte"data field and two "1-byte"
flag fields.
The interpretation of these fields
is machine model dependent,
but this must be done by the ap‐
plication.
statinfo.<number> • int16 All elements are read with one
number values: function call.
• default supported
*(0...99) see comment for value There are several more but ac‐
cording to requirements they are
meaning.
not needed.
1. hdck: Status of manual han‐
dle retrace
2. tmmode: T/M mode selection
3. aut: AUTO/MANUAL mode se‐
lection
4. run: Status of automatic op‐
eration
5. motion: Status of axis move‐
ment,dwell
6. mstb: Status of M,S,T,B func‐
tion
7. emergency: Status of emer‐
gency
8. alarm: Status of alarm
9. edit: Status of program edit‐
ing

Getting Connected to MindSphere

Getting Started, 08/2022 193
Configuring protocols
10.10 Overview of Fanuc Focas protocol

param.<paramnumber>. Depends on transformation: The parameters are dependent

<axisnumber> • boolean on the axis or axis independent
(axisnumber 0).
Example: • int8
For axis specific parameter, it is
param. *(0...32767;0...99 ) • int16 possible to read the parameter
• int32 for all axis or only for a specific
axis.
diag.<diagnumber>. Depends on transformation: There are diagnosis values with
<axisnumber>, • boolean the axis dependent, and axis in‐
*(0...32767;0...99 ) dependent
• int8
(axisnumber 0).
• int16
For axis specific diagnosis values,
• int32 it is
• float possible to read the values for all
axis
or only for a specific axis.
feedrate • int32 One function for one value.
• default supported
spindlespeed • int32 One function for one value.
• default supported
sysinfo • string Maximum length of read value is
20 characters. for‐
mat:<cnc_type> <series> <ver‐
sion> <mt_type>

Note
You need to ensure the parameters entered are valid for Fanuc Focas protocol.

Getting Connected to MindSphere

194 Getting Started, 08/2022
 Configuring protocols
10.11 Overview of Sinumerik protocol

10.11 Overview of Sinumerik protocol

The following image shows the data source input window for the Sinumerik protocol:

Note
The supported device types are S7 SINUMERIK, example S7 840D sl.

In order to connect a Sinumerik device, you need to select the Sinumerik protocol and enter the
following data source parameters:

Parameter Description
IP Address IP address of the device.
Slot Number Choose the correct slot number, where the “NC
unit” of the device is mounted.

Getting Connected to MindSphere

Getting Started, 08/2022 195
Configuring protocols
10.11 Overview of Sinumerik protocol

Sinumerik data point parameter

The following image shows the data point parameter window:

The following table shows the parameter of the Sinumerik data point window:

Parameter Description
Datapoint Address Peripheral address strings in WinCC OA must be en‐
tered in a symbolic manner using the Siemens BTSS
format.
Examples:
S7Conn1./Nck/Spindle/speedOvr[1]
NCK2.@SinumerikErrors@
Type The following datapoint types are supported:
• int
• long
• double
• boolean
• string

Getting Connected to MindSphere

196 Getting Started, 08/2022
 Configuring protocols
10.12 Overview of IEC61850 protocol

Parameter Description
Type Transformation For the above datatypes, the following transforma‐
tion types are available (see also table below):
• int: INT16, INT32, UINT16, UINT32, BYTE
• long: INT16, INT32, UINT16, UINT32, BYTE, DA‐
TETIMELONG
• double: FLOAT, DATETIMELONG
• boolean: BIT
• string: STRING, DATETIMELONG, BLOB
Data Acquisition Mode The following modes are supported:
• READ
• WRITE
• READ and WRITE

The following table shows the transformation type of the Sinumerik data point window:

Transformation type Description

UNDEFINED Default
INT16 16 Bit Integer signed
INT32 32 Bit Integer signed
UINT16 16 Bit Integer unsigned
BYTE Byte
FLOAT Floating-point value
BIT Boolean
STRING Text
UINT32 32 Bit Integer unsigned
DATETIME Date/Time variable (used for S7 300 and S7 400
models)
BLOB Blob
BITSTRING Bit pattern
DATETIMELONG Date/Time variable (used for S7 1200 models)

10.12 Overview of IEC61850 protocol

IEC61850 defines an architecture to meet the needs of electrical substation automation. It
defines a data model and the communication services for the interaction with and between the
elements of a substation such as feeders, breakers, protection devices, etc.
The following image shows the data source input window for the IEC61850 protocol:

Getting Connected to MindSphere

Getting Started, 08/2022 197
Configuring protocols
10.12 Overview of IEC61850 protocol

In order to connect a IEC61850 device, you need to select the IEC61850 protocol and enter the
following data source parameters:

Parameter Description
SCD File Choose a valid SCD file. It contains the connection
details (IP address, server name, access point) and
the data (logical nodes, data types, data points, …).
The SCD File must have a valid extension: *.xml,
*.zip, *.tgz, *.tar.gz.
Server Name Name of the Intelligent Electronic Devices (IED)
must match to the SCD file.
Access point name Name of the access point must match to the SCD
file.

Note
• The IED name within the SCD file must be set to “MindSphereClient” or to the serial number
of the device.
• Server Name and Access point must match with the data in the SCD file. It is necessary for a
double check of the configuration.

Getting Connected to MindSphere

198 Getting Started, 08/2022
 Configuring protocols
10.12 Overview of IEC61850 protocol

IEC61850 data point parameter

The following image shows the data point parameter window:

The following table shows the parameter of the IEC61850 data point window:

Parameter Description
Datapoint Address The browse string, as defined in the SCD file.
Example:
MSC_SRV01CTRL/ATCC1$ST$HiTapPos$stVal
Type The following datapoint types are supported:
• int
• long
• double
• boolean
• string

Getting Connected to MindSphere

Getting Started, 08/2022 199
Configuring protocols
10.13 Overview of MTConnect protocol

Parameter Description
Type Transformation For the above datatypes, the following transformation types
are available (see also table below):
• int: INT8, INT16, INT32, INT64, UINT8, UINT16, UINT32
• long: INT8, INT16, INT32, INT64, UINT8, UINT16, UINT32,
BITSTRING, TIMESTAMP
• double: FLOAT32, FLOAT64, INT32, INT64, UINT8, UINT16,
UINT32, BITSTRING, TIMESTAMP
• boolean: BOOL
• string: OCTET_STRING64, VISIBLE_ STRING64, VISIBLE_
STRING255, TIMESTAMP
Data Acquisition Mode The following modes are supported:
• READ (spontaneous / reports)
• WRITE
• READ and WRITE

10.13 Overview of MTConnect protocol

MTConnect is a manufacturing technical standard to retrieve process information from
numerically controlled machine tools.
The following image shows the data source input window for the MTConnect protocol:

Getting Connected to MindSphere

200 Getting Started, 08/2022
 Configuring protocols
10.13 Overview of MTConnect protocol

In order to connect a MTConnect device, you need to select the MTConnect protocol and enter
the following data source parameter:

Parameter Description
URL The URL of the MTConnect device. The port is also part of the
URL.
Example:
http://mtconnect.mazakcorp.com:5610/

MTConnect data point parameter

The following image shows the MTConnect data point parameter window:

Getting Connected to MindSphere

Getting Started, 08/2022 201
Configuring protocols
10.13 Overview of MTConnect protocol

The following table shows the parameter of the MTConnect data point window:

Parameter Description
Datapoint Address ID of the DataItem from the MTConnect device.
Example (excerpt of an xml-file):
<DataItem category="SAMPLE"
coordinateSystem="MACHINE" id="xpm"
name="Xabs" nativeUnits="MILLIMETER"
subType="ACTUAL" type="POSITION"
units="MILLIMETER"/>
→ Datapoint Address: xpm
Type The following datapoint types are supported:
• int
• long
• double
• boolean
• string

Getting Connected to MindSphere

202 Getting Started, 08/2022
Firmware update for Mindconnect Nano / IOT 2040 11
11.1 Manual firmware update of MindConnect Element
To prepare your MindConnect Element for MindSphere V3 please follow the next two steps:
• Set MindConnect to factory settings
• Load new firmware on your MindConnect Element

Set MindConnect to factory settings

Note
This procedure is only necessary for boxes that were already connected to MindSphere V2 (SAP).
V1 cannot be upgraded.

1. Set the MindConnect back to factory settings.

2. Create a “ConBox_Commands.json” file with your favorite code editor.
Content of "ConBox_Commands.json":
{
"Commands": [
{
"Cmd": "DoFactoryReset",
"DeviceID": "MindConnectID"
}
]
}
Note
MindConnectID has to be replaced with the serial number of the device.

3. Copy the extracted/unzipped fw.tar file to a USB stick (fat32 formatted).

4. Plug the USB stick in the MindConnect hardware.
– The MindConnect will be restarted automatically.
– The network and SAL settings will be reset to their initial state on MindConnect Element.
– All SAL and script logging files will be deleted.

Getting Connected to MindSphere

Getting Started, 08/2022 203
Firmware update for Mindconnect Nano / IOT 2040
11.2 Firmware update in Asset Manager

Load new firmware on your MindConnect Element

1. Download the firmware ZIP file from Siemens Industry Online Support Page.
– Firmware download MindConnect Nano (https://
support.industry.siemens.com/cs/ww/en/view/109745561)
– Firmware download MindConnect IoT2040 (https://
support.industry.siemens.com/cs/ww/en/view/109745562)
2. Unzip the firmware on your local machine.
3. Copy the unzipped files to a USB stick.
4. Insert the USB stick into the MindConnect Element and wait until the firmware update is
complete.
– Update carried out: ERROR LED flashes orange
– MindConnect Element reboots
– MAINT LED flashes orange for a few seconds
– RUN LED orange (not connected to MindSphere)
5. Disconnect the USB stick.

11.2 Firmware update in Asset Manager

In Asset Manager you can update the firmware of your MindConnect Element.

NOTICE
Outdated version
Please keep your firmware always updated.

NOTICE
Data loss
Please note that data loss can occur during the time of the firmware update. The amount of data
loss depends on the reading and uploading cycle.

To perform a firmware update, follow these steps:

1. Select the asset in the "Asset" tab.
2. Open the MindConnect plugin.
3. Click next to "Firmware" on the button .
4. Accept the terms and conditions.
5. To select a firmware release click "Choose another firmware release".
– The "select firmware" dialog appears.
6. Select product and available version and click "Accept".
7. To update your firmware click "Update your firmware".

Getting Connected to MindSphere

204 Getting Started, 08/2022
 Firmware update for Mindconnect Nano / IOT 2040
11.2 Firmware update in Asset Manager

Note
Incomplete firmware update
If the connection is interrupted while the new firmware is being downloaded, note that the
downloaded content might be lost if the connection cannot be recovered via the box.
For example, if the connection is interrupted while 50% of the firmware are downloaded, the
process might be canceled. In that case you have to click firmware update on the user interface
to restart the process. It is still possible to do manual firmware updates via USB stick.

Canceling an Online Firmware update

If the firmware update process is triggered from UI then the cancel button will be activated. By
clicking the button the ongoing operation will be interrupted and cancelled.

Note
The firmware update operation can take longer time depending on the network quality.

Once the cancellation operation successful, it is possible to re-trigger the online firmware
update.

Getting Connected to MindSphere

Getting Started, 08/2022 205
Firmware update for Mindconnect Nano / IOT 2040
11.2 Firmware update in Asset Manager

Firmware updates for multiple devices

In Asset Manager under "Connectivity Management" tab, you can trigger firmware updates for
multiple devices using "Mass update" selection. This allows you to update the selected firmware
devices like, MindConnect Nano, MindConnect Iot2040 and MindConnect Software Agent.
To update the firmware for multiple devices, select assets in the “Connectivity Management” tab
under "Mass Update" and click "Update Firmware".

Getting Connected to MindSphere

206 Getting Started, 08/2022
 Firmware update for Mindconnect Nano / IOT 2040
11.3 Automatic firmware update of MindConnect Element

11.3 Automatic firmware update of MindConnect Element

In Asset Manager, the firmware of your MindConnect Element is updated by both manually and
automatically. If the auto firmware update option is enabled, MindConnect Element is
automatically updated with the new version when it is released.

Note
• If the system is already updated with a new version available for the device and the auto
firmware update option is enabled later, MindConnect Element will be not triggered to
update the previous released version. Auto firmware update will work only for further
releases.
• If the auto firmware update is enabled, manual firmware update operation is not allowed.
• If the firmware update job is in progress triggered by the auto firmware update, then "Cancel"
button will be activated. By clicking "Cancel" button, the ongoing operation will be
interrupted and cancelled. If an auto firmware update trigger is cancelled, it will not be
tirggered again for the same firmware release.

To perform auto firmware update, follow these steps:

1. Select the asset in the "Asset" tab.
2. Open the MindConnect plugin.
3. Click next to "Firmware" on the button .
4. Click on “Auto FW Update” checkbox in “Firmware Settings” section.

5. Accept the terms and conditions for all releases.

6. Click "Save" button to save the changes .

Getting Connected to MindSphere

Getting Started, 08/2022 207
Firmware update for Mindconnect Nano / IOT 2040
11.3 Automatic firmware update of MindConnect Element

Getting Connected to MindSphere

208 Getting Started, 08/2022
Remote functions 12
12.1 Remote restart
By using the remote restart function in the MindConnect Element Plugin, you can restart your
device without having to use the on / off button on the device. This makes it easier to restart
boxes that are difficult to reach.
If an active restart process is in progress, no further process can be created in the user interface.
The following picture shows the restart device button in the MindConnect Element plugin
screen.

12.2 Send commands

The commanding functionality provides you to send data directly from cloud applications and
from MindSphere applications to your devices. The first example of this functionality was remote
restart. The send command functionality is extended to cover writing data to the field via S7 and
OPC UA plugins. It is possible to write data in the following data types:
• Integer
• Long

Getting Connected to MindSphere

Getting Started, 08/2022 209
Remote functions
12.2 Send commands

• Double
• Boolean
• Float
• String (OPC UA only)

WARNING
It is important to know the limitations of your devices, before you set a specific value for
a datapoint.
Failure to check value ranges within your controllers may result in damages to your devices. We
recommend to set and verify limits within your local program to block values out of device
limits.

User interface
The following screen shows the data source configuration screen:

The type column provides the following values:

Value Description
Read Within this type you can only collect data.
Write Within this type you can only send data.
Read&Write Within this type you can collect and send data.

The "Send a value" button is only visible on writeable data point types. This creates a command
instance on cloud platform on Edge area for execution.
The "Log" column shows the general result of the latest operation made on the data point itself.
For more information you can click on the data point name on the left hand side and view the
details of the executed command.
The following screen shows the "Send value" detailed screen with the entry of the value to be
written to the data point:

Getting Connected to MindSphere

210 Getting Started, 08/2022
 Remote functions
12.2 Send commands

Commanding Device via API

In order to command the device, there are 3 critical id’s that needs to be get from the system.
Those id’s are deviceId, datasourceId and datapointId. To get the id’s, follow these steps:

Getting deviceId
You can "GET" the "id" of your device using the "id" of your asset with a below request.
/api/devicemanagement/v3/devices?assetId={id}
In the response, device id will be displayed. For more information, see Device Management
Service (https://documentation.mindsphere.io/MindSphere/apis/edge-devicemanagement/api-
devicemanagement-api.html) documentation.

Getting datasourceId and datapointId

In the second step, we need to make a request to mindconnectdevicemanagment service to
"GET" the id of the datasource and the datapoint.
/api/mindconnectdevicemanagement/v3/devices/{assetId}/dataConfig
In the response of this request the id’s will be displayed and should be exdtracted for the final api
call. Below is the response for the above request. The "id" field in dataSource item represents the
datasourceId and the dataPointId represents the "id" of the datapoint.

{
"id": "392fe515-5b61-439d-814d-b37b9fa7ef7b",
"agentId": "25137086d6c141b682d9fcb135c8168e",
"uploadCycle": "10",
"configurationId": "1650623649731",
"dataSources": [
{
"id": "326340f5-88c6-409a-a5d9-03e95ce7af94",

Getting Connected to MindSphere

Getting Started, 08/2022 211
Remote functions
12.2 Send commands

"name": "WindTurbine",
"description": "datasource_description",
"protocol": "S7",
"readCycleInSeconds": "60",
"protocolData": {
"ipAddress": "192.168.1.1",
"manualRackAndSlot": "Automatic",
"rackNumber": "0",
"slotNumber": "2"
},
"dataPoints": [
{
"id": "6efc38d1-b4e7-4e6e-98ce-cb6b3b3f36b2",
"dataPointId": "36cd56f91c154",
"name": "Energy",
"description": "description",
"unit": "kw",
"dataType": "DOUBLE",
"dataPointData": {
"address": "DB1.DBD1",
"hysteresis": "0",
"onDataChanged": false,
"acquisitionType": "READ"
}
}
]
}
]
}
The final api call is to deploymentworkflow service. For more information, see Deployment
Workflow Service (https://documentation.mindsphere.io/MindSphere/apis/edge-
deploymentworkflow/api-deploymentworkflow-api.html). A "POST" request to the below
endpoint should be made,
/api/deploymentworkflow/v3/instances
The body of the request should be, as below example:

{
"deviceId": "f5168f95-2cc6-4a2c-b598-bfd5dadfc4df",
"model": {
"key": "mdsp-core-commandDispatcher"
},
"data": {
"type": "datapoint-write",
"createdBy": "[email protected]",
"version": "v1.0",
"to": "some_protocol",
"payload": {
"desiredValue": "7",
"dataSourceId": "10d9c36c-69f7-4c33-8624-f67537e142a4",
"dataPointId": "b932b9da42f04",

Getting Connected to MindSphere

212 Getting Started, 08/2022
 Remote functions
12.2 Send commands

"protocol": "some_protocol"
}
}
}
In the below list, there are some fields which require certain data only:

Field Name Allowed Values

to OPCUA, S7
protocol OPCUA, S7
version v1.0
type datapoint-write
key mdsp-core-commandDispatcher

The following list shows the details of the commanding functionality:

• If command operation fails, then the box will set the state of the job to "FAILED" indicating
some more details in the message column of the command itself. On the other hand, the
state of the job will be "EXECUTED", if the command operation succeeded. These updated
states can be checked via Deployment Workflow’s endpoint GET /instances too.
• The commanding operations are executed in a chronological order, starting first from the
oldest to the newest. The execution of those commands is synchronized with the
configuration updates to avoid inconsistencies between the device side content and cloud
side content.
– In order to keep the device configuration content up to date with the backend side do not
forget to click the "Apply changes" button. Otherwise, some of your commands will get
rejected by the device side, for example a command is sent for a "READ" typed datapoint.
• Boolean type is only working strictly for ‘true’ and ‘false’ values.

Getting Connected to MindSphere

Getting Started, 08/2022 213
Remote functions
12.2 Send commands

Getting Connected to MindSphere

214 Getting Started, 08/2022
Visual analysis of assets in Fleet Manager 13
13.1 Overview visual analysis
This chapter provides a brief overview of the visual analysis of your asset, which was configured
in Asset Manager. It gives you a brief overview of how to monitor the data of a selected asset in
Fleet Manager. For more information refer to the MindSphere documentation.

Requirements
• MindConnect Nano/IoT2040 is connected to the internet and onboarded.
• Aspects and variables are configured in Asset Manager.

Procedure
To see the visualized data in Fleet Manager, you can proceed as follows:
1. Select a required asset to view its data. (Page 215)
2. View aspects of a selected asset. (Page 217)
3. View events of a selected asset. (Page 219)

13.2 Selecting assets

Fleet Manager offers the means for viewing and simple searching/sorting/filtering of assets. You
access Fleet Manager via the MindSphere Launchpad.

Requirement
You have created assets in Asset Manager.

Procedure
To select an asset in Fleet Manager, proceed as follows:
1. In the MindSphere Launchpad, click "Fleet Manager".
The overview page of Fleet Manager appears and you can see the list with assets on the left-
hand side.
2. To view an asset, select between "Fleet" or "Hierarchy" views.

Getting Connected to MindSphere

Getting Started, 08/2022 215
Visual analysis of assets in Fleet Manager
13.2 Selecting assets

3. To see the map view, click .

4. To quickly find the created asset e.g. "Wind turbine", choose one of the following features:
– Select the asset that is linked to your aspect and asset type.
– Enter a required text in the searching box.

Figure 13-1 Finding the asset via the searching text

Getting Connected to MindSphere

216 Getting Started, 08/2022
 Visual analysis of assets in Fleet Manager
13.3 Viewing aspects

– Or click the “Filter & sort" button to restrict the asset list.

Figure 13-2 Finding the asset "Filter & sort"

Result
The navigation displays the selected asset that corresponds to the search or filter parameters.

13.3 Viewing aspects

After you have selected an asset to be monitored, you can open an extension to see the status
of its single aspects or events in detail in the right column. To view variables of aspects Fleet
Manager offers you the "Aspects" extension.

Requirement
You have created aspects in Asset Manager.

Getting Connected to MindSphere

Getting Started, 08/2022 217
Visual analysis of assets in Fleet Manager
13.3 Viewing aspects

Procedure
To view variables of aspects in the "Aspect" extension, proceed as follows:
1. In the right-hand side of Fleet Manager, click the "Aspects" extension icon.
– The "Aspects" extension opens on the right-hand side.
2. Select and expand an aspect e.g. "Generator":
– Aspect "Generator" is opened.
– You can set a time frame (Time picker: day, week, and month) and see the variables, which
you want to monitor.
3. Select the dates from the last week in the calendar.
4. To show the exact measured values, move the mouse over the graph.

Result
The "Aspects" extension shows the chosen aspect of an asset.

Getting Connected to MindSphere

218 Getting Started, 08/2022
 Visual analysis of assets in Fleet Manager
13.4 Viewing events

13.4 Viewing events

All events are displayed in an overview of the "Events" extension and you can influence the view
through different filter criteria. You can also assign a specific status to events. You can find
additional information on creating events in the Fleet Manager documentation.

Requirements
• You have created assets in Asset Manager.
• Events have been created and are already available.

Procedure
1. Select the required asset e.g. “Wind turbine", in the left-hand side of the window.
2. In the right-hand side, click the "Events" extension icon.
3. Click the tab "Events".

Result
The events data of asset "Wind turbine" is displayed.

Note
It can take up to 15 minutes for the events to arrive in MindSphere.

Getting Connected to MindSphere

Getting Started, 08/2022 219
Visual analysis of assets in Fleet Manager
13.4 Viewing events

Getting Connected to MindSphere

220 Getting Started, 08/2022
Appendix A
A.1 Data center locations
You can license MindSphere on different regions in various data centers.
The following table shows the regions and the data center location for each region:

Region Data center location MindSphere infrastructure

provider
Europe 1 Frankfurt, Germany (eu1) Amazon Web Services
Europe 2 Amsterdam, Netherlands (eu2) Microsoft Azure
China 1 Shanghai, China (cn1) Alibaba Cloud

A.2 Quality code settings

A.2.1 Using quality code

The quality code measures the quality of the connection from a data provider to the
MindConnect Element. In MindSphere you can enable or disable the transmission of the quality
code.
You can switch the quality code on or off:
• TRUE: The quality code is transferred with the data to MindSphere.
• FALSE: The quality code is not transferred with the data to MindSphere. Erroneous or bad
transmissions and signal losses can not be detected by MindSphere. Instead the value 0 will
be stored for the missing data.
You can find more information about the corresponding values in chapter Quality codes OPC UA
and S7 protocol (Page 222).
Within a MindConnect Element the quality code is set by default to on. You can activate or
deactivate the quality code using the Time Series Service API (https://developer.mindsphere.io/
apis/iot-iottimeseries/api-iottimeseries-overview.html).
If you export the time series value (e.g. with Fleet Manager) you can see the data points with its
connected quality code. This helps you to analyze time ranges where no data is available. This
will avoid drawing false conclusions from a null value.
The following graphic shows a dataflow overview of the quality code:

Getting Connected to MindSphere

Getting Started, 08/2022 221
Appendix
A.2 Quality code settings

MindSphere - Quality code

The time series data includes the value and the quality code.
Mindsphere IoT storage Time Series API

Export: The data can be exported via

API or Fleet Manager including value
value of quality code and quality code.

MindConnect Nano /IoT

Data provider client

Type

Data provider server

e. g. S7 PLC, OPC UA Server

If the data provider (e.g. S7 PLC, OPC UA Server) is not available, the MindConnect Element or
the data provider client will send up a "0" with a quality code. The value of the quality code shows
that this is not a valid data.
• If the function "Quality code" is enabled for this data point all the information can be stored
in the database. The database creates a request to Fleet Manager to show the bad quality
code information in a chart.
• If the function "Quality code" is disabled, the value 0 will be saved anyway. But you cannot
figure out if this data is valid.

A.2.2 Quality codes OPC UA and S7 protocol

The following table is based on the OPC UA standard and shows the possible quality codes for
OPC UA and S7:

Quality code Quality code Short description Long description

(hex) (dec)
0x00000000 0 GOOD Good, all items could be read.
0x00BA0000 12189696 GOOD_INCOMPLETE Good results may be incomplete - at least one
item could be read.
0x002F0000 3080192 GOOD_OVERLOAD Sampling has slowed down due to resource limi‐
tations.

Getting Connected to MindSphere

222 Getting Started, 08/2022
 Appendix
A.2 Quality code settings

Quality code Quality code Short description Long description

(hex) (dec)
0x40920000 1083310080 UNCERTAIN_INITIAL_VALUE Uncertain Initial Value - initial value.
0x80000000 -2147483648 BAD Bad - generic error.
0x80020000 -2147352576 BAD_INTERNAL_ERROR An internal error occurred as a result of a pro‐
gramming or configuration error.
0x80050000 -2147811328 BAD_COMMUNICATION_ERROR A low level communication error occurred.
0x80090000 -2146893824 BAD_UNKNOWN_RESPONSE An unrecognized response was received from the
server.
0x800A0000 -2146828288 BAD_TIMEOUT Bad Timeout - Timeout occurred.
0x800B0000 -2146762752 BAD_SERVICE_UNSUPPORTED Bad Service Unsupported - service unsupported.
0x80100000 -2146435072 BAD_TOO_MANY_OPERATIONS Bad Too Many Operations - The request could not
be processed because it specified too many oper‐
ations.
0x80130000 -2146238464 BAD_SECURITY_CHECKS_FAILED Indicates security problems.
0x801F0000 -2145452032 BAD_ACCESS_DENIED Bad Access Denied - Access denied.
0x80210000 -2145320960 BAD_IDENTITY_TOKEN_REJECTED Bad Identity Token Rejected.
0x80330000 -2144141312 BAD_NODE_ID_INVALID The syntax of the node ID is not valid.
0x80340000 -2144075776 BAD_NODE_ID_UNKNOWN Bad item address.
0x80360000 -2143944704 BAD_INDEX_RANGE_INVALID The syntax of the index range parameter is inva‐
lid.
0x803A0000 -2143682560 BAD_NOT_READABLE Read operation(s) has problem.
0x803B0000 -2143617024 BAD_NOT_WRITABLE Write operation(s) has problem.
0x803D0000 -2143485952 BAD_NOT_SUPPORTED Operation is not supported.
0x803E0000 -2143420416 BAD_NOT_FOUND A requested item was not found or a search op‐
eration ended without success.
0x804F0000 -2142306304 BAD_SERVER_URI_INVALID The ServerUri is not a valid URI.
0x80740000 -2139881472 BAD_TYPE_MISMATCH Type conversion has problem.
0x807D0000 -2155675648 BAD_TCPSERVER_TOO_BUSY The server cannot process the request because it
is too busy.
0x80820000 -2138963968 BAD_TCP_INTERNAL_ERROR TCP internal error occurred.
0x80860000 -2138701824 BAD_SECURE_CHANNEL_CLOSED The secure channel has been closed.
0x80890000 -2138505216 BAD_CONFIGURATION_ERROR Lack of configuration info.
0x808D0000 -2138243072 BAD_OUT_OF_SERVICE OPC service has problems.
0x809B0000 -2137325568 BAD_NO_DATA No data exists for the requested time range or
event filter.
0x809D0000 -2137194496 BAD_DATA_LOST Data is missing due to collection started/stopped/
lost.
0x80AB0000 -2136276992 INVALID_ARGUMENT Bad Invalid Argument - all items could not be read.
0x80AC0000 -2136211456 BAD_CONNECTION_REJECTED Connection problem.
0x80AD0000 -2136145920 BAD_DISCONNECT The server has disconnected from the client.
0x80AF0000 -2136014848 BAD_INVALID_STATE The operation cannot be completed because the
object public String getValue() { return value; }is
closed.
0x80B80000 -2135425024 BAD_REQUEST_TOO_LARGE Request too large.
0x80D70000 -2133393408 BAD_BOUND_NOT_FOUND No data found to provide upper or lower bound
value.

Getting Connected to MindSphere

Getting Started, 08/2022 223
Appendix
A.2 Quality code settings

A.2.3 Quality codes Modbus protocol

The following table shows the possible quality codes for devices that use the Modbus protocol:

Quality code Quality code Short description Long description

(hex) (dec)
0x00000000 0 Good No error occurred
0x80050000 -2147155968 Communication error Modbus connection reset for connection
0x80310000 -2144272384 No communication Communication with the data source is defined
but not established and there is no last known
value available
0x803A0000 -2143682560 Not readable The access level does not allow reading or sub‐
scribing to the node
0x80790000 -2139553792 No subscription There is no subscription available for this session
0x80AB0000 -2136276992 Invalid argument One or more arguments are invalid
0x80330000 -2144141312 NodeIdInvalid Parser bad node syntax
0x809E0000 -2137128960 Data unavailable Expected data is unavailable for the requested
time range due to an unmounted volume, an off‐
line archive or tape, or similar reason for tempo‐
rary unavailability
0x809F0000 -2137063424 Entry exists The data or event was not successfully updated
because no matching entry exists
0x803C0000 -2143551488 Out of range The value was out of range
0x80270000 -2144927744 Session not activated The session cannot be used because ActivateSes‐
sion has not been called
0x808B0000 -2138374144 Device failure There has been a failure in the device/data source
that generates the value that has affected the
value
0x803D0000 -2143485952 Not supported The server cannot retrieve a bound for the varia‐
ble
0x80630000 -2140995584 Type definition invalid The type definition node ID does not reference an
appropriate type node
0x800D0000 -2146631680 Server not connected The operation could not complete because the
client is not connected to the server.
0x80730000 -2139947008 Write not supported The server does not support writing the combi‐
nation of value status and timestamps provided
0x807D0000 -2139291648 Data source busy Previous read request of data source is still in pro‐
gress

A.2.4 Quality codes SIMATIC I/O Shield

The following table shows the possible quality codes for SIMATIC I/O Shield devices:

Quality code Quality code Short description Long description

(hex) (dec)
0x00000000 0 Good No error occurred
0x80050000 -2147155968 Communication error Modbus connection reset for connection

Getting Connected to MindSphere

224 Getting Started, 08/2022
 Appendix
A.2 Quality code settings

Quality code Quality code Short description Long description

(hex) (dec)
0x802A0000 -2144731136 Request header invalid Correct HTTP Status Code when rejecting a re‐
quest because User-Agent header is invalid
0x80330000 -2144141312 Node Id invalid AIO/GPIO instance is not valid
0x803E0000 -2143420416 Not found A requested item was not found
0x80AB0000 -2136276992 Invalid argument There is an error with one or more arguments
0x80020000 -2147352576 Internal error An internal error occurred. Please check pro‐
gramm or configuration
0x80030000 -2147287040 Out of memory Not enough memory for operation
0x00BA0000 12189696 Good results may be incomplete The server should have followed a reference to a
node in a remote server but did not. The result set
may be incomplete
0x80730000 -2139947008 Write not supported The server does't support writing the combina‐
tion of the given values
0x807D0000 -2139291648 Data source busy Previous read request of data source is still in pro‐
gress
0x801F0000 -2145452032 User access denied User does not have permission for requested op‐
eration
0x805E0000 -2141323264 Node Id exists Board info file does not exist
0x80B60000 -2135556096 Syntax error Syntax error

A.2.5 Quality codes SYSTEM protocol

The following table shows the possible quality codes for devices that use the SYSTEM adapters:

Quality code Quality code Short description Long description

(hex) (dec)
0x00000000 0 Good No error occurred
0x803A0000 -2151284736 Not readable The access level does not allow the operation to
the Node (reading or subscribing)
0x807D0000 -2139291648 Data source busy Previous read request of data source is still in pro‐
gress

A.2.6 Quality codes Rockwell protocol

The following table shows the possible quality codes for devices that use the Rockwell protocol:

Quality code Quality code Short description Long description

(hex) (dec)
0x00000000 0 Good No error occurred
0x80010000 -2147418112 Unexpected error An unexpected error occured
0x80020000 -2147352576 Internal error An internal error occured
0x80030000 -2147287040 Out of memory Not enough memory for operation
0x80050000 -2147155968 Communication error Connection to device failed

Getting Connected to MindSphere

Getting Started, 08/2022 225
Appendix
A.3 Technical specifications of MindConnect Nano

Quality code Quality code Short description Long description

(hex) (dec)
0x80090000 -2146893824 Unknown response Received an unsolicited message
0x800A0000 -2146828288 Timeout The operation timed out
0x800B0000 -2146762752 Service unsupported Service is not supported
0x800F0000 -2146500608 Nothing to do Nothing to send
0x801F0000 -2145452032 Access denied User does not have permission for requested op‐
eration
0x80330000 -2144141312 Invalid tag Requested item (tag) is not known
0x805E0000 -2141323264 Node does not exist Info file does not exist
0x80630000 -2140995584 Invalid type definition The type definition does not reference an appro‐
priate type
0x80740000 -2139881472 Type mismatch Data type is not supported
0x80780000 -2139619328 Too many publish requests Pending buffer is full
0x807D0000 -2139291648 Data source busy Previous read request of data source is still in pro‐
gress
0x80840000 -2138832896 Request interrupted Request interrupted
0x80850000 -2138767360 Request timeout Receive timeout occured
0x80B10000 -2135883776 No data available No more data available
0x80B60000 -2135556096 Invalid syntax Syntax error
0x80B80000 -2135425024 Request too large Buffer is too small
0x80CE0000 -2133983232 Invalid response Received an invalid reply

A.2.7 Quality codes S7+, Fanuc Focas, Sinumerik, IEC61850 and MTConnect
The following table shows the possible quality codes for devices that use the S7+, Fanuc Focas,
Sinumerik, IEC61850 and MTConnect protocol:

Quality code Quality code Short description Long description

(hex) (dec)
0x00000000 0 GOOD Value quality is good
0x80AD0000 -213614592 BAD_DISCONNECT The device is not connected
0
0x80AC0000 -213621145 BAD_CONNECTION_REJEC‐ The device is deactivated
6 TED
0x80AB0000 -213627699 INVALID_ARGUMENT Invalid value (marked by device or our
2 driver)

A.3 Technical specifications of MindConnect Nano

Functions
Field protocol – S7 Siemens S7 (for S7-3xx / S7-4xx / S7-12xx/ S7-15xx / ET-200s PLCs)
Field protocol – OPC UA Part 8 of the OPC UA specification (Data Access)

Getting Connected to MindSphere

226 Getting Started, 08/2022
 Appendix
A.3 Technical specifications of MindConnect Nano

Functions
Configuration of data collection With Asset Manager in MindSphere
Data buffering Up to 500 MB buffering space for collected data
Proxy support Yes
DHCP support Yes
Security Connection outbound via HTTPS on port 443 to MindSphere only; no incoming con‐
nection accepted SSL/TLS encryption of data in transit to MindSphere

Supply voltage
Type of supply voltage 24 V
Current consumption max. 1.8 A at 24 V
Mains buffering
Mains/voltage failure stored energy 20 ms
time

Interfaces
USB port 1x USB 3.0 / 3x USB 2.0
PCIe slot 1x PCIe x1 (Disabled)
serial interface 1x COM (Disabled)
Video interfaces
Graphics interface 1x DisplayPort (Disabled)
Industrial Ethernet
Industrial Ethernet interface 2x 1000 Mbit RJ45

Monitoring functions
Status LEDs Yes
Fan No

EMC
Interference immunity against discharge of static electricity
Interference immunity against dis‐ ±6 kV contact discharge acc. to IEC 61000-4-2; ±8 kV air discharge acc. to IEC 61000-4-2
charge of static electricity
Interference immunity to cable-borne interference
Interference immunity on supply • ±2 kV acc. to IEC 61000-4-4, burst; ±1 kV acc. to IEC 61000-4-5, surge symmetric;
cables • ±2 kV acc. to IEC 61000-4-5, surge asymmetric;
Interference immunity on signal ca‐ • ±2 kV acc. to IEC 61000-4-5, surge, length > 30 m;
bles >30m
Interference immunity on signal ca‐ • ±1 kV acc. to IEC 61000-4-4; burst; length < 3 m;
bles < 30m • ±2 kV acc. to IEC 61000-4-4; burst; length > 3 m;
Interference immunity against voltage surge
asymmetric interference ±2 kV acc. to IEC 61000-4-5, surge asymmetric
symmetric interference ±1 kV acc. to IEC 61000-4-5, surge symmetric

Getting Connected to MindSphere

Getting Started, 08/2022 227
Appendix
A.3 Technical specifications of MindConnect Nano

EMC
Interference immunity against high-frequency electromagnetic fields
Interference immunity against high • 10 V/m for 80 - 1000 MHz and 1.4 - 2 GHz, 80% AM acc. to IEC 61000-4-3;
frequency radiation • 3 V/m for 2 - 2.7 GHz, 80% AM acc. to IEC 61000-4-3;
• 10 V/m for 10 kHz - 80 MHz, 80% AM acc. to IEC 61000-4-6
Interference immunity to magnetic fields
Interference immunity to magnetic 100 A/m; to IEC 61000-4-8
fields at 50 Hz
Emission of conducted and non-conducted interference
Interference emission via line/AC EN 61000-6-3, EN 61000-6-4, CISPR 22 Class B, FCC Class A
current cables

Degree and class of protection

IP (at the front) IP20
IP (rear) IP40
Standards, approvals, certificates
CE mark Yes
UL approval Yes
UL 508 Yes
cULus Yes
RCM (formerly C-TICK) Yes
KC approval Yes
EMC CE, EN 61000-6-4:2007, EN 61000-6-2:2005
EN 61000-6-2 Yes
Dust protection Protection against foreign bodies > 1 mm
FCC Yes
Marine approval
Germanischer Lloyd (GL) Yes
American Bureau of Shipping (ABS) Yes
Bureau Veritas (BV) Yes

Ambient conditions
Ambient temperature during operation
Ambient temperature during opera‐ 0 °C up to 60 °C
tion
min. 0 °C
max. 60 °C
Ambient temperature during storage/transportation
min. -20 °C
max. 60 °C
Relative humidity
Relative humidity Tested according to IEC 60068-2-78, IEC 60068-2-30: Operation: 5% to 80% at 25 °C (no
condensation), Storage: 5% to 95% at 25 °C (no condensation)

Getting Connected to MindSphere

228 Getting Started, 08/2022
 Appendix
A.4 Technical specifications of MindConnect IoT2040

Ambient conditions
Vibrations
Vibration load in operation Tested to DIN IEC 60068-2-6: 10 Hz to 58 Hz: 0.075 mm, 58 Hz to 200 Hz: 9.8 m/s² (1 g)
Shock testing
Shock load during operation Tested according to IEC 60068-2-27: 150 m/s², 11 ms

Software
MindConnect Software Pre-installed MindConnect Software

Dimensions
Width 191 mm
Height 100 mm
Depth 60 mm

A.4 Technical specifications of MindConnect IoT2040

Functions
Field protocol – S7 Siemens S7 (for S7-3xx / S7-4xx / S7-12xx/ S7-15xx/ ET-200s PLCs)
Field protocol – OPC UA Part 8 of the OPC UA specification (Data Access)
Configuration of data collection With Asset Configuration tool in MindSphere
Data buffering Up to 500 MB buffering space for collected data
Proxy support Yes
DHCP support Yes
Security Connection outbound via HTTPS on port 443 to MindSphere only; no incoming con‐
nection accepted SSL/TLS encryption of data in transit to MindSphere

Installation type/mounting
Design IoT Gateway, built-in unit
Mounting DIN rail, wall mounting

Supply voltage
Type of supply voltage DC 9…36 V, no galvanic isolation
Current consumption max. 1.4 A
Mains buffering
Mains/voltage failure stored energy 5 ms
time

Getting Connected to MindSphere

Getting Started, 08/2022 229
Appendix
A.4 Technical specifications of MindConnect IoT2040

Interfaces
USB port 1x USB 2.0, 1x USB client
Connection for keyboard/mouse USB / USB
serial interface 2x COM ports (RS 232, RS 485)
Industrial Ethernet
Industrial Ethernet interface 2 x Ethernet (RJ45)
100 Mbps Yes
1000 Mbps No

Monitoring functions
Watchdog Yes
Status LEDs Yes

EMC
Interference immunity against discharge of static electricity
Interference immunity against dis‐ ±4 kV contact discharge acc. to IEC 61000-4-2; ±8 kV air discharge acc. to IEC 61000-4-2
charge of static electricity
Interference immunity against high-frequency electromagnetic fields
Interference immunity against high • 10 V/m for 80 - 1000 MHz, 80% AM acc. to IEC 61000-4-3;
frequency radiation • 3 V/m for 1.4 - 2 GHz, 80% AM acc. to IEC 61000-4-3;
• 1 V/m for 2 - 2.7 GHz, 80% AM acc. to IEC 61000-4-3;
• 10 V for 150 kHz - 80 MHz, 80% AM acc. to IEC 61000-4-6;
Interference immunity to cable-borne interference
Interference immunity on supply ca‐ • ±2 kV acc. to IEC 61000-4-4, burst;
bles • ±1 kV acc. to IEC 61000-4-5, surge symmetric;
• ±2 kV acc. to IEC 61000-4-5, surge asymmetric;
Interference immunity on signal ca‐ ±2 kV acc. to IEC 61000-4-5, surge, length > 30 m
bles >30m
Interference immunity on signal ca‐ ±2 kV in accordance with IEC 61000-4-4, burst, length > 30 m
bles < 30m
Interference immunity against voltage surge
Asymmetric interference ±2 kV acc. to IEC 61000-4-5, surge asymmetric
Symmetric interference ±1 kV acc. to IEC 61000-4-5, surge symmetric
Interference immunity to magnetic fields
Interference immunity to magnetic 100 A/m; to IEC 61000-4-8
fields at 50 Hz
Emission of conducted and non-conducted interference
Emission of conducted and non-con‐ EN 61000-6-4:2007 +A1:2011
ducted interference

Getting Connected to MindSphere

230 Getting Started, 08/2022
 Appendix
A.4 Technical specifications of MindConnect IoT2040

Degree and class of protection

IP (at the front) IP20
Standards, approvals, certificates
Approval CE (industry), UL, cULus
CE mark Yes
UL approval Yes
cULus Yes
KC approval Yes
EMC • CE
• EN 61000-6-4:2007 +A1:2011
• EN 61000-6-2:2005
• EN 61000-6-3:2007 +A1:2011
• EN 61000-6-1:2007

Ambient conditions
Ambient temperature during operation
Ambient temperature during opera‐ 0 °C to 50 °C
tion
min. 0 °C
max. 50 °C
Relative humidity
Relative humidity • Tested according to IEC 60068-2-78
• IEC 60068-2-30: Operation: 5 % to 85 % at 30 °C (no condensation)
• storage / transport: 5 % to 95 % at 25 / 55 °C (no condensation)
Vibrations
Vibration load in operation Tested according to IEC 60068-2-6: 5 Hz to 9 Hz: 3.5 mm; 9 Hz to 200 Hz: 9.8 m/s²
Shock testing
Shock load during operation Tested according to IEC 60068-2-27: 150 m/s², 11 ms

Software
MindConnect Software Pre-installed MindConnect Software

Dimensions
Width 144 mm
Height 90 mm
Depth 53 mm

Getting Connected to MindSphere

Getting Started, 08/2022 231
Appendix
A.6 Read performance MindConnect Elements

A.5 Offline buffer

In order to calculate the buffer time for MindConnect Nano or MindConnect IoT2040 you can use
the following formula:

%XIIHUVL]H
%XIIHUWLPH 
1XPEHURIGDWDSRLQWV5HDGF\FOH %\WHVSHUGDWDSRLQW

MindConnect Nano data buffer is 500 MB. When the buffer is at full capacity, the new incoming
data will overwrite the oldest data.
The following example shows the buffer time for a MindConnect Nano with 500 MB data buffer:
In this case, 120 bytes is the memory needed for one data point.

E\WH
%XIIHUWLPH  VฬKUV
V E\WH


A.6 Read performance MindConnect Elements

All MindConnect Elements have a clear limitation on soft limits(unmonitored number of data
points and data connections). The only fixed limit is 1050 data points. Within the soft limits, you
can configure data connections and data points without reaching the limits. For 250 datapoints
read per second, the upload bandwidth should be at least 0.5 MB/s.
The following describes how to proceed if you want to exceed these limits.

Tested MindConnect limits

MindConnect Nano MindConnect IOT2040

Max mount of data points can be config‐ 1050 1050
ured (Fix)
Data points OPC UA / S7 / Modbus TCP 250 30
(read per second)
Connections to data providers 30 5
String data points 10 3
Data points - Modbus RTU RS485 / RS422 20 15
- 9,6 kBd
Data points - Modbus RTU RS485 / RS422 35 20
- 19,2 kBd
Data points - Modbus RTU RS485 / RS422 80 30
- >= 38,4 kBd
Data points - Modbus RTU RS232 - 57,6 40 30
kBd

Getting Connected to MindSphere

232 Getting Started, 08/2022
 Appendix
A.6 Read performance MindConnect Elements

Adaptions of the limits

Subsequently listed are the parameters the influence the read performance of a MindConnect
Element. By varying one of these parameters all others will be affected as well. These are the
variables:
• Performance of MindConnect hardware
• Number of connections to data providers
• Type of connection to providers (S7 / OPC UA / Modbus / ...)
• Amount of data points per second
• Type of data points (String or no string)
• Performance of data provider (PLC, OPC Server)

Note
• Reading data from a data provider will always cause an effect on it. The performance of the
data provider (PLC / OPC Server / Modbus) is one of the most important limiting factors. If
more devices (e.g. OPC server, HMIs, SCADA systems,...) are connected to this data provider
(e.g. PLC) the reading cycle can rise.
• For MindConnect Software Agent, the readings are not applicable as it depends on the
hardware for a particular agent and configuration.

Example calculations (MindConnect Nano)

• It can be possible to read 300 data points per second out of a PLC. This is possible if the PLC
is powerful and just one data provider is used.
• It can be possible to read 1000 data points out of 30 data providers if the reading cycle will
be switched to 4sec.
• It can be possible to read out of 35 data providers if you just read 200 data points per second.

Note
To make sure a configuration works for your setup it needs to be monitored over a longer period
of time.

System Test results

The following tables show how long it takes to read a data item from one of the devices. These
are not fixed values but an indication of how the devices would react.

Getting Connected to MindSphere

Getting Started, 08/2022 233
Appendix
A.7 Firewall Settings

MindConnect NANO

Type MS per data point read

Min Mid Max
S7 300 1,13 1,74 3,08
S7 1500 0,37 1,60 3,89
S7 1200 3,50 5,18 7,50
S7 ET200S CPU 0,89 2,09 3,71
OPC UA @ PC 1)
2,38 6,64 8,53
OPC UA@ PLC 2,66 3,27 4,69
1)
OPC UA @ PC always depends on the hardware.
• Read of a string data point you have to multiply the time with 2,5 per data point
• All devices are around 75% full

MindConnect IOT2040

Type MS per data point read

Min Mid Max
S7 300 2,10 4,28 6,61
S7 1500 3,73 4,54 5,22
S7 1200 6,29 6,72 7,11
S7 ET200S CPU 1,92 5,01 8,33
OPC UA @ PC
OPC UA@ PLC 4,42 5,50 7,66

• Read of a string data point you have to multiply the time with 2,5 per data point
• All devices are around 75% full

A.7 Firewall Settings

It is recommended to use a firewall between the Internet and the MindConnect Elements, this
is also recommended for communication to the automation network.
In the direction to Automation Network a firewall supporting NAPT (in case of DMZ, see section
“List of abbreviations”) or supporting the “Ghost-Mode” is required. Siemens offers many types
of Firewalls for fulfilling these requirements.

Getting Connected to MindSphere

234 Getting Started, 08/2022
 Appendix
A.7 Firewall Settings

① Corporate / Office Network with route to the internet or direct internet access, e.g. via a DSL
modem
② Production / Machine Network

“Ghost-Mode”, also known as “Transparent Mode”, is used to protect individual, event

alternating, devices by dynamically taking over the IP address.

Getting Connected to MindSphere

Getting Started, 08/2022 235
Appendix
A.8 ESD guideline

A.8 ESD guideline

What does ESD mean?

An electronic module is equipped with highly integrated components. Due to their design,
electronic components are highly sensitive to overvoltage and thus to the discharge of static
electricity. Such electronic components or modules are labeled as electrostatic sensitive devices.
The following abbreviations are commonly used for electrostatic sensitive devices:
• ESD – Electrostatic sensitive device,
• ESD – Electrostatic Sensitive Device as a common international designation.
Electrostatic sensitive devices can be labeled with an appropriate symbol.

NOTICE
Damage to ESD from touch
Electrostatic sensitive devices, ESD, can be destroyed by voltages which are far below the
human perception limit. If you touch a component or electrical connections of a module
without discharging any electrostatic energy, these voltages may arise.
The damage to a module by an overvoltage can often not be immediately detected and only
becomes evident after an extended period of operation. The consequences are incalculable
and range from unforeseeable malfunctions to a total failure of the machine or system.
Avoid touching components directly. Make sure that persons, the workstation and the
packaging are properly grounded.

Charge
Every person without a conductive connection to the electrical potential of his/her surroundings
can be electrostatically charged.
The material with which this person comes into contact is of particular significance. The figure
shows the maximum electrostatic voltages with which a person is charged, depending on
humidity and material. These values conform to the specifications of IEC 61000-4-2.

Getting Connected to MindSphere

236 Getting Started, 08/2022
 Appendix
A.8 ESD guideline




① Voltage
② Synthetic materials
③ Wool
④ Antistatic materials such as wood or concrete
⑤ Relative humidity

NOTICE
Grounding measures
There is no equipotential bonding without grounding. An electrostatic charge is not discharged
and may damage the ESD.
Protect yourself against discharge of static electricity. When working with electrostatic
sensitive devices, make sure that the person and the workplace are properly grounded.

Getting Connected to MindSphere

Getting Started, 08/2022 237
Appendix
A.9 Return of defect hardware

Protective measures against discharge of static electricity

• Disconnect the power supply before you install or remove modules which are sensitive to
ESD.
• Pay attention to good grounding:
– When handling electrostatic sensitive devices, make sure that persons, the workstation
and devices, tools and packaging used are properly grounded. This way you avoid static
discharge.
• Avoid direct contact:
– As a general rule, do not touch electrostatic sensitive devices, except in the case of
unavoidable maintenance work.
– Hold the modules at their edge so that you do not touch the connector pins or conductor
paths. This way, the discharge energy does not reach and damage the sensitive
components.
– Discharge your body electrostatically before you take a measurement at a module. Do so
by touching grounded metallic parts. Always use grounded measuring instruments.

A.9 Return of defect hardware

In case of a defect or corrupted hardware you can find contacts and information under the
following links:

Spare part services

In case of a defect or corrupted hardware you can find detail information in the SIOS Article -
Spare Parts Services (https://support.industry.siemens.com/cs/sc/2110/spare-parts-services?
lc=en-WW).

Delivery of spare parts

For ordering, provision and delivery of spare parts you can find more information in the SIOS
Article - Delivery of Spare Parts. (https://support.industry.siemens.com/cs/sc/2112/ordering-
provision-and-delivery-of-spare-parts?lc=en-WW)

Siemens Contact Database

You can find your personal contact for spare parts in the Siemens Contact Database (https://
www.automation.siemens.com/aspa_app/?cntryid=DE&comptcid=e&lang=en).

Getting Connected to MindSphere

238 Getting Started, 08/2022
 Appendix
A.11 MindConnect EthernetIP - CIP Communication path (route parameters) settings

A.10 List of abbreviations

Abbreviation Description
DMZ Demilitarized Zone (referred to a perimeter network)
GUI Graphical User Interface
HTTPS Hyper Text Transfer Protocol Secure
IoT Internet of things
IoT2040 MindConnect IoT2040
IP Internet Protocol
LAN Local Area Network
MCN MindConnect Nano
MSU MindSphere Unit
NAPT Network Address and Port Translation
OEM Original Equipment Manufacturer
OPC UA Open Platform Communications Unified Architecture
PC Personal Computer
S7 STEP 7
UI User Interface

A.11 MindConnect EthernetIP - CIP Communication path (route

parameters) settings
The CIP uses a method of encapsulating the messages adding communication path segments to
the command segment. This leads to a longer and longer growing message as the number of
routing stations grows.
As an example, the following simple layout is used to explain that fact.
The MindConnect is acting as a CIP client.
The CIP server is provided by a ControlLogix or CompactLogix.

Getting Connected to MindSphere

Getting Started, 08/2022 239
Appendix
A.11 MindConnect EthernetIP - CIP Communication path (route parameters) settings

Each CIP message contains the routing information to the target. Every time a bridge accepts
such a CIP message it strips out its own address information and forwards the modified CIP
message to the next addressee along the way. When there is no further routing information
available the destination target has been reached and the CIP message will be interpreted. Once
interpreted the response will be send the same way back the request came. This means each
bridge keeps a reference to the request package.

A.11.1 Case 1 – Accessing data inside an Allen- Bradley PLC

In this case, a ControlLogix uses the ENET bridge in slot 1 (0 based counting) for communicating
with the CIP client. The processor module itself is in slot 2. An additional ControlNet Bridge is in
slot 4 and is not used in this scenario.
The MindConnect sends a request to the ControlLogix on 192.168.0.22, slot 2.

This communication path (route parameters) is formed as follows:

Getting Connected to MindSphere

240 Getting Started, 08/2022
 Appendix
A.11 MindConnect EthernetIP - CIP Communication path (route parameters) settings

It recognizes the CIP message is not for it and therefore, it removes its address part (1) from the
CIP message. The remaining CIP message is being forwarded to the processor module as
indicated by the remaining address information (2). The message contains a reduced
communication path with the slot number. The processor removes that information and start
interpreting the remaining message, as there is no further routing information in the packet.
The following Wireshark packet analysis shows the additional segment.

A.11.2 Case 2 – Accessing the Allen- Bradley PLC via integrated Ethernet port
In this scenario, the CIP client sends some data into the CPU module using the integrated
Ethernet port. In a CPU module with integrated Ethernet port, the Ethernet port is in the same
slot as the CPU module.
The CIP client in the MindConnect sends a request package to the CPU module at 192.168.0.32
addressing the processor module in slot 0.

Following the previous schema, the above image represents the communication path (route
parameters).
Following the previous made explanations, the CIP message travels first through the processor
module to the backplane and it returns back to the processor module for interpretation. For such
situations, it is possible to use an abbreviated communication path only containing the IPv4
address.
The MindConnect block uses the parameter "slot" to form the communication path (route
parameters).

Getting Connected to MindSphere

Getting Started, 08/2022 241
Appendix
A.12 MindConnect general security principles

A.11.3 Case 3 – Accessing the Allen- Bradley PLC via the ControlNet interface
In this scenario, the CIP client reads data from the Allen- Bradley PLC. Now, the communication
path will be through the CompactLogix acting as bridge between EtherNet/IP and ControlNet.

The yellow line in the above image represents the communication path (route parameters).
In the communication path, the red marked sections always contain a network specific address.
The blue marked part identifies the backplane or the interface to be used. It is not important that
the backplane is physically existing or virtual. The green part identifies the slot number of the
next bridge module (next hop) or the destination module.

A.12 MindConnect general security principles

The following are the security principles of MindConnect services:
• Communication between devices and MindSphere cloud services through HTTPS and signed
URLs.
• Authentication and authorisation using OAuth 2.0 mechanisms.
• Security tokens have a limited timespan of validity and must be renewed.
• Before installation, firmware is signed and signature is validated by the device.

Onboarding agent (example, MindConnect Nano)

To onboard an agent, establish the trust between agent and MindSphere agent management:
1. Create an agent in Asset Manager.
2. Define the network and security profile in Asset Manager.
3. Download the initial access token and network configuration to your local machine.
4. Deploy the initial access token to agent, for example via USB stick.

Getting Connected to MindSphere

242 Getting Started, 08/2022
 Appendix
A.12 MindConnect general security principles

With the initial access token, the agent can prove it‘s identity towards MindSphere agent
management by:
• The Initial Access Token (IAT) is physically entitled to onboard the agent.
• The initial access token is valid for 7 days for security measures to avoid the misuse.

Registering an agent (example, MindConnect Nano)

To register an agent at agent management, follow these OAuth 2.0 protocol in two cases:
Case-1: Compute limited agent will use a shared secret in further communication. For example,
the agent registers at MindSphere agent management with the IAT.
Case-2: Powerfull agent uses public / private keys in further communication. For example, the
agent registers at MindSphere agent management with the IAT and additionally, a JSON Web-
Key is set according to RFC7517 that contains a self generated public key.

Accepting the registration (example, MindConnect Nano)

With this response, the agent is onboarded and agent management accepts the registration.
There are two cases, the agent managmement responds with:

Case 1
• The shared secret (valid for 7 days) – to be used to access token in the request.
• The re-registration access token (RAT) – to be used for the renewal of registration, once the
registration is expired.

Case 2
• The re-registration access token (RAT) – to be used for the renewal of registration, once the
registration is expired.
• The agent management stores the public key received after registering an agent and uses it
to verify the request access token from agent, which uses JWT signed with private key from
now on. For more information, see Onboarding an Agent (https://developer.mindsphere.io/
howto/howto-agent-onboard.html).

Validity of the credentials

By default, each registered agent (either RSA 3072 or Shared Secret security profile) has its own
credentials valid for 7 days and it must be renewed on a regular basis. After this period,
MindSphere will not grant any access tokens to the agent and the agent credentials will be
invalid. The agent needs to re-register to MindSphere by providing its Registration Access Token
(RAT).
Registration access tokens have no practical expiration times but each time a client refreshes its
registration a new RAT is generated by MindSphere.

API communication agent (e.g. MindConnect Nano)

Except the one for onboarding and registration, all MindSphere APIs require an access token:

Getting Connected to MindSphere

Getting Started, 08/2022 243
Appendix
A.12 MindConnect general security principles

The Agent requests an access token from Agent IAM using a self signed JSON Web Token (JWT).
The JWT is signed (see RFC-7515) with either the shared secret (Case 1) or the private key of the
public / private key pair (Case 2) in Step 2. The JWT contains the tenantId
The granted access token is valid for 30 minutes. It is also a JWT and contains:
• tenantId
• scopes: It describes the type of services used in this token holder.
After expiry, a new token needs to be requested.

Firmware management
Firmware management is stored in secure cloud storage. Agent accesses secure storage through
a signed URL issued by MindSphere and it is valid for 7 days.
Firmware is signed with private key from MindSphere. Firmware installer (MERS) on device,
checks signature against matching public key provided at initial installation in the factory.

Getting Connected to MindSphere

244 Getting Started, 08/2022
Glossary

Aspect
Aspects are a data modeling mechanisms for assets. Aspects group the data points based on
logical sense. For example: The pump skid has an aspect e.g. “Energy_consumption” that
contains the data points: "power", "current", "voltage" etc.
Aspect is specified in Asset Manager and its name can be freely chosen, but should bring
together a logical grouping of data points and a physical asset.

Asset
An asset is a digital representation of a machine or an automation system with one or multiple
automation units (e.g. PLC) connected to MindSphere.
MindSphere data collection and data provisioning is based on so called (virtual) assets. This can
be anything such as a pump, motor, PLC, an entire tool machine, a production line, a robot, a
crane, a car, a wind turbine and so on. The data of an asset is collected and sent to MindSphere
to make that data available for further processing and analytics.

Asset Identifier
Asset Identifier is an identifier assigned by the manufacturer of the device, to which
MindConnect Nano will be connected. After the onboarding process, MindConnect Nano is
connected to this device. The serial number identifies the asset to which the data belongs.

Asset Manager
Asset Manager is a Web Graphical User Interface for asset configuration. According to these
configurations, the following functions are available:
Asset Configuration: assets can be created, onboarded, modified, moved, offboarded or deleted.

Asset type
Asset type is a sort or kind of a product line made by one manufacturer.

Components
Components represent built-in functionality in MindSphere. Components are:
• Asset Manager
• Fleet Manager
• Settings
• UTC Reporting
For the complete list and description of Components, refer to the “MindSphere” documentation.

Getting Connected to MindSphere

Getting Started, 08/2022 245
Glossary

Data point
Data points refer to elements (variables), which allow values to be obtained from data sources
(OPC UA or S7 etc.). They are combined into a relevant aspect. For example, “temperature” and
“torque” are data points of an aspect “Energy_consumption”.
Data points are configured in "Asset Manager”. In “Fleet Manager”, their values are visualized as
time series.

Data source
A data source is a physical element of a device, which can be monitored by MindSphere.
For example: OPC UA Server, S7.

Event
In "Fleet Manager", an event is a change of a datapoint state. Events are used for the requests.
With a rule it is possible to define the request, which will be created in MindSphere when the
event is triggered.
Besides the monitoring rule, a description of event (e.g. “The limit is exceeded, this may indicate
damage in the pump”), the resulting action (e.g. “Please contact your hotline”) and priority
(urgent, important or info) can be lodged.
See also “request”, “rule".

Fleet Manager
Fleet Manager is a visualization tool which provides an overview of existing assets and their
information (asset name, customer name, location). Fleet Manager displays your configured
asset, aspects with datapoints in charts and list of all requests etc.

Last Connection
"Last Connection" status in “Asset Manager” gives the information, when a MindConnect
Element was online for the last time.

MindConnect Element
MindConnect Elements are devices for transferring data and allow connectivity to MindSphere
such as MindConnect Nano, MindConnect IoT2040 or MindConnect FB.

MindSphere
MindSphere is the Siemens Industrial IoT operation system comprising the core cloud services
and applications, whereas the MindConnect Element provides secure and easy connectivity
from the field or machine to MindSphere. In MindSphere, submitted data by a MindConnect
Element is processed and stored for analysis and further management purposes.
For more information, refer to the “MindSphere” documentation.

Getting Connected to MindSphere

246 Getting Started, 08/2022
 Glossary

MindSphere Launchpad
MindSphere Launchpad is the entry point for components as well as for available applications.

Online/Offline Mode in Asset Manager

Online indicates internet connection, when the MindConnect Nano/IoT2040 sends the data to
the server. Offline mode means the absence of the internet connection and the MindConnect
Nano/IoT2040 is no longer able to send data to the server.

Organization
Organization is the part of hierarchical asset configuration in Asset Manager. Within
organization, areas/assets are specified.
As the administrator (OEM), you manage organizations, their customers and assets. As the user
of an organization, you can access the assets assigned only to this organization.
In the context of MindSphere, an organization can be anything and is defined by the
administrator depending on their requirements: customer, cost center, branch etc.

Request
Requests are the messages which log asset incidents based on predefined rules.
You can create manual requests as well as requests for the regular acquisition of measured
quantities with measuring series.
See also “event", "rule".

Rule
With rules you can configure an automatic monitoring of datapoints on events. For example, a
request will be created automatically by the system, if a value exceeds or falls below a threshold
(edge trigger).
See also “event", "request".

Settings
Settings is a Web Graphical User Interface for user, organization and role configuration.

Time series
Time series is a sequence of measurements which are produced by data sources over time.
Analysis and visualization tools (e.g. Fleet Manager) can retrieve collected time series and
present it to the user after processing. In Asset Manager, the measurements, that have to be
collected, can be specified.

Getting Connected to MindSphere

Getting Started, 08/2022 247
Glossary

Getting Connected to MindSphere

248 Getting Started, 08/2022