First upload notifier

LICENSE.md

@@ -0,0 +1,30 @@
+# **Legal information**
+
+## **Use of application examples**
+
+Application examples illustrate the solution of automation tasks through an interaction of several components in the form of text, graphics and/or software modules. The application examples are a free service by Siemens AG and/or a subsidiary of Siemens AG (“Siemens”). They are non-binding and make no claim to completeness or functionality regarding configuration and equipment. The application examples merely offer help with typical tasks; they do not constitute customer-specific solutions. You yourself are responsible for the proper and safe operation of the products in accordance with applicable regulations and must also check the function of the respective application example and customize it for your system.
+
+Any change to the application examples is your responsibility. The application examples are not required to undergo the customary tests and quality inspections of a chargeable product; they may have functional and performance defects as well as errors. It is your responsibility to use them in such a manner that any malfunctions that may occur do not result in property damage or injury to persons. Siemens reserves the right to make changes to the application examples at any time without notice. The application examples of this repository are licensed under the MIT License (see below).
+
+## MIT License
+
+Copyright 2020 Siemens AG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+## **Security information**
+
+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 constitute one element of such a concept. Customers are responsible for preventing unauthorized access to their plants, systems, machines and networks. Such systems, machines and components should only be connected to an enterprise network or the Internet if and to the extent such a connection is necessary and only when appropriate security measures (e.g. firewalls and/or network segmentation) are in place.  
+For additional information on industrial security measures that may be implemented, please visit https://www.siemens.com/industrialsecurity.
+
+Siemens’ products and solutions undergo continuous development to make them more secure. Siemens strongly recommends that product updates are applied as soon as they are available and that the latest product versions are used. Use of product versions that are no longer supported, and failure to apply the latest updates may increase customer’s exposure to cyber threats.
+
+To stay informed about product updates, subscribe to the Siemens Industrial Security RSS Feed at: https://www.siemens.com/industrialsecurity.
+
+
+
+

README.md

