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 Environment Metrics from attached I2C sensors.

Supported sensors connected to the I2C bus of the device will be automatically detected at startup. Environment 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, Environment Telemetry Enabled, Show on Device Screen, and Display Fahrenheit.

Currently Supported Sensor Typesโ€‹

SensorI2C AddressData Points
BMP2800x76, 0x77Temperature and barometric pressure
BME2800x76, 0x77Temperature, barometric pressure and humidity
BME6800x76, 0x77Temperature, barometric pressure, humidity and air resistance
MCP98080x18Temperature
INA2600x40, 0x41Current and Voltage
INA2190x40, 0x41Current and Voltage
LPS220x5D, 0x5cBarometric pressure
SHTC30x70Temperature and humidity
SHT310x44Temperature and humidity

Module Config Valuesโ€‹

Update Intervalsโ€‹

Device Metrics Update Intervalโ€‹

How often we should send Device Metrics over the mesh.

Default is every 15 minutes.

Environment Metrics Update Intervalโ€‹

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

Default is every 15 minutes.

Sensor optionsโ€‹

Environment Telemetry Enabledโ€‹

Enable the Environment Telemetry (Sensors)

Show on device screenโ€‹

Show the Telemetry Module on the device display.

Display Fahrenheitโ€‹

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

Default is false.

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.environment_measurement_enabled true --set telemetry.environment_screen_enabled true --set telemetry.environment_display_fahrenheit true
tip

You can change the values above to suit your needs but it is recommended that commands be chained together as one as shown.

  • Device will reboot after command is sent.
  • When the device boots again 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 firmware provided there is a GPL licensed library for us to include to support it, and the library 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.