From 18daad7855bf6472c5b8c23fe6cd069055a67dfa Mon Sep 17 00:00:00 2001 From: Ben Meadors Date: Fri, 29 Jul 2022 08:34:22 -0500 Subject: [PATCH] Update telemetry.mdx --- docs/settings/moduleconfig/telemetry.mdx | 34 +++++------------------- 1 file changed, 6 insertions(+), 28 deletions(-) diff --git a/docs/settings/moduleconfig/telemetry.mdx b/docs/settings/moduleconfig/telemetry.mdx index 940abd71..9458b11a 100644 --- a/docs/settings/moduleconfig/telemetry.mdx +++ b/docs/settings/moduleconfig/telemetry.mdx @@ -9,7 +9,9 @@ import TabItem from '@theme/TabItem'; 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. -The telemetry module config options are: Device Metrics Update Interval, Environment Metrics Update Interval, Environement Telemetry Enabled, Sensor Type, Show on Device Screen, Display Fahrenheit, Error Threshold and Error Recovery Interval. Range Test Module config uses an admin message sending a `ConfigModule.Telemetry` protobuf. +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. ## Telemetry Module Config Values @@ -35,7 +37,7 @@ Enable the Environment Telemetry (Sensors) ### Sensor Type -Specify the sensor type. +Supported sensor types. | Sensor | Data Points | | :-----: | :-----------------------------------------------------------: | @@ -56,14 +58,6 @@ The sensor is always read in Celsius, but the user can opt to view the temperatu Default is off -### Error 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. - -### Error Recovery Interval - -Sometimes we can end up with more than our configured threshold for errors. 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. - ## Device Config Client Availability @@ -188,7 +166,7 @@ Steps: - configure the device: ```shell -meshtastic --set telemetry_module_measurement_enabled true --set telemetry_module_screen_enabled true --set telemetry_module_update_interval 15 --set telemetry_module_display_farenheit true --set telemetry_module_sensor_type 6 +meshtastic --set telemetry_module_measurement_enabled true --set telemetry_module_screen_enabled true --set telemetry_module_display_farenheit true ``` :::tip @@ -203,4 +181,4 @@ You can change the values above to suit your needs. The commands can be run one meshtastic --info ``` -and verify the the `telemetry_module_sensor_type` \ No newline at end of file +and verify the the `telemetry_module_sensor_type`