RUTX Azure IoT Hub cloud connection
The information in this page is updated in accordance with the RUTX_R_00.02.01.1 firmware version.
Introduction
This article contains instructions on how to configure a Teltonika Networks device in order to connect to the Azure IoT Hub. Azure IoT Hub is a managed service hosted in the cloud that acts as a central message hub for communication between an IoT application and its attached devices.
Prerequisites
You will need:
- A Teltonika Networks device;
- An Azure IoT Hub account.
Azure account creation
Visit https://azure.microsoft.com/en-us/ and create an account that will suit your needs, for testing purposes we will be using free Azure account.
Managing Azure services
- First you will want to create a Resource group for easier management of resources that will be added later. In Microsoft Azure home page.
- In new window, select Add
- And finish creating the Resource group Select your subscription, for this example Free Trial will be used.
- Name your group
- Choose server location for meta data. We will choose (South America) Brazil South and will use it during this example.
- At this moment Tags will be skipped, press Review + create at the bottom of screen and click Create to finish setup.
- After being redirected to Homepage click on Resource groups. You should see the newly created group, select it and press Add.
- Select Internet of Things or simply search IoT Hub and press Create.
- We leave default subscription and resource group and choose:
1. Region – (South America) Brazil South as before2. Create a name for IoT Hub3. Go to Size and scale tab
- For testing purposes, we are using F1: Free tier
- Inside IoT Hub list:
Scroll down to Explorers and select IoT devices
- Press New
-
In new device creation1. Enter Device ID2. Leave everything else on default and press Save
- After creating a new device you will be redirected back to IoT devices. Select the newly created Device ID
- In the device window you will find information needed to connect Teltonika devices to Azure IoT Hub.
- Select Resource groups
If it is not in very first page, click More services and locate it there.
Configuring Azure IoT Hub on RutOS
To configure an Azure IoT Hub instance on the Teltonika device it is essential to install the Azure IoT Hub package via the package manager.
- To install required package navigate to System > Package Manager and install Azure IoT Hub package
Navigate to Services > Cloud solutions > Azure IoT Hub and add a new instance. In the pop-up window there will be two different connection types available:
- Shared Access signature (SAS) key
- Device Provisioning Service (DPS)
In this article both connection types will be demonstrated.
SAS key connection type configuration
Configuring Azure IoT Hub using the SAS key connection type is straightforward:
After the instance is correctly configured the connection status icon will be visible. A green dot indicates that the connection is successful.
Device Provisioning Service (DPS) configuration
The IoT Hub Device Provisioning Service (DPS) is a helper service for IoT Hub that enables zero-touch, just-in-time provisioning to the right IoT hub without requiring human intervention, allowing customers to provision millions of devices in a secure and scalable manner.
One of the primary features of DPS is its capability to dynamically manage multiple device identities. This service manages the device identity creation using enrollments which can be configured using the following attestation types:
- 1. X.509 intermediate certificates
- 2. Symmetric keys
To learn more about DPS service read about it here
DPS X.509 attestation
- Root CA certificate
- Intermediate CA certificate
- Devices certificates 2. After successfully generating the certificates return to the Azure portal page and navigate to your Azure IoT Hub Device Provisioning Service (DPS) page. From there proceed create an enrollment group. The Microsoft guide for creating enrollment groups can be found here.
- In the ID scope field, specify your Azure DPS service ID. This value can be retrieved from the DPS instance found on Azure Portal page or by following the earlier guides.
- In the Registration ID field enter the "REG_ID" value you specified in the script. For example, "wiki-newly-generated-device".
- In the Symmetric key field enter the output value of the script that was used earlier here.
The required certificates and keys:
4. The final step is to return to the device WebUI and navigate to Services -> Cloud Solutions -> Azure IoT Hub page to create a new configuration instance:
4.1 Set connection type as a Device Provisioning Service (DPS);
4.2 Enter ID Scope of your DPS service page on Azure. This value can be retrieved from the DPS instance found on Azure Portal page or by following the earlier guide;
4.3 Specify the Registration ID. This is the subject common name (CN) of the device leaf certificate that was created using the earlier guide.
4.4 Upload the certificate chain file and the private key file.
With all the required values in place the configuration pop-up window should resemble the screenshot below:
After a couple of moments the status of the configured instance status icon should turn green indicating the device has successfully established connection to Azure server.
DPS Symmetric key mechanism
The Symmetric key mechanism configuration is more straightforward. To configure it go back to the Azure portal page, navigate to your DPS service page and create a new enrollment group with the Symmetric key attestation mechanism.
Inspecting the newly created enrollment group will reveal some keys. The primary key will be used to derive each individual device identity. This can be done using a simple script, which is available here
In the script, you will notice a couple of important variables: KEY and REG_ID. In the KEY field, you must specify the primary key, which can be obtained from the newly created enrollment group.
The REG_ID field specifies the device identity name that will be created. Upon executing the script a shared access key will be created.
Go back to the device WebUI Services -> Cloud Solutions -> Azure IoT Hub configuration page and add a new instance. In the configuration window select DPS connection type and Symmetric Key connection type.
If you are following this guide your configuration window should look similar to the screenshot below.
After a few moments the device should establish connection to the Azure server.
Moreover, we can return to the IoT Hub services in the Azure portal and check the device list. There we will see that the DPS service has created a new device identity named the same as what we specified in the REG_ID field in the script earlier.
Direct methods configuration
IoT Hub direct methods enable you to remotely invoke calls on devices from the cloud. Direct methods follow a request-response pattern and are meant for communications that require immediate confirmation of their result.
By default, all configuration instances will have this option disabled. To enable it, navigate on the router WebUI to Services -> Cloud Solutions -> Azure IoT Hub and press the edit button on the specific instance. Afterwards the "Enable Direct Methods" option needs to be enabled.
For testing and demonstration purposes we will use the Azure IoT Explorer application. The Azure IoT Explorer is a graphical tool for interacting with devices connected to your IoT hub. To learn more about this tool you can follow the Microsoft documentation here.
After enabling the Direct Method feature go to Azure IoT Explorer, select the appropriate device identity and navigate to the Direct Methods tab. All our devices support the api_call direct method which exposes the API interface to be used from the Azure side. In this example we will make a simple GET request to retrieve the I/O status of the device. Full documentation of Teltonika devices API can be found here .
The Azure IoT Explorer Direct Method tab will have a Payload field. In this field the api_call method expects JSON formatted data.
The API call expects at least two parameters. The first one is called "method" which needs to have an integer value between zero and three, corresponding to the API method type - either GET, POST, PUT or DELETE. The second parameter is "endpoint" which expects a string value of the API endpoint. In this case, we will call the /io/status endpoint.
After pressing the "Invoke Method" button the response from the device will be visible which is a standard API response specified in our documentation.
To determine the appropriate payload and method to use we provide an additional file currently called teltonikaGenericDevice.json. This file is written in Digital Twin Definition Language (DTDL). To learn more about DTDLs and Digital Twins read about it in Microsoft documentation here.
In this file you can see that it supports the api_call method, which accepts three values. The request body is optional, as some methods, such as the GET method, may not require it. JSON files can be downloaded here
The IoT Explorer can be configured to parse DTDL files and display them to the user for easier work:
IoT plug and Play configuration
Navigate to the "IoT Plug and Play components" tab on the IoT Explorer. Initially there may be an error stating that it did not retrieve an interface model. To resolve this click on the "Configure" button. In this guide a local folder will be added by pressing the "Add" button.
The specified directory must have the DTDL ".json" files. After adding the local folder press the "Save" button.
Return to the device identity Plug and Play tab. Now you will be able to see two components with model IDs named "genericDevice" and "deviceInformation". The generic device will display the DTDL interface description.
In the upper toolbar select the "Commands" tab. There you will see that IoT Explorer has parsed the API call method and created three new fields. Now we can try to call the same I/O status method that we called previously.
We can see that some information was correctly retrieved from the router. This workflow makes it easier to work with API calls from the Azure side.
Sending data with "Data to Server" feature
The Data to Server service allows you to set up collections that collect data from various sources and periodically sends it to various servers. We can configure this feature to send data from the device to Azure IoT Hub.
Data to Server configuration
To configure the Data to Server service on Teltonika devices navigate to Services -> Data to Server on the WebUI. This guide will cover only the collection output part. To learn more about Data to Server features you can find the dedicated guide on our Wiki. From this point it is assumed the collection is properly set up with correct inputs.
In the "Configuration type" field you can choose whether to use an existing Azure IoT Hub configuration or configure a new and unique Azure IoT Hub configuration. In this example we will stick with the previously created Azure IoT Hub instance configuration. If you choose to create a new unique Azure IoT Hub configuration on the Data to Server instance you will need to input all the options that were discussed earlier in this guide.
If you are following this guide your configuration should resemble something similar to the screenshot below.
Checking if data reaches IoT Hub on Azure
To determine whether data successfully reaches Azure IoT Hub select your device and navigate to the "Telemetry" tab on the Azure IoT Explorer. Ensure that "Use built-in event hub" option is enabled and press the "Start" button. After some time you should see that data was sent from the device to the Azure IoT Hub.
External links
- https://azure.microsoft.com/en-us/
- https://developers.teltonika-networks.com/
- https://learn.microsoft.com/en-us/azure/iot/howto-use-iot-explorer
- https://learn.microsoft.com/en-us/azure/iot-dps/how-to-legacy-device-symm-key?tabs=linux&%3Bpivots=programming-language-ansi-c&pivots=programming-language-ansi-c#derive-a-device-key
- https://learn.microsoft.com/en-us/azure/iot-dps/tutorial-custom-hsm-enrollment-group-x509?pivots=programming-language-ansi-c#create-a-root-ca-certificate
