Enrollment Process Overview
1. Introduction
Enrolling an edge device consists of registering the device with the RIoT Secure Platform and installing the FUSION Core Firmware on the device.
When a device has been enrolled, application firmware can be installed on the device over-the-air.
This introductory guide provides an overview of the steps taken when enrolling a device.
Related Documentation
Enrollment TutorialsDevice Management
Firmware Management
Embedded Development
Firmware Over-the-Air Tutorial
2. Enrollment Steps
1.1. Prepare the Device Hardware
The RIoT Secure Platform supports different types of hardware.
If using the RIoT FUSION Shield, assemble the device according to the instructions provided for the device.
On devices that requires the use of a micro SD card, make sure to format and insert the SD card before installing the core firmware. Note that the SD card must be left inserted into the device. It should not be removed.
Devices that use an SD card:
-
Arduino Mega with the RIoT FUSION Shield and an Arduino MKR modem
-
Arduino Uno with the RIoT FUSION Shield and an Arduino MKR modem
Devices that don’t use an SD card:
- Arduino UNO R4 WiFi
1.2. Create a Device Entry in the Management Console
Open the Devices Screen in the Management Console to create a new entry for the device.
Fill in the properties in the device form. It is imoprtant to configure the device for the network that is used.
The RIoT Secure Platform supports WiFi, GSM, NB-IoT, and LTE networks. WiFi networks are configured by registering the name and password of the network. Other network types use slightly different parameters.
1.3. Download RIoTInstaller
Next step is to download the RIoTInstaller bundle from the Managment Console. Do this by clicking the download icon for the device to be enrolled.
1.4. Install the Core Firmware on the Device
The RIoTInstaller bundle contains the files needed to install (flash) the FUSION Core Firmware to the device. The process for flashing the firmware differs between boards. Consult the enrollment documentation to for the specific boards for detailed instructions.
Once the Core Firmware has been flashed to the device, it connects to the RIoT Secure Cloud to enroll the device. The enrollment process can be monitored in the Serial Monitor in the Arduino IDE (or a similar tool).
The enrollment may take up to 5-10 minutes.
1.5. Verify Device Status
Inspect the device in the Management Console to verify that it is enrolled.
Open the Devices Screen and inspect the device in the device table. Once the device is enrolled, the fields Enrolled and Last Communication should be updated.
When the device has been enrolled, application firmware can be installed.
2. Upload Application Firmware
Export the sketch for the application firmware from the Arduino IDE.
Use the Management Console to upload the exported file. Go to the Application Firmwares Screen and create a new firmware entry. Select the exported firmware sketch.
Then go to the Devices Screen in the Management Console and select the uploaded application firmware to deploy it to the device. This is done in the Microcontrollers section in the device details view.
Firmware deployment is done over-the-air and usually takes around 1 to 2 minutes.
3. Field Deployment
The enrollment process is typically performed in an office setting, as it involves using the Arduino IDE and connect to the device over USB.
Once the device has been enrolled, it can be deployed and installed in the field. Subsequent firmware updates are done over-the-air.