Skip to content

Small fixes, banner image removed from text #1622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 20, 2023
Merged

Small fixes, banner image removed from text #1622

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
38a7427
Small fixes, banner image removed from text
jcarolinares Dec 20, 2023
ca3fd59
Trademark and Images descriptions fixed
jcarolinares Dec 20, 2023
12e83d1
Not used image removed
jcarolinares Dec 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed .../tutorials/opta-azure-iot-tutorial-en/assets/opta-azure-iot-tutorial-201212.png
View file
Open in desktop
Binary file not shown.
90 changes: 43 additions & 47 deletions ...rdware/07.opta/opta-family/opta/tutorials/opta-azure-iot-tutorial-en/content.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Arduino Opta with Azure IoT'
description: "Learn to connect your Arduino Opta to the Microsoft Azure cloud"
title: 'Opta™ with Azure IoT'
description: "Learn to connect your Opta™ to the Microsoft Azure cloud"
author: 'Mirko Pacioni'
libraries:
- name: 'Azure SDK for C'
Expand All @@ -15,17 +15,15 @@ hardware:
- hardware/07.opta/opta-family/opta
---

![Arduino Opta Azure IoT Tutorial Hero Banner](hero-banner.png)

## Introduction

This tutorial demonstrates the integration of Arduino Opta with Azure IoT. You will proceed to create a reliable and secure IoT environment, harnessing the power of these two technologies.
This tutorial demonstrates the integration of Opta™ with Azure IoT. You will proceed to create a reliable and secure IoT environment, harnessing the power of these two technologies.

## Goals

- **Initial Configuration:** Guide the user through the initial setup steps for Azure IoT and IoT Hub to establish a connection between Arduino Opta and Azure IoT.
- **Initial Configuration:** Guide the user through the initial setup steps for Azure IoT and IoT Hub to establish a connection between Opta™ and Azure IoT.

- **Reliable Transmission:** How to reliably transmit data from Arduino Opta to Azure IoT.
- **Reliable Transmission:** How to reliably transmit data from Opta™ to Azure IoT.

## Required Hardware and Software

Expand Down Expand Up @@ -67,7 +65,7 @@ Open the Library Manager from the menu **Sketch->Include Library->Manage Librari

Search for the "Azure SDK for C" library using the Library Manager's search feature.

![Arduino Opta Azure IoT Tutorial Library Manager](assets/opta-azure-iot-tutorial-213345.png)
![Opta™ Azure IoT Tutorial Library Manager](assets/opta-azure-iot-tutorial-213345.png)


