Plugins 〉AWS IoT TwinMaker App
14 day trial Install plugin
1 Enterprise plugin Upgrade and install
AWS IoT TwinMaker App
AWS IoT TwinMaker Application Plugin for Grafana
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.
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
- Install the AWS CLI
- Run
aws configureand enter your IAM user credentials - 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
- Access from http://localhost:3000 on your browser. First time login will be username:
adminpassword: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.
Configure your TwinMaker datasources.
Import a dashboard and start using the Scene Viewer and Video Player panels.
Documentation
You can find documentation on:
- TwinMaker datasource
- Dashboard templates
- Scene Viewer panel
- Video Player panel
- Getting started with a GG Edge Connector for KVS
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.
Grafana Cloud Pro
- $25 / user / month and includes a free trial for new users
- Available with a Grafana Cloud Pro plan
- Access to 1 Enterprise plugin
- Fully managed service (not available to self-manage)
Grafana Cloud Advanced / Grafana Enterprise
- Available with a Grafana Cloud Advanced plan or Grafana Enterprise license
- Access to all Enterprise plugins
- Run fully managed or self-manage on your own infrastructure
Installing AWS IoT TwinMaker App on Grafana Cloud:
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
For more information, visit the docs on plugin installation.
Installing on a local Grafana:
For local instances, plugins are installed and updated via a simple CLI command. Plugins are not updated automatically, however you will be notified when updates are available right within your Grafana.
1. Install the Application
Use the grafana-cli tool to install AWS IoT TwinMaker App from the commandline:
grafana-cli plugins install The plugin will be installed into your grafana plugins directory; the default is /var/lib/grafana/plugins. More information on the cli tool.
Alternatively, you can manually download the .zip file for your architecture below and unpack it into your grafana plugins directory.
Alternatively, you can manually download the .zip file and unpack it into your grafana plugins directory.
2. Enable it
Next, log into your Grafana instance. Navigate to the Plugins section, found in your Grafana main menu.
Click the Apps tabs in the Plugins section and select the newly installed app.
To enable the app, click the Config tab. Follow the instructions provided with the application and click Enable. The app and any new UI pages are now accessible from within the main menu, as designed by the app creator.
If dashboards have been included with the application, they will attempt to be automatically installed. To view the dashboards, re-import or delete individual dashboards, click the Dashboards tab within the app page.
Changelog
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 paginaton 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.
