How-To Guides
Integration Guides
AWS SiteWise Integration Guide
14min
review the following guide for setting up an integration between litmus edge and aws sitewise before you begin 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 what is aws iot sitewise key components ingesting data to aws iot sitewise interacting with other aws services step 1 collect aws sitewise connection parameters 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 step 2 add aws sitewise connector in litmus edge once you have collected the required aws connection parameters, follow the steps to add a connector docid\ ogw7fkqbwidbabn4wl5rr 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 step 3 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 3u7jzldinehy8shvifd d and relevant error messages step 4 set up connection (outbound or inbound) with aws sitewise you have the option of setting up an outbound or inbound connection set up outbound 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 step a 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 make sure to select the enable data store checkbox step b add tags 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 c create outbound topics for connector 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 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 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 d enable topics ensure the topics you imported are enabled by returning to the topics tab and clicking the enable all topics icon step e verify connection 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 set up inbound connection you have the option of subscribing to data from aws sitewise step a create inbound topics for connector 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 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 step b verify connection in litmus edge 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 docid\ yabkqsucfr461 ewjgrxf such as visualize data using grafana docid 5o vfup1zhzcebvrd1i62 you can also view the data in the flows manager docid bvxnzlgo8fsoglib4o l and analytics docid\ zaowl1npjlkefhjbxhgvu areas of litmus edge if you are creating a flow from the flows manager docid bvxnzlgo8fsoglib4o l , subscribe to the local data topic name see subscribe to topics with flows docid eyie5jljwuavpob0upc1 to learn more if you are using analytics docid\ zaowl1npjlkefhjbxhgvu , select the datahub subscribe processor and use the local data topic name see create an analytics flow docid\ qqogdbmh nz5rlbe3eni1 and add processors and processor connections docid\ hlhao9nxasjvcczrziclh to learn more