Skip to content

Latest commit

 

History

History
370 lines (270 loc) · 13.7 KB

readme.md

File metadata and controls

370 lines (270 loc) · 13.7 KB
page_type description languages products
sample
Connecting a RPI Pico W as an Arduino device, to Azure IoT using the Azure SDK for Embedded C. Based upon the ESP8256 version.
c
azure-iot
azure-iot-pnp
azure-iot-dps
azure-iot-hub

How to Setup and Run Azure SDK for Embedded C IoT Hub Client on Raspberry Pi Pico

How to install Arduino BSP onto a RPI Pico

https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json
  • In the IDE click Tools>Board>Boards Manager...on the menu bar
  • Enter Pico in the searching box, and select ”Raspberry Pi Pico/RP2040” and click on [Install]
  • Click Yes in the pop-up “dpinst-amd64.exe”installation window.
  • Starting with the Pico disconnected from computer: Press and keep pressing the white button (BOOTSEL) on Pico, and connect Pico to computer using the USB port before releasing the button. (Note: Be sure to keep pressing the button before powering the Pico, otherwise the firmware will not download successfully)/
  • In the Arduino IDE. Click File>Examples>01.Basics>Blink.
  • Click Tools>Board>Raspberry Pi RP2040 Boards>Raspberry Pi Pico.
  • Click Tools>Port>UF2 Board.
  • Upload sketch to Pico.
  • LED onboard should flash.

From here on you upload to a specific COM port.

Introduction

This is a "to-the-point" guide outlining how to run an Azure SDK for Embedded C IoT Hub telemetry sample on a Rapsberry Pi Pico microcontroller with Arduino OS installed. The command line examples are tailored to Debian/Ubuntu environments.

What is Covered

  • Configuration instructions for the Arduino IDE to compile a sample using the Azure SDK for Embedded C.

  • Configuration, build, and run instructions for the IoT Hub telemetry sample.

The following was run on Windows 11 environment, with Arduino IDE 2.0.3.

Prerequisites

  PS C:\>az extension add --name azure-iot

On Linux:

  $ curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash
  $ az extension add --name azure-iot

A list of all the Azure IoT CLI extension commands can be found here.

  • The most recent version of Azure IoT Explorer installed. More instruction on its usage can be found here.

    NOTE: This guide demonstrates use of the Azure CLI and does NOT demonstrate use of Azure IoT Explorer.

Setup and Run Instructions

  1. Run the Arduino IDE.

  2. Install the Azure SDK for Embedded C library.

    • On the Arduino IDE, go to menu Sketch, Include Library, Manage Libraries....

    • Search for and install azure-sdk-for-c.

  3. Install the Arduino PubSubClient library. (PubSubClient is a popular MQTT client for Arduino.)

    • On the Arduino IDE, go to menu Sketch, Include Library, Manage Libraries....

    • Search for PubSubClient (by Nick O'Leary).

    • Hover over the library item on the result list, then click on "Install".

  4. You may also need to install the Install the Arduino TimeLib library.

    • Search for TimeLib aka Time (by Michael Margiolis).

    • Hover over the library item on the result list, then click on "Install".

  5. Open the sample.

    • On the Arduino IDE, go to menu File, Examples, azure-sdk-for-c.

    • Click on azure_esp8266 to open the sample. <-- This needs to change when this is fomally merged into the original repository.

    • For now Download the repository and open the Sketch in this folder, in the IDE. azure-sdk-for-c-arduino\examples\Azure_IoT_Hub_RPI_Pico

    • Alt Open the azure esp8266 example as above and make the changes as here.

  6. Configure the sample.

    Enter your Azure IoT Hub and device information into the sample's iot_configs.h.

  7. Connect the RPI Pico microcontroller to your USB port.

  8. On the Arduino IDE, select the board and port.

    • Go to menu Tools, Board and select Raspberry Pi Pico W.

    • Go to menu Tools, Port and select the port to which the microcontroller is connected.

  9. Upload the sketch.

    • Go to menu Sketch and click on Upload.
   Executable segment sizes:
   IROM   : 361788          - code in flash         (default or ICACHE_FLASH_ATTR)
   IRAM   : 26972   / 32768 - code in IRAM          (ICACHE_RAM_ATTR, ISRs...)
   DATA   : 1360  )         - initialized variables (global, static) in RAM/HEAP
   RODATA : 2152  ) / 81920 - constants             (global, static) in RAM/HEAP
   BSS    : 26528 )         - zeroed variables      (global, static) in RAM/HEAP

 Sketch uses 436972 bytes (20%) of program storage space. Maximum is 2093056 bytes.
 Global variables use 72244 bytes (27%) of dynamic memory, leaving 189900 bytes for local variables. Maximum is 262144 bytes.
 Resetting COM3
 Converting to uf2, output size: 910848, start address: 0x2000
 Flashing E: (RPI-RP2)
 Wrote 910848 bytes to E:/NEW.UF

  1. Monitor the MCU (microcontroller) locally via the Serial Port.

    • Go to menu Tools, Serial Monitor.

      If you perform this step right away after uploading the sketch, the serial monitor will show an output similar to the following upon success:

