From 37c179c09445947fd84af85699349e816feae90c Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Thu, 8 Jun 2023 09:25:01 -0700 Subject: [PATCH] add sensor and configs update formatting --- .../configuration/module-config/telemetry.mdx | 49 ++++++++++++------- 1 file changed, 30 insertions(+), 19 deletions(-) diff --git a/docs/configuration/module-config/telemetry.mdx b/docs/configuration/module-config/telemetry.mdx index 1630f1b6..ee125bd7 100644 --- a/docs/configuration/module-config/telemetry.mdx +++ b/docs/configuration/module-config/telemetry.mdx @@ -8,12 +8,10 @@ sidebar_label: Telemetry import Tabs from "@theme/Tabs"; 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 Environment Metrics from attached I2C sensors. +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 | Sensor | I2C Address | Data Points | @@ -27,39 +25,50 @@ The telemetry module config options are: Device Metrics Update Interval, Environ | LPS22 | 0x5D, 0x5c | Barometric pressure | | SHTC3 | 0x70 | Temperature and humidity | | SHT31 | 0x44 | Temperature and humidity | +| PMSA003I| 0x12 | Concentration units by size and particle counts by size | ## Module Config Values -### Update Intervals +### Environment Telemetry Enabled -### Device Metrics Update Interval - -How often we should send Device Metrics over the mesh. - -Default is every 15 minutes. +Enable the Environment Telemetry (Sensors). ### Environment Metrics Update Interval How often we should send Environment(Sensor) Metrics over the mesh. -Default is every 15 minutes. +Default is `900` seconds (15 minutes). -## Sensor options +### Device Metrics Update Interval -### Environment Telemetry Enabled +How often we should send Device Metrics over the mesh. -Enable the Environment Telemetry (Sensors) +Default is `900` seconds (15 minutes). -### Show on device screen +### Environment Screen Enabled -Show the Telemetry Module on the device display. +Show the environment telemetry data on the device display. + +Default is `false`. ### Display Fahrenheit -The sensor is always read in Celsius, but the user can opt to display in Fahrenheit using this setting. +The sensor is always read in Celsius, but the user can opt to display in Fahrenheit (on the device display only) using this setting. Default is `false`. +### Air Quality Enabled + +This option is used to enable/disable the sending of air quality metrics from an attached supported sensor over the mesh network. + +Default is `false`. + +### Air Quality Interval + +This option is used to configure the interval (in seconds) that should be used to send air quality metrics from an attached supported sensor over the mesh network. + +Default is `900` seconds (15 minutes). + ## Device Config Client Availability