Skip to main content

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

SensorData Points
BMP280Temperature and barometric pressure
BME280Temperature, barometric pressure and humidity
BME680Temperature, barometric pressure, humidity and air resistance
MCP9808Temperature
INA260Current and Voltage
INA219Current 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

info

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

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.