AMQP TCP Integration Guide
Review the following guide for setting up an integration between Litmus Edge and an AMQP broker.
Before You Begin
You will need access to an AMQP-TCP broker.
Refer to the following to learn more:
Step 1: Add a Device
Follow the steps to Connect a DeviceConnect a Device. The device will be used to store tags that will be eventually used to create outbound topics in the connector. Make sure to select the Enable Data Store checkbox.
Step 2: Add Tags
After connecting the device in Litmus Edge, you can Add TagsAdd Tags to the device. Create tags that you want to use to create outbound topics for the connector.
Step 3: Add the AMQP TCP Connector
Follow the steps to Add a Connector and select the AMQP TCP provider.
Note: For configuring exchange options, see AMQP TCP and refer to the Exchange Options section to learn more.
Enter the details for the connector.
- Name: Enter a name for the connector.
- Hostname: Enter the IP address for the AMQP broker.
- Port: Enter the port number for the AMQP broker. The default value is 5671.
- Virtual host (Optional): Enter the virtual host path, which specifies the namespace for permissions, exchanges, queues, and bindings on the server.
- Username (Optional): Enter the username for authentication with the AMQP broker. The default value is guest.
- Password (Optional): Enter the password for authentication with the AMQP broker. The default value is guest.
- Exchange (Optional): Enter the northbound (third-party) topic to publish to through the connector.
- exchangeType: Select the exchange type (direct, fanout, topic, x-custom).
- Exchange durable: Select the checkbox to allow the exchange to survive restarts.
- Exchange auto delete: Select the checkbox to make the server no longer remain declared when there are no remaining bindings.
- Exchange internal: Select the checkbox to enable the internal flag.
- Exchange no wait: Select the checkbox to instruct the exchange to not wait for a response.
- Routing key: The AMQP routing key that the exchange might use to determine how to route messages to the queue.
- ISO8601 timestamp: Select this checkbox to convert message timestamps to the ISO8601 format before sending.
- Throttling limit (Optional): 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 4: Enable the Connector
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.
Step 5: Create Topics for Connector
You will now need to create outbound topics for the connector from the tags created in Step 2.
To create outbound topics:
- Click the connector tile. The connector Dashboard appears.
- Click the Topics tab.
- Click the Import from DeviceHub tags icon. The DeviceHub Import dialog box appears.
After adding all required topics, navigate to the Integration overview page and ensure the connector is not disabled and still shows a CONNECTED status.
Step 6: Enable Topics
Ensure the topics you imported are enabled by returning to the Topics tab and clicking the Enable all topics icon.
Step 7: Verify Successful Connection
Access the AMQP broker and ensure that data is being sent from Litmus Edge to the broker.