This application example can be used to create a JS application that interacts with the IEM and IED public APIs to automatically onboard multiple Edge Devices to the IEM and activate them. Currently, this example shows two onboarding solutions:
- Perform API calls via a standalone docker-based Node.js application in a machine connected to the same IEM/IEDs subnet or
- Run this app on an already onboarded IED.
Public Edge Management's and Edge Device's APIs enable us to interact with the system and automate different processes. Here, we laverage those APIs to automate the onboarding process of multiple Edge Devices to the IEM. This documentation describes how to automate this process using a Node.js application. The functionality of the application is as follows. When your Edge Device(s) are setup and have its own IP address(es), you can configure the device configuration in provided excel-list. The excel file has a strict structure which has to be followed in order for tha application to run correctly. Different configurations are divided in sheets and required information in the each sheet is highlighted with "*" symbol. The provided file consists of some representative examples.
When you are done configuring the edge devices, you can run the application which then onboards all your edge devices to the IEM using different API calls. The application can run either as a standalone docker-based application or run on another edge device. The process is done synchronously, so the devices are onboarded one after another to prevent IEM overload. More information can be found in docs. The pictures below show the network configuration for each use case. Important! This example follows the approach of running the application on edge device. At the moment, different device types are not supported so only IPC227E can be onboarded over this application.
- Installed Industrial Edge Management
- Linux VM with docker and docker-compose installed
- Installed Industrial Edge App Publisher
- Edge Devices are setup, switched on and with known IP and MAC addresses
- Industrial Edge Device V 1.5.0-56
- Industrial Edge Management V 1.5.6
- Industrial Edge Publisher V 1.5.6
- VM Ubuntu 20.04
- Docker 19.03.13
To successfully run this application you need to follow three steps:
Detailed description of the installation steps can be found here.
- 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.