AWS IoT SiteWise (Gen 1)
Review the AWS SiteWise Integration Guide.
Overview
AWS IoT SiteWise integration enables an Edge System connection with Amazon AWS IoT SiteWise.
Supported Communication Directions
- Outbound: Publish data from Edge to AWS IoT SiteWise
- Inbound: Subscribe to data from AWS IoT SiteWise
Variable Definitions
Variable | Details |
|---|---|
Name | Name for the connector |
Region | AWS Region. See AWS IoT SiteWise endpoints and quotas to learn more. |
Access Key | AWS Access Key |
Secret Key Access | AWS Secret Access Key |
Subscribe interval | Time between fetching inbound messages (in seconds) |
Number of batch messages | Maximum amount of outbound messages sent in one batch |
Throttling limit | Maximum throughput counted in messages per second |
High-Precision Timestamps (offsetInNanos)
The AWS IoT SiteWise connector supports high-precision timestamps in the standard deviceHub payload. You can provide a timestamp object containing both timeInSeconds and offsetInNanos fields. This enables nanosecond-level precision for asset property values sent to AWS IoT SiteWise.
Payload Format
To use high-precision timestamps, include the timestamp object in your payload:
{ "datatype": "float64", "description": "", "deviceID": "C250EEBF-2611-47F8-B8B9-A27F084DA3D7", "deviceName": "sim", "metadata": {}, "registerId": "FDD88267-AABD-4118-A2EE-24E2D89CEFB5", "success": true, "tagName": "tag1", "timestamp": { "timeInSeconds": 1765387245162, "offsetInNanos": 0 }, "value": 0}where:
- timeInSeconds is the main timestamp in seconds (Unix epoch time).
- offsetInNanos (optional) specifies a nanosecond offset for higher precision. Set to 0 if not needed.
Considerations
High-precision timestamps allow for more accurate event ordering and data analysis in time-sensitive applications. High-precision timestamps also allow for data transformation. Use Analytics to convert DeviceHub standard timestamps, enrich data, or filter records before sending to AWS IoT SiteWise.
Note the following:
- timeInSeconds and offsetInNanos both map directly to the BatchPutAssetPropertyValue in AWS IoT SiteWise.
- offsetInNanos defaults to 0 when omitted.
Configurations
Variable | Detail | Required |
|---|---|---|
Name | Connector name | Yes |
Region | Geographic area where Amazon Web Services resources are hosted | Yes |
Access key id | Unique identifier in AWS IoT SiteWise used for authentication and, enabling secure and authorized access to the SiteWise service for applications and entities | Yes |
Secret access key | A confidential authentication credential in AWS IoT SiteWise used to securely access and interact with the SiteWise service | Yes |
Subscribe interval | Defines the time in seconds between consecutive data update notifications for a subscribed asset property. Specifies the frequency at which the system checks and receives updates on the specified property within the IoT SiteWise platform. | No |
Number of batch messages | The quantity of grouped data transmissions | No |
Throttling limit | Set a limit on the number of outbound messages per second. Ensures that no messages are lost when sending data to a server that has restrictions on the rate of incoming messages. | No |
Persistent storage | If enabled, messages in the outbound queue are stored on disk. If there are interruptions in connection or power loss, messages are retained and eventually sent when the connection is restored. | No |
Queue mode | Select the sequence of data transfer: FIFO or LIFO. FIFO (First In First Out) sends the earliest message first. LIFO (Last In First Out) sends the last message first. | No |
Compatibility Validation
This information for reference. More products and versions may be supported provided they are compatible with the supported version as mentioned above.
Product | Version | Date |
|---|---|---|
aws.amazon.com | AWS SDK for Go v2 (v1.21.0) | 2023-07-31 |