Documentation - "Whisker.IO Portal"

Save to PDF

1 Introduction

The Whisker.IO portal provides a powerful, easy to use interface for:

  • Managing your account and users
  • Managing locations
  • Managing your devices - change settings, configure services, etc.
  • Configuring automation
  • Monitoring deployed devices
  • Historical analysis of device data using time-series line graphs

The following video is a complete walk-through of the Whisker.IO Portal

2 Whisker.IO Overview

In the Whisker.IO platform, an enterprise is represented as an account.  Each account can have multiple users, locations, devices, protocol forwarding definitions, and automation rules.

Users can be given different levels of permissions, which control what users are able to do in the portal.  Basic users can only view data while Master Admin users can change everything related to the account.

A location represents a physical location on a map.  For example, in an oil well monitoring application, each oil well would be a single location.  That location would contain a gateway and several end-point devices (SensorBlocks).

Devices (gateways and end-points) are attached to a location.  Each end-point has one or more channels that represent an input or output.  For example, our Basic SensorBlock has an internal temperature sensor and two external digital inputs, for a total of 3 channels.

The Whisker.IO platform currently offers 3 services: 

  • Forwarding 
  • Storage
  • Alerting.

The forwarding service is a free service we offer that allows device data to be forwarded any RESTful or MQTT based end-point.  Forwarding is a flexible service that can be used in a variety of ways.  For customers with existing ERP or IoT applications, a simple forwarding rule will allow Whisker.IO to push data into the application.  Or, for customers that want to develop custom applications, forwarding can be used to push data to 3rd party application platforms like Amaon's AWS or Microsoft's Azure.

When a device is provisioned with the storage service, its data is stored in the Whisker.IO cloud and available for monitoring and analytics in our portal.  

Finally, the alerting service provides rules based automation for Whisker.IO devices.  Alerting automation can be used to send notifications to user specified contacts via email or SMS text message when predefined conditions are met.

3 Portal

The portal can only be accessed by logged in users.  Once a user has successfully logged in, the top menu will display a drop down menu titled "Portal".  This drop down menu offers two choices:

  • Dashboard
  • Control Panel

3.1 Dashboard

Whisker.IO Control Panel Image

The dashboard presents a tabbed user interface with options to:

  • View current gateway status
  • View current device status
  • Analyze historical data stored for each device
  • View alert history

The gateway status tab contains a filterable table that displays the name, time of last report, and status (ok, alert, etc) for each gateway.  The table can be filtered by name, status, or time of last report.

The device status tab contains a filterable table that displays the current state of each channel for every device.  The state includes the location, time of last report, signal quality, status, and last reported value.  This table is also filterable on each column, making it easy to sort by location, status, device name, and channel name.

The device dashboard shows a graphical representation of the same data, but organized into an array of data cards.

Using the device table and dashboard, a user can quickly determine which devices are working properly and which devices need attention, either because the device itself has a problem or because the parameters that the device is monitoring are outside of their prescribed limits.

3.2 Control Panel

Whisker.IO Control Panel Image

The control panel is a tabbed user interface with options to:

  • Manage account settings
  • Add, remove, change users
  • Add or change gateways and end-point devices
  • Add or change locations
  • Add or change automation rules
  • Add or change forwarding rules

The account tab displays account information and the API key needed to use the REST API. The user table lists all current account users and provides a simple interface for adding new users or changing existing user data. This tab is only displayed for users with Master Admin privileges. 

The user tab displays the logged-in user's information.  This tab is available to all users and provides a simple interface for changing their information, including password.

The locations tab displays a table of all defined locations for the account.  If the logged-in user has MasterAdmin privileges, he can change existing locations or add new locations to the account.

The devices tab shows two tables: one for gateways and one for devices.  If the logged-in user has MasterAdmin privileges, he can add new gateways and devices or edit existing ones using this interface.

The alert tab shows all of the automation rules defined for the account.  If the logged-in user has MasterAdmin privileges, he can add new automation rules or edit existing ones using this interface.

The forwarding tab shows all of the forwarding rules defined for the account.  If the logged-in user has MasterAdmin privileges, he can add new forwarding rules or edit existing ones using this interface.


Copyright © 2016, 2017 Digital Six Laboratories, All Rights Reserved