Skip to content
This repository has been archived by the owner on Oct 30, 2023. It is now read-only.

Latest commit

 

History

History
108 lines (68 loc) · 6.74 KB

README.md

File metadata and controls

108 lines (68 loc) · 6.74 KB

IoT Application Kit

Build Status NPM Version License Bundle Size Downloads


NEW in 4.0: IoT Application Kit has been fully migrated to React 18! There are a number of key breaking changes in React 18 that you should be aware of before upgrading to this version, which you can find details about here:

At this point, AppKit version ^3 versions move into maintenance mode, and will only receive critical upgrades. Please submit a Github issue if you need a new feature and are currently unable to upgrade, and we will work with you on coming up with a solution.

There should be no breaking changes in the AppKit components themselves, but their behaviors might be altered as a result of this upgrade, so if you find any issues please report them via the github issues at the top, and we will do our best to prioritize these.

Thanks!

  • AWS IoT AppKit Team

IoT Application Kit is a development library for building Industrial IoT web based applications.

IoT App Kit is an open-source library consisting of front-end components and utilities. With IoT App Kit, you can build front-end applications and webpages to utilize IoT data. By default, IoT App Kit helps to retrieve data from AWS IoT SiteWise and AWS IoT TwinMaker You can also install plugins to retrieve data from your own sources. There’s no charge for using IoT App Kit.

For an example of a real world use case using the IoT App Kit, visit this tutorial on how to use IoT App Kit

IoT App Kit Demo

Table of contents

Components

React hooks (For building custom IoT App Kit components)

Utilities

  • Viewport manager - Learn how to make your custom IoT App Kit components synchronize with viewport groups

Data sources

Data source features built into AWS IoT SiteWise and AWS IoT TwinMaker

  • Time series data features - Learn about what IoT App Kit does for you when managing time series data around caching, TTLs, buffering, etc.

For IoT App Kit contributors

Contributors guide to IoT App Kit

Learn how to contribute at the development guide.

Packages

The IoT Application Kit containing the following public packages:

@iot-app-kit/react-components

@iot-app-kit/react-components exposes the core iot-app-kit web components as React components.

Learn more here.

@iot-app-kit/scene-composer

@iot-app-kit/scene-composer is a 3D rendering component built over @react-three/fiber that renders your digital twin and enables you to interact with it.

Learn more here.

@iot-app-kit/source-iotsitewise

@iot-app-kit/source-iotsitewise exposes the AWS IoT SiteWise source, which enables you to visualize and interact with your AWS IoT SiteWise data and assets.

Learn more here.

@iot-app-kit/source-iottwinmaker

@iot-app-kit/source-iottwinmaker exposes the AWS IoT TwinMaker source, which enables you to visualize and interact with your AWS IoT TwinMaker data and digital twins.

Learn more here.

@iot-app-kit/core

@iot-app-kit/core is the core library which exposes the iot-app-kit framework and shared typescript Types and utilities, and is what iot-app-kit components are built upon.

Learn more here.

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.