Azure IoT Hub Cloud Connection: Difference between revisions

From Teltonika Networks Wiki
VisualWikitext
(add modbus example)
No edit summary
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<b>Azure IoT Hub</b> is an open and flexible cloud platform that supports open-source SDKs and multiple protocols.
__TOC__
==Introduction==
This article contains instructions on how to configure a RUT router in order to connect to the Azure IoT Hub.<br>


{{Template:Networking_rutx_manual_fw_disclosure
{{Template:Networking_rutx_manual_fw_disclosure
Line 4: Line 10:
}}
}}


__TOC__
 
==Introduction==
This article contains instructions on how to configure a Teltonika Networks device in order to connect to the Azure IoT Hub. <b>Azure IoT Hub</b> 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==
==Prerequisites==


You will need:
You will need:


*A Teltonika Networks device;
*A router from the RUTX09 or RUTX11
*An Azure IoT Hub account.
*An Azure IoT Hub account


==Azure account creation==
==Azure account creation==
Line 21: Line 25:


<ul>
<ul>
     <li>First you will want to create a Resource group for easier management of resources that will be added later. In Microsoft Azure home page.</li>
     <li>First you will want to create a Resource group for easier management of resources that you will add later. In Microsoft Azure home page.</li>
     <ul>Select '''Resource groups''' <br>If it is not in very first page, click '''More services''' and locate it there. </ul>  
     <ul>Select '''Resource groups''' <br>If it is not in very first page, click '''More services''' and locate it there. </ul>  
     <div>[[File:Azure01.png|border|class=tlt-border|800px]]</div>
     <div>[[File:Azure01.png|border|class=tlt-border|800px]]</div>
Line 27: Line 31:
[[File:Azure02.png|border|class=tlt-border]]
[[File:Azure02.png|border|class=tlt-border]]


<li>And finish creating the Resource group </li>
<li>And then finish creating yours Resource group </li>


Select your subscription, for this example '''Free Trial''' will be used.  
Select your subscription, we are using '''Free Trial''' for this test.  
#Name your group
#Name your group
#Choose server location for meta data. We will choose '''''(South America) Brazil South''''' and will use it during this example.
#Finally, choose server location for meta data. We will choose '''''(South America) Brazil South''''' and will use it during test where available.
[[File:Azure03_RUTX.png|border|class=tlt-border]]
[[File:Azure03_RUTX.png|border|class=tlt-border]]


<li>At this moment Tags will be skipped, press '''Review + create''' at the bottom of screen and click Create to finish setup.</li>
<li>At this moment we will skip adding Tags since we will be able to do that later if needed, so simply press '''Review + create''' at the bottom of screen and then click Create to finish setup.</li>
[[File:Azure04.png|border|class=tlt-border]]
[[File:Azure04.png|border|class=tlt-border]]
<br>
<br>
[[File:Azure05_RUTX.png|border|class=tlt-border]]
[[File:Azure05_RUTX.png|border|class=tlt-border]]


<li>After being redirected to Homepage click on '''Resource groups'''. You should see the newly created group, select it and press '''Add'''.</li>
<li>You will be redirected to Homepage, then click on '''Resource groups'''. You should see yours newly created group, select it, and press '''Add'''.</li>


[[File:Azure06_RUTX.png|border|class=tlt-border|800px]]
[[File:Azure06_RUTX.png|border|class=tlt-border|800px]]
Line 51: Line 55:
     <div>1. Region – '''(South America) Brazil South''' as before</div>  
     <div>1. Region – '''(South America) Brazil South''' as before</div>  
     <div>2. Create a name for IoT Hub</div>
     <div>2. Create a name for IoT Hub</div>
     <div>3. Go to '''Size and scale tab''' </div>
     <div>3. Then go to '''Size and scale tab''' </div>
</li>
</li>
[[File:Azure08_RUTX.png|border|class=tlt-border|800px]]
[[File:Azure08_RUTX.png|border|class=tlt-border|800px]]
Line 57: Line 61:
   <div>At the bottom of the screen '''Review + create'''</div>
   <div>At the bottom of the screen '''Review + create'''</div>
