Telemetry Module Configuration

The Telemetry Module provides two types of data over the mesh. Device metrics (Battery Level, Voltage, Channel Utilization and Airtime) from your meshtastic device and Environement Metrics from attached I2C sensors.

Supported sensors connected to the I2C bus of the device will be automattically detected at startup. Environement Telemetry must be enabled for them to be instrumented and their readings sent over the mesh.

The telemetry module config options are: Device Metrics Update Interval, Environment Metrics Update Interval, Environement Telemetry Enabled, Show on Device Screen, and Display Fahrenheit.

Currently Supported Sensor Types

Sensor	Data Points
BMP280	Temperature and barometric pressure
BME280	Temperature, barometric pressure and humidity
BME680	Temperature, barometric pressure, humidity and air resistance
MCP9808	Temperature
INA260	Current and Voltage
INA219	Current and Voltage

Telemetry Module Config Values

Update Intervals

Device Metrics Update Interval

How often we should send Device Metrics over the mesh.

Default is every 5 minutes.

Environment Metrics Update Interval

How often we should send Environment(Sensor) Metrics over the mesh.

Default is every 5 minutes.

Sensor options

Environment Telemetry Enabled

Enable the Environment Telemetry (Sensors)

Show on device screen

Show the Telemetry Module on-device display.

Display Fahrenheit

The sensor is always read in Celsius, but the user can opt to view the temperature display in Fahrenheit using this setting.

Default is off

Device Config Client Availability

Android

info

Telemetry Module config is not available for Android.

Apple

info

All telemetry module config options are available on iOS, iPadOS and macOS at Settings > Module Configuration > Telemetry.

CLI

All telemetry module config options are available in the python CLI. Example commands are below:

Settings

Setting	Acceptable Values	Default
telemetry.device_update_interval	integer (seconds)	0
telemetry.environment_display_fahrenheit	true, false	false
telemetry.environment_measurement_enabled	true, false	false
telemetry.environment_screen_enabled	true, false	0
telemetry.environment_update_interval	integer (seconds)	0

Set module update intervals (Default of 0 is 5 Minutes)

meshtastic --set telemetry.device_update_interval 0
// Device Metrics Two Minutes
meshtastic --set telemetry.device_update_interval 120
// Environment Metrics Two Minutes
meshtastic --set telemetry.environment_update_interval 120

Enable/Disable Environment Module

meshtastic --set telemetry.environment_measurement_enabled true
meshtastic --set telemetry.environment_measurement_enabled false

Enable/Disable on device screen

meshtastic --set telemetry.environment_screen_enabled true
meshtastic --set telemetry.environment_screen_enabled false

Enable / Disable Display Farenheit

meshtastic --set telemetry.environment_display_fahrenheit true
meshtastic --set telemetry.environment_display_fahrenheit false

Flasher

info

No telemetry module config options are available in the Flasher.

Web

info

All telemetry module config options are available in the Web UI.

Examples

RAK 4631 with BME680 Environment Sensor

Setup of a RAK 4631 with Environment Sensor

Requirements:

• RAK4631
• Environment Sensor

Steps:

• configure the device:

meshtastic --set telemetry.measurement_enabled true --set telemetry.screen_enabled true --set telemetry.display_farenheit true

tip

You can change the values above to suit your needs. The commands can be run one at a time or in a group as show above.

• Reboot/reset the device (press the button or unplug/plug in the device)
• When the device boots it should say "Telemetry" and it may show the sensor data
• If this does not appear to have any effects, run:

meshtastic --noproto

And examine the serial logs for Telemetry diagnostic information.

Supporting Additional Sensors

Environment Metrics

The environment metrics in the telemetry module supports a limited amount of fields as they are stored in memory on the device. Support for sensors that provide one or more of the following fields can potentially be added to the main firmare provided there is a GPL licensed library for us to include to support it, and the libary size is not prohibitive.

• Temperature
• Relative Humidity
• Barometric Pressure
• Gas Resistance (AQI)
• Voltage
• Current

Supporting Other Sensor types

For other interesting sensor types and use cases we need to add a portnum for more generic telemetry packets and a second MCU will be required to interact with the sensor and process the data to be sent over the mesh. This data will not be stored in the nodedb on the device.