--- title: Litmus Edge with AWS IoT SiteWise slug: litmusedge/litmus-edge-with-aws-iot-sitewise docTags: createdAt: 2024-08-22T19:18:57.713Z --- Review the following guide to set up an integration between Litmus Edge and AWS IoT SiteWise to send data directly to the cloud. # Before You Begin Before completing these steps, make sure to do the following: - Have access to an AWS account with the appropriate user privileges. - Set up a [SiteWise Edge gateways with AWS IoT Greengrass](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gw-self-host-gg2.html). - A Litmus Edge Manger instance with an active configuration ready for deployment of an edge device. See [Set Up an Activation Configuration](docId\:VbRFW-a0LLtuJmwdpuNNV) for details. - Refer to *Step 3: Add Template *in the [Set Up an Activation Configuration](docId\:VbRFW-a0LLtuJmwdpuNNV) section to include the template file below. This JSON file contains the configuration for the AWS IoT SiteWise Edge Integration and should be uploaded to the activation config. ::File{src="https://api.archbee.com/api/presign/Q116WJTAr1sefeVNvMCF9-hbKzLnfoColO-eBDQfPAi-20240905-161836.json" label="AWS_IoT_SiteWise_Edge_template.json"} # Set Up Integration in AWS ## Step 1: Deploying Litmus Edge From AWS IoT SiteWise Console **To deploy litmus edge from your AWS IoT SiteWise console:** 1. Open the *AWS IoT SiteWise* browser tab and navigate to **Data Sources **section. See [Add a partner data source](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/cpa-add-source.html) and [SiteWise Edge gateway partner data source option](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-partner-data-source.html#cp-litmus) for more details. 2. Click **Add data source**. The *Add data source* panel appears. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/F3LNZWbPGe542TO0Dc2Vj_image.png" size="100" width="1693" height="291" position="center" caption="Add data source panel" darkWidth="1693" darkHeight="291" showCaption="true" indent="2"} 3. Configure the following parameters to add data source and activate litmus edge. - **Source type: **Select **Litmus Edge** from the drop-down list. - **Source name:** Name your Litmus Edge instance. - **Activation configuration: **This configuration is optional. - For this guide, select **Activate now using a code**. - **Litmus Edge Manager Activation URL: **See [Step 8: Retrieve Activation Code/URL](docId\:VbRFW-a0LLtuJmwdpuNNV) to generate an activation URL. - **Litmus Edge Manager activation code: **See [Step 8: Retrieve Activation Code/URL](docId\:VbRFW-a0LLtuJmwdpuNNV) to generate an activation code. - **Litmus Edge Manager CA certificate: **See [Add a Custom CA Certificate](docId\:TTt4LhsdYPNd0siTfg2BY) for more details. - To activate with Litmus Edge manager later, select **Activate later on Litmus Edge*****.*** - Litmus Edge will not be activated with Litmus Edge Manager and will require manual activation, licensing and configuration. See [Activate an Edge Device](docId\:tDJ648wJgATVqzyx79UwB) for details. - Check the **Authorize** check box. - Click **Save**. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/GkDGhDaJp2oHXoyJTMyDS_image.png" size="80" width="887" height="831" position="center" darkWidth="887" darkHeight="831" showCaption="false" indent="3"} ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/Ye-8KbfmQrjMm8QbRwrNk_image.png" size="80" width="876" height="514" position="center" caption="Add data source dialog box" darkWidth="876" darkHeight="514" showCaption="true" indent="3"} ## Step 2: Monitor the Deployment **To monitor the deployment of edge devices:** 1. Return to the *AWS IoT SiteWise Console.* 2. Click the **Greengrass core device name** under the *Edge gateways* section. The *Overview *page for the Core Device appears. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/o1E0QcVJemGvm9zKci_GE_image.png" size="100" width="1700" height="743" position="center" caption="Overview page" darkWidth="1700" darkHeight="743" showCaption="true" indent="2"} 3. Click **Deployments **and check the status of the latest deployment. Allow a few minutes for the deployment to refresh. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/6RkMdejknHXJm7axq5PFL_image.png" size="100" width="1502" height="606" position="center" caption="Deployments page" darkWidth="1502" darkHeight="606" showCaption="true" indent="2"} 4. The Status on this device tab will change to **Succeeded**. The deployment of the edge device is completed. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/vJCdn1oenFc97ISDQx_75_image.png" size="100" width="1491" height="603" position="center" caption="Deployments page" darkWidth="1491" darkHeight="603" showCaption="true" indent="2"} ## Step 3: Approve Activation in Litmus Edge Manager :::hint{type="info"} **Notes: **Ensure that the correct template is applied during the configuration, as this will provide the necessary connector setup. **See Step 3: Add Template** in [Set Up an Activation Configuration](docId\:VbRFW-a0LLtuJmwdpuNNV) for details. Download the template file below: ::File{src="https://api.archbee.com/api/presign/Q116WJTAr1sefeVNvMCF9-Ndi54T6Dz3bH6ViaeB0a6-20240905-162238.json" label="AWS_IoT_SiteWise_Edge_template.json"} ::: After deployment, go back to Litmus Edge Manager and approve the activation request. See [Step 4: Approve the Activation Request in Litmus Edge Manager](docId\:rdL1GO82TH_UOLBJRhaW3) for details. # Set Up Integration in Litmus Edge After setting up your AWS account, you will need to log in to the previously deployed Litmus Edge instance to complete the steps for integrating with AWS IoT SiteWise. You can access the Litmus Edge UI by directly accessing the AWS SiteWise Edge gateway. If direct access is not available, they can also remotely connect to the Litmus Edge instance from the Litmus Edge Manager from [Open Edge Devices](docId\:XpURI-8b1QSviQEpNCvzD). :::hint{type="info"} **Important: **To log in to your Litmus Edge instance, you need the IP of the gateway and port 8443. See [Access the Litmus Edge Web UI](docId\:tGtrj9DEH1W_ro24kmbmQ) for more details. ::: ## Step 4: Add Device Follow the steps to [Connect a Device](docId:3eyAfPpweuVmBLCEy17sq). The device will be used to store tags that will be eventually used to create outbound topics in the connector. ## Step 5: Add Tag to Device After connecting the device in Litmus Edge, you can [Add Tags](docId:8sE7z3PmRfwL1nmzcwaLX) to the device. Create tags that you want to use to create outbound topics for the connector. ## Step 6: Add MQTT - AWS IoT SiteWise Edge Connector Follow the steps to [Add a Connector](docId\:b7eMDh8AO2-NOqDHwPD7Y) and select the **MQTT - AWS IoT SiteWise Edge **provider. Configure the following parameters. - **Name: **Enter Connector Name. - **Client ID: **Enter Unique client identity. - **Property Alias:** This can be static or use format directives, with the default being **/$D/$N** `(e.g., //)`. Ensure the Property Alias matches the AWS IoT SiteWise Asset Measurement Alias. - **Integration Topic:** AWS recommends that the default integration topic for publishing matches the Property Alias. - **Additional Alias Definition: **(Optional) String to further define dynamic *Property Alias *and *Integration Topic*. - Click **Save **or **Update**. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/SkD7TXX2hIiaiNeWtRimx_image.png" size="100" width="1107" height="681" position="center" caption="MQTT - AWS IoT SiteWise Edge dialog box" darkWidth="1107" darkHeight="681" showCaption="true" indent="2"} ## Step 7: Enable the Connector After adding the connector, click the toggle in the connector tile to enable it. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/GBc0HbwaV7_s7wCYQOVSF_image.png" size="50" width="402" height="346" position="center" caption="Enable the Connector" darkWidth="402" darkHeight="346" showCaption="true"} If you see a *Failed *status, you can review the [Connector Logs](docId:5hctoRLhgaX3Ikh_lvi0A) and relevant error messages. ## Step 8: Create Topics for Connector You will now need to create topics for the connector. To create outbound topics, you have the option of importing the tag created in Step 5. To create inbound topics, you will have to manually create the topic. **To create outbound topics:** 1. Click the connector tile. The connector *Dashboard *appears. 2. Click the **Topics **tab. 3. Click the** Import from DeviceHub **tags icon. The *DeviceHub Import *dialog box appears. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/ypZrUmB7ziVyI_86MQpP4_image.png" size="100" isUploading="false" width="1820" height="544" darkWidth="1820" darkHeight="544" showCaption="false" indent="2"} 4. Select all the tags to import and click **Import**. ## Step 9: Enable Topics Ensure the topics you imported are enabled by returning to the *Topics *tab and clicking the **Enable all topics** icon. ![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/7fNlyn-OodMfSH8N2szfW_image.png) ## Step 10: Verify Outbound Data To verify that data is landing in AWS IoT SiteWise, you can check either the Data Streams or the specific Asset where the data is expected to publish. You will need to log in to your AWS console to verify that outbound messages are being sent. ### Step 10a: Verify Data from Data Streams **To verify outbound messages from data streams: ** 1. Log in to your *AWS console*. 2. From the side menu, navigate to the **Data streams** pane. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/J_a5G9ysaINmjV_t2yr62_image.png" size="100" width="1920" height="427" position="center" caption="Data streams pane" darkWidth="1920" darkHeight="427" showCaption="true" indent="2"} 3. Click the **Refresh **button to refresh the page. The *Data streams info *table shows a new topic. 4. Enable the topic and confirm that data is flowing correctly from Litmus Edge to AWS IoT SiteWise. - The Data stream alias in AWS SiteWise Console will be the Integration Topic or Remote Data topic defined in the Litmus Edge AWS IoT SiteWise Edge Integration. The data was successfully sent from Litmus Edge to the broker AWS IoT Sitewise. ![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/tpvjxjpW5tP6pVa8euj9v_image.png "Data streams page") ### Step 10b: Verify Data from Asset’s Measurement If the *Property Alias *configured in Litmus Edge matches what is set in AWS IoT SiteWise, the data will be visible in the Asset’s measurement section. **To verify outbound messages from asset’s measurement: ** 1. Log in to your *AWS console*. 2. From the side menu, navigate to the **Assets** pane. 3. Click **Measurements** under the *Property Type*. 4. Confirm that data is flowing correctly from Litmus Edge to AWS IoT SiteWise. The data was successfully sent from Litmus Edge to the broker AWS IoT Sitewise. ![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/zPSMGrnxn8wQ6GvHe7tCb_image.png "Asset’s Measurement Page")