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

created environmental measurement plugin setting page

Browse source
This commit is contained in:
Foster Irwin 2021-04-27 15:05:36 -06:00
parent c715fbf574
commit ffb567d27c
1 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
website/docs/settings/environmental-measurment-plugin.md Normal file
View file

@ -0,0 +1,24 @@
---
id: environmental-measurement-plugin
title: Environmental Measurement Plugin Settings
sidebar_label: Environmental Measurement Plugin
---
## Overview
## Settings
| Setting | Acceptable Values | Default | Description |
| :-----: | :---------------: | :-----: | :---------: |
| environmental_measurement_plugin_measurement_enabled | `true`, `false` | `false` | Enables the plugin. |
| environmental_measurement_plugin_display_farenheit | `true`, `false` | `false` | We'll always read the sensor in Celsius, but sometimes we might want to display the results in Farenheit as a "user preference". |
| environmental_measurement_plugin_read_error_count_threshold | `integer` | `0` | 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 |
| environmental_measurement_plugin_recovery_interval | `integer` (seconds) | `0` | 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 |
| environmental_measurement_plugin_screen_enabled | `true`, `false` | `0` | Enable/Disable the environmental measurement plugin on-device display |
| environmental_measurement_plugin_sensor_pin | `integer` | `0` | Specify the preferred GPIO Pin for sensor readings |
| environmental_measurement_plugin_sensor_type | `DHT11` | `0` | Specify the sensor type |
| environmental_measurement_plugin_update_interval | `integer` (seconds) | `0` | Interval in seconds of how often we should try to send our measurements to the mesh |
## Details