Skip to main content

Telemetry Module Settings

warning

GPIO access is fundamentally dangerous because invalid options can physically damage or destroy your hardware. Ensure that you fully understand the schematic for your particular device before trying this as we do not offer a warranty. Use at your own risk.

important
The name of ths option changed between Meshtastic 1.2 and 1.3. This documentaton already reflects the 1.3 syntax. Please substitute 'telemetry_module_environment' prefix with 'environmental_measurement_plugin' to get the 1.2 compatible command name.
note

The environment metrics feature of this module requires attaching a peripheral accessory to your device. It will not work without one.

Overview​

In addition to key device metrics such as battery level, the Telemetry Module will also allow nodes to send environmental metrics from externally connected sensors. Currently supported sensors are BME280, BME680, DHT11, DHT12, DHT21, DHT22, Dallas 1-wire DS18B20 and MCP9808.

tip

Once module settings are changed, a reset is required for them to take effect.

Settings​

SettingAcceptable ValuesDefault
telemetry_module_device_update_intervalinteger (seconds)0
telemetry_module_environment_display_fahrenheittrue, falsefalse
telemetry_module_environment_measurement_enabledtrue, falsefalse
telemetry_module_environment_read_error_count_thresholdinteger0
telemetry_module_environment_recovery_intervalinteger (seconds)0
telemetry_module_environment_screen_enabledtrue, false0
telemetry_module_environment_sensor_pininteger0
telemetry_module_environment_sensor_type0-60
telemetry_module_environment_update_intervalinteger (seconds)0

telemetry_module_device_update_interval​

Interval in seconds of how often we should try to send our measurements to the mesh.

Set module update interval to default
meshtastic --set telemetry_module_device_update_interval 0
Set module update interval to 120 seconds
meshtastic --set telemetry_module_device_update_interval 120

telemetry_module_environment_display_fahrenheit​

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

Display Farenheit/Celsius​

Display Farenheit
meshtastic --set telemetry_module_environment_display_fahrenheit true
Display Celsius
meshtastic --set telemetry_module_environment_display_fahrenheit false

telemetry_module_environment_measurement_enabled​

Enables the module to utilize environmental metrics.

Enable/Disable the module​

Enable Module
meshtastic --set telemetry_module_environment_measurement_enabled true
Disable Module
meshtastic --set telemetry_module_environment_measurement_enabled false

telemetry_module_environment_read_error_count_threshold​

Sometimes sensor reads can fail. If this happens, we will retry a configurable number of attempts. Each attempt will be delayed by the minimum required refresh rate for that sensor

Configure telemetry_module_environment_read_error_count_threshold​

Configure telemetry_module_environment_read_error_count_threshold to 3 tries
meshtastic --set telemetry_module_environment_read_error_count_threshold 3

telemetry_module_environment_recovery_interval​

Sometimes we can end up with more than read_error_count_threshold failures. In this case, we will stop trying to read from the sensor for a while. Wait this long until trying to read from the sensor again.

Configure telemetry_module_environment_recovery_interval​

Configure telemetry_module_environment_recovery_interval to 120 seconds
meshtastic --set telemetry_module_environment_recovery_interval 120

telemetry_module_environment_screen_enabled​

Enable/Disable the Telemetry Module on-device display.

Enable/Disable the module on device screen​

Enable on device screen
meshtastic --set telemetry_module_environment_screen_enabled true
Disable on device screen
meshtastic --set telemetry_module_environment_screen_enabled false

telemetry_module_environment_sensor_pin​

note

The preferred setup is using I2C, so the telemetry_module_environment_sensor_pin may not be needed.

Specify the preferred GPIO Pin for sensor readings. May not be needed if using I2C.

caution

To prevent damaging your device, double check your device's schematics before attaching to the GPIO pins and setting this value.

Set module sensor pin​

Set module sensor pin
meshtastic --set telemetry_module_environment_sensor_pin PINNUMBER

telemetry_module_environment_sensor_type​

Specify the sensor type.

important

The sensor values changed between 1.2 and 1.3. The docs represent the 1.3 values. When configuring devices on 1.2, please subtract 1 from the numbers below for the appropriate sensor.

ValueDescriptionSensor Features
1DHT11Temperature, Humidity
2DS18B20 (Dallas 1-wire)Temperature
3DHT12Temperature, Humidity
4DHT21Temperature, Humidity
5DHT22Temperature, Humidity
6BME280Temperature, Humidity, Pressure
7BME680Temperature, Humidity, Pressure, VOC Gas
8MCP9808Precision Temperature

Set sensor type​

important

The sensor values changed between 1.2 and 1.3. The docs represent the 1.3 values. When configuring devices on 1.2, please subtract 1 from the numbers on the table above for the appropriate sensor.

note

The CLI is able to take the value or the name of the sensor from the table above.

Set sensor type to DS18B20
meshtastic --set telemetry_module_environment_sensor_type 2
Set sensor type to DS18B20
meshtastic --set telemetry_module_environment_sensor_type DS18B20

Set module update interval​

Set module update interval to 120 seconds
meshtastic --set telemetry_module_environment_update_interval 120

Details​

Hardware​

The sensors can be wired differently, here's one example for sensor DS18B20.

Known Problems​

  • No default configuration values are currently set, so this must be done when enabling the module.