Getting Started Guide

Introduction

IoT Dashboard is the real-time interactive dashboard with dynamic widgets designed to visualize & monitor IoT data of real-time devices connected to AWS IoT. This documentation provides a complete guide for user to make use optimum use of the IoT Dashboard.

Connecting AWS IoT Core & creating Certificates

AWS platform as a built-in IoT platform is called AWS IoT core. AWS will allow client only via TLS/SSL connection and has Message Borker running with TLS/SSL at port 8883. Below steps will help you create AWS certificate.

AWS Configuration
  • Login to AWS account
  • Click on services select AWS IoT core
  • Create a device policy by clicking “Secure” on the left side. Then select policies
  • Give policy name and in the action section give iot:*
  • Resource ARN give *
  • Click create
  • Click on manage & select Thing
  • Click “Create a Single Thing” to create a Device/thing
  • Give a name to the device in the “NAME” field & select “THING TYPE” if you already created or create a new one and select that. After that, click Next.
  • Click “Create Certificate” to download TLS/SSL certificate for AWS IoT Core.
  • AWS IoT itself generate certificates for you because AWS uses TLS for device communication.
  • Download first & last certificate and download root certificate above “Activate button”
  • Click on activate to activate the created device.
  • Next, click the “Attach Policy” button. In that window select the policy which you have created and click “Register Thing”
  • Rename the downloaded *****.crt file to client.crt and *******.key as client.key.
  • Also, rename the downloaded root certificate to root.crt.

Installation and Setup

IoT Client Dashboard is available to download for Windows / Windows servers (32 & 64 bit), Linux, MAC, and Raspbian operating systems. The binaries are available as a zip archive for Linux, Mac, and Raspbian and as a self extracting exe for the windows OS.

Windows Installation and setup
  • Just Double click the downloaded“Bevywise_IoT_Dashboard_Win_64.exe” file and the installation window will pop up.
  • In Installation Window, give the installation path and install it.
  • Put certificates in Bevywise Build as follows

  • client.crt and client.key in Bevywise/IoTDashboard/Certificates/client

  • root.crt in Bevywise/IoTDashboard/Certificates/root

  • Next, open command prompt and go to the “bin” folder(< Installation path>/Bevywise/IoTDashboard/bin).
  • Now type “rundashboard.bat” and hit enter to start the IoT Dashboard. Once you start, the user interface will be opened in your default web browser.
Linux / Mac Installation
  • Unzip the downloaded “Bevywise_IoT_Dashboard_Linux.zip” or “Bevywise_IoT_Dashboard_Mac.zip” file and extract to the location you want, Now Bevywise folder will be created in the extracted location.
  • Put your AWS certificates in Bevywise Build as follows

  • client.crt and client.key in Bevywise/IoTDashboard/Certificates/client

  • root.crt in Bevywise/IoTDashboard/Certificates/root

  • Open the Linux/Mac terminal and go to the bin folder(< Installation path >/Bevywise/IoTDashboard/bin).
  • Run the “rundashboard.sh” by “sh” command and hit enter to start the IoT Dashboard.
  • Once you start the IoT Dashboard, user Interface will open in the Default web browser

Now its time to visualize your data from AWS. To proceed further, start creating your own dashboard with pre-built widgets available.

Dashboard Creation

  • Enter the name of the dashboard you are about to create in the respective space provided.
  • Provide the description of the dashboard.
  • Click create button.
  • The widgets you create will be displayed in the created dashboard.
How to create widgets?
  • Click + icon present at the top right corner of the page.
  • The pop-up window will open showing “Select Widget type”.
Text widget
  • To create “Text widget”, select “Text” from the widgets list.
  • Then provide a suitable title for the widget
  • After providing the title for the widget, enter topic for which you need to visualize the data. The created topics will be listed in the drop down menu & you can select one from the list..
  • Enter “key”, “unit” (if your data denotes any specific parameter) in the respective space provided & select “colour” to display.
  • Then Select “Minimum”,& “Maximum” value according to your payload.
  • Enter “Offset” value as you need & provide “Subtitle” and select “Colour” to display.
  • If you need to add more key click the “Add” button and repeat the previous steps.
  • Once you complete, click the “Create” button to view the widget.