[[File:Azure09.png|border|class=tlt-border|800px]]
[[File:Azure09.png|border|class=tlt-border|800px]]
     <div>Click on >> '''Create''' </div>
     <div>And finally, Click on >> '''Create''' </div>
[[File:Azure10_RUTX.png|border|class=tlt-border|400px]]
[[File:Azure10_RUTX.png|border|class=tlt-border|400px]]
   <div>'''Note:''' Wait until resource deploys and press Go to '''Resources''' </div>
   <div>'''Note:''' Wait until resource deploys and press Go to '''Resources''' </div>
Line 74: Line 78:
[[File:Azure13_RUTX.png|border|class=tlt-border|400px]]
[[File:Azure13_RUTX.png|border|class=tlt-border|400px]]


     <li>After creating a new device you will be redirected back to IoT devices. Select the newly created '''Device ID'''</li>
     <li>After you finish creation, you will be redirected back to IoT devices select yours newly created '''Device ID'''</li>
[[File:Azure14_RUTX.png|border|class=tlt-border|800px]]
[[File:Azure14_RUTX.png|border|class=tlt-border|800px]]


     <li>In the device window you will find information needed to connect Teltonika devices to Azure IoT Hub.</li>
     <li>In your device window you will find information needed to connect RUT devices to Azure IoT Hub.</li>
       <div>For now only '''connection string''' will be used. Copy Primary Connection string. </div>
       <div>For now, we will only need '''connection string'''. Copy Primary Connection string by pressing copy icon next to it. </div>
[[File:Azure16_RUTX.png|border|class=tlt-border|800px]]
[[File:Azure16_RUTX.png|border|class=tlt-border|800px]]


</ul>
</ul>


==Configuring Azure IoT Hub on RutOS==
==Configuring RUTX Azure IoT Hub==
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.
<ul>
<ul>
<li>To install required package navigate to '''System > Package Manager''' and install Azure IoT Hub package </li>
<li>First open router WebUI, go to '''System > Package Manager''' and install Azure IoT Hub package </li>
[[File:Azure RutOSconf 1.png|border|class=tlt-border]]
[[File:Networking_rutx_configuration_examples_package_manager_v1.png|border|class=tlt-border]]
</ul>
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:
<ul> <li> '''Shared Access signature (SAS) key''' </li>
<li> '''Device Provisioning Service (DPS)''' </li> </ul>
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:
<div>1. Make sure to enable the instance by pressing '''Enable''' button </div>
<div>2. Paste previously copied '''Connection String'''</div>
<div>3. Press '''Save & Apply''' button </div>
[[File:Azure RutOSconf 2.2.png|border|class=tlt-border]]
</ul>
After the instance is correctly configured the connection status icon will be visible. A green dot indicates that the connection is successful.
[[File:Azure RutOSconf 3.png|border|class=tlt-border]]
 
===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.
<li>Now navigate to ''' Services > Cloud solutions > Azure IoT Hub''' </li>
<div>1. Select Enable '''Azure IoT Hub monitoring'''</div>
<div>2. Paste previously copied Connection String (For this test we leave other values as default)</div>
<div>3. Select what kind of information you want to send to Azure IoT Hub</div>
<div>4. Press '''Save''' </div>
[[File:Networking_rutx_configuration_examples_azure_iot_hub_v1.png|border|class=tlt-border]]


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:
<ul>
<li> 1. X.509 intermediate certificates </li>
<li> 2. Symmetric keys </li>
</ul>
</ul>
 
