mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-03-05 21:00:08 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #1488 from fifieldt/patch-3
Some checks failed
CI / quality (push) Has been cancelled
Details
CI / build (push) Has been cancelled
Details

Browse source 
Add initial documentation for Health Telemetry
This commit is contained in:
pdxlocations 2024-10-13 09:10:05 -07:00 committed by GitHub
parent e2e3a2067c 1a9a0aa177
commit f9ca5b7e3f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 22 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
docs/configuration/module/telemetry.mdx
View file

@ -2,15 +2,15 @@
id: telemetry
title: Telemetry Module Configuration
sidebar_label: Telemetry
description: This module allows sharing of Device, Environment, and Air Quality metrics from your Meshtastic device.
description: This module allows sharing of Device, Environment, Health, and Air Quality metrics from your Meshtastic device.
---
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
The Telemetry Module provides three types of data over the mesh: Device metrics (Battery Level, Voltage, Channel Utilization and Airtime) from your Meshtastic device, Environment Metrics from attached I2C sensors, and Air Quality Metrics from attached I2C particle sensors.
The Telemetry Module provides four types of data over the mesh: Device metrics (Battery Level, Voltage, Channel Utilization and Airtime) from your Meshtastic device, Environment Metrics, Air Quality Metrics, and Health metrics (Heart rate, Oxygen Saturation and body temperature).
Supported sensors connected to the I2C bus of the device will be automatically detected at startup. Environment Telemetry and Air Quality must be enabled for them to be instrumented and their readings sent over the mesh.
Supported sensors connected to the I2C bus of the device will be automatically detected at startup. The Environment Telemetry, Air Quality, and Health Telemetry modules must be enabled for them to be instrumented and their readings sent over the mesh.
<object data="https://www.youtube.com/embed/6jj1s-fsPlc?autohide=1&autoplay=0" width="100%" height="400"></object>
@ -32,6 +32,9 @@ Supported sensors connected to the I2C bus of the device will be automatically d
| SHT31 | 0x44 | Temperature and humidity |
| PMSA003I| 0x12 | Concentration units by size and particle counts by size |
| DFROBOT_LARK | 0x42 | Temperature, barometric pressure, humidity, wind direction, wind speed |
| MAX30102 | 0x57 | Heart Rate, Oxygen Saturation, and body temperature |
| MLX90614 | 0x5A | Body temperature |
## Module Config Values
@ -77,6 +80,18 @@ This option is used to configure the interval (in seconds) that should be used t
Default is `1800` seconds (30 minutes).
### Health Telemetry Enabled
This option is used to enable/disable the sending of health data from an attached supported sensor over the mesh network.
Default is `false`.
### Health Telemetry Interval
This option is used to configure the interval (in seconds) that should be used to send health data from an attached supported sensor over the mesh network.
Default is `1800` seconds (30 minutes).
## Telemetry Config Client Availability
<Tabs
@ -133,6 +148,10 @@ All telemetry module config options are available in the python CLI. Example com
| telemetry.environment_update_interval | `integer` (seconds) | Default `0` is 30 minutes(`1800` seconds). |
| telemetry.air_quality_enabled | `true`, `false` | `false` |
| telemetry.air_quality_interval | `integer` (seconds) | Default `0` is 30 minutes(`1800` seconds). |
| telemetry.health_measurement_enabled | `true`, `false` | `false` |
| telemetry.health_update_interval | `integer` (seconds) | Default `0` is 30 minutes(`1800` seconds). |
| telemetry.health_screen_enabled | `true`, `false` | `false` |
:::tip