From bdffcd5bf2207396598ee3418a48eec13c319ed1 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Mon, 3 May 2021 14:11:24 -0600 Subject: [PATCH] Removed description from table --- .../environmental-measurment-plugin.md | 56 +++++++++++++++---- 1 file changed, 46 insertions(+), 10 deletions(-) diff --git a/website/docs/settings/environmental-measurment-plugin.md b/website/docs/settings/environmental-measurment-plugin.md index 7ae5107a..8d4955e1 100644 --- a/website/docs/settings/environmental-measurment-plugin.md +++ b/website/docs/settings/environmental-measurment-plugin.md @@ -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