Console User Guide

The Afero Console is designed for partners so they can monitor and visualize their device deployments and usage. It offers aggregated, real-time location views of partner devices as well as individual device use history.

The Console is easy-to-use and self-documenting, but an overview of the user interface is presented below.

Term Definitions

Active Device A device that has sent at least one attribute update within the given time period.
Activity The history of events that have affected the state of a device. Events can be attribute value changes, device association/disassociation events, and device available/unavailable status changes.
Attribute A variable used to describe the state of an IoT device. It is shared between an IoT device, the Cloud, and, if the attribute’s values are exposed to the end-user to control the device, the Afero mobile app. It’s the smallest useful piece of data that can be communicated between the device and the Cloud. Read more in What Is an Attribute?
Association
Dissociation
A device is “associated” with an end-user’s account when the user scans or types the device’s QR code (representing the device’s “Association ID”) in the Afero mobile app. (This is also referred to as “onboarding”.) Association will only happen in the context of an end-user’s account, and a device can be associated with only one end-user account at a time. Devices can be “disassociated” from the account using the mobile app Device Settings screen > Remove Device option.
Available
Unavailable
A device is “available” when it is powered on and connected to the Afero Cloud. It is “unavailable” when it is either powered off, or powered on but not connected to the Cloud. Connection to the Cloud is via Bluetooth or Wi-Fi.
Device An individual, internet-connected physical object, able to communicate with other connected devices and computer systems.
Device ID The primary, unique identifier for an individual device in the Afero system.
Device Type

Defined using the Afero Profile Editor and part of the profile’s “Device Type Definition”. Once you use the Profile Editor to publish a device profile, an ID is associated with the “device type” (also referred to as the project) that remains unchanged as long as that device type/project is active.

Note that you can always rename your device type, but, once published, the devicetypeID in the system will not change. In other words, you can publish difference profile versions to the same device type.

Event An attribute value change or other operation that affects the state of a device.
Linked Timestamp The last time the device linked to the Afero Cloud. The linked timestamp is displayed in the Individual Device Data Viewer, labeled as Extended Data.
Value Option

Many attributes have associated UI controls, the elements in the mobile app that allow end-users to read, and in some cases change, attribute values. Some attribute controls simply report a numeric value to the end-user, but others are labeled so the end-user understands the value meanings. These labels are referred to as “Value Options”.

For example, a Fan Speed attribute might have four possible values: 0-3. In the mobile app, you'd like to display these values using friendly words, rather than simple digits. To do that you’d use the Afero Profile Editor to define Value Options so that when the attribute value = 0, the control displays the string "Off"; when the value = 1, the display is "Low”, when 2 it’s “Medium”, and 3 is “High”.

Signing In and Out of the Afero Console

Go to https://console.afero.io then sign in with your Afero partner email or username and password.

To sign out, click the arrowin the upper-right of the main Console window.

The Console Windows

To view any of the windows in the Afero Console, use the left-hand Navigation pane. In addition to the Real-Time Activity window, which opens by default, you’ll find links to the Device Type Reports (click to see all your device types), Platform Usage, Platform Status, the Developer Portal, and the Dev Portal page with links for purchasing Afero hardware. Each window is described and illustrated below:

Real-Time Activity Window

Click Real-Time Activity in the left-hand Navigation Pane to open a window displaying by location the activity, or lack of activity, taking place on your devices in the field (your fleet) in real-time. Only devices experiencing an event will display. Device indicators are color-coded by event class, or type:

  • Device attribute state has just changed.
  • Device is on, connected to the Afero Platform, and available.
  • Device has disconnected from the Afero Platform, perhaps off, definitely not connected to the network, or otherwise unavailable.

The number of events occurring, by activity type, are displayed in the key below the map.

You can switch between a map of the world (Global Map) or United States (USA Map). Zoom in/out, go full screen, switch among map, satellite, terrain, and street views, or jump to a map location, by using the usual Google Map controls.

To clear the map of all device activity, click the Clear Markers button in the upper-right corner.

Device Type Reports Window

Click Device Type Reports in the left-hand Navigation pane to show a list of all your device types, then select a specific device type to view its usage metrics.

Note that metrics are shown in date ranges; click (in the upper-right) From This Week, From This Month, or Select Date Range (to customize the range):

You’ll be able to view your device type usage in the following ways:

Device Type Status

At the top are four metrics: number of devices currently associated (attached to an end-user account) and pending association (produced but not yet associated), and total number of devices currently online (available) and offline (unavailable).

Attribute Usage Breakdown

This table displays, for a selected device type, each partner-defined attribute’s usage, important information for determining how customers are using a specific type of device. In the example, the attributes compared are EcoMode, Heating Level, and Fan Speed. You can see that Fan Speed has changed more than the others.

<Attribute Name> Value Breakdown

To the right of the Attribute Usage table is a donut graph or bar chart showing how end-users have used each of the attributes' values.

To start, click an attribute in the Attribute Usage table, then look right to the graph or chart to see how popular that attribute’s values have been, based on how many times the customers have changed the value in the given timeframe.

  • To view the popularity of a subset of values, select only the desired values using the View in Chart checkboxes in the table below the graph.

  • To see the total number of times that an attribute value was selected in the given timeframe, hover over an attribute value in the graph or look in the Total Records column in the table.

  • Attribute values are identified in this table using their labels, or Value Options. These labels are displayed to the end-user in the mobile app UI, as control options.

Relative Associated Device Distribution Map

Scroll down the page to see the Relative Associated Device Distribution map. Use this map to see at a glance where all your associated devices are located, at this point in time.

You can switch views between United States only or Global by toggling the iconin the upper-right of the pane.

Cumulative Device Association Trend

Scroll further down the window to see the cumulative rate of device association trend over time.

Application Version Breakdown

Scroll down to see a graph displaying the versions running on the associated devices. To report a version number, a device must have been associated and connected to the Afero Cloud. Those reporting an unknown version have not yet connected to the Cloud.

Connection Type Breakdown

To find out how associated devices have connected to the Afero Cloud, Bluetooth or Wi-Fi, scroll down to the Connection Type Breakdown graph.

Platform Usage Window

Click Platform Usage on the left-hand navigation pane to display month-to-date details for each device type:

  • Total monthly message count
  • Total unique active devices
  • Monthly per device (message) average

Totals across device types are also provided.

Platform Status Window

You can view the current status of the Platform by clicking Platform Status in the left-hand navigation pane or the checkmark iconin the upper-right of the main window.

Status is checked automatically every minute and reported as healthy if all subsystems are operating as expected. A degraded status means some part of the Platform has reported a less than optimal status, and also means the Operations Team has been notified.

Individual Device Data Viewer

To view usage data on an individual device, you can either:

  • Type the device ID in the Search box at the top of the main window, or
  • From the Real-Time Activity window, click an event as it's blinking. A summary of the event will appear, with a link to the Device Details viewer.

On successful search or navigation, the Device Details tab opens. The Attribute Browser tab displays each attribute definition as well as how this attribute displays on the mobile UI.