Plugins 〉AWS IoT TwinMaker App


Developer
AWS IoT TwinMaker

Resources

Sign up to receive occasional product news and updates:



Application
grafana

AWS IoT TwinMaker App

  • Overview
  • Installation
  • Change log
  • Related content

AWS IoT TwinMaker Application Plugin for Grafana

dashboard

Summary

  • Introduction
  • Getting Started
  • Documentation
  • Development
  • License

Introduction

Create end-user 3D digital twin applications to monitor industrial operations with AWS IoT TwinMaker. AWS IoT TwinMaker is a service that makes it faster and easier for developers to create digital replicas of real-world systems, helping more customers realize the potential of digital twins to optimize operations.

The AWS IoT TwinMaker Application Grafana plugin provides custom panels, dashboard templates, and a datasource to connect to your digital twin data.

Custom Panels

  • Scene Viewer
  • Video Player

Dashboard Templates

  • Alarm Dashboard

Import a dashboard from the TwinMaker datasource configuration page. See the “Dashboard” tab.

dashboard-tab

Requirements

  • Grafana 8.2.0+

Getting Started

Quick Start

Interact with a demo TwinMaker dashboard in Grafana Play. This dashboard monitors a cookie factory by visualizing a 3D factory, listing alarms, graphing temperature sensor history, and playing a video camera stream.

Installation

Local Installation

Use the grafana-cli tool to install from the command line:

grafana-cli plugins install grafana-iot-twinmaker-app

Local Docker Setup

  1. Install the AWS CLI
  2. Run aws configure and enter your IAM user credentials
  3. Run the following docker command:
docker run -d -p 3000:3000 --name=grafana -v ~/.aws:/usr/share/grafana/.aws -e "GF_INSTALL_PLUGINS=grafana-iot-twinmaker-app" grafana/grafana

a. -v ~/.aws:/usr/share/grafana/.aws will mount a volume with the credentials you configured on your machine so you can use the “AWS SDK Default” authentication provider for the TwinMaker datasource

  1. Access from http://localhost:3000 on your browser. First time login will be username:admin password:admin.

Enable the Application plugin

Navigate to Grafana in your browser and log in. Go to the plugin list and search for AWS IoT TwinMaker Application and enable the plugin.

app-plugin

Configure your TwinMaker datasources.

Import a dashboard and start using the Scene Viewer and Video Player panels.

Documentation

You can find documentation on:

Development

If you are interested in developing and contributing to this project, find instructions on the git repo here.

License

  • Apache License Version 2.0, see LICENSE.

Installing AWS IoT TwinMaker App on Grafana Cloud:

For more information, visit the docs on plugin installation.

Changelog

1.15.0

1.14.0

1.13.0

1.12.0

  • Update grafana/aws-sdk-go to 0.20.0 in #273
  • Upgrade UxSDK to add path query feature for query editor in #272

1.11.1

  • Query Editor: Disable delete if only one filter, fix tooltip (new form styling) in #268
  • GetPropertyValueHistory: Convert time objects to strings with nanosecond precision #264

1.11.0

  • Support for new region cn-north-1 (BJS) in datasource

1.10.1

  • Fixed scene loading issue for Grafana version 9.x and below

1.10.0

  • Config editor: Fix workspace loading in new form styling in #258
  • Add ramda 0.27.2 to resolutions in #256
  • Query editor: Migrate to new form styling under feature toggle in #249
  • Config editor: Migrate to new form styling under feature toggle in #244

1.9.3

  • Upgrade IotAppKit dependency from 9.2.0 to 9.6.0
    • Support Auto Query and Tag Occlusion in Scene Viewer panel
    • Fix toggle playback mode functionality and reflect time range changes in Video Player panel
    • Minor bug fixes related to tags, Custom styled tags, overlay and synced Matterport tags
  • Upgrade three-stdlib dependency from 2.17.3 to 2.23.9
  • Upgrade fast-xml-parser dependency from to 4.2.5

