Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/industrial-edge/hello-world-at-scale

This application example shows how to use configuration files and device tags for mass deployment.
https://github.com/industrial-edge/hello-world-at-scale

ie-config ie-tags industrial-edge v1-3

Last synced: 1 day ago
JSON representation

This application example shows how to use configuration files and device tags for mass deployment.

Awesome Lists containing this project

README 

        
# Hello World at Scale



This application example shows how to use configuration files and device tags for mass demployment.



- [Hello World at Scale](#hello-world-at-scale)

  - [Description](#description)

    - [Overview](#overview)

  - [Requirements](#requirements)

    - [Used Components](#used-components)

  - [Installation](#installation)

  - [Usage](#usage)

  - [Documentation](#documentation)

  - [Contribution](#contribution)

  - [License and Legal Information](#license-and-legal-information)

  - [Disclaimer](#disclaimer)



## Description



### Overview



This application is based on the [Hello World](https://github.com/industrial-edge/hello-world) application example.



## Requirements



### Used Components



- OS: Windows or Linux

- Docker minimum V18.09

- Docker Compose V2.4

- Industrial Edge App Publisher (IEAP) V1.2.7

- Industrial Edge Management (IEM) V1.3.0-58

- Industrial Edge Device (IED) V1.2.0-56



## Installation



This example is based on the Hello World application, you can find how to install it [here](https://github.com/industrial-edge/hello-world/blob/main/docs/installation.md)



## Usage



After installing the application, login to the Industrial Edge Device and click on the application icon to open a web page in your browser.



![Without Configuring](./docs/graphics/original.png)



As we can see, the application looks the same as the original Hello World application.



We will create new JSON file that will contain our configuration with the following content.



```json

{

  "title": "Configuration and Device Tags",

  "ip": "##$ip$##",

  "deviceName": "##$deviceName$##" 

}

```



The *##$ip$##* and *##$deviceName$##* indicate placeholders that will be replaced by device tags.



Let's now create the device tags. Head over to Industrial Edge Management and open *Edge Devices/My Edge Devices/.../Tags*.



![Tags location](./docs/graphics/tags_1.png)



Add the two tags as mentioned before.



![New tags](./docs/graphics/tags_2.png)



Now we will upload our config.json file to Industrial Edge Management. Open *Applications/My Projects/config-device-tags/Configurations* and add new configuration.



![Configuration Location](./docs/graphics/add_config_1.png)



![New configuration](./docs/graphics/add_config_2.png)



The template file is the *config.json* file we created earlier.



Now that we have created the configuration, we will download it to the Industrial Edge Device. Open *My Installed Apps/.../Update Configuration*



![Adding configuration to the application](./docs/graphics/update_config_1.png)



![Updating the application with the configuration](./docs/graphics/update_config_2.png)



After the configuration is downloaded, refresh the application website. You should see the device name and IP displayed.



![Updated Application](./docs/graphics/updated.png)



## 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://forum.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)

  - [Industrial Edge documentation page](https://docs.eu1.edge.siemens.cloud/index.html)

  

## Contribution



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](https://cla-assistant.io/industrial-edge/) (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.



## License and Legal Information



Please read the [Legal information](LICENSE.txt).



## Disclaimer



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.