Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Java V2 Add Sitewise Basics Scenario #6871

Merged
merged 41 commits into from
Oct 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
f3af6c4
Add Java Basics for IoT Sitewise
scmacdon Sep 16, 2024
da03f63
updated Java file
scmacdon Sep 17, 2024
b8a57c5
updated Java Scenario
scmacdon Sep 17, 2024
fe55670
update tag
scmacdon Sep 17, 2024
121a654
added sitewise yaml
scmacdon Sep 17, 2024
52e03d9
updated YAML file
scmacdon Sep 17, 2024
4a73906
updated YAML file
scmacdon Sep 18, 2024
ad40905
updated YAML file to include Hello
scmacdon Sep 18, 2024
48907e3
updated YAML file
scmacdon Sep 18, 2024
f692fb3
updated Spec to specify metadata tags
scmacdon Sep 18, 2024
8687a65
updated YAML
scmacdon Sep 18, 2024
e704981
updated Readme
scmacdon Sep 18, 2024
dcf124d
updated yaml to address a lint issue
scmacdon Sep 18, 2024
5c913ad
updated a placeholder for tests
scmacdon Sep 18, 2024
62b27c0
updated yaml to address lint issue
scmacdon Sep 18, 2024
c2dee05
updated scout to use a Cloudformation template
scmacdon Sep 18, 2024
181cec2
updated scout to use a Cloudformation template
scmacdon Sep 18, 2024
5873c69
updated spec
scmacdon Sep 18, 2024
f290776
updated spec
scmacdon Sep 18, 2024
ec874d6
updated spec
scmacdon Sep 18, 2024
d410007
Rolled in reviewers changes
scmacdon Sep 25, 2024
ba100f7
updated Spec
scmacdon Sep 25, 2024
b6777e9
updated Sitewise Java examples
scmacdon Sep 26, 2024
094a709
updated Sitewise YAML file
scmacdon Sep 26, 2024
628c6c2
updated Sitewise Java file
scmacdon Sep 26, 2024
7add687
updated Sitewise Readme
scmacdon Sep 26, 2024
f89fc0b
updated Sitewise Java files
scmacdon Sep 26, 2024
4a3ecce
updated high level Readme
scmacdon Sep 26, 2024
c66f236
updated high level Readme
scmacdon Sep 26, 2024
c9d56ec
updated high level Readme
scmacdon Sep 26, 2024
a959f55
Rolled in review comments
scmacdon Sep 26, 2024
96a2111
Rolled in review comments
scmacdon Sep 26, 2024
1767386
Rolled in review comments
scmacdon Sep 27, 2024
0bbe562
Rolled in review comments
scmacdon Sep 27, 2024
95c8904
rolled in review comments
scmacdon Sep 30, 2024
354df78
rolled in review comments
scmacdon Sep 30, 2024
f1c037e
Rolled in reviewers changes
scmacdon Oct 2, 2024
e88e711
Rolled in reviewers changes
scmacdon Oct 2, 2024
765a936
updated readme
scmacdon Oct 2, 2024
3765597
rolled in review comments
scmacdon Oct 3, 2024
556fb72
updated sitewise tests
scmacdon Oct 3, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
204 changes: 204 additions & 0 deletions .doc_gen/metadata/iot_sitewise_metadata.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,204 @@
# zexi 0.4.0
iotsitewise_Hello:
title: Hello &ITSWlong;
title_abbrev: Hello &ITSW;
synopsis: get started using &ITSW;.
category: Hello
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/iotsitewise
sdkguide:
excerpts:
- description:
snippet_tags:
- iotsitewise.hello.main
services:
iotsitewise: {ListVersions}
iotsitewise_DescribeGateway:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/iotsitewise
excerpts:
- description:
snippet_tags:
- sitewise.java2.describe.gateway.main
services:
iotsitewise: {DescribeGateway}
iotsitewise_DeleteGateway:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/iotsitewise
excerpts:
- description:
snippet_tags:
- sitewise.java2.delete.gateway.main
services:
iotsitewise: {DeleteGateway}
iotsitewise_CreateGateway:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/iotsitewise
excerpts:
- description:
snippet_tags:
- sitewise.java2.create.gateway.main
services:
iotsitewise: {CreateGateway}
iotsitewise_DescribePortal:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/iotsitewise
excerpts:
- description:
snippet_tags:
- sitewise.java2.describe.portal.main
services:
iotsitewise: {DescribePortal}
iotsitewise_ListAssetModels:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/iotsitewise
excerpts:
- description:
snippet_tags:
- sitewise.java2.list.asset.model.main
services:
iotsitewise: {ListAssetModels}
iotsitewise_DeletePortal:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/iotsitewise
excerpts:
- description:
snippet_tags:
- sitewise.java2.delete.portal.main
services:
iotsitewise: {DeletePortal}
iotsitewise_CreatePortal:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/iotsitewise
excerpts:
- description:
snippet_tags:
- sitewise.java2.create.portal.main
services:
iotsitewise: {CreatePortal}
iotsitewise_DeleteAssetModel:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/iotsitewise
excerpts:
- description:
snippet_tags:
- sitewise.java2.delete.asset.model.main
services:
iotsitewise: {DeleteAssetModel}
iotsitewise_DeleteAsset:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/iotsitewise
excerpts:
- description:
snippet_tags:
- sitewise.java2.delete.asset.main
services:
iotsitewise: {DeleteAsset}
iotsitewise_DescribeAssetModel:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/iotsitewise
excerpts:
- description:
snippet_tags:
- sitewise.java2.describe.asset.model.main
services:
iotsitewise: {DescribeAssetModel}
iotsitewise_GetAssetPropertyValue:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/iotsitewise
excerpts:
- description:
snippet_tags:
- sitewise.java2_get_property.main
services:
iotsitewise: {GetAssetPropertyValue}
iotsitewise_BatchPutAssetPropertyValue:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/iotsitewise
excerpts:
- description:
snippet_tags:
- sitewise.java2_put_batch_property.main
services:
iotsitewise: {BatchPutAssetPropertyValue}
iotsitewise_CreateAsset:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/iotsitewise
excerpts:
- description:
snippet_tags:
- sitewise.java2_create_asset.main
services:
iotsitewise: {CreateAsset}
iotsitewise_CreateAssetModel:
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/iotsitewise
excerpts:
- description:
snippet_tags:
- sitewise.java2_create_asset_model.main
services:
iotsitewise: {CreateAssetModel}
iotsitewise_Scenario:
synopsis: Learn core operations for &ITSWlong; using an &AWS; SDK.
category: Basics
languages:
Java:
versions:
- sdk_version: 2
github: javav2/example_code/iotsitewise
sdkguide:
excerpts:
- description: Run an interactive scenario demonstrating &ITSW; features.
snippet_tags:
- iotsitewise.java2.scenario.main
- description: A wrapper class for &ITSW; SDK methods.
snippet_tags:
- iotsitewise.java2.actions.main
services:
iotsitewise: {}
39 changes: 39 additions & 0 deletions basics_scenarios/sitewise_scenario/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## Overview
This AWS IoT SiteWise Service basic scenario demonstrates how to interact with the AWS IoT SiteWise service using an AWS SDK. The scenario covers various operations such as creating an Asset Model, creating assets, sending data to assets, and retrieving data.

## Key Operations

1. **Create an AWS SiteWise Asset Model**:
- This step creates an AWS SiteWise Asset Model by invoking the `createAssetModel` method.

2. **Create an AWS IoT SiteWise Asset**:
- This operation creates an AWS SiteWise asset.

3. **Retrieve the property ID values**:
- To send data to an asset, we need to get the property ID values for the model properties. This scenario uses temperature and humidity properties.

4. **Send data to an AWS IoT SiteWise Asset**:
- This operation sends data to an IoT SiteWise Asset.

5. **Retrieve the value of the IoT SiteWise Asset property**:
- This operation gets data from the asset.

**Note** See the Eng spec for a full listing of operations.

## Resources

This Basics scenario requires an IAM role that has permissions to work with the AWS IoT SiteWise service. The scenario creates this resource using a CloudFormation template.

## Implementations

This scenario example will be implemented in the following languages:

- Java
- Python
- JavaScript

## Additional Reading

- [AWS IoT SiteWise Documentation](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/what-is-sitewise.html)

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0
Loading
Loading