==Checking if Data reaches Azure IoT Hub==
To learn more about DPS service read about it [https://learn.microsoft.com/en-us/azure/iot-dps/ here]
 
====DPS X.509 attestation====  
<ul>
<ul>
<div> 1. The initial step generating certificates. The Microsoft guide for generating certificates can be found [https://learn.microsoft.com/en-us/azure/iot-dps/tutorial-custom-hsm-enrollment-group-x509?pivots=programming-language-ansi-c#create-an-x509-certificate-chain here] which explains each step of the process in detail.
<li>From router side, connect to it with CLI or SSH client and write in command '''azure_iothub''' and press Enter </li>
<div>- You should get answer that looks something like that, depending on what information you chose to send. </div>
[[File:Azure19_RUTX.png|border|class=tlt-border]]
<li>From Azure IoT Hub side you can check if it receives data. Go to IoT Hub that you created previously. Select '''Overview''', there you can see:
</li>
<div>1. How many devices are connected to hub, and how many messages it sent during chosen period of time.</div>
<div>2. Device to cloud messages, that your router is sending.</div><br>
<div>It should look something like that if IoT Hub is receiving data. </div>
[[File:Azure20_RUTX.png|border|class=tlt-border|800px]]
<li>To capture logs you will need '''Device Explorer''' for IoT Hub Devices.</li>
<div>For Windows you can get here: https://github.com/Azure/azure-iot-sdk-csharp/releases/tag/2019-1-4 </div><br>
<div>Scroll down to Assets, download and install '''SetupDeviceExplorer.msi''' </div>
[[File:Azure21.png|border|class=tlt-border]]
<li>Now you will need connection string of yours Azure IoT Hub, Not device. Navigate to IoT hub in your browser, then:</li>
<div>1. Click '''Shared access policies'''</div>
<div>2. Next choose '''iothubowner'''</div>
<div>3. And copy '''Connection string – primary key'''</div>
[[File:Azure22-1_RUTX.png|border|class=tlt-border|800px]]


The required certificates and keys:
<li>After that go back to Device Explorer: </li>
<li> '''Root CA certificate''' </li>
<div>1. In Configuration tab paste in Connection string that you just copied</div>
<li> '''Intermediate CA certificate''' </li>
<div>2. Copy HostName part from connection string and paste it in '''Protocol Gateway HostName'''</div>
<li> '''Devices certificates''' </li>
<div>3. Click '''Update''' </div>
[[File:Azure23_RUTX.png|border|class=tlt-border|600px]]


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 [https://learn.microsoft.com/en-us/azure/iot-dps/tutorial-custom-hsm-enrollment-group-x509?pivots=programming-language-ansi-c#create-an-enrollment-group here].
<li>Open Management tab </li>
</div>
<div>1. Click Update </div>
<div>2. You should see your device in the list below and '''Connection state''' </div>
[[File:Azure24_RUTX.png|border|class=tlt-border|800px]]


3. Return to the device WebUI and navigate to '''Services -> Cloud Solutions -> Azure IoT Hub''' page to create a new configuration instance:
<li>Go to Data tab</li>
<div>1. Click monitor, and wait for '''Event Hub Data''' to update (Depends on yours chosen interval)</div>
<div>2. Messages like this should start appearing. </div>
[[File:Azure25_RUTX.png|border|class=tlt-border|600px]]


3.1 Set connection type as a '''Device Provisioning Service (DPS)''';
==Setting router to Forward MQTT messages/commands to Azure IoT Hub==
<div>First you will need MQTT broker to subscribe to, for testing purposes we will set MQTT Broker in same router, and will use PC from LAN to sent MQTT messages.</div>


3.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;
<li>Go to Services > MQTT > Broker </li>
<div>1. Click '''Enable'''</div>
<div>2. Use same port in MQTT Broker and Azure IoT Hub settings.</div>
<div>3. Press '''Save'''</div>
[[File:Azure26-1_RUTX.png]]


3.3 Specify the '''Registration ID'''. This is the subject common name (CN) of the device leaf certificate that was created using the earlier guide.
<li>Go to '''Services > Cloud solutions > Azure IoT Hub'''</li>
<div>1. Enable monitoring </div>
<div>2. Use same Connection string as before (GSM values configuration) </div>
<div>3. Messages Type choose '''MQTT messages''' </div>
<div>4. Enter MQTT Host address, we are using 127.0.0.1 since our broker is set up on same router.</div>
<div>5. Port '''Same as MQTT Broker'''</div>
<div>6. And Topic under which router will subscribe to MQTT Broker</div>
<div>7. Press '''Save''', we will not need username or password.</div>
[[File:Azure27-2_RUTX.png]]


3.4 Upload the certificate chain file and the private key file.
</ul>
 
==Checking if MQTT messages are being forwarded to Azure IoT Hub==
With all the required values in place the configuration pop-up window should resemble the screenshot below:
 
[[File:Azure RutOSconf 11.png|border|class=tlt-border]]
 
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.
 
[[File:Azure RutOSconf 12.png|border|class=tlt-border]]
 
====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.
 
[[File:Azure RutOSconf 13.png|border|class=tlt-border]]
 
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 [https://learn.microsoft.com/en-us/azure/iot-dps/how-to-legacy-device-symm-key?tabs=linux&amp%3Bpivots=programming-language-ansi-c&pivots=programming-language-ansi-c#derive-a-device-key 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.
 
[[File:Azure RutOSconf 14.1.png|border|class=tlt-border]]
 
The '''REG_ID''' field specifies the device identity name that will be created. Upon executing the script a shared access key will be created.
 
[[File:Azure_RutOSconf_15.png|border|class=tlt-border]]
 
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.


===Linux===
<ul>
<ul>
<li> 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.</li>
<div>Connect to router with SSH, in logread you should see Router establishing connection to Azure IoT Hub: </div>
<li> In the '''Registration ID''' field enter the "REG_ID" value you specified in the script. For example, "wiki-newly-generated-device". </li>
[[File:Azure27-1.png|border|class=tlt-border]]
<li> In the '''Symmetric key''' field enter the output value of the script that was used earlier [https://learn.microsoft.com/en-us/azure/iot-dps/how-to-legacy-device-symm-key?tabs=linux&pivots=programming-language-ansi-c#derive-a-device-key here].</li>
<li>Open terminal and publish to MQTT Broker message with previously chosen topic.<br>
For our example we are using example: '''mosquito_pub -h 192.168.1.1 -p 8883 -m ‘testing Azure MQTT messages’ -t test''' </li>
<br><div>If everything was configured correctly in Device Explorer Data tab you should receive message like: </div>
[[File:Azure28_RUTX.png|border|class=tlt-border|1000px]]
<div>This means our router Forwards MQTT messages to Azure IoT Hub. </div>
</ul>
</ul>


If you are following this guide your configuration window should look similar to the screenshot below.
===Windows===
[[File:Azure_RutOSconf_16.png|border|class=tlt-border]]
<ul>
<li>Install a MQTT client software to do the test, for this example we used MQTT.fx</li>
<div>1. Setup your Router IP Address</div>
<div>2. Use the '''same broker port'''</div>
<div>3. Paste your '''Connection string – primary key''' and click '''Apply'''</div>
[[File:Azure29-1_RUTX.png|border|class=tlt-border|800px]]


After a few moments the device should establish connection to the Azure server.
<div>1. Connect to the server broker</div>
 
<div>2. Use the created topic. For this example '''test'''</div>
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.
<div>3. Send a message</div>
[[File:Azure_RutOSconf_18.png|border|class=tlt-border]]
[[File:Azure30_RUTX.png|border|class=tlt-border|1000px]]


<li>If you did everything right this message will be shown in the device explorer</li>
</ul>
</ul>
==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.
[[File:Azure RutOSconf 19.png|border|class=tlt-border]]
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 [https://learn.microsoft.com/en-us/azure/iot/howto-use-iot-explorer 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 [https://developers.teltonika-networks.com/ here] .
The Azure IoT Explorer Direct Method tab will have a Payload field. In this field the '''api_call''' method expects JSON formatted data.
[[File:Azure RutOSconf 20.png|border|class=tlt-border]]
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.
[[File:Azure RutOSconf 22.1.png|border|class=tlt-border]]
After pressing the "'''Invoke Method'''" button the response from the device will be visible which is a standard API response specified in our [https://developers.teltonika-networks.com/fundamentals/#request-and-response-structures documentation].
[[File:Azure RutOSconf 21.png|border|class=tlt-border]]
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 [https://learn.microsoft.com/en-us/azure/digital-twins/concepts-models 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  [[Media:Teltonika-dtmi-docs.zip|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.
[[File:Azure RutOSconf 23.png|border|class=tlt-border]]
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.
[[File:Azure RutOSconf 24.png|border|class=tlt-border]]
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.
[[File:Azure RutOSconf 25.png|border|class=tlt-border]]
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.
<li> In the server configuration configuration window, choose "'''Type'''" as a "'''Azure IoT Hub'''" option; </li>
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.
<li> Select your preferred Azure IoT Hub instance; </li>
<li> Press "'''Save & Apply'''" button. </li>
If you are following this guide your configuration should resemble something similar to the screenshot below.
[[File:Azure RutOSconf 28.png|border|class=tlt-border]]
</ul>
====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.
[[File:Azure RutOSconf 29.png|border|class=tlt-border]]
==Example use cases==
This section shows some practical examples that combines most of the features that are discussed earlier.
===Dynamically monitoring Modbus data===
This example shows how to monitor and dynamically control Modbus data purely from the Azure cloud. We will set up a simple Modbus TCP server and client with Data to Server which will forward all the incoming Modbus data to Azure IoT Hub. In the end, using Direct Methods we will showcase how Modbus TCP client can collect and report different data from the cloud.
[[File:Azure_drawio_diagram.png|border|class=tlt-border]]
For this we will be using the following services:
*Azure IoT Hub;
*Data to Server;
*Modbus TCP Server;
*Modbus TCP Client;
*An Azure IoT Hub account.
In this example the Azure IoT Hub WebUI service configuration will not be covered since all the necessary information can be found in the earlier sections.
====Modbus TCP Server====
Enable the service in '''Services -> Modbus -> Modbus TCP Server''' with '''Enable''' option. For more information about this service you can find it on our Modbus Wiki [https://wiki.teltonika-networks.com/view/RUTX11_Modbus#Modbus_TCP_Server TCP server section]
====Modbus TCP Client====
Go to '''Services -> Modbus -> Modbus TCP Client''' page and create a new instance. This part will assume most of the configuration for this page is already made. For more information about this service you can find it on our Modbus Wiki [https://wiki.teltonika-networks.com/view/RUTX11_Modbus#Modbus_TCP_Client TCP client section].
For this use case a single Modbus request configuration will be created to request the current device timestamp:
*Data type: '''32bit UINT, Byte order 1,2,3,4'''
*Function: '''Read holding registers (3)'''
*First register number: '''2'''
*Register counter/Values: '''2'''
For device specific Modbus register information refer to the appropriate Wiki documentation.
====Data to Server====
1. Go to '''Services -> Data to Server''' page and create a new collection instance.
1.1. Select the input '''Type''' to '''Modbus''';
1.2. Change the '''Format type''' to '''Custom''';
1.3. In the '''Format string''' we will enter the following data: '''{"Date (Linux timestamp)": %timestamp%, "MODBUS server ID": "%server_id%", "MODBUS server name" : "%server_name%", "Request name": "%name%", "Start register": "%addr%", "Register data (JSON object)": %data%, "Raw data": "%raw_data%"}'''. This will form requests about Modbus data including the register values;
1.4. In the '''Collection configuration''' page select the '''Format type''' to custom;
1.5. Change the '''Format string''' to '''{ "input1": %input1% }'''. Make sure to change the '''%input1%''' value to your specific input name. Note that this value is not enclosed in braces. This is intentional since the braces are present in the Modbus input '''Format string''' field;
1.6. In the '''Server configuration''' select the '''Type''' to '''Azure IoT Hub''' and configure the Azure configuration instance in accordance to your needs.
====Monitoring and controlling incoming data====
Inspecting the incoming data to the Azure IoT Hub using Azure IoT Explorer reveals that Modbus data is being received successfully.
[[File:Azure modbus example 1 modified 1.png|border|class=tlt-border]]
In order to change the type of Modbus data sent to the Azure IoT Hub without going to the device WebUI the '''Direct Methods''' feature can be utilized. Using Azure IoT Explorer go to the device identity that was configured on the Teltonika device and select '''Direct method''' tab.
Using the '''api_call''' direct method create API requests that update the Modbus TCP Client request configurations (API reference for Modbus services can be found [https://developers.teltonika-networks.com/reference/7.6.10/v1/modbus/ here]. In this example the request configuration will be changed to collect '''Mobile signal strength'''. To do this using only API we will need to resolve the Modbus TCP client instance ID then the request ID of the instance which currently collects the temperature data. Using both of the IDs we will form the last API PUT request to update the register values:
2.1. Invoke '''/modbus/client/tcp/config''' GET request and inspect the output on IoT Explorer. The '''"data"''' array will contain JSON objects of every configured client instance. The '''"id"''' value will be used when forming the next API request;
[[File:Azure modbus example 2.png|border|class=tlt-border]]
2.2. Invoke '''/modbus/client/tcp/{id}/requests/config''' GET request and replace the '''{id}''' with the '''"id"''' value from the previous step. Inspecting the output will reveal the '''"data"''' array which contain JSON objects of every configured request. The '''"id"''' value of the request that collects temperature data will be used when forming the next API request;
[[File:Azure modbus example 3.png|border|class=tlt-border]]
2.3. Invoke '''/modbus/client/tcp/{id}/requests/config/{request_id}''' PUT request and replace the '''{id}''' with the '''"id"''' value from the 2.1. step and replace the '''{request_id}''' with the '''"id"''' value from the 2.2. step. In the '''request_body''' field add values to change the first register and data type values: '''{"data":{"first_reg":"4","data_type":"32bit_int1234"}}''' which corresponds to mobile signal strength register (other parameters such as number of registers stay the same since the timestamp register count is the same too).
[[File:Azure modbus example 4.png|border|class=tlt-border]]
2.4. Observe the incoming telemetry data. At this point the register data shall contain the mobile signal strength values.
[[File:Azure modbus example 5.png|border|class=tlt-border]]
This concludes the Azure IoT Hub guide. Using Direct Methods with device API is a powerful tool that unlocks new capabilities of device monitoring and control from the cloud. Nearly all features available via device WebUI are also available using API.
'''
==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&amp%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

Revision as of 11:33, 20 February 2020

Azure IoT Hub is an open and flexible cloud platform that supports open-source SDKs and multiple protocols.

Introduction

This article contains instructions on how to configure a RUT router in order to connect to the Azure IoT Hub.

The information in this page is updated in accordance with the RUTX_R_00.02.01.1 firmware version.


Prerequisites

You will need:

  • A router from the RUTX09 or RUTX11
  • 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 you will add later. In Microsoft Azure home page.
      • Select Resource groups
      If it is not in very first page, click More services and locate it there.
  • In new window, select Add
  • And then finish creating yours Resource group
    • Select your subscription, we are using Free Trial for this test.
    1. Name your group
    2. Finally, choose server location for meta data. We will choose (South America) Brazil South and will use it during test where available.
  • At this moment we will skip adding Tags since we will be able to do that later if needed, so simply press Review + create at the bottom of screen and then click Create to finish setup.

  • You will be redirected to Homepage, then click on Resource groups. You should see yours 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 before
    2. Create a name for IoT Hub
    3. Then go to Size and scale tab
  • For testing purposes, we are using F1: Free tier
    • At the bottom of the screen Review + create

    And finally, Click on >> Create

    Note: Wait until resource deploys and press Go to Resources


  • Inside IoT Hub list:
    Scroll down to Explorers and select IoT devices

  • Press New
  • In new device creation
    1. Enter Device ID
    2. Leave everything else on default and press Save
  • After you finish creation, you will be redirected back to IoT devices select yours newly created Device ID
  • In your device window you will find information needed to connect RUT devices to Azure IoT Hub.
    • For now, we will only need connection string. Copy Primary Connection string by pressing copy icon next to it.

Configuring RUTX Azure IoT Hub

  • First open router WebUI, go to System > Package Manager and install Azure IoT Hub package
  • Now navigate to Services > Cloud solutions > Azure IoT Hub
    • 1. Select Enable Azure IoT Hub monitoring
    2. Paste previously copied Connection String (For this test we leave other values as default)
    3. Select what kind of information you want to send to Azure IoT Hub
    4. Press Save

Checking if Data reaches Azure IoT Hub

  • From router side, connect to it with CLI or SSH client and write in command azure_iothub and press Enter
    • - You should get answer that looks something like that, depending on what information you chose to send.

  • From Azure IoT Hub side you can check if it receives data. Go to IoT Hub that you created previously. Select Overview, there you can see:
    • 1. How many devices are connected to hub, and how many messages it sent during chosen period of time.
    2. Device to cloud messages, that your router is sending.

    It should look something like that if IoT Hub is receiving data.

  • To capture logs you will need Device Explorer for IoT Hub Devices.

    • Scroll down to Assets, download and install SetupDeviceExplorer.msi

  • Now you will need connection string of yours Azure IoT Hub, Not device. Navigate to IoT hub in your browser, then:
    • 1. Click Shared access policies
    2. Next choose iothubowner
    3. And copy Connection string – primary key

  • After that go back to Device Explorer:
    • 1. In Configuration tab paste in Connection string that you just copied
    2. Copy HostName part from connection string and paste it in Protocol Gateway HostName
    3. Click Update

  • Open Management tab
    • 1. Click Update
    2. You should see your device in the list below and Connection state

  • Go to Data tab
    • 1. Click monitor, and wait for Event Hub Data to update (Depends on yours chosen interval)
    2. Messages like this should start appearing.

    Setting router to Forward MQTT messages/commands to Azure IoT Hub

    First you will need MQTT broker to subscribe to, for testing purposes we will set MQTT Broker in same router, and will use PC from LAN to sent MQTT messages.
  • Go to Services > MQTT > Broker
    • 1. Click Enable
    2. Use same port in MQTT Broker and Azure IoT Hub settings.
    3. Press Save

  • Go to Services > Cloud solutions > Azure IoT Hub
    • 1. Enable monitoring
    2. Use same Connection string as before (GSM values configuration)
    3. Messages Type choose MQTT messages
    4. Enter MQTT Host address, we are using 127.0.0.1 since our broker is set up on same router.
    5. Port Same as MQTT Broker
    6. And Topic under which router will subscribe to MQTT Broker
    7. Press Save, we will not need username or password.

Checking if MQTT messages are being forwarded to Azure IoT Hub

Linux

    Connect to router with SSH, in logread you should see Router establishing connection to Azure IoT Hub:

  • Open terminal and publish to MQTT Broker message with previously chosen topic.
    For our example we are using example: mosquito_pub -h 192.168.1.1 -p 8883 -m ‘testing Azure MQTT messages’ -t test

    • If everything was configured correctly in Device Explorer Data tab you should receive message like:

    This means our router Forwards MQTT messages to Azure IoT Hub.

Windows

  • Install a MQTT client software to do the test, for this example we used MQTT.fx
    • 1. Setup your Router IP Address
    2. Use the same broker port
    3. Paste your Connection string – primary key and click Apply

    1. Connect to the server broker
    2. Use the created topic. For this example test
    3. Send a message

  • If you did everything right this message will be shown in the device explorer
Retrieved from "https://wiki.teltonika-networks.com/index.php?title=Azure_IoT_Hub_Cloud_Connection&oldid=55337"