Receive Data from Azure IoT Hub with a Device Certificate
Review the following guide for setting up an inbound data integration between Litmus Edge and Azure IoT Hub using a Device Certificate.
Refer to the following resources for more information.
Note: Integration does not support wildcard characters for inbound messages.
You must first Set up an Azure IoT Hub. When you add the IoT device to the hub, select X.509 Self-Signed as the Authentication type when you add the IoT device in Azure.
You will need to log in to Azure to retrieve the parameters for configuring the connector in Litmus Edge.
Tip: Use the following command to generate a public/private key pair:
To retrieve the connector parameters:
- From the Microsoft Azure home page, click your IoT Hub.
- From the Navigation panel under Explorers, click IoT devices.
- From the Azure IoT devices pane, copy the device name from the Device ID column.
- Click the Device ID for the device you want to connect.
- Copy the key ID and paste it to the Primary Thumbprint field, and then copy the certificate ID and paste it to the Secondary Thumbprint field.
Follow the steps to Add a Connector and select the MQTT - Azure IoT Hub using Device Certificates provider.
Configure the following parameters.
- Name: Enter a name the connector.
- Hostname: IP Address or Server FQDN of MQTT broker.
- Port: Verify the default value of 8883 is entered.
- Device ID: Copy the Device ID retrieved in Step 1.
- Certificate: Paste the certificate from the mydevicekeycer.pem file generated in Step 1.
- Private key: Paste the key certificate from the myprivatekey.pem file generated in Step 1.
- Parallel Publish Count: The maximum number of concurrently published messages. The default value is 16.
- Integration Topic: The default topic to publish or subscribe to.
- Token TTL: The token expiry time in minutes. The default value is 1440.
- LWT Topic: The topic for MQTT's Last Will and Testament feature.
- LWT payload: The payload for MQTT's Last Will and Testament feature.
- LWT payload type: The payload type for MQTT's Last Will and Testament feature. The options are string and base64.
- LWT QoS: The Quality of Service value for MQTT's Last Will and Testament feature.
- LWT retained: Select this check box to retain the value for MQTT's Last Will and Testament feature.
- Throttling Limit: The maximum number of messages per second to be processed. The default value is zero, which means that there is no limit.
- Persistent storage: When enabled, this will cause messages to undergo a store-and-forward procedure. Messages will be stored within Litmus Edge when cloud providers are online.
- Queue Mode: Select the queue mode as lifo (last in first out) or fifo (first in first out). Selecting lifo means that the last data entry is processed first, and selecting fifo means the first data entry is processed first.
After adding the connector, click the toggle in the connector tile to enable it.
If you see a Failed status, you can review the Connector Logs and relevant error messages.
You will now need to create inbound topics to receive data from Azure IoT Hub.
To create topics:
- Click the connector tile. The connector Dashboard appears.
- Click the Topics tab.
- Add topics to the connector with the details below. See the Add a Topic to a Connector section in Manage Connectors for more information.
- Data Direction: Select Remote to Local - Inbound.
- Local Data Topic: Enter integration.raw.inboundtest.
- Remote Data Topic: Replace devices/[Device ID]/messages/events/ with devices/[Device ID]/messages/devicebound/%24.to=%2Fdevices%2Fmessages%2Fdevicebound. Replace [Device ID] with the Device ID value configured for the connector.
- Enable: Click the toggle to enable the topic.
- Click Yes to add the topic.
- After adding all required topics, navigate to the Integration pane.
- From the connector tile, ensure the connector is not disabled and still shows a CONNECTED status.
You will need to create a flow to view the inbound messages from the connector.
To initiate and view inbound messages:
- DataHub Subscribe:
- Debug
- Double-click the DataHub Subscribe node. The Edit DataHub Subscribe node dialog box appears.
- Enter Azure inbound in the Name field.
- Paste the Topic you created in Step 4 in the Topic field.
- If needed, configure the Datahub Subscribe connection. See the "Step 3: Configure Connector Nodes" section in Create a Flow to learn more.
- Click Done, and then click Deploy.
- Click the debug tab.
- Log in to Azure.
- Open the device pane and click Message to Device. The Message to device pane appears.
- Enter Test Message in the Message Body field and click Send Message.
- Open the flow you created in Litmus Edge and check the Debug messages tab. See the Additional Options section in Manage the Flow Canvas for more details.
- Verify that Test Message appears in the debug results.