Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 19 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,26 +38,31 @@ The data is collected, stored in a database for a specific time period and made

- Access to an Industrial Edge Management System (IEM)
- Onboarded Industial Edge Device on IEM
- Installed Configurators for Databus and OPC UA Connector
- Installed Configurators for Databus and OPC UA Connector (IEM)
- Installed Apps on IED:
- Databus
- OPC UA Connector
- IIH Essentials
- Common Configurator
- IIH Semantics
- OPC UA Connector
- Common Import Converter
- Edge device is connected to PLC
- TIA portal project loaded on PLC
- HTML5-capable Internet browser

### Used components

- Industrial Edge Management (IEM) V1.16.11
- Databus V2.3.2-5
- Databus Configurator V2.3.2-2
- OPC UA Connector V2.x.x
- Common Connector Configurator V1.9.1-1
- IIH Essentials V1.10.x
- Industrial Edge Device V1.12.0-3-a
- TIA Portal V16
- S7-PLCSIM Advanced V3.0
- Industrial Edge Management (IEM) V1.15.9
- Industrial Edge Device V3.0.0-51
- Databus Configurator V3.2.3
- Common Connector Configurator V2.0.0
- Common Configurator V2.3.0
- Common Import Converter V3.0.0
- Databus V3.2.3
- IIH Semantics V2.3.0
- OPC UA Connector V2.3.2-11
- TIA Portal V19

### TIA Project

Expand All @@ -66,8 +71,8 @@ The used TIA Portal project can be found in the miscellaneous repository under "
## Configuration steps

