From 4b4a242dd3dc464b269e413f2a2a83821124ce02 Mon Sep 17 00:00:00 2001 From: Mike Kinney Date: Sat, 22 Jan 2022 13:03:40 -0800 Subject: [PATCH] add more info about env sensors --- docs/software/plugins/environment.md | 31 ++++++++++++------- .../environmental-measurment-plugin.md | 27 +++++++++++----- 2 files changed, 39 insertions(+), 19 deletions(-) diff --git a/docs/software/plugins/environment.md b/docs/software/plugins/environment.md index a1023474..8ff1b6ee 100644 --- a/docs/software/plugins/environment.md +++ b/docs/software/plugins/environment.md @@ -5,7 +5,9 @@ sidebar_label: Environment measurement --- ## About -The Environment Measurement Plugin will allow nodes to send a specific message with information from connected environmental sensors. Currently supported sensors are DHT11 and Dallas 1-wire DS18B20. This plugin does only work on ESP32 devices. +The Environment Measurement Plugin will allow nodes to send a specific message with information from connected environmental sensors. Currently supported sensors are BME280, BME680, DHT11, DHT12, DHT21, DHT22 and Dallas 1-wire DS18B20. + +The preferred setup is using I2C, so the `environmental_measurement_plugin_sensor_pin` may not be needed. ## Configuration @@ -13,7 +15,7 @@ These are the settings that can be configured. environmental_measurement_plugin_enabled Is the plugin enabled? - + 0 = Disabled (Default) 1 = Enabled @@ -40,21 +42,26 @@ These are the settings that can be configured. environmental_measurement_plugin_display_fahrenheit Should temperature readings be converted to fahrenheit? - + 0 = Disabled (Default) 1 = Enabled - + environmental_measurement_plugin_sensor_type What sensor is connected? - + 0 = DHT11 (Default) 1 = Dallas 1-wire DS18B20 - + 2 = DHT12 + 3 = DHT21 + 4 = DHT22 + 5 = BME280 + 6 = BME680 + environmental_measurement_plugin_sensor_pin Which pin is the sensor connected to? - + Default = 0 - + ## Usage Notes @@ -63,22 +70,22 @@ For basic usage, start with: environmental_measurement_plugin_enabled = 1 environmental_measurement_plugin_screen_enabled = 1 - + Depending on which pin your sensor is connected to, set it accordingly: environmental_measurement_plugin_sensor_pin = 13 - + :::note The device must be restarted after the settings have been changed for the plugin to take effect. ::: - + ## Hardware The sensors can be wired differently, here's one example for sensor DS18B20 https://randomnerdtutorials.com/esp32-ds18b20-temperature-arduino-ide - + ## Known Problems * No default configuration values are currently set, so this must be done when enabling the plugin. diff --git a/docs/software/settings/environmental-measurment-plugin.md b/docs/software/settings/environmental-measurment-plugin.md index 099d4880..f37628d9 100644 --- a/docs/software/settings/environmental-measurment-plugin.md +++ b/docs/software/settings/environmental-measurment-plugin.md @@ -9,11 +9,7 @@ import TabItem from '@theme/TabItem'; ## 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. +The Environmental Measurement Plugin will allow you to connect environment sensors to report conditions to your mesh. Examples are temperature, humidity and gas pressure. ## Settings @@ -50,7 +46,7 @@ Enable/Disable the environmental measurement plugin on-device display. ### environmental_measurement_plugin_sensor_pin -Specify the preferred GPIO Pin for sensor readings. +Specify the preferred GPIO Pin for sensor readings. May not be needed if using I2C. ### environmental_measurement_plugin_sensor_type @@ -72,15 +68,32 @@ Interval in seconds of how often we should try to send our measurements to the m values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, + {label: 'iOS', value: 'iOS'}, + {label: 'web', value: 'web'}, ]}> - TODO +meshtastic --set environmental_measurement_plugin_measurement_enabled true +meshtastic --set environmental_measurement_plugin_screen_enabled true +meshtastic --set environmental_measurement_plugin_update_interval 15 +meshtastic --set environmental_measurement_plugin_display_farenheit true +meshtastic --set environmental_measurement_plugin_sensor_type 5 +meshtastic --set environmental_measurement_plugin_sensor_type BME280 TODO + + + + TODO + + + + + TODO +