mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-23 12:44:20 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Removed description from table

Browse source
This commit is contained in:
Foster Irwin 2021-05-03 14:11:24 -06:00
parent be1eb0b170
commit bdffcd5bf2
1 changed files with 46 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -6,19 +6,55 @@ sidebar_label: Environmental Measurement Plugin
## Overview
:::caution
This is a work in progress and is not yet available.
:::
The Environmental Measurement Plugin will allow you to connect climate sensors to report local conditions to your mesh.
## 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 |
| Setting | Acceptable Values | Default |
| :-----: | :---------------: | :-----: |
| environmental_measurement_plugin_measurement_enabled | `true`, `false` | `false` |
| environmental_measurement_plugin_display_farenheit | `true`, `false` | `false` |
| environmental_measurement_plugin_read_error_count_threshold | `integer` | `0` |
| environmental_measurement_plugin_recovery_interval | `integer` (seconds) | `0` |
| environmental_measurement_plugin_screen_enabled | `true`, `false` | `0` |
| environmental_measurement_plugin_sensor_pin | `integer` | `0` |
| environmental_measurement_plugin_sensor_type | `DHT11` | `0` |
| environmental_measurement_plugin_update_interval | `integer` (seconds) | `0` |
### environmental_measurement_plugin_measurement_enabled
Enables the plugin.
### environmental_measurement_plugin_display_farenheit
The sensor is always read in Celsius, but the user can opt to view the temperature display in Farenheit using this setting.
### environmental_measurement_plugin_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
### environmental_measurement_plugin_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
### environmental_measurement_plugin_screen_enabled
Enable/Disable the environmental measurement plugin on-device display.
### environmental_measurement_plugin_sensor_pin
Specify the preferred GPIO Pin for sensor readings.
### environmental_measurement_plugin_sensor_type
Specify the sensor type
### environmental_measurement_plugin_update_interval
Interval in seconds of how often we should try to send our measurements to the mesh.
## Details