Skip to content

Commit

Permalink
Merge branch 'awslabs:main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
square-li authored Jul 13, 2022
2 parents 90da9ba + 8523409 commit d7941f4
Show file tree
Hide file tree
Showing 58 changed files with 3,488 additions and 685 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ __diff_output__
# Cypress screenshots
**/cypress/screenshots
**/cypress/videos
**/cypress/snapshots/All Specs

# Local development hard-coded credentials for use with the AWS SDK.
creds.json
Expand Down
1 change: 1 addition & 0 deletions .stylelintignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ dist/
www/
loader/
node_modules/
coverage/
28 changes: 28 additions & 0 deletions docs/AWSIoTSiteWiseSource.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ You can download the AWS IoT SiteWise source from the following location: https:

To set up the AWS IoT SiteWise source, follow the instructions in [Getting started with IoT Application Kit](https://github.com/awslabs/iot-app-kit/tree/main/docs/GettingStarted.md).

---

## Queries

The AWS IoT SiteWise source provides queries that you can use to filter AWS IoT SiteWise data and assets.
Expand All @@ -34,6 +36,8 @@ query.timeSeriesData({

This query for time series data, can then be provided to any of the IoT App Kit components that support time series data.

---

## API

### `timeSeriesData`
Expand Down Expand Up @@ -140,6 +144,7 @@ const { query } = initialize({ iotsitewiseClient });
]}
/>
```
---

### `assetTree`

Expand Down Expand Up @@ -206,3 +211,26 @@ Type: Boolean

Type: Boolean

---

## SiteWiseDataSourceSettings

(Optional) Settings that can be provided when initializing the AWS IoT SiteWise source.

```
import { initialize } from '@iot-app-kit/source-iotsitewise';
const { IoTSiteWiseClient } = require("@aws-sdk/client-iotsitewise");
const iotsitewiseClient = new IoTSiteWiseClient({ region: "REGION" });
const { query } = initialize({ iotsitewiseClient, settings: { batchDuration: 100 } });
```

`batchDuration`

(Optional) Timeframe over which to coalesce time-series data requests before executing a batch request, specified in ms. e.g. a `batchDuration` of 100 will cause the AWS IoT SiteWise source to repeatedly batch all requests that occur within a 100 ms timeframe.

Type: Number

The AWS IoT SiteWise source communicates with SiteWise using batch APIs to reduce network overhead. By default, all individual requests for time-series data that occur within a single frame of execution are coalesced and executed in a batch request. This behaviour is scheduled using the [Job and JobQueue](https://262.ecma-international.org/6.0/#sec-jobs-and-job-queues) concepts. Depending on dashboard configuration, widget configuration, latency, and a multitude of other factors, batching on a single frame of execution might not be desirable.
2 changes: 1 addition & 1 deletion lerna.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "1.4.0",
"version": "1.5.0",
"packages": [
"packages/*"
],
Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@
"test:unit": "lerna run test --stream --concurrency 1",
"test:git": "git diff --exit-code",
"pack": "lerna run pack",
"versionup:auto": "lerna version --conventional-commits --no-push --no-git-tag-version --yes",
"versionup:patch": "lerna version patch --conventional-commits --no-push --no-git-tag-version --yes",
"versionup:minor": "lerna version minor --conventional-commits --no-push --no-git-tag-version --yes",
"versionup:major": "lerna version major --conventional-commits --no-push --no-git-tag-version --yes",
"versionup:auto": "lerna version --conventional-commits --no-changelog --no-push --no-git-tag-version --yes",
"versionup:patch": "lerna version patch --conventional-commits --no-changelog --no-push --no-git-tag-version --yes",
"versionup:minor": "lerna version minor --conventional-commits --no-changelog --no-push --no-git-tag-version --yes",
"versionup:major": "lerna version major --conventional-commits --no-changelog --no-push --no-git-tag-version --yes",
"publishToNpm": "lerna publish from-package --no-verify-access --yes"
},
"devDependencies": {
Expand Down
72 changes: 72 additions & 0 deletions packages/components/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,78 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

# 1.5.0 (2022-07-09)


### Features

* synchro-charts version updated to 5.0.0

* Added properties to the following components:

IotBarChart:
* alarms
* axis
* gestures
* layout
* legend
* messageOverrides
* movement
* scale
* size
* trends

IotKpi:
* messageOverrides

IotLineChart:
* axis
* gestures
* layout
* legend
* messageOverrides
* movement
* scale
* size
* trends

IotScatterChart:
* alarms
* axis
* gestures
* layout
* legend
* messageOverrides
* movement
* scale
* size
* trends

IotStatusGrid:
* labelsConfig

IotStatusTimeline:
* alarms
* annotations
* axis
* gestures
* layout
* messageOverrides
* movement
* scale
* size

IotTable:
* messageOverrides
* trends

### Fixes

* integration tests asset model and asset summary mocks updated to return current response.




# 1.4.0 (2022-06-09)


Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions packages/components/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"publishConfig": {
"access": "public"
},
"version": "1.4.0",
"version": "1.5.0",
"description": "IoT App Kit Components",
"main": "dist/index.cjs.js",
"module": "dist/custom-elements/index.js",
Expand Down Expand Up @@ -41,11 +41,11 @@
"@awsui/collection-hooks": "^1.0.0",
"@awsui/components-react": "^3.0.0",
"@awsui/design-tokens": "^3.0.0",
"@iot-app-kit/core": "^1.4.0",
"@iot-app-kit/related-table": "^1.4.0",
"@iot-app-kit/source-iotsitewise": "^1.4.0",
"@iot-app-kit/core": "^1.5.0",
"@iot-app-kit/related-table": "^1.5.0",
"@iot-app-kit/source-iotsitewise": "^1.5.0",
"@stencil/core": "^2.7.0",
"@synchro-charts/core": "^4.0.1",
"@synchro-charts/core": "^5.0.0",
"styled-components": "^5.3.0"
},
"devDependencies": {
Expand Down
Loading

0 comments on commit d7941f4

Please sign in to comment.