Group Actions
Engagement
  • Author Author: bwilless
  • Date Created: Date Created
  • Views 1807 views
  • Likes 7 likes
  • Comments 3 comments
Related
Recommended

Troubleshooting Azure IoT Hub Connection Issues

bwilless

This blog is intended to help developers who are having issues connecting to an IoT Hub, or an IoT Central application using one of the Avnet OOB example projects.  My personal experience is that I've always been able to connect to my IoT Hub.  I've done my best to identify and capture  things that I think can go wrong.  My list is not comprehensive at all, if you find another debugging tip, please post it in the comments for others to use!

 

There are three failure points when connecting to an IoT Hub from the Avnet Azure Sphere OOB example application.

  1. Is the Azure Sphere application properly configured?
  2. Is the network passing data from the Azure Sphere Device to the IoT Hub and other Azure services?
  3. Are the Azure resources correctly configured?
  4. Is the device actually connected to the internet and working properly?

 

Let’s look at each of these categories and determine how to prove to ourselves that each one is working correctly.

 

Is the application properly configured?

 

There are three code changes required for the Avnet Azure Sphere OOB application to connect to an IoT Hub, or an IoT Central application (which is using an IoT Hub under the covers)

  1. connection_strings.h
    1. Verify that you added a connection string to the header file
    2. Verify that you’re using the correct connection string
      1. IoT Hub:  Copy the "primary connection string" from the IoT Hub --> <your device> --> primary connection string
      2. IoT Central:  Generate a connection string using the method documented here:  https://docs.microsoft.com/en-us/azure/iot-central/howto-generate-connection-string
  2. build_options.h
    1. Modify the header file to include only code required for either IOT_CENTRAL_APPLICATION or IOT_HUB_APPLICATION
  3. app_manifest.json
    1. Verify that the hostname for the IoT Hub has been added to the “AllowedConnections” entry. This entry tells the OS to allow the application to send traffic to all FQDNs/IP Address' in the list.
    1. Verify that the hostname is correct!

 

Is the network passing data from the Azure Sphere Device to the IoT Hub and other Azure services?

 

This is the tricky part to validate.  If we could send a ping from the Azure Sphere device to the IoT Hub that would be great. But, we don’t have a shell on the Azure Sphere device to send a ping, and even if we could, the IoT Hub does not respond to pings.  So what can we do to validate that we have a clear network path from the Azure Sphere device to the IoT Hub?

 

The first thing we need to do is verify that our Azure Sphere device is connected to a Wi-Fi network. From the Azure Sphere command line tool execute the following command.

  • azsphere device wifi show-status

If the device is connected then you’ll see a status printed out similar to the graphic below

image

The network requirements for Azure Sphere are documented here:  https://docs.microsoft.com/en-us/azure-sphere/network/ports-protocols-domains.  If your ISP or internet connection blocks any of these ports you’re connection likely won’t work.  We can use Windows Powershell and the tnc (Test NetConnection) utility to probe ports on our IoT Hub and other azure resources to verify if they are reachable.  If your network blocks any of these ports, try using a different network, for example the network on your mobile phone’s wifi hotspot.  For the test below your PC should be connected to the same wifi network as your Azure Sphere device.

 

A successful tnc execution will look like the graphic below:

image

 

  1. Launch windows power shell
  2. Copy paste in each tnc * line below to check network connectivity.  Note that if the command shows <Your IoT Hub Hostname> you need to replace that text with your IoT Hub hostname
    • Device provisioning and communication with IoT Hub
      • tnc <Your IoT Hub Hostname> -port 8883
    • Device provisioning and communication with IoT Hub
      • tnc <Your IoT Hub Hostname> -port 443
    • Communication with web services, network time (NTP) server, and Azure Sphere Security service
      • tnc prod.device.core.sphere.azure.net -port 443
    • Internet connection checks, certificate file downloads, and similar tasks
      • tnc www.msftconnecttest.com -port 80

 

Are the Azure resources correctly configured?

 

We can use a simulated device running in a web browser to connect to the device we provisioned on the IoT Hub (or IoT Central).  While this does not validate that we can send data from the actual Azure Sphere device, it will confirm if we can connect to our IoT Hub and that the IoT Hub is correctly configured.  If the web browser and the Azure Sphere device are on the same network, then we can assume that the data path from our local network to the IoT Hub is good.

 

There is a Raspberry Pi simulator that will connect to the IoT device on your IoT Hub.

  1. Open the simulator: online Raspberry Pi simulator
  2. Using your IoT device connection string modify the source code at line #15
    1. Note this connection string can be from your IoT Hub --> IoT device, or the connection string you generated for your IoT Central application
  3. Click on the run link under the source code
  4. You should see the device send data to the IoT Hub

 

image

 

Is the device actually connected to the internet and working properly?

 

One way to determine if your device is working properly is to run one of the Microsoft Azure Sphere examples called "HTTPS_Curl_Easy.sln" that can be found here: https://github.com/Azure/azure-sphere-samples/tree/master/Samples/HTTPS/HTTPS_Curl_Easy .  This application demonstrates how to use the cURL "easy" API with Azure Sphere over a secure HTTPS connection.  The application periodically downloads the index web page at example.com.

 

A working system will display output similar to the graphic below . . .

image

A non-working system will display output similar to the graphic below.  Note, I turned off my cable modem and left my wifi router on-line to capture this state.  The application just hung waiting for a connection.

image

 

I hope this you blog helps you find issues with the OOB application connecting to your IoT Hub.  Please share things that you find by commenting on this blog. Hopefully we can help others get past similar roadblocks!

  • in reply to bwilless

    Thanks Brian,

     

    I thought I had missed something fundamental, but couldn't see where..

  • in reply to tekmeister

    Sorry for the confusion.  The Blog and the Hackster Technical Training course use DIFFERENT gitHub repositories.  The codebase for this blog uses the connection string method for connecting the device to your IoT Hub, and the Hackster Technical Training course codebase uses the Device Provisioning Service to connect to your IoT Hub. 

     

    Make sure and save a copy of the app_manifest.json file you updated for DPS and use it in the new repo.

     

    For the Hackster Technical Training course please clone the GitHub project here:  https://github.com/bawilless/AzureSphereHacksterTTC.git

     

    Brian

     

  • Hi Brian,

     

    I've been trying to complete Lab 4 of the Hackster training course and there's seems to be a step missing when configuring the application for IoT Hub. MY_CONNECTION_STRING needs to be updated, but neither the lab PDF or the accompanying video reference this, unless I missed it?

     

    On this page you suggest the connection string should be copied from the primary connection string of the IoT Hub. This confuses me somewhat as the steps preceding these in the lab are about configuring a Device Provisioning Service. I thought one of the goals of the DPS was to assign the hub to the device? Doesn't putting the IoT Hub connection string directly in the app bypass the DPS in this instance?