How it fits together
Everything in MaxwellTrack is built from a few pieces: templates, devices, datastreams and readings, plus the dashboards, automations and assistant that use them.
The pieces
| Term | What it is |
|---|---|
| Template | The description of a kind of device: its datastreams. Devices are created from it. |
| Device | One piece of equipment, with its own Device ID and access token. |
| Datastream | One channel on a template: a name people see, the key the device writes to, a data type, a unit and a range. |
| Reading | One value on one datastream at one moment. |
| Dashboard | Widgets that show readings and send commands, for one device or several. |
| Automation | A flow on a device that runs when something happens: a reading, a schedule, a status change, a webhook. |
| Alert | A problem found on your devices, automations, updates, vehicles or billing. |
| Workspace | Your company's space for sharing devices with its own customers. |
How a reading travels
- 1
The device sends it
Code on the device writes a value to a key such as
temperature, over WiFi, a cellular modem or a web request. - 2
The cloud matches it
The key is matched to the datastream on the device's template. A reading for a key with no datastream is ignored.
- 3
It is shown and stored
Open dashboards update at once, and the reading is kept for charts, exports and the assistant.
- 4
Automations run
Flows on the device that start from that datastream run with the new value.
How a command travels
A switch, slider or button on a dashboard, an automation step, or the assistant (after you approve) sends a value to a key. Code on the device receives it in an onWrite handler and acts on it: a relay switches, a setpoint changes. See Receive commands.
Reporting, not reporting, never reported
Every device page and list shows one of three states. A device is Reporting while the cloud hears from it at least every 30 seconds. Not reporting means it has gone quiet; its last values stay on screen with their age. Never reported means it has not connected yet.
Boards running the device library send a heartbeat every 10 seconds on their own. A system that reports by web request less often than every 30 seconds shows as not reporting between reports; its readings are still stored.
Something unclear or out of date on this page? Tell support.
