How-To Guides
Integration Guides
LitmusEdge with AWS IoT SiteWise
15min
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 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 https //archbee doc uploads s3 amazonaws com/q116wjtar1sefevnvmcf9 hbkzlnfocolo ebdqfpai 20240905 161836 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 open the aws iot sitewise browser tab and navigate to data sources section see add a partner data source and sitewise edge gateway partner data source option for more details click add data source the add data source panel appears 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 set up an activation configuration docid\ vbrfw a0lltujmwdpunnv to generate an activation url litmus edge manager activation code see set up an activation configuration 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 step 2 monitor the deployment to monitor the deployment of edge devices return to the aws iot sitewise console click the greengrass core device name under the edge gateways section the overview page for the core device appears click deployments and check the status of the latest deployment allow a few minutes for the deployment to refresh the status on this device tab will change to succeeded the deployment of the edge device is completed step 3 approve activation in litmus edge manager 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 https //archbee doc uploads s3 amazonaws com/q116wjtar1sefevnvmcf9 ndi54t6dz3bh6viaeb0a6 20240905 162238 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 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 , /\<device name>/\<tag name>) 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 step 7 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 manage connectors 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 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 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 step 10 verify outbound d ata 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 log in to your aws console from the side menu, navigate to the data streams pane click the refresh button to refresh the page the data streams info table shows a new topic 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 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 log in to your aws console from the side menu, navigate to the assets pane click measurements under the property type 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