Scenarios: Troubleshooting AzureIotThings
This topic presents scenarios for issues that may arise with Azure IoT Edge devices and Azure IoT Devices, all represented as AzureIotThings in ThingWorx.
The following scenarios describe issues that may arise during operation of an Azure IoT Hub Connector and the Azure IoT Devices and Edge devices connected to ThingWorx. Each section presents possible causes and solutions.
 |
The Connector loads and caches all configuration settings during startup. Any changes that you make to the configuration when troubleshooting are ignored until the Connector is restarted.
|
Thing is not connected
If you observe one or more of the following conditions, it is likely that the device is not connected:
• Green 'connected` icon is red and 'broken'.
• The values of the isConnected and isReporting properties are false, which is indicated by the absence of checkmarks for the properties in the ThingWorx Composer UI.
• lastConnection time is either the epoch, 1969-12-31 19:00:00:00.000, or older than the last time Azure IoT Hub Connector started.
|
Possible Causes
|
Solutions
|
|---|---|
|
Azure IoT Hub Connector is not running or is not connected to the ThingWorx Platform. In ThingWorx Composer, verify the Connector is communicating with the platform by looking for the name of the Connector, such as AzureIot-cxserver-ac85c4b6-d8b2-4c91-adca-fc0ef4b8dc27, in > .
|
Start/restart the Azure IoT Hub Connector.
|
|
The gatewayThing property of an AzureIotThing is not set.
|
Set the gatewayThing property of the AzureIotThing to the ThingName of the AzureIotHubThing configured in the Azure IoT Hub Connector and restart the Connector.
|
|
The AzureIotHubThing is not currently bound. Check the Connector logs for the string where <Hub Thing Name> is the name of your AzureIotHubThing.
Azure IoT Hub Thing <Hub Thing Name> successfully bound" If this message is missing or there is a message indicating it was unbound, the Hub is not bound and the Things connected to it cannot be connected to the ThingWorx Platform.
|
Verify the name of the AzureIotHubThing matches the spelling and case of the hub-thing-nameconfiguration of your Azure IoT Hub Connector. If you make a change, restart the Connector.
// The Thingname of the entity model // object in ThingWorx that represents // the Iot Hub in Azure cx-server.protocol.hub-thing-name = "MyHubThing" |
Device twin updates not reflected in Azure
The following table offers causes and solutions if you discover that setting a twin property of an AzureIotThing, such as twinDesired or twinTags, is not reflected in the Azure IoT portal.
|
Possible Causes
|
Solutions
|
|---|---|
|
The AzureIotThing is not connected to the ThingWorx Platform.
|
Stop and restart the Azure IoT Hub Connector.
|
|
The Azure Edge Agent or Edge Hub is not functioning correctly.
|
Verify the AzureIotThing has its gatewayThing property set to the correct AzureIotHub Thing that is bound through the Azure IoT Hub Connector. If you make a change, restart the Connector.
|
|
The Azure IoT Hub Connector has lost its connection to the Azure IoT Hub.
|
For Azure IoT Edge devices: Restart the edgeAgent and/or edgeHub modules on the Azure IoT Edge device itself.
|
|
Azure is experiencing a delay in delivering twin updates to the device.
|
For Azure IoT Devices, restart the devices.
|
Device twin updates not reflected in ThingWorx
The following table provides possible causes and solutions if you discover that setting a device twin property in the Azure IoT portal is not reflected in the ThingWorx Platform.
|
Possible Causes
|
Solutions
|
|---|---|
|
The AzureIotThing is not connected to the ThingWorx Platform.
|
Verify the AzureIotThing has its gatewayThing property set to the correct AzureIotHub Thing that is bound through the Azure IoT Hub Connector. If you make a change, restart the Connector.
|
|
Azure IoT is experiencing a delay in delivering twin updates to ThingWorx.
|
Stop and then restart the Azure IoT Hub Connector.
|
|
The Azure IoT Hub Connector has lost its connection with the Azure IoT Hub.
|
Verify that the configuration of the AzureIotHub Thing is correct. If you make any changes, stop and then restart the Azure IoT Hub Connector.
|
Property writes from Edge not reflected in ThingWorx
The following table presents possible causes and solutions if you discover that an Azure IoT Edge device is sending non-twin property updates to the ThingWorx Platform, but the updates are not reflected on the AzureIotThing that represents that device in the platform.
|
Possible Causes
|
Solutions
|
|---|---|
|
The AzureIotThing is not connected to the platform.
|
Verify the AzureIotThing has its gatewayThing property set to the correct AzureIotHub Thing that is bound through the Connector. If you make a change, restart the Connector.
|
|
Messages being sent are not in the correct JSON format.
|
Refer to the solutions for
property write issues that follow this table.
|
|
The AzureIotThing does not have a remotely bound property with the same name as the incoming property.
|
Verify the property names in the message match the remotely-bound property names on the AzureIotThing Thing exactly.
|
|
The Azure IoT Hub Connector has lost its connection with the Azure IoT Hub.
|
Stop and then restart the Azure IoT Hub Connector.
|
|
Azure IoT is experiencing a delay in delivering messages to the Azure IoT Hub Connector
|
Stop and then restart the Azure IoT Hub Connector.
|
Solutions for property writes issues
Verify the messages being sent from the Azure IoT (Edge) Device have the following JSON format (whitespace added for legibility):
[
{
"property1Name": "property1Value",
"property2Name": "property2Value",
"property3Name": 123,
"property4Name": true
},
{
"property1Name": "property1Value2",
"property2Name": "property2Value2",
"property3Name": 456,
"property4Name": false
}
]