You can find the further information about the following steps in the [docs](docs/Installation.md)
- Configure PLC Connection (Databus, OPC UA Connector)
- Configure IIH Essentials
- [Configure PLC Connection (Databus, OPC UA Connector)](docs/Installation.md#configure-plc-connection)
- [Configure IIH Essentials](docs/Installation.md#configure-iih-essentials)

## Usage

Expand All @@ -79,7 +84,8 @@ Now the data can be retrieved via REST-API by apps like Performance Insight or N
You can find further documentation and help in the following links

- [Industrial Edge Hub](https://iehub.eu1.edge.siemens.cloud/#/documentation)
- [Industrial Edge Forum](https://forum.industrial-edge.siemens.cloud)
- [Industrial Edge Forum - Mendix](https://forum.industrial-edge.siemens.cloud)
- [Industrial Edge Technical Forum - Sieportal](https://www.siemens.com/industrial-edge-forum)
- [Industrial Edge Documentation](https://docs.industrial-edge.siemens.cloud/)
- [Industrial Edge landing page](https://new.siemens.com/global/en/products/automation/topic-areas/industrial-edge/simatic-edge.html)
- [Industrial Edge GitHub page](https://github.com/industrial-edge)
Expand Down
71 changes: 35 additions & 36 deletions docs/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
- [Configuration](#configuration)
- [Configure PLC Connection](#configure-plc-connection)
- [Configure Databus](#configure-databus)
- [Databus Settings in IIH](#databus-settings-in-iih)
- [Configure OPC UA Connector](#configure-opc-ua-connector)
- [Configure IIH Essentials](#configure-iih-essentials)
- [Configure Connector](#configure-connector)
- [Configure an Asset with variables](#configure-an-asset-with-variables)
- [Configure an Aspect](#configure-an-aspect)

## Configure PLC Connection

We will use the OPC UA Connector to retrieve data from a PLC with OPC UA Server and provide the data to Edge Applications. The OPC UA Connector establishes a connection to the PLC via the OPC UA protocol and publishes data to Databus, where IIH Essentials gathers the required data.
We will use the OPC UA Connector to retrieve data from a PLC with OPC UA Server and provide the data to Industrial Edge Applications. The OPC UA Connector establishes a connection to the PLC via the OPC UA protocol and publishes data to Databus, where IIH Essentials gathers the required data.
In order to setup IIH Essentials, first these apps must be configured properly:

- Databus
Expand All @@ -30,73 +30,71 @@ In order to setup IIH Essentials, first these apps must be configured properly:

<p><kbd><img src="graphics/IE_Databus.PNG"/></kbd></p>

3. Deploy the configuration.
1. Deploy the configuration.

### Configure OPC UA Connector

1. In your `IEM` go to `Data Connections` and launch the `OPC UA Connector configurator`.
2. Add a data source:
### Databus Settings in IIH

<p><kbd><img src="graphics/S7_Connector_Data_Source.PNG"/></kbd></p>
1. Click on the icon `Settings` on the left sidebar in Common Configurator. Under **Datbus credentials** enter username and password of user created in Databus Configurator.

3. Add tags:
<p><kbd><img src="graphics/commonconfigurator_databus_settings.png"/></kbd></p>

<p><kbd><img src="graphics/opcuaconnector.png"/></kbd></p>
2. Go to `IIH Essentials>Settings> Databus settings` and enter the same credentials. (If you already configured Databus Settings over Common Configurator, this step isn't needed)

- ProducedBottles: ns=3;s="GDB"."process"."numberProduced"
- FaultyBottles: ns=3;s="GDB"."process"."numberFaulty"
- TankLevel: ns=3;s="GDB"."signals"."tankSignals"."actLevel"
- TankTemperature: ns=3;s="GDB"."signals"."tankSignals"."actTemperature"
<p><kbd><img src="graphics/iihessentials_databus_settings.png"/></kbd></p>

4. Configure settings:
### Configure OPC UA Connector

<p><kbd><img src="graphics/opcuaconnector_settings.png"/></kbd></p>
1. In your `IED` go to `Common Configurator > Get data` and select `OPC UA Connector`.

Hint: Enter username and password of user created in Databus Configurator.
<p><kbd><img src="graphics/Opcua_connector_element.png"/></kbd></p>

5. Deploy project.
2. Add a data source:

## Configure IIH Essentials
<p><kbd><img src="graphics/Opcua_datasource.png"/></kbd></p>

In your IED Web UI open the app IIH Essentials.

### Configure Connector
1. Add tags:
Click on `Browse Tags` and select the desired Tags for you setup.
Configure the Aquisition Properties and click `Save for Import`and afterwards `Add to Data Source`
<p><kbd><img src="graphics/opcuaconnector.png"/></kbd></p>

1. Click on the icon `Settings` on the left sidebar. Then open `Databus Settings` and enter username and password of user created in Databus Configurator.
- ProducedBottles: ns=3;s="GDB"."process"."numberProduced"
- FaultyBottles: ns=3;s="GDB"."process"."numberFaulty"
- GoodBottles: ns=3;s="GDB"."process"."numberGood"

<p><kbd><img src="graphics/iihessentials_databus_settings.png"/></kbd></p>
1. Deploy project.

2. Click on the icon `Connectors` on the left sidebar. To add a connector click on the `plus` icon. IIH Essentials discovers automatically all available connectors. In this case OPC UA Connector is shown.
## Configure IIH Essentials

<p><kbd><img src="graphics/iihessentials_addconnector.png"/></kbd></p>
In your IED Web UI open the app IIH Essentials.

3. To use the connector click on `Add`. After that the connector must be activated. Therefore select this connector and click on `edit`, set `status` to active and save.
1. Click on the icon `Connectors` on the left sidebar. To add a connector click on the `plus` icon. IIH Essentials discovers automatically all available connectors. In this case OPC UA Connector is already shown.

<p><kbd><img src="graphics/iihessentials_opcuaconnector.png"/></kbd></p>

The connector (here OPC UA Connector) is now activated and connected to the IIH Essentials.

<p><kbd><img src="graphics/iihessentials_opcuaconnector_status.png"/></kbd></p>

### Configure an Asset with variables

An Asset is a digital representation of a machine or automation system with one or more automation units (e.g. PLC). The data that describes an Asset is collected and stored. The data is then made available for further processing and evaluation.

1. On the left sidebar click the icon `Assets & Connectivity`. For the "edge" Asset you can add child Assets as needed. Click `Create first variable` or `Add variable` on the right side to add one or more tags.
1. On the left sidebar click the icon `Manage Data`. For the "edge" Asset you can add child Assets as needed. Click on the `Plus Icon` next to edge or the `Plus Icon` on the right side to add one or more tags.
<p><kbd><img src="graphics/asset_creation.png"/></kbd></p>

2. Choose OPC UA Connector and select one or multiple tags.
<p><kbd><img src="graphics/mapping_tags.png"/></kbd></p>

<p><kbd><img src="graphics/iihessentials_addvariable.png"/></kbd></p>

After adding all variables it looks as following

<p><kbd><img src="graphics/Data_Service_Assets.PNG"/></kbd></p>
<p><kbd><img src="graphics/result.png"/></kbd></p>

Using the **variables preview**, you can immediately check whether data is received from Databus:
Using the **variables preview**, you can immediately check whether data is received from Databus (The checkbox **Store** has to be selected):

<p><kbd><img src="graphics/Data_Service_Preview.PNG"/></kbd></p>

<p><kbd><img src="graphics/data_preview_graph.PNG"/></kbd></p>

The **data storage period** can be set individually for each Asset. The data is deleted from the disk after this time.
To change the this time period, click on edit next to the name of the Asset:
To change the time period, click on the **Gear Icon** next to the name of the Asset:

<p><kbd><img src="graphics/Data_Service_Retention.PNG"/></kbd></p>

Expand All @@ -108,7 +106,8 @@ Choose the register `Aspects` on the created Asset to create a new Aspect by cli

<p><kbd><img src="graphics/iihessentials_addaspect.png"/></kbd></p>

Hint: An Aspect can include several variables, but each variable can only be assigned to one Aspect.
Hint: An Assets can have multiple Aspects/Assets for Children, but Aspects can exclusively have Aspects for Children.

<p><kbd><img src="graphics/iihessentials_aspects.png"/></kbd></p>

Now you are ready to create your own Assets or incorporate additional Apps ([Performance Insights](https://github.com/industrial-edge/performance-insight-getting-started)).
Binary file modified docs/graphics/Data_Service_Preview.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/graphics/Data_Service_Retention.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/graphics/IE_Databus.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/graphics/IE_Databus_User.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/graphics/Opcua_connector_element.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/graphics/Opcua_datasource.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/graphics/asset_creation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/graphics/data_preview_graph.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/graphics/iihessentials_addaspect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/graphics/iihessentials_aspects.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/graphics/iihessentials_databus_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/graphics/iihessentials_opcuaconnector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/graphics/mapping_tags.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/graphics/opcuaconnector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/graphics/result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.