Telemetry
Telemetry allows modules to provide live runtime information to the ArmorLink App.
Examples include:
- Battery voltage
- Battery percentage
- Temperature
- Sensor values
- System status
- Custom module data
Telemetry belongs to the module that produces it.
The Gateway does not store telemetry data for other modules.
For more information about Modules, see Modules.
Why Telemetry?
Configuration defines how a module should behave.
Telemetry describes what the module is doing right now.
Examples:
| Configuration | Telemetry |
|---|---|
| Audio Volume | Battery Voltage |
| Servo Position | Temperature |
| LED Brightness | Sensor Data |
| Animation Speed | Runtime Status |
For more information about Configuration, see Configuration.
Telemetry is On-Demand
Telemetry is not continuously broadcast across the ArmorLink network.
Telemetry is only active when requested by the ArmorLink App.
This minimizes ESP-NOW traffic and reduces unnecessary network activity.
When telemetry is disabled, modules do not continuously transmit telemetry data.
How Telemetry Works
When the ArmorLink App connects to a Gateway, telemetry can be enabled for a module.
App connects
|
v
Telemetry enabled
|
v
Gateway requests telemetry
|
v
Module starts sending data
|
v
Gateway forwards data to App
When telemetry is disabled, the module stops sending telemetry updates.
Telemetry Flow
The Gateway acts only as a bridge.
Module
|
v
Gateway
|
v
ArmorLink App
The Gateway coordinates communication but does not permanently store telemetry values.
Telemetry remains the responsibility of the module that produces it.
Telemetry in the ArmorLink App
The ArmorLink App automatically discovers telemetry values exposed by modules.
Telemetry values can be viewed in real time while connected to the Gateway.
This allows developers and users to monitor system status without requiring a serial connection.
Telemetry vs Configuration
Configuration and Telemetry serve different purposes.
Configuration
Configuration values:
- Persist across reboots
- Can be modified by the user
- Define module behavior
Examples:
- Audio volume
- Servo positions
- LED brightness
Telemetry
Telemetry values:
- Represent live data
- Are generated while the module is running
- Reflect the current state of the system
Examples:
- Battery voltage
- Temperature
- Sensor values
Telemetry vs Remote Logging
Telemetry and Remote Logging are often used together but serve different purposes.
Telemetry
Structured runtime data:
- Battery voltage
- Temperature
- Sensor values
- Status information
Remote Logging
Developer-focused diagnostic information:
- Debug messages
- Warnings
- Errors
For more information, see Remote Logging.
Summary
Telemetry provides live runtime information from ArmorLink modules.
Telemetry:
- Belongs to the module that produces it
- Is automatically displayed by the ArmorLink App
- Is forwarded through the Gateway
- Is only active when requested
- Helps minimize ESP-NOW traffic
The Gateway coordinates telemetry delivery but does not own or store telemetry data.