Release on IE Hub¶

This section provides insights for device builders who want to publish their Industrial Edge Devices. It explains how to make your device type and firmware available to all IE Hubs. Before proceeding with this process, it is important to ensure that you have successfully passed the Ecosystem Review, which you can find more information about here.

Device_OverviewOnboarding

During the device development process, the device builder creates metadata information including the required artifacts for the publishing process, e.g. Device type, release notes, firmware file, software package (for SW-based devices).

Initially, these files and artifacts are only visible within the Industrial Edge Management of the device builder. To make the device type and firmware updates visible to customers, they need to be published to the Industrial Edge Hubs globally, allowing them to sync in the device catalogs of the Industrial Edge Managements. This process ensures that your device type and firmware updates can be accessed and utilized by customers across various Industrial Edge Hubs.

release_on_IEH

To make your device type and firmware updates available to customers, you need to send the files to the Siemens Ecosystem team and initiate the release process. You can find more information on the release process here. Once you've submitted the files, they will be made available for a period of 3 weeks on the Partner Stage. During this time, the files will undergo thorough testing and evaluation. If no issues or findings arise during this period, the files will be released to the Production environment. This process ensures that your device type and firmware updates are thoroughly reviewed and ready for deployment to all Industrial Edge Hubs.

Publishing Device Types¶

For publishing device type on the Industrial Edge Hub, the following folder structure must be respected.

Folder Structure¶

Device Type Name.zip/ 
├── Device Type Name/
     ├──assests/
     │     ├── icon.svg
     │     ├── vendor.png
     │     ├── ports.png
     ├── device_description.json

Section	Description	Name Structure
icon.svg	Device type icon image file.	It should end with .svg or .png.
vendor.png	Device type vendor image file.	It should end with .svg or .png.
ports.png	Device type ports image file. This file is optional.	It should end with .svg or .png.
device_description.json	This .json file includes device type descriptions.	It should be a .json file. The name should be exactly: device_description.json

Publishing Firmware Release¶

For publishing firmware release on the Industrial Edge Hub, the following folder structure must be respected.

Folder Structure¶

    Device Type Version Name/
    ├── firmware/
         ├── ied.7z 
         ├── ied_readme.7z
         ├── firmware-release-name.swu 
         ├── release-releaseId.json 
         └── ReleaseNotes-version-name.md

Section	Description	Name Structure
ied.7z	It includes OSS files.	It should end with .7z. The name should be exactly: ied.7z
ied_readme.7z	It includes the OSS readme file.	It should end with .7z. The name should be exactly: ied_readme.7z
firmware-release-name.swu	The firmware release artifact file.	It should end with .swu.
release-releaseId.json	This .json file includes information about the firmware and firmware release.	It should end with .json.
ReleaseNotes-version-name.md	This .md file includes release notes.	It should end with .md.

Publishing Software¶

For publishing software on the Industrial Edge Hub, the following folder structure must be respected.

Folder Structure¶

    Device Type Version Name/
    └── software/
        ├── install-version-name.tar.gz 
        ├── oss-version-name.tar.gz         
        └── readme-version-name.tar.gz

Section	Description	Name Structure
install-version-name.tar.gz	Installation file of the related software version.	It should start with install- and end with tar.gz.
oss-version-name.tar.gz	OSS file of the related software version.	It should start with oss- and end with tar.gz.
readme-version-name.tar.gz	Readme file of the related software version.	It should start with readme- and end with tar.gz.

Publishing Software & Firmware¶

For publishing both software and firmware on the Industrial Edge Hub, the following folder structure must be respected.

Folder Structure¶

Device Type Version Name/
├── software/
│    ├── oss-version-name.tar.gz 
│    ├── readme-version-name.tar.gz
│    └── install-version-name.tar.gz
└── firmware/
     ├── firmware-release-name.swu
     ├── ReleaseNotes-version-name.md
     ├── release-releaseId.json
     ├── ied.7z
     └── ied_readme.7z

Section	Description	Name Structure
oss-version-name.tar.gz	OSS file of the related software version.	It should start with oss- and end with tar.gz.
readme-version-name.tar.gz	Readme file of the related software version.	It should start with readme- and end with tar.gz.
install-version-name.tar.gz	Installation file of the related software version.	It should start with install- and end with tar.gz.
firmware-release-name.swu	The firmware release artifact file.	It should end with .swu.
ReleaseNotes-version-name.md	This .md file includes release notes.	It should end with .md.
release-releaseId.json	This .json file includes information about the firmware and firmware release.	It should end with .json.
ied.7z	It includes OSS files.	It should end with .7z. The name should be exactly: ied.7z
ied_readme.7z	It includes the OSS readme file.	It should end with .7z. The name should be exactly: ied_readme.7z

Device Builder Capabilities¶

While publishing a new device, you need to complete the capability statement for Device Builder. For more instructions refer Device Builder Capabilities. This data is required by Industrial Edge Compatibility Checker which is a tool to provide clear insights into which devices and versions meet the needs of specific applications and versions. This transparency ensures a safer, smoother update process and better decision-making when purchasing applications or devices.