Console User Guide

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. A description of the user interface is presented on this page. Be sure to refer to the Glossary for term definitions when using the Console.

Sign In and Out of Afero Console

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

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

Switch Partners

If you belong to more than one partner, you can switch to view the Console of a different partner. To do so, click your username in the upper-left of any Console window. Your partner names will appear; select the partner whose Console you want to view. You can also edit your partner name by clicking Update Partner Name.

The Console Windows

To view any of the windows in 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 Device Listing, 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. The Console windows are 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 Listing

Click Device Listing in the left-hand Navigation pane to open a window displaying all your devices, including methods for filtering and finding a specific device or set of devices.

In the table titled Your Afero Powered Device Listing, click a Device ID to open the Device Data Viewer, or click a Device Type Name to go to the relevant Device Type Reports window.

You can package and download the contents of this device listings table (with additional Creation Date, Profile ID, and Location information) into a zipped .csv file. Click the download icon on the far rightthen click the download link that appears. When unzipping the file, you’ll be prompted to enter the password provided under the download link (use copy & paste).

Individual Device Data Viewer

To view usage data on an individual device, do any of the following:

  • From the Device Listing window, click a Device ID, or
  • 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 Device Details.

On successful search or navigation, the Device Details tab opens. The Attribute Browser tab displays each attribute definition, how this attribute is presented on the mobile UI, and attribute update history (updates that occurred in the last 31 days, up to 200 entries).

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 window.

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.

Data Explorer

Click Data Explorer on the left-hand Navigation pane to run your own SQL-92 compliant queries across all your devices’ historical data. Each query is run across multiple servers, returning results quickly and efficiently.

SQL Query Credits

Afero will give you a monthly allocation of Query Credits. Each query you run is charged on a per byte basis, where every byte of data that is evaluated in the query is measured and charged. Note that before your queries are run, they are evaluated; query evaluation is not charged against your credits. Each query evaluation will also result in a projected cost of Query Credits.

Your remaining monthly credits will always appear at the top of the Data Explorer Home window, along with other useful information:

Enter a Query

There are a few ways you can query your data:

  • Type your SQL query in the SQL Query field at the top of the Data Explorer Home window (shown above where you see “Type your SQL query here …”). Use the Table Schema Reference tab for field names, and you can find a good SQL reference at this site: Google Cloud Big Query Standard SQL Reference.

  • Construct your SQL query using one of the SQL Builder Tools in the upper-right corner of the Data Explorer Home window:

    Select one of the tools to begin:

    • Geolocation Tool - Click Start Drawing, then click a location on the map to drop your first pin, clicking and dropping additional pins to define your geolocation boundary. Close the boundary by clicking the first (blue) pin you dropped. Once defined, you can fine-tune your geolocation by dragging the pins. You can always clear the map and start over by clicking the trash icon. When finished, click Save, and once you’ve saved your query, it will appear in the SQL Query field.
    • Time Selector - Select a time and date range for your query, then click Save. Your query is ready to run. Note that range defaults to the last 24 hours, and all times are shown in UTC (Coordinated Universal Time).
    • Query Builder - Build your query by first selecting the fields that you’re interested in. Then define your conditions using the selectors. Once you click Save, your query will appear in the SQL Query field.
  • Load a SQL query template provided in the Query Templates tab:

    To select a query and have appear it in the SQL Query field, click the Load Query button. In the examples below, we will use the query in the template, “Find the Top 10 Most Active Devices”.

  • Run a Query

    Once you have a query in the SQL Query field, simply select the Validate & Price button. The results will appear in the upper far-right pane:

    If your query is valid and you have enough Query Credits, you can go ahead and select the Execute Query Job button to proceed. If your query is not valid or you do not have sufficient Query Credits, you will see a notification describing the error or problem.

    View Query Results

    Results are displayed in the Results tab, on the far right of the tab bar. Each query you run is displayed in a numbered Results tab. You can clear any of the results by clickingin the tab.

    By default, results are displayed in tabular format:

    You can change the display by clicking the icons on the right:

    Tabular
    Line
    Donut
    Area
    Bar

    For all but the tabular format, you can select which columns are used in the display. Click the Save button to save the query to use another time. Your saved queries will be listed in the Query Templates tab > Your Custom Query Templates.

    Your Query History

    Your past queries (up to 200) are saved in the Your Query History tab, including when the query was run, the query text, time to execute, and cost. You can also conveniently run it again from this location.

    Table Schema Reference

    To view the details on what data is stored for your devices and how to reference the data in your queries, click the Table Schema Reference tab.

    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.

    User Manager Window

    This feature allows partners to invite users to view and use their Console. Users are invited with certain privileges, which partners can always edit or revoke.

    Invite Users

    To invite a user, select User Manager > Invite User from the left-hand Navigation bar. On the window that opens, type the email address in the @ field, then click Next. The Set User Privileges pane appears:

    You can grant the following partner privileges; note that all privileges are On by default:

    • Invite Other Users - This user will be able to extend invitations to others to access your Console.
    • Manage Device Profiles - This user will be able to add, update, and remove device Profiles using the Afero Profile Editor.
    • View Real-Time Device Details - This user will be able to view real-time, device-specific details.
    • View Reports & Run Queries - This user will be able to use all the Console reporting tools.

    Turn On or Off the privileges you want to grant this user, then select Send User Invitation.

    The user will receive the invitation with either a link to sign in to Afero Console, or if they don’t already have an Afero account, a link to register. Once registered, they will automatically be signed in to Console.

    Edit Privileges

    Once you have invited at least one user who has accepted your invitation, you can change the privileges you have given them at any time. Select User Manager > Edit Privileges from the left-hand Navigation bar. After selecting the user you want to modify, simply turn On or Off the privilege(s) you want to change; or, you can Remove User. Once you are finished editing, select the Save Privileges button.