How-To Guides
...
Integration Guides
Azure IoT Hub Guides

Receive Data from Azure IoT Hub with an SAS Key

5min

Review the following guide for setting up an inbound data integration between Litmus Edge and Azure IoT Hub using an SAS Key.

Before You Begin

You must first Set up an Azure IoT Hub.

Step 1: Add the Azure IoT Hub using SAS Key Connector

Follow the steps to Add a Connector and select the MQTT - Azure IoT Hub using SAS Key provider.

Configure the following parameters.

  • Name: Enter a name for the connector.
  • Hostname: Enter the IP address or server FQDN of the MQTT broker (must be reachable from your edge device).
  • Port: Enter the MQTT broker's port number. The default value is 8883.
  • Device ID: Copy the Device ID of your edge device from the IoT Devices page in the Azure portal and paste it here.
  • SAS Key: Copy the primary or secondary shared access key from the IoT Devices page in the Azure portal and paste it here.
  • 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: devices/[deviceId]/messages/events/. Replace [deviceId] with the Device ID copied from Azure.
  • 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.

Step 2: Enable the Connector

After adding the connector, click the toggle in the connector tile to enable it.

Toggle to enable connector
Toggle to enable connector


If you see a Failed status, you can review the Connector Logs and relevant error messages.

Step 3: Create Inbound Topics for Connector

You will now need to create inbound topics that will receive data from Azure IoT Hub.

To create topics:

  1. Click the connector tile. The connector Dashboard appears.
  2. Click the Topics tab.
  3. 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: Paste the Raw Topic for the tag created in Step 2.
    • 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 parameter configured for the connector.
    • Enable: Click the toggle to enable the topic.
  4. Click Yes to add the topic.
  5. After adding all required topics, navigate to the Integration pane.
  6. From the connector tile, ensure the connector is not disabled and still shows a CONNECTED status.

Step 4: Initiate and View Inbound Messages

You will need to create a flow to view the inbound messages from the connector.

To initiate and view inbound messages:

  1. Follow the steps to Create a Flow and add the following nodes.
    • DataHub Subscribe:
    • Debug
  2. Connect the two nodes.
  3. Double-click the DataHub Subscribe node. The Edit DataHub Subscribe node dialog box appears.
    • Paste the local topic you created in Step 4.
    • 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.
  4. Log in to Azure.
  5. Open the device pane and click Message to Device. The Message to device pane appears.
  6. Enter Test Message in the Message Body field and click Send Message.
  7. 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.
  8. Verify that Test Message appears in the debug results.



Updated 23 Sep 2024
PREVIOUS
Send Data to Azure IoT Hub with an SAS Key
NEXT
Send Data to Azure IoT Hub with a Device Certificate
Docs powered by Archbee