@@ -1,2 +1,125 @@
-# notifier
-Example showing how to use the Industrial Edge App "Notifier" to create notifications in case of an event.
+# Notifier application example
+
+This example shows how to use the Industrial Edge App "Notifier" to create notifications in case of an event.
+
+- [Notifier application example](#notifier-application-example)
+  - [Description](#description)
+    - [Overview](#overview)
+    - [General task](#general-task)
+  - [Requirements](#requirements)
+    - [Prerequisities](#prerequisities)
+    - [Used components](#used-components)
+    - [TIA Project](#tia-project)
+  - [Installation steps](#installation-steps)
+  - [Usage](#usage)
+  - [Documentation](#documentation)
+  - [Contribution](#contribution)
+  - [Licence and Legal Information](#licence-and-legal-information)
+
+## Description
+
+### Overview
+
+This document describes how to manage globally available notifications generated in case of an event.
+These events can be watched by a mobile phone or a smartwatch.
+
+![0](docs/graphics/0_Overview.PNG)
+
+### General task
+
+A filling process is monitored by the Industrial Edge. In case of certain events notifications are generated by the system using the Notifier.
+Data is read from the PLC using the S7 Connector and published to the IE Databus.
+Necessary values are collected and managed by the [Data Service](https://github.com/industrial-edge/data-service).
+The Notifier as well as Performance Insight (for KPIs) can use these data to create the following notification rules:
+
+- Information: Production was started
+- Warning: Tank level falls below a defined level
+- Alert: Production quality falls below defined KPI level
+
+## Requirements
+
+### Prerequisities
+
+- Access to an Industrial Edge Management System (IEM)
+- Onboarded Industial Edge Device on IEM
+- Installed System Configurators for Databus and S7 Connector
+- Installed System Apps Databus and S7 Connector
+- Installed Apps Data Service, Performance Insight and Notifier
+- Edge device is connected to PLC
+- TIA portal project for filling application available
+- Google Chrome (Version ≥ 72) or Firefox (Version ≥ 62)
+
+### Used components
+
+- Industrial Edge Management (IEM) V1.0.10
+  - IE Databus V1.0.11
+  - IE Databus Configurator V1.0.44
+  - S7 Connector V1.0.22
+  - S7 Connector Configurator V1.0.9
+  - Data Service V1.0.9
+  - Performance Insight V1.0.9
+  - Notifier V1.0.9
+- Industrial Edge Device V 1.0.0-34
+- TIA Portal V16
+- PLC: CPU 1511 FW 2.8.3
+
+### TIA Project
+
+The used TIA Portal project can be found in the [miscellenous repository](https://github.com/industrial-edge/miscellenous) under the following name and is also used for several further application examples:
+
+- [tia-tank-application-20201028.7z](https://github.com/industrial-edge/miscellenous/blob/main/tia-tank-application-20201028.7z)
+
+## Installation steps
+
+You can find the further information about the following steps in the [docs](docs/Installation.md)
+
+- Configure PLC project
+- Configure PLC Connection (Databus, S7 Connector, Data Service)
+- Configure Performance Insight
+- Configure Notifier
+
+## Usage
+
+To run the application, follow these instructions:
+
+- Make sure that the  PLC is connected to the Edge device and TIA project is downloaded
+- S7 Connector, Databus and Data Service applications are running
+- Performance Insight and Notifier are running
+- Open the Notifier user interface
+- Start the filling application via the HMI
+
+Simulate some 'faulty bottle' productions in the HMI
+-> alert "Low limit violated" (KPI) appears in the Notifier
+
+![5_3](docs/graphics/5_3_Notifier.PNG)
+
+Wait till the tank level falls near 160l
+-> warning "tank empty" appears in the Notifier
+
+![5_4](docs/graphics/5_4_Notifier.PNG)
+
+Reset and start the filling simulation in the HMI
+-> information "production started" appears in the Notifier
+
+![5_5](docs/graphics/5_5_Notifier.PNG)
+
+Hint: Notifications can be triggered by other apps, such as Performance Insight.
+To identify where the notification originated, the detail text of the respective notification contains the Operating App area.
+
+By accepting a notification, you inform  other users that you will take care of the issue. The acceptance of a notification cannot be undone.
+A notification is marked as "automatically resolved" in the Archive tab, when it has not been accepted by any user or the reason for triggering no longer exists.
+
+## Documentation
+
+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://www.siemens.com/industrial-edge-forum)
+  - [Industrial Edge landing page](http://siemens.com/industrial-edge)
+
+## Contribution
+
+Thanks for your interest in contributing. Anybody is free to report bugs, unclear documenation, and other problems regarding this repository in the Issues section or, even better, is free to propose any changes to this repository using Merge Requests.
+
+## Licence and Legal Information
+
+Please read the [Legal information](LICENSE.md).

docs/Installation.md

@@ -0,0 +1,81 @@
+# Configuration
+
+- [Configuration](#configuration)
+  - [Configure PLC project](#configure-plc-project)
+  - [Configure PLC Connection](#configure-plc-connection)
+  - [Configure Performance Insight](#configure-performance-insight)
+  - [Configure Notifier](#configure-notifier)
+
+## Configure PLC project
+
+1) Open TIA portal and open the project containing the filling application
+2) Download the PLC program to the PLC and set the PLC into RUN
+3) Open the HMI to control the filling application
+
+## Configure PLC Connection
+
+To read data from the PLC and provide the data, we will use S7 Connector to establish connection with the PLC via OPC UA.
+The S7 Connector sends the data to the Databus, where the Data Service app can collect what is needed for the notification rules.
+In order to build this infrastructure, these apps must be configured properly:
+
+- IE Databus
+- S7 Connector
+- Data Service
+
+Please refer to [using the Data Service](https://github.com/industrial-edge/data-service).
+
+Finally the configurations should look like this:
+
+**IE Databus**
+
+![1](graphics/1_Databus.PNG)
+
+**S7 Connector**
+
+![2](graphics/2_S7_Connector.PNG)
+
+**Data Service**
+
+![3](graphics/3_DataService.PNG)
+
+## Configure Performance Insight
+
+In order to create a KPI and assign appropriate variables, we need to use the Performance Insight app.
+Limit values and activate notifications can be configured here, which will be forwarded to the Notifier.
+
+Open the user interface of the Performance Insight app on your IE Device. On the left bar navigate to Configuration > KPI types and click "New KPI type".
+Create a new KPI "production quality" with the following formula (`<faulty>` and `<produced>` are operands)
+
+`100 - (<faulty> / <produced> * 100%)`
+
+![4_1](graphics/4_1_PerformanceInsight.png)
+
+Navigate to My Plant > filling application > Parameter (drop down menu on the top of the heading).
+
+![4_2](graphics/4_2_PerformanceInsight.png)
+
+Choose 'New KPI instance' to create a new instance according to the following settings:
+
+![4_3](graphics/4_3_PerformanceInsight.png)
+
+Select the tab 'Limits' to enter the low limit for the KPI value and activate the notification option:
+
+![4_4](graphics/4_4_PerformanceInsight.png)
+
+Now a new KPI instance should be available:
+
+![4_5](graphics/4_5_PerformanceInsight.png)
+
+## Configure Notifier
+
+In the chapter above we already created an alert notification for the KPI "production quality".
+In order to create some warning and information notifications, we now use the Notifier app.
+
+Open the user interface of the Notifier app on your IE Device. On the left bar navigate to Settings > Manage notification rules and click "Add notification rule".
+Create a new warning notification "tank empty" with the following settings:
+
+![5_1](graphics/5_1_Notifier.PNG)
+
+Create a further information notification "production started" with the following settings:
+
+![5_2](graphics/5_2_Notifier.PNG)