EDGEHOG
Search…
Edgehog 101
EDGE Resources
Using the Device Manager
Local API
Cloud API
File Uploader
This feature will give customers the ability to upload files to devices remotely, even in multiple campaigns.
Let's imagine this general-purpose functionality useful to manage machine configuration files or specific application configurations or firmware binary files specific to PLCs connected to the gateway.
As for devices and applications, the logic is to work with File Models, which will contain the actual Files.
As we will see, this feature allows the client to better manage the versioning of each file.
Create File Model
To create a File Model select Create File Model. Then enter:
- File Model Name;
- File Model Description;
- Upload File: You can use the button to select a file by uploading it from your PC. A limit of 20MB is set;
- Upload File Description: A useful description for the uploaded file, or file version, (e.g. v.1.0b, configuration Italy);
- Remote Path: Enter here the path on the device you wish to upload the selected files to. Due to security reasons, we defined a specific folder where the files can be uploaded. The path defined will be appended to the path
/var/lib/seco-iot/downloads/. If the path doesn’t exist, the folder will be created. If the file you want to upload already exists in the path you enter, it will be replaced by the uploaded one - Select Tags tags to filter the file model on the file model list;
- External ACK: If activated, once the file has been successfully uploaded to the device, EDGEHOG Device Manager still waits for an ACK message from a third-party application to confirm the successful download campaign to the Cloud (e.g. firmware updates of a PLC machine connected to the gateway can be managed through this functionality. There will be a piece of software on the gateway, a Docker Application for example, which will manage these update binary by communicating with the machine to be updated. This application, when it realizes that a new file has been downloaded via the File Uploader, has the possibility to verify its validity and confirm that everything is ok to the EDGEHOG Device Manager, through an internal API).
- Decompress on Arrival: This option becomes selectable only when a compressed file with extension
.zipis chosen for uploading. If activated, the compressed file will be decompressed automatically when it arrives on the device in the chosen folder.
Then press the Save button.
Files Models List
In this section a list of all created File Models and their details is available.
Here it’s possible to select a single File Models clicking on the line. Once the model is selected the File Model page is going to open.
Edit File Model
To edit a model, simply modify the fields or load a new File Version and press the Save button.
Upload a New File Version
By pressing the New Version button, on the table below, you can upload a new updated version of the selected file. For example, it could be a new release of the firmware or a revised or alternative version of a configuration.
Each time a new version of a file is uploaded it will be identified by an incremental version number that is automatically assigned.
If the user's file has its own version code that is different from the incremental loading version (e.g. version of a binary firmware, version of a configuration), it will be the user's task to keep track of this version by writing it in the Version Description field.
File Campaign
In this section, you can create a File Campaign by deciding which of the devices should be involved. Select:
- File Model;
- File Version: the version of the file to upload to the devices. You can choose a specific version file of a File Model to upload;
- Enter Campaign Name;
- Select Tags;
- Rollout Rate: Specifies the maximum number of devices that will be informed of the update per minute.
- Execution Timeout: Specifies the maximum amount of time (in minutes) a device should take to install the update.
If the operation on the individual device is not completed (with success or error) before the end of the Execution Timeout, the campaign will report the Timeout status on that device. The server will no longer wait for a response from the device, which may continue operations in the background and complete them successfully despite the online interface reports the Timeout.
Once you have entered all the parameters you can create the App Campaign by clicking on the button Create File Campaign. You will be redirected to the status page of the File Campaign where you can start it and see the status of each device being updated refreshing the page.
Files Campaigns List
In this section a list of all created campaigns and their status is available.
Here it’s possible to select a single campaign by clicking on the appropriate line. Once the campaign is selected the Campaign Recap page is going to open.
Once a file upload campaign is over, it will be visible in a dedicated tab inside each device involved. See the Device Page for more information.