AWS SiteWise Integration Guide
Review the following guide for setting up an integration between Litmus Edge and AWS SiteWise.
You need to create an AWS account. See Setting up an AWS account to learn more.
Refer to the following AWS resources to learn more about AWS SiteWise:
You will need the following parameters to configure the connection in Litmus Edge.
- Region: You need to get the region name for your AWS account. See AWS IoT SiteWise endpoints and quotas and Specify which AWS Regions your account can use to learn more.
- Access Key: Copy and paste the access key somewhere securely. See Managing access keys for IAM users and Identity and access management for AWS IoT SiteWise to learn more.
- Secret Access Key: Copy and paste the secret access key somewhere securely. See Managing access keys for IAM users and Identity and access management for AWS IoT SiteWise to learn more.
Once you have collected the required AWS connection parameters, follow the steps to Add a Connector and select the AWS SiteWise Connector provider.
Configure the following parameters.
- Name: Enter a name for the connector.
- Region: Enter the region name you collected in Step 1 that is associated with your AWS account.
- Access key: Paste the access key collected in Step 1.
- Secret access key: Paste the secret access key collected in Step 1.
- Subscribe interval: Enter the subscription interval in seconds. Subscribe interval defines the time in seconds between consecutive data update notifications for a subscribed asset property, specifying the frequency at which the system checks and receives updates on the specified property within the IoT SiteWise platform.
- Number of batch messages: Enter the number of batch messages to publish. This value refers to the quantity of grouped data transmissions.
- 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 have the option of setting up an outbound or inbound connection.
To set up an outbound connection, you will need to create a DeviceHub device and tags. The tags will be used to send data to AWS SiteWise.
You will now need to import the tags you added to the connector as topics.
Note: If there any existing inbound topics already created for the connector, disable them before creating the outbound topics.
After adding all required topics, navigate to the Integration overview page and ensure the connector is not disabled and still shows a CONNECTED status.
You can now access your AWS account to verify that data is successfully being sent from Litmus Edge. See Ingesting data to AWS IoT SiteWise to learn more.
You have the option of subscribing to data from AWS SiteWise.
You will create topics for the connector that will subscribe to data from associated AWS SiteWise topics.
Note: If there any existing outbound topics already created for the connector, disable them before creating the outbound topics.
To create inbound topics:
- Navigate to Integration.
- Click the connector tile.
- Click the Topics tab.
Click the Add a new subscription icon. The Data Integration dialog box appears.
Add a new subscription icon- Configure the following parameters.
- Data Direction: Select Remote to Local - Inbound.
- Local Data Topic: Enter a topic name that will be used for subscribing to data in Litmus Edge.
- Remote Data Topic: Copy and paste the associated topic name from AWS SiteWise.
- Enable: Select the toggle to enable the topic.
- Click Yes to add the topic.
- From the connector tile, ensure the connector is not disabled and still shows a CONNECTED status. Also verify the topic shows an Enabled status.
You have several options for verifying the connection in Litmus Edge. When subscribing to the data, you will need to use the Local Data Topic name configured in the previous step.
You can visualize the incoming data using one of the dedicated Applications such as Grafana.
You can also view the data in the Flows Manager and Analytics areas of Litmus Edge.
- If you are creating a flow from the Flows Manager, subscribe to the Local Data Topic name. See Subscribe to Topics with Flows to learn more.
- If you are using Analytics, select the DataHub Subscribe processor and use the Local Data Topic name. See Create an Analytics Flow and Add Processors and Processor Connections to learn more.