## Azure IoT Instructions
Expand All @@ -78,19 +76,19 @@ Sign in to your Microsoft account from the [Azure portal](https://portal.azure.c

You will be presented with the home page where you can add resources to your subscription.

![Arduino Opta Azure IoT Tutorial 1](assets/opta-azure-iot-tutorial-194248.png)
![Home page of Azure IoT Portal](assets/opta-azure-iot-tutorial-194248.png)

You'll need to add an IoT Hub to your subscription, so click on **Create a resource**, and the Azure resource store will appear.

![Arduino Opta Azure IoT Tutorial 2](assets/opta-azure-iot-tutorial-194314.png)
![Create a resource page inside Azure IoT Portal](assets/opta-azure-iot-tutorial-194314.png)

You can use the search function to search for the keyword **"iot hub"**.

![Arduino Opta Azure IoT Tutorial 3](assets/opta-azure-iot-tutorial-194413.png)
![Marketplace inside sAzure IoT Portal](assets/opta-azure-iot-tutorial-194413.png)

Among the search results, the resource we're interested in, IoT Hub, will appear as the first result. Click on **Create** to start creating your IoT Hub.

![Arduino Opta Azure IoT Tutorial 4](assets/opta-azure-iot-tutorial-194518.png)
![Click on IoT hub and fill the required information](assets/opta-azure-iot-tutorial-194518.png)

To create the new IoT Hub, fill in all the required fields on the page.

Expand All @@ -102,35 +100,35 @@ To create the new IoT Hub, fill in all the required fields on the page.

The daily message limit for the **Free** plan is 8,000 and cannot be changed otherwise.

After entering all the necessary information, you should have something similar to this:
After entering all the necessary information, you should have something similar to the following images:

![Arduino Opta Azure IoT Tutorial 5](assets/opta-azure-iot-tutorial-194559.png)
![IoT hub configuration - Create a new Resource group](assets/opta-azure-iot-tutorial-194559.png)

![Arduino Opta Azure IoT Tutorial 5](assets/opta-azure-iot-tutorial-195158.png)
![Iot hub configuration - Be sure to check the Tier plan more convenient to you](assets/opta-azure-iot-tutorial-195158.png)

After entering all the necessary information, you can click on **Review + create**, skipping the other configurations.

A final summary prompts you to check that the entered information is correct, after which you can click on **Create** to complete the Hub creation and move on to the next steps.

![Arduino Opta Azure IoT Tutorial 6](assets/opta-azure-iot-tutorial-195244.png)
![Final summary showing the information filled](assets/opta-azure-iot-tutorial-195244.png)

![Arduino Opta Azure IoT Tutorial 6](assets/opta-azure-iot-tutorial-194452.png)
![Overview page of your new IoT Hub subscription](assets/opta-azure-iot-tutorial-194452.png)

You will be redirected to the creation and registration status page of the new IoT Hub; the operation takes a few moments.

![Arduino Opta Azure IoT Tutorial 7](assets/opta-azure-iot-tutorial-195326.png)
![Deployment page](assets/opta-azure-iot-tutorial-195326.png)

Subsequently, you will receive a message confirming that the IoT Hub is created and configured.

![Arduino Opta Azure IoT Tutorial 8](assets/opta-azure-iot-tutorial-195443.png)
![Deployment complete screen](assets/opta-azure-iot-tutorial-195443.png)

You can click on **Go to resource** to access the IoT Hub dashboard.

![Arduino Opta Azure IoT Tutorial 9](assets/opta-azure-iot-tutorial-195509.png)
![IoT Hub Dashboard](assets/opta-azure-iot-tutorial-195509.png)

Now you can add a device to your Hub; the new device will allow the connection to your Arduino Opta. To add a new device, click on **Devices** under the **Device management** section on the left side of your Hub.
Now you can add a device to your Hub; the new device will allow the connection to your Opta™. To add a new device, click on **Devices** under the **Device management** section on the left side of your Hub.

![Arduino Opta Azure IoT Tutorial 10](assets/opta-azure-iot-tutorial-195552.png)
![Devices screen](assets/opta-azure-iot-tutorial-195552.png)

On the page that appears, click on **Add Device**.

Expand All @@ -140,43 +138,41 @@ On the page that appears, click on **Add Device**.

You will then have a page with fields filled in similar to this:

![Arduino Opta Azure IoT Tutorial 11](assets/opta-azure-iot-tutorial-195652.png)
![Creation of a new device](assets/opta-azure-iot-tutorial-195652.png)

By clicking on **Save**, you will be redirected back to the list of devices.

![Arduino Opta Azure IoT Tutorial 12](assets/opta-azure-iot-tutorial-195718.png)
![New device created is now listed](assets/opta-azure-iot-tutorial-195718.png)

Click on the name of the newly created device in the list of devices associated with your Hub. The device configuration page will be displayed. You don't need to make any changes to this page, but you will need to use the information provided on this page in the sketch to be uploaded to Arduino Opta.
Click on the name of the newly created device in the list of devices associated with your Hub. The device configuration page will be displayed. You don't need to make any changes to this page, but you will need to use the information provided on this page in the sketch to be uploaded to Opta™.

From the current page, the only information needed for the configuration is the **Device ID** and the **Primary key**. Once requested, you can easily copy them using the 'Copy' button next to each corresponding field.

![Arduino Opta Azure IoT Tutorial 13](assets/opta-azure-iot-tutorial-195821.png)

![Arduino Opta Azure IoT Tutorial 13](assets/opta-azure-iot-tutorial-201212.png)
![Opta™ Azure IoT Tutorial 13](assets/opta-azure-iot-tutorial-195821.png)

The next step of the tutorial is dedicated to customizing and understanding the sample code.

## Sketch

### Introduction

In this section, some parts of the sample code provided by Microsoft are analyzed and explained, modified to be used correctly on Arduino Opta.
In this section, some parts of the sample code provided by Microsoft are analyzed and explained, modified to be used correctly on Opta™.

The original project example can be found in the official library repository, accessible from [this page](https://github.com/Azure/azure-sdk-for-c-arduino/blob/main/examples/Azure_IoT_Hub_PortentaH7/Azure_IoT_Hub_PortentaH7.ino).

The example modified for Arduino Opta is available [here](assets/opta-azure-iot-tutorial-sketch.zip).
The example modified for Opta™ is available [here](assets/opta-azure-iot-tutorial-sketch.zip).

### Sketch Configuration for Connection

To establish a connection to Azure IoT, you don't need to make many changes to your sketch. All the configurations necessary to make the transmission of data from Arduino Opta to the Microsoft cloud work are enclosed in a few lines of code.
To establish a connection to Azure IoT, you don't need to make any changes to your sketch. All the configurations necessary to make the transmission of data from Opta™ to the Microsoft cloud work are enclosed in a few lines of code.

In particular, the information to be customized for the connection is represented by various **#define** in the **iot_configs.h** file.

![Arduino Opta Azure IoT Tutorial Sketch 1](assets/opta-azure-iot-tutorial-201329.png)
![Opta™ Azure IoT Tutorial Sketch- Defines section](assets/opta-azure-iot-tutorial-201329.png)

You will need some of the information present on the device configuration page on Azure. As mentioned earlier, you can copy the necessary information and modify the code accordingly:

```cpp
``` arduino
// Wifi
#define IOT_CONFIG_WIFI_SSID "MyWifi" // Change it to your Wi-Fi network name
#define IOT_CONFIG_WIFI_PASSWORD "12345678" // Change it to your Wi-Fi network password
Expand All @@ -192,32 +188,32 @@ The **IOT_CONFIG_WIFI_SSID** definition assumes the value of your Wi-Fi network'

Note that **IOT_CONFIG_IOTHUB_FQDN** contains the hostname, easily obtainable by copying the name of your IoT Hub. In the context of this tutorial, the chosen name is **MyOptaHub**.

The hostname that facilitates the connection of Arduino Opta to Azure IoT is consistently **azure-devices.net**. You will need to add the name of your hub before this hostname as follows: **MyHubID.azure-devices.net**. Consequently, for this tutorial, it becomes **MyOptaHub.azure-devices.net**.
The hostname that facilitates the connection of Opta™ to Azure IoT is consistently **azure-devices.net**. You will need to add the name of your hub before this hostname as follows: **MyHubID.azure-devices.net**. Consequently, for this tutorial, it becomes **MyOptaHub.azure-devices.net**.

The **IOT_CONFIG_DEVICE_ID** definition specifies the device identifier, and for this tutorial, **MyOpta** was selected.

Finally, **IOT_CONFIG_DEVICE_KEY** requires entering the device's private key.

### Other Code Customizations

In the **iot_configs.h** file, you find a definition that allows indicating in milliseconds the time that must elapse between sending one telemetry message and the next. The relevant definition is **IOT_CONFIG_TELEMETRY_FREQUENCY_MS** at line 19.
In the **iot_configs.h** file, you find a definition that allows indicating in milliseconds the time that must elapse between sending one telemetry message and the next. The relevant definition is **IOT_CONFIG_TELEMETRY_FREQUENCY_MS** on line 19.

In the code, it is set to 300,000 milliseconds, or 5 minutes:
In the code, it is set to 300,000 milliseconds or 5 minutes:

![Arduino Opta Azure IoT Tutorial Sketch 1](assets/opta-azure-iot-tutorial-202105.png)
![Opta™ Azure IoT Tutorial Sketch - Telemetry frequency](assets/opta-azure-iot-tutorial-202105.png)

```cpp
``` arduino
// Publish 1 message every 5 minutes
#define IOT_CONFIG_TELEMETRY_FREQUENCY_MS 300000
```
You can customize the value in milliseconds to change the time interval between sending messages.

In the **Azure_IoT_Hub_Opta.ino** file, you find a portion of code represented by the **generateTelemetry()** function at line 329, which is called to allow sending the message to Azure IoT:

![Arduino Opta Azure IoT Tutorial Sketch 1](assets/opta-azure-iot-tutorial-202627.png)
![Opta™ Azure IoT Tutorial Sketch - Telemetry payload](assets/opta-azure-iot-tutorial-202627.png)


```cpp
``` arduino
/*
* generateTelemetry:
* Simulated telemetry.
Expand All @@ -237,7 +233,7 @@ You can modify this function by changing the value of **telemetryPayload** and s

You can modify this function to send a different message, for example, a classic "Hello, World":

```cpp
``` arduino
static char* generateTelemetry()
{
telemetryPayload = String("Hello, World!");
Expand All @@ -247,22 +243,22 @@ static char* generateTelemetry()

### Uploading the Sketch

If the modifications made to the code meet your requirements, you can upload the code to your Arduino Opta and check if a message confirming the successful sending of telemetry data is displayed in the serial monitor:
If the modifications made to the code meet your requirements, you can upload the code to your Opta™ and check if a message confirming the successful sending of telemetry data is displayed in the serial monitor:

![Arduino Opta Azure IoT Tutorial Sketch 1](assets/opta-azure-iot-tutorial-213347.png)
![Serial monitor messages](assets/opta-azure-iot-tutorial-213347.png)

You can verify the actual reception of messages from the dashboard of our IoT Hub:

![Arduino Opta Azure IoT Tutorial Sketch 1](assets/opta-azure-iot-tutorial-201604.png)
![IoT Hub Dashboard receiving data from Opta™](assets/opta-azure-iot-tutorial-201604.png)

### Conclusion

In conclusion to this tutorial, we have explored and customized a sample sketch provided by Microsoft to enable the connection of Arduino Opta to Azure IoT. Here's a summary of the activities performed:
In conclusion to this tutorial, we have explored and customized a sample sketch provided by Microsoft to enable the connection of Opta™ to Azure IoT. Here's a summary of the activities performed:

- **Analysis of the Sample Sketch:** We examined a sample sketch provided by Microsoft for connecting to Azure IoT, available in the official library repository.
- **Modifications for Arduino Opta:** We made the necessary changes to the sketch to adapt it and use it correctly with Arduino Opta, customizing definitions and configurations.
- **Modifications for Opta™:** We made the necessary changes to the sketch to adapt it and use it correctly with Opta™, customizing definitions and configurations.
- **Azure IoT Configuration:** We explained how to obtain the necessary information from the device configuration on Azure IoT, including the hostname of your hub and the device key.
- **Integration with Azure IoT Hub:** We illustrated the process of configuring the definitions in the `iot_configs.h` file, which manages Wi-Fi connection and communication with Azure IoT Hub.
- **Code Customizations:** We provided guidance on further customizing the code, including adjusting the telemetry message sending interval and modifying the simulated data sent to Azure IoT.

The tutorial provides a detailed guide to connect Arduino Opta to Azure IoT, allowing the secure and reliable transmission of data. This is just a starting point, and further customizations can be made based on the specific needs of the project. Hoping that this tutorial has been helpful and has contributed to understanding the integration of Arduino Opta with Azure IoT.
The tutorial provides a detailed guide to connect Opta™ to Azure IoT, allowing the secure and reliable transmission of data. This is just a starting point, and further customizations can be made based on the specific needs of the project. In case you want to dig deeper into the Azure IoT technology, check the [Azure IoT official documentation](https://learn.microsoft.com/en-us/azure/iot/).fSA