Application example how to communicate over MQTT broker (called Databus in case of Industrial Edge) using Flow Creator and Python.
There are also implementations in other programming languages, you can find them in their own repositories:
Javascript : https://github.com/industrial-edge/pingpong-nodejs
C : https://github.com/industrial-edge/pingpong-c
If you want to run everything locally with single command just run docker-compose up -d and open webpage on localhost:1880 and import flows.
This application example demonstrates how Industrial Edge application can communicate with Databus using MQTT protocol. The goal is to send a string "Ping" message to Databus (MQTT broker) to a topic "topic1" and subscribe to MQTT topic "topic2" which should return "Pong python". The return message is generated by this python application. You can play virtual ping pong using this application!
Ready to use application example can be downloaded on Industrial Edge GitHub repository in the releases section called PingPongApplicationExample_x.x.x.app.zip. After unzipping this file you can directly import the .app file to your Industrial Edge Management system.
The release section also includes a docker base image that was used for this application example. The base image is included here for legal reasons.
A picture bellow shows the application data flow and architecture from the docker container point of view.
This application version 1.1.x was created and tested using these components
- Industrial Edge App Publisher V1.10.5
- Docker Engine 20.10.2
- Docker Compose V2.4
- Industrial Edge Device V1.10.0-9
- Databus Configurator V2.0.0-5
- Databus V2.0.0-4
- Flow Creator V1.12.0-1
- IE Management System V1.5.2-4
- IE Device is onboarded to a IE Management
- Databus Configurator is deployed to the IE Management
- Databus is deployed to the IE Device
- Flow Creator is deployed to the IE Device
You have two options how to install this app into Industrial Edge Management system. You can either use the Direct Import section to reuse .app we build for you or you can follow the Complete Installation section to create the .app yourself.
- Import .app application available at GitHub to your Industrial Edge Management using one of the two options
- Industrial Edge App Publisher (recommended)
- Catalog import functionality
- Install the imported app to onboarded Industrial Edge Device
- Follow the configuration steps in Installation guide.
Comprehensive instructions for building and installing this application is available in the Installation guide.
In order for this application to run properly on Industrial Edge Device (IED), the following two applications must be installed and configured on the IED
- Databus application
- Flow Creator application
For detailed explanation have a look in the Installation guide in the Testing section.
Have a look in the Installation guide testing section on how to play ping pong in Industrial Edge. :D
- You can find further documentation and help in the following links
Thank you for your interest in contributing. Anybody is free to report bugs, unclear documentation, and other problems regarding this repository in the Issues section. Additionally everybody is free to propose any changes to this repository using Pull Requests.
If you haven't previously signed the Siemens Contributor License Agreement (CLA), the system will automatically prompt you to do so when you submit your Pull Request. This can be conveniently done through the CLA Assistant's online platform. Once the CLA is signed, your Pull Request will automatically be cleared and made ready for merging if all other test stages succeed.
Please read the Legal information.
IMPORTANT - PLEASE READ CAREFULLY:
This documentation describes how you can download and set up containers which consist of or contain third-party software. By following this documentation you agree that using such third-party software is done at your own discretion and risk. No advice or information, whether oral or written, obtained by you from us or from this documentation shall create any warranty for the third-party software. Additionally, by following these descriptions or using the contents of this documentation, you agree that you are responsible for complying with all third party licenses applicable to such third-party software. All product names, logos, and brands are property of their respective owners. All third-party company, product and service names used in this documentation are for identification purposes only. Use of these names, logos, and brands does not imply endorsement.
