Industrial Edge Starter Template
Overview
The "Industrial Edge Starter Template" is a starter template designed to kickstart any Mendix project meant to interact with Siemens Industrial Edge software. The starter template leverages the power of 5 different Mendix assets developed for Siemens Industrial Edge: Industrial Edge Databus Example, Industrial Edge Device API Connector, Industrial Edge IIH Essentials Connector & Test UI, and the Industrial Edge Plugin (Mx10).
Documentation
Introduction & Overview
The "Edge Starter Template" is a starter template designed to kickstart any Mendix project meant to interact with Siemens Industrial Edge software. The starter template leverages the power of 5 different Mendix assets developed for Siemens Industrial Edge:
- Industrial Edge Databus Example
- Industrial Edge Device API Connector
- Industrial Edge IIH Essentials Connector
- Industrial Edge IIH Connector Test UI
- Industrial Edge Plugin (Mendix 10)
After setting up the device using the Device API module’s UI, the Mendix developer can start exploring the data provided by the IIH Essentials Connector by using the IIH Essentials Test UI. After setting up a connection to the Databus using the Databus example implementation, the user can also explore the available topics to publish or subscribe to. The Device API, Test UI and Databus example are all accessible through the navigation. The Industrial Edge Plugin is used for deploying your Mendix app on your Edge device. This is achieved through Studio Pro. For instructions, head over to the documentation of the module.
To summarize, the Mendix developer can use the Edge Starter Template as a starting point for their Mendix on Edge projects.
Prerequisites
Ensure the following dependencies are installed from the Marketplace:
- Mendix Version 10.6.11 or higher
The Device API Connector needs the Encryption module to work, and the Databus Example relies on the MQTT Connector module. These modules are already included with the Starter Template.
Installation Guide
Step 1: Setting up Studio Pro
- Download the Edge Starter Template
- If you want to connect to an external Edge device, follow these steps:
- Go to your Edge Device’s UI by entering it’s IP address in your browser
- Click ‘Settings’ and then ‘System’
- Click ‘Download Edge Device Certificate Chain’
- Go back to Studio Pro and click ‘Settings’
- At ‘Certificates’, upload the certificate you just downloaded
- Next, make sure you have an encryption key set up for Encryption.EncryptionKey. This should be any string of 32 characters
- Lastly, set up a 32 character encryption key for MQTTConnector.EncryptionKey
Step 2: Set up the Edge Device
- Log in as MxAdmin and open the ‘Devices’ page
- Set up a main device first
- After that, you can set up an External device. This is what you usually do when testing and developing locally before deploying your app to the Edge device itself
- After entering the most essential credentials such as username, password and IP address, you are ready to connect
- Now you can explore the Databus and the IIH Test UI App
For further information on the individual components included in the Edge Starter Template, please consult the documentation for the Databus example, Device API Connector, IIH Essentials Connector, IIH Test UI and Industrial Edge Plugin.
Usage Guide
Use the navigation to explore the options the Starter Template offers out of the box. Feel free to use anything out of the USE_ME folders in your own projects, or use our implementations to get inspired.
Happy coding!