Inspector User Guide

The Afero Inspector provides a real-time, in-depth view of the state of each device associated with a given Afero account. The tool is useful for developers when testing and debugging device behavior.

You can open the Inspector by going to inspector.afero.io then signing in with your Afero developer account.

The Inspector Main Window

After you sign in, the Inspector Main window appears:

Inspector Main Window

The left-hand Navigation pane has two sections:

  • Device Types - All the device types associated with your account. The device type is the name you assigned when creating a profile in the Afero Profile Editor.
  • Recent Devices - The last five devices you’ve viewed in your currently signed-in session.

To the left of the selected device is an orange bar. The summary information about this device is displayed in the right-hand pane. If the device is a Preview Device or if you’ve given your device a friendly name in the mobile app, that information will appear in the far-right column.

To hide/show the left-hand Navigation pane, click this menu icon in the top bar: Inspector Menu.

To the right of the menu icon is the Account drop-down menu, which lists all the accounts that you own or have been invited to join. The account name is listed first with the User ID in parentheses.

To display detailed information about the selected device, click the orange device ID in the summary information line in the right-hand pane. The detailed view is described in the sections below.

The Device Details Window

After you select a specific device in the Main window, the Device Details window opens. The details are grouped by category:

Device Information

This section contains identification details that you have defined for the device in the Afero Profile Editor, as well as system-assigned information, such as device location and update status. The icon you assigned the device appears in the upper-right corner.

Field Description Example
deviceId Unique alphanumeric string assigned to every Afero Platform device. 01231732d62ca571
profileId Unique alphanumeric string assigned to a device profile. ED2B11B7-1597-42E7-8E0A-3F1AF92E347D
updating Whether or not the device is currently receiving and installing a firmware update. True or False
createdTimestamp When the device was first associated with an account. September 9th 2015, 4:51 pm
virtual Whether or not a device is “virtual”; that is, either: 1) a “Preview” device created in the Afero Profile Editor, or 2) one of the non Afero smart devices that are supported by Afero (e.g., Nest Learning Thermostat). True or False
disconnectNotificationLevel How to notify customers after the detection of a device disconnection. Low - After 15 minutes, badge notification only.
Medium - After 10 minutes email, push, and badge notifications; suppressed for 8 hours.
Important - After 5 minutes, email, push, and badge notifications; suppressed for 4 hours.
Critical - After 1 minute, email, push, and badge notifications; suppressed for 30 minutes.
friendlyName The “friendly” name given to the device by the user in the Afero mobile app. True or False
developerDevice Whether or not the device is associated with a developer account. True or False
partnerId Unique alphanumeric string assigned to the partner the user is associated with. 3BFFBED9-D443-4962-89D1-59B4B06E3864
deviceTypeId Universally unique identifier (UUID) value that maps to a specific Device Type (thermostat, washing machine, camera, etc.). DeviceTypeId values are unique across the platform. 0B84D736-240D-4D2D-9696-34B9DF138F49
Location Last Reported Date when device was last online. September 19th 2017, 5:03 pm
Latitude/Longitude Latitude/longitude of last location reported. 48.42, -123.3047

User Information

Most of the information in this section was provided by the user during Afero account registration.

Field Description Example
First Name User’s given name. Cera
Last Name User’s surname or family name. Smith
User ID Unique alphanumeric string assigned to a user. 47622660-D8BE-40CB-9F7B-XXXXXXXXXXXX
Email Email address used by the user to register their Afero account. csmith@example.io
Last Signin Date when the user last signed in to the Afero Inspector. September 22nd 2017, 2:16 pm

Connectivity

This section displays the connection state of the device; if it’s online, the hub it’s using as well as the signal strength of the Wi-Fi or Bluetooth connection are shown.

Field Description Values
Online Status Whether or not the device is currently online. Online/Offline
Hub(s) on Account Wi-Fi signal strength as seen by the hub the device is connected to. -60
Last Reported Bluetooth RSSI Bluetooth signal strength coming from device. 0
Last Reported Wi-Fi Bars Wi-Fi signal strength for UI purposes. -47
Last Reported Wi-Fi SSID Name of the Wi-Fi network the device is connected to. SHAW-66E150
Last Reported Wi-Fi Steady State Wi-Fi connection state when last stable:
  • 0 = Not Connected
  • 1 = Pending
  • 2 = Connected
  • 3 = Unknown Failure
  • 4 = Association Failed
  • 5 = Handshake Failed
  • 6 = Echo Failed
  • 7 = SSID (Network Name) Not Found
  • 8 = NTP (Network Time Protocol) Failed

This value is used to communicate the Wi-Fi state to the apps outside the Wi-Fi setup.

2

Bluetooth Signal Strength (RSSI)

This section graphically displays the Bluetooth signal strength (in db) of the device whose details you are viewing, as seen by the hub(s). If there is no hub advertising, this section will not appear.

The Received Signal Strength Indicator is primarily a function of distance and battery power, but of course there are other interferences such as refractions, reflections, scattering. RSSI is expressed in decibels from 0 (zero) to -120db. (Zero being the strongest signal.) For Bluetooth, typical values will be between -25 (a few inches away) and -100 (~50 meters away).

Use the icons in the upper-right corner of the graph to zoom in/out on the graph, or download the data to a .csv file.

Device Channel Wiretap

This section lists the activity (events) between this device and Afero in the past 12 hours.

Field Description Example
Attribute ID Unique numeric identifier of an attribute changed by a given activity. 1024
Attribute Name Name assigned to this attribute. You assign device attributes in the Afero Profile Editor. Power
Value Resulting value of an attribute changed by a given activity. 0
Operations Operations, or flag(s), that have been set for the attribute. READ/WRITE
Timestamp Time when a given activity occurred. 5:23:58 pm, Sep 27

Device Attributes and Afero System Attributes

The Device Attributes section details the activity of device attributes. Some attribute values can be edited in real-time when the device is online; these values are indicated with a pencil icon Pencil Icon. Click the icon to edit and update a value.

The attributes shown in the Afero System Attributes section are generally set by the Cloud and read by the module, but they can also be set by the module. They are hidden from the MCU. For a description of these attributes, refer to Device Attribute Registry.

Field Description Example
Attribute ID Attributes are identified by a 2-byte ID and can contain a variable amount of information based on the type of attribute. Attributes can come in many types and have specific ID ranges. 1024
Attribute Name Name assigned to this attribute. You assign device attributes in the Afero Profile Editor. LED
Value Current value of the attribute. 1
Operations Operations, or flag(s), that have been set for the attribute. Inputs are read-only; Outputs are read/write. READ/WRITE
Last Update Time Timestamp of when the attribute was last changed. 11:58:44 am, Sep 27