1.9.2

  • Bump go.opentelemetry.io/contrib/instrumentation/net/http/httptrace/otelhttptrace from 0.42.0 to 0.44.0 by @dependabot in https://github.com/grafana/grafana-iot-twinmaker-app/pull/237
  • Fix imported Alarm Dashboard's filter value from string to struct by @fridgepoet in https://github.com/grafana/grafana-iot-twinmaker-app/pull/240
  • Bump @babel/traverse from 7.22.15 to 7.23.2 by @dependabot in https://github.com/grafana/grafana-iot-twinmaker-app/pull/241
  • Bump google.golang.org/grpc from 1.58.2 to 1.58.3 by @dependabot in https://github.com/grafana/grafana-iot-twinmaker-app/pull/242

1.9.1

  • Support for custom style for tags in the Scene Viewer panel
  • Other minor bug fixes in the Scene Viewer panel

1.9.0

  • Support for new regions ap-south-1 (BOM), ap-northeast-1 (NRT), & ap-northeast-2 (ICN) in datasource
  • Fix to allow custom cell types to display images
  • Fix to load a scene with Matterport space in the scene viewer

1.8.1

  • Wrap QueryEditor panel plugin in CustomScrollbar to fix scrolling behavior in #223

1.8.0

  • Upgrade plugin dependencies to React 18 and iot-app-kit@7 in #212
  • Update grafana-aws-sdk to v0.19.2

1.7.1

  • Update @grafana/aws-sdk frontend package to fix a bug with a future feature called temporary credentials
  • Fix 'invalid url' when endpoint is empty string

1.7.0

  • Update grafana-aws-sdk to v0.19.1

v1.6.3

  • fix visibility of data overlays on parent objects
  • add entity binding support
  • fix raycast issues
  • add support for selection events on data overlays

v1.6.2

  • Setting up sticky video controls for Video Player
  • Error handling for Matterport scenes
  • Auto collapse sidebar for Scene Viewer
  • Fix usage of repeat template variables for Scene Viewer and Video Player panels
  • Other minor bug fixes in Scene Viewer and Video Player panels

1.6.1

  • Update grafana-aws-sdk version.
  • Security: Upgrade Go in build process to 1.20.4
  • Update grafana-plugin-sdk-go version to 0.161.0 to avoid a potential http header problem. https://github.com/grafana/athena-datasource/issues/233

v1.6.0

  • Launch Matterport integration in the Scene Viewer
  • Support tag resize settings in the Scene Viewer
  • Support data overlay widgets in the Scene Viewer

v1.5.0

  • Update backend dependencies

v1.4.0

  • Support for GovCloud region us-gov-west-1 (PDT) in datasource

v1.3.2

  • Fix tiles render issue in Scene Viewer

v1.3.1

  • Bug fixes in Scene Viewer and Alarm Configuration panel
  • Support property display name in queries

v1.3.0

  • Launch Alarm Configuration Panel
  • Launch Query Editor Panel
  • Support querying Athena tabular connector through TwinMaker with Get Property Value
  • Launch Scene Viewer features: camera view, scene hierarchy search, opacity shader, and sub-model selection
  • Bug fixes in Scene Viewer and Video Player panels
  • Upgraded Go AWS SDK
  • The minimum Grafana version is now >=8.4

v1.2.1

  • Fix for pagination issue that lead to partial data on the dashboard
  • Fix minor bugs with the Scene Viewer and Video Player panels

v1.2.0

  • Live time series history streaming
  • Set max number of alarms to retrieve data for in the Get Alarms query
  • Set propertyName using a template variable
  • Avoid unnecessary panel refreshes on the dashboard
  • Show Motion Indicator in the scene viewer
  • Fixed Model Shader functionality in the scene viewer

v1.1.2

  • Increase the size and brightness of the tag selection graphic
  • Color the outer circle to be blue for tags
  • Make video tag consistent with other tags
  • Black icon issue for tags in FireFox

v1.1.1

  • Fix bug in GetPropertyValue query to display multiple LIST property types
  • Assume Role ARN is required to configure an IoT TwinMaker datasource
  • Optimize alarm lookup

v1.1.0

  • Upgrade Go AWS SDK.
  • Update aws-iot-twinmaker-grafana-utils package.
  • Fix minor bugs with the datasource configuration page.

v1.0.1

  • Update aws-iot-twinmaker-grafana-utils package.
  • Fix broken link on datasource configuration page.

v1.0.0

  • Initial release.