Data Types

Overview

A Device reports its internal state to the platform in four ways:

TypeRequiredModifiable byDescription
TelemetryYesDeviceFrequently changing values that build the Device's current state.
DetailsNoDeviceRarely changing values that do not need continuous updates.
ConfigurationNoDevice & End UsersValues that the End Customer can modify from the Customer Portal.
EventsNoDeviceOne-off notifications about uncommon occurrences.

When deciding what to send, weigh frequency, ownership, and payload size — and never include sensitive data such as passwords or customer names.

The data falls into two logical groups:

  1. Data consumed by customers via Widgets, Rules, dashboards, etc.
  2. Data used by the manufacturer to understand Device usage in the field and improve the product.

Send as much state data as is reasonable. Rich historical data lets product managers build Widgets and reports, and feeds back into future product decisions.