.........WiFi connected, IP address: 192.168.0.14
Setting time using SNTP..........done!
Current time: Fri Dec 30 05:05:48 2022
Client ID: PicoDev137
Username: PicoHub137.azure-devices.net/PicoDev137/?api-version=2020-09-30&DeviceClientType=c%2F1.5.0-beta.1(ard;rpipico)
MQTT connecting ... connected.
13652 RPI Pico (Arduino) Sending telemetry . . . OK
16352 RPI Pico (Arduino) Sending telemetry . . . OK
19021 RPI Pico (Arduino) Sending telemetry . . . OK
  1. Monitor the telemetry messages sent to the Azure IoT Hub using the connection string for the policy name iothubowner found under "Shared access policies" on your IoT Hub in the Azure portal.
$ az iot hub monitor-events --login <your Azure IoT Hub owner connection string in quotes> --device-id <your device id>

Starting event monitor, filtering on device: PicoDev137, use ctrl-c to stop...
{
    "event": {
        "origin": "PicoDev137",
        "module": "",
        "interface": "",
        "component": "",
        "payload": "{ \"msgCount\": 1 }"
    }
}
{
    "event": {
        "origin": "PicoDev137",
        "module": "",
        "interface": "",
        "component": "",
        "payload": "{ \"msgCount\": 2 }"
    }
}
{
    "event": {
        "origin": "PicoDev137",
        "module": "",
        "interface": "",
        "component": "",
        "payload": "{ \"msgCount\": 3 }"
    }
}
^CStopping event monitor...

Certificates - Important to know

The Azure IoT service certificates presented during TLS negotiation shall be always validated, on the device, using the appropriate trusted root CA certificate(s).

The Azure SDK for C Arduino library automatically installs the root certificate used in the United States regions, and adds it to the Arduino sketch project when the library is included.

For other regions (and private cloud environments), please use the appropriate root CA certificate.

Additional Information

For important information and additional guidance about certificates, please refer to this blog post from the security team.

Troubleshooting

  • The error policy for the Embedded C SDK client library is documented here.

  • File an issue via GitHub Issues.

  • Check previous questions or ask new ones on StackOverflow using the azure and c tags.

Contributing

This project welcomes contributions and suggestions. Find more contributing details here.

License

This Azure SDK for C Arduino library is licensed under MIT license.

Azure SDK for Embedded C is licensed under the MIT license.

Changes made to the ESP8266 Example when porting to the RPI Pico

Porting from the Azure IoT Hub ESP8266 example to the Azure IoT Hub RPI Pico example only required a few code changes as follows. You can just open the ESP8266 example and make these changes, plus the setup as above.

////////////////////////////////////////////////////////////////
// Change ESP8266 code:
// configTime(-5 * 3600, 0 ,NTP_SERVERS);
//To:
configTime(-5 * 3600, 0, "pool.ntp.org","time.nist.gov"); 
// Got error in Pico Sketch Verifye saying 4 parameters required.
// No such error with ESP8266 though.
////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////
// Change ESP8266 code:
//#include <ESP8266WiFi.h>
//To:
#include <WiFi.h>; 
////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////
// Change ESP8266 code:
// Serial.print(" ESP8266 Sending telemetry . . . ");
//To:
  Serial.print(" RPI Pico (Arduino) Sending telemetry . . . ");
////////////////////////////////////////////////////////////////

In line below:

// When developing for your own Arduino-based platform,
// please follow the format '(ard;<platform>)'. (Modified this)
////////////////////////////////////////////////////////////////
// Change ESP8266 code:
//#define AZURE_SDK_CLIENT_USER_AGENT "c%2F" AZ_SDK_VERSION_STRING "(ard;ESP8266)"
//To:
#define AZURE_SDK_CLIENT_USER_AGENT "c%2F" AZ_SDK_VERSION_STRING "(ard;rpipico)"
////////////////////////////////////////////////////////////////

That is all!

Nb: As noted above, I had to add the timelib library.