You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: basics_scenarios/sitewise_scenario/SPECIFICATION.md
+19-10Lines changed: 19 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,31 +1,40 @@
1
1
# AWS IoT SiteWise Service Scenario Specification
2
2
3
3
## Overview
4
-
This SDK Basics scenario demonstrates how to interact with AWS IoT SiteWise using the AWS SDK. It demonstrates various tasks such as creating a SiteWise Asset Model, creating an asset, sending data to the asset, reading data, and so on. Finally this scenario demonstrates how to clean up resources. Its purpose is to demonstrate how to get up and running with AWS IoT SiteWise and the AWS SDK.
4
+
This SDK Basics scenario demonstrates how to interact with AWS IoT SiteWise using an AWS SDK.
5
+
It demonstrates various tasks such as creating a SiteWise Asset Model, creating an asset,
6
+
sending data to the asset, reading data, and so on. Finally this scenario demonstrates how
7
+
to clean up resources. Its purpose is to demonstrate how to get up and running with
8
+
AWS IoT SiteWise and an AWS SDK.
5
9
6
10
## Resources
7
-
This Basics scenario has a depedency on an IAM role that has permissions for this service. We will create this resource using a CloudFormation template so the user does not have to manually create it. You can see this functionality in the Program execution section below.
11
+
This Basics scenario requires an IAM role that has permissions to work with AWS IoT
12
+
SiteWise service. The scenario creates this resource using a CloudFormation template.
8
13
9
14
## Hello AWS IoT SiteWise
10
15
This program is intended for users not familiar with the AWS IoT SiteWise Service to easily get up and running. The logic is to show use of
11
16
`listAssetsPaginator`.
12
17
13
-
## Scenario Program Flow
18
+
## Basics Scenario Program Flow
14
19
The AWS IoT SiteWise Basics scenario executes the following operations.
15
20
16
21
1.**Create an AWS SiteWise Asset Model**:
17
-
- Description: This operation creates an AWS SiteWise Asset Model. Invoke the `createAssetModel` method.
18
-
- Exception Handling: Check to see if a `ResourceAlreadyExistsException` is thrown. If it is thrown, get the asset model ID and move on.
22
+
- Description: This step creates an AWS SiteWise Asset Model by invoking the `createAssetModel` method.
23
+
- Exception Handling: Check to see if a `ResourceAlreadyExistsException` is thrown.
24
+
If it is thrown, get the asset model ID and move on.
19
25
20
26
2.**Create an AWS IoT SiteWise Asset**:
21
27
- Description: This operation creates an AWS SiteWise asset.
22
28
- The method `createAsset` is called to obtain the asset ID.
23
-
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program.
29
+
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so,
30
+
display the message and end the program.
24
31
25
32
3.**Retrieve the property ID values**:
26
-
- Description: To send data to an asset, we need to get the property ID values for the Temperature and Humidity properties.
27
-
- The method `listAssetModels()` is called to retrieve the asset ID values.
28
-
- Exception Handling: Check to see if an `IoTSiteWiseException` is thrown. There are not many other useful exceptions for this specific call. If so, display the message and end the program.
33
+
- Description: To send data to an asset, we need to get the property ID values for the
34
+
the model properties. This scenario uses temperature and humidity properties.
35
+
- The method `listAssetModelProperties()` is called to retrieve the property ID values.
36
+
- Exception Handling: Check to see if an `IoTSiteWiseException` is thrown. There are not
37
+
many other useful exceptions for this specific call. If so, display the message and end the program.
29
38
30
39
4.**Send data to an AWS IoT SiteWise Asset**:
31
40
- Description: This operation sends data to an IoT SiteWise Asset.
@@ -47,7 +56,7 @@ The AWS IoT SiteWise Basics scenario executes the following operations.
47
56
- The method `describePortal()` is called and returns the URL.
48
57
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program.
49
58
50
-
8.**Create an IoTSitewise Gateway**:
59
+
8.**Create an IoTSiteWise Gateway**:
51
60
- Description: This operation creates an IoT SiteWise Gateway.
52
61
- The method `createGateway` is called.
53
62
- Exception Handling: Check to see if an `IoTSiteWiseException` is thrown.
0 commit comments