SIAPP IOTGW Configuration Manual en DC8-102!2!08
SIAPP IOTGW Configuration Manual en DC8-102!2!08
Table of Contents
SIAPP 1
SICAM A8000 Series Device Configuration 2
SIAPP Configuration
IoT Time Series 3
for IoT Gateway
SIAPP Configuration 4
V1.2.x Literature
Manual
DC8-102-2
NOTE
i For your own safety, observe the warnings and safety instructions contained in this document, if available.
Target Audience
This manual is addressed to personnel and customers who are responsible for evaluation, conceptual design,
configuration, and technical system maintenance.
Scope
This manual is valid for the SICAM A8000 series.
Additional Support
For questions about the system, contact your Siemens sales partner.
Training Courses
Inquiries regarding individual training courses should be addressed to our Training Center:
Siemens AG
Siemens Power Academy TD Phone: +49 911 9582 7100
Humboldtstraße 59 E-mail: poweracademy@siemens.com
90459 Nuremberg Internet: www.siemens.com/poweracademy
Germany
Notes on Safety
This manual is not a complete index of all safety measures required for operation of the equipment (module
or device). However, it includes important information that must be followed for personal safety and to avoid
material damage. Information is highlighted and illustrated as follows according to the degree of danger:
! WARNING
WARNING means that death or severe injury may result if the measures specified are not taken.
² Comply with all instructions, in order to avoid death or severe injuries.
! CAUTION
CAUTION means that medium-severe or slight injuries can occur if the specified measures are not taken.
² Comply with all instructions, in order to avoid moderate or minor injuries.
NOTE
i Important information about the product, product handling or a certain section of the documentation
which must be given attention.
OpenSSL
This product includes software developed by the OpenSSL Project for use in OpenSSL Toolkit (http://
www.openssl.org/).
This product includes software written by Tim Hudson (tjh@cryptsoft.com).
This product includes cryptographic software written by Eric Young (eay@cryptsoft.com).
Preface.......................................................................................................................................................... 3
1 SIAPP.............................................................................................................................................................7
1.1 Introduction........................................................................................................................8
1.2 HTTPS Network Topology.................................................................................................... 9
1.3 HTTPS MindSphere............................................................................................................11
1.4 Fast Acquisition File Upload over MQTT............................................................................. 12
1.5 MQTT MindSphere ........................................................................................................... 13
2 Device Configuration..................................................................................................................................15
2.1 Importing SIAPP................................................................................................................ 16
2.2 Adding Hardware and Configuring Ports............................................................................ 17
2.3 Adding Firmware.............................................................................................................. 19
2.4 Adding Licenses................................................................................................................ 20
4 SIAPP Configuration................................................................................................................................... 29
4.1 Configuring SIAPP............................................................................................................. 30
4.2 HTTPS Configuring Application Settings............................................................................. 32
4.3 MQTT Configuring Application Settings............................................................................. 34
4.4 Uploading SIAPP Configuration to the Device.....................................................................37
Literature.................................................................................................................................................... 39
1.1 Introduction 8
1.2 HTTPS Network Topology 9
1.3 HTTPS MindSphere 11
1.4 Fast Acquisition File Upload over MQTT 12
1.5 MQTT MindSphere 13
1.1 Introduction
The SICAM application SIAPP can be used on a CP-8031 or CP-8050 to communicate with MindSphere. This
gateway provides 2 main features.
Only one type of transmission can be used, either HTTPS or MQTT.
• HTTPS connection
HTTPS communicates with the MindSphere API using the MindConnect Library V4 (MCL). This implemen-
tation of the MindConnect Library V4 provides a monitoring-towards-cloud solution only.
– MindSphere file upload
The file upload is explicitly used for MQTT messages provided by the AssetGuard. The MQTT
message payload must meet the fast acquisition (FAC) JSON structure (see 1.4 Fast Acquisition
File Upload over MQTT).
– MindSphere time series upload
All signals provided via the EdgeDataApi are uploaded as time series data in a specific time schedule.
The signals are divided into spontaneous and periodic data types (see 3.1 Signal Assignment).
• MQTT connection
The IOT Gateway communicates with MindSphere over an encrypted MQTT Broker – Client system. This
implementation provides a monitor and command solution for MindSphere.
– MindSphere monitoring
All signals provided via the EdgeDataApi are uploaded as time series data in a specific time schedule
from 30 s.
– MindSphere commanding
Commanding signals provided via the EdgeDataApi are possible to set in MindSphere with the
SICAM Navigator.
The following requirements must be met in order to run SIAPP:
• Devices:
– SICAM CP-8031 Master Module or
– SICAM CP-8050 Master Module
• Engineering:
– SICAM Device Manager V3.90 and higher
• Firmware:
– CPCI85 V4.90 and higher
– SICWEB V5.80 and higher
– LXAR85 V4.85 and higher
• License:
– SICAM Application Runtime license
[dw_Network_diagram, 1, en_US]
The communication between the IoT Gateway and the MindSphere MindConnect Library can only be estab-
lished by the client. Data can only be sent to MindSphere. The other direction - out of MindSphere is not
possible.
The communication is based on the MindSphere REST JSON API via HTTP and a TLS V1.2 encryption.
Authentication is done by a shared secret, generated by the user on the MindSphere MindConnect Web
application.
In order to resolve the MindSphere Gateway host name, a DNS is required. The firewall settings must be set to
port 443, TCP (HTTPS) and port 53, UDP (DNS). It must be possible to ping the DNS server (ICMP).
NOTE
i • The communication between devices and the MindSphere cloud services takes place through HTTPS
and signed URLs.
• Security tokens have a limited validity period and must be renewed regularly.
• The file upload via the SICAM Device Manager is encrypted and secure.
NOTE
• Due to the preconfiguration of SIAPP, only port 1883 and port 8883 are valid ports.
• Only the port setting is mandatory. If user/password and/or psk encrypted communication is not
used, remove the related lines from the file.
NOTE
i • The communication between devices and the MindSphere cloud services takes place through
encrypted MQTT.
• The file upload via SICAM Device Manager is encrypted and secure.
[sc_SIAPP_Upload_kl, 1, en_US]
² Select menu.
² Select SIAPP....
The dialog appears.
[sc_Import_siapp, 1, en_US]
² Select the desired SIAPP file (*.siapp) from your file system and click confirm.
The selected file is displayed and ready for import.
[sc_SIAPP_upload_05, 2, en_US]
Adding Hardware
² Select Hardware on the homepage.
[sc_Start_Hardware, 1, --_--]
Configuring Ports
² Click on the top of the master module.
[sc_Config_HW_Module, 1, en_US]
[sc_Hardware_settings, 2, en_US]
² If you need a 2nd Ethernet port add a new row in LAN port groups. Select Singular in the Type column.
A 2nd port for CP-X2 will be activated automatically.
² Confirm your entries.
[sc_Start_Application_best, 1, en_US]
[sc_Firmware_application_settings, 1, en_US]
² Select Add.
² Confirm the dialog.
[sc_Add_firmware, 2, en_US]
[sc_Start_Application_best, 1, en_US]
² Select Licenses.
[sc_Licenses_Start, 2, en_US]
[sc_Licenses_Activation, 2, en_US]
[dw_SIAPP_Edgedata_to_Mindsphere_Timeseries, 1, en_US]
• Periodic
All parameterized periodic signals are recorded every 30 s and transmitted every 60 s. This means that 2
time series are sent to MindSphere every minute.
• Spontaneous
Spontaneous signals are only transmitted when they have changed. If the signal changes, a time slot of
30 s opens and then each changed signal is transmitted to MindSphere.
With the Keyframe function a snapshot of all signals in a 15 min time frame (periodic and spontaneous) is
sent to MindSphere.
NOTE
NOTE
i When using MQTT, the spontaneous signals and commands are transmitted immediately. Periodic signals
are transmitted by change in 30 second slots. There is no keyframe when using MQTT.
Signal Type IEC 60870 EDGE Data Type MindConnect Lib V4 Data Type
Spontaneous TI32 E_EDGE_DATA_TYPE_INT32 E_MCL_DATA_TYPE_DOUBLE
Spontaneous TI33 E_EDGE_DATA_TYPE_UINT32 E_MCL_DATA_TYPE_DOUBLE
Periodic TI34 E_EDGE_DATA_TYPE_FLOAT32 E_MCL_DATA_TYPE_DOUBLE
Periodic TI35 E_EDGE_DATA_TYPE_INT32 E_MCL_DATA_TYPE_DOUBLE
Periodic TI36 E_EDGE_DATA_TYPE_FLOAT32 E_MCL_DATA_TYPE_DOUBLE
Spontaneous TI37 E_EDGE_DATA_TYPE_INT32 E_MCL_DATA_TYPE_DOUBLE
Spontaneous TI45 E_EDGE_DATA_TYPE_UINT32 E_MCL_DATA_TYPE_DOUBLE
Spontaneous TI46 E_EDGE_DATA_TYPE_UINT32 E_MCL_DATA_TYPE_DOUBLE
– – E_EDGE_DATA_TYPE_INT64 E_MCL_DATA_TYPE_LONG
– – E_EDGE_DATA_TYPE_UINT64 E_MCL_DATA_TYPE_LONG
– – E_EDGE_DATA_TYPE_DOUBLE64 E_MCL_DATA_TYPE_DOUBLE
[sc_Start_Signals_RTU, 1, --_--]
² Select Central Processing (M). Here you can define the SIAPP signals.
[sc_Signal_settings, 1, en_US]
[sc_Signal_parameter, 1, en_US]
[sc_Signal_parameter_details, 1, en_US]
[sc_Start_Signals_RTU, 1, --_--]
² Select Central Processing (M). Here you can define the SIAPP signals.
[sc_Signal_settings_MQTT, 1, en_US]
[sc_Signal_parameter_MQTT, 1, en_US]
² Select all commanding signals again from the right side and click assign to SIAPP.
² Select the processing type as SIAPP slot 0 input for all signals.
² Select the processing type as SIAPP slot 0 output for all commanding signals.
² Select Parameter.
[sc_Signal_parameter_details_MQTT, 1, en_US]
² Enter a signal name in the column Name with the following format:
TIxx_<signalname> → and for TI36: TI36_<UNIT>_<signalname>
² Select SIAPP 0 output.
² Enter exact the same naming for all commanding signals.
[sc_Signal_parameter_close_MQTT, 1, en_US]
NOTE
i • Commanding signals must be defined two times. Enter the exact same name in the column Name as
input and as output.
Unit
A unit must be defined for all TI36 signals.
To define a unit, use the underline “_” directly after the “IEC 60870” TI36 type. Followed by a second underline
“_” after the unit.
TI36_<UNIT>_<signalname> → TI36_kWh_Energy
NOTE
NOTE
i To avoid communication certificate errors ensure that the time is set correctly for CP-8031 or CP-8050.
[sc_Start_SIAPP, 2, en_US]
NOTE
i The SIAPP IPv4 address needs to be in the same subnet as the router.
[sc_SIAPP_RuntimeConfig, 2, en_US]
[sc_SIAPPs_Config, 3, en_US]
NOTE
[sc_IoT_General_Settings_HTTPS, 1, en_US]
NOTE
i The MindSphere connection type can be HTTPS or MQTT. Leave the settings for the unused protocols as
default.
² Upload the MQTT config file for AssetGuard. The file format must be a json.
² Choose the file and click confirm.
[sc_Config_Assetguard, 1, en_US]
² Upload the Onboarding file from MindSphere. The file format must be a json.
² Choose the file and click confirm.
[sc_Config_MindSphere, 1, en_US]
NOTE
[sc_Config_Application_MQTT_Start, 1, en_US]
NOTE
i The MindSphere connection type can be HTTPS or MQTT. Leave the settings for the unused protocols as
default.
NOTE
i The Device ID must match the certificate name from SICAM GridPass.
² Upload the MQTT CA Certificate (MindSphere Root Certificate). The file format must be *.pem.
² Choose the file and click confirm.
[sc_Config_MQTT_pem, 1, en_US]
² Upload the MQTT Client Device Certificate. The file format must be *.p12.
² Choose the file and click confirm.
[sc_Config_MQTT_p12, 1, en_US]
[sc_Password_Pin, 1, en_US]
[sc_Start_Upload, 1, en_US]
[sc_Upload_device, 1, en_US]
² Confirm the dialog to accept the changes and wait for the update to take place.
² Execute a selective restart.
NOTE
• The data model is uploaded only once when SIAPP is first started. It is possible to add a signal (new
data point) to SIAPP. But all existing data points will not be updated, only the changed or new signals.
• To update the whole data model, a new device name with a new certificate is necessary.