Colour
  • To create “Colour widget”,select “colour” from the widgets list.
  • Then provide a suitable Title for the widget
  • After providing the title for the widget, enter topic for which you need to visualize the data. The created topics will be listed in the drop down menu & you can select one from the list.
  • Enter “key”, “unit” (if your data denotes any specific prameter) in the respective space provided & select “colour” to display.
  • If you need to add more key click the “Add” button and repeat the previous steps.
  • Once you complete, click the “Create” button to view the widget.
Line Chart
  • To create “Line Chart”,select “Line Chart” from the widgets list.
  • Then provide a suitable title for the widget
  • After providing the title for the widget, enter topic for which you need to visualize the data. The created topics will be listed in the drop down menu & you can select one from the list.
  • Enter “key”, “unit” (if your data denotes any specific parameter in the respective space provided & select “colour” to display.
  • If you need to add more key click the “Add” button and repeat the previous steps.
  • Once you complete, click the “Create” button to view the widget.
Bar Chart
  • To create “Bar Chart”,select “Bar Chart” from the widgets list.
  • Then provide a suitable title for the widget
  • After providing the title for the widget, enter topic for which you need to visualize the data. The created topics will be listed in the drop down menu & you can select one from the list..
  • Enter “key”, “unit” in the respective space provided & select “colour” to display.
  • If you need to add more key click the “Add” button and repeat the previous steps.
  • Once you complete, click the “Create” button to view the widget.
Gauge Chart
  • To create “Gauge Chart”, select “Gauge Chart” from the widgets list.
  • Then provide a Title for the widget
  • After providing the title for the widget, enter topic for which you need to visualize the data. The created topics will be listed in the drop down menu & you can select one from the list..
  • Enter “key”, “unit” in the respective space provided & select “colour” to display.
  • Then Select “Minimum”,& “Maximum” value according to your payload.
  • Enter “Offset” value as you need & provide “Subtitle” and select “Colour” to display.
  • If you need to add more key click the “Add” button and repeat the previous steps.
  • Once you complete, click the “Create” button to view the widget.
Vertical Gauge
  • To create “Vertical Gauge”, select “Vertical Gauge” from the widgets list.
  • Then provide a Title for the widget
  • After providing the title for the widget, enter topic for which you need to visualize the data. The created topics will be listed in the drop down menu & you can select one from the list..
  • Enter “key”, “unit” in the respective space provided & select “colour” to display.
  • Then Select “Minimum”,& “Maximum” value according to your payload.
  • Enter “Offset” value as you need & provide “Subtitle” and select “Colour” to display.
  • If you need to add more key click the “Add” button and repeat the previous steps.
  • Once you complete, click the “Create” button to view the widget.
Horizontal Gauge
  • To create “Horizontal Gauge”, select “Horizontal Gauge” from the widgets list.
  • Then provide a Title for the widget
  • After providing the title for the widget, enter topic for which you need to visualize the data. The created topics will be listed in the drop down menu & you can select one from the list..
  • Enter “key”, “unit” in the respective space provided & select “colour” to display.
  • Then Select “Minimum”,& “Maximum” value according to your payload.
  • Enter “Offset” value as you need & provide “Subtitle” and select “Colour” to display.
  • If you need to add more key click the “Add” button and repeat the previous steps.
  • Once you complete, click the “Create” button to view the widget.
Led Light
  • To create “Led Light Widget”, select “Led Light” from the widgets listed.
  • Then provide a Title, for the widget.
  • After providing the title for the widget, enter topic for which you need to visualize the data. The created topics will be listed in the drop down menu & you can select one from the list..
  • Select Active value and Colour to display active value. Similarly, select Inactive value and colour to display inactive value.
  • Once you complete, click “Create” button to view the widget.
Widgets