Merge pull request #190 from mkinney/add_env_sensor_info

add more info about env sensors
This commit is contained in:
mkinney 2022-01-22 13:15:25 -08:00 committed by GitHub
commit acd86c17d2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 39 additions and 19 deletions

View file

@ -5,7 +5,9 @@ sidebar_label: Environment measurement
--- ---
## About ## 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 ## Configuration
@ -13,7 +15,7 @@ These are the settings that can be configured.
environmental_measurement_plugin_enabled environmental_measurement_plugin_enabled
Is the plugin enabled? Is the plugin enabled?
0 = Disabled (Default) 0 = Disabled (Default)
1 = Enabled 1 = Enabled
@ -40,21 +42,26 @@ These are the settings that can be configured.
environmental_measurement_plugin_display_fahrenheit environmental_measurement_plugin_display_fahrenheit
Should temperature readings be converted to fahrenheit? Should temperature readings be converted to fahrenheit?
0 = Disabled (Default) 0 = Disabled (Default)
1 = Enabled 1 = Enabled
environmental_measurement_plugin_sensor_type environmental_measurement_plugin_sensor_type
What sensor is connected? What sensor is connected?
0 = DHT11 (Default) 0 = DHT11 (Default)
1 = Dallas 1-wire DS18B20 1 = Dallas 1-wire DS18B20
2 = DHT12
3 = DHT21
4 = DHT22
5 = BME280
6 = BME680
environmental_measurement_plugin_sensor_pin environmental_measurement_plugin_sensor_pin
Which pin is the sensor connected to? Which pin is the sensor connected to?
Default = 0 Default = 0
## Usage Notes ## Usage Notes
@ -63,22 +70,22 @@ For basic usage, start with:
environmental_measurement_plugin_enabled = 1 environmental_measurement_plugin_enabled = 1
environmental_measurement_plugin_screen_enabled = 1 environmental_measurement_plugin_screen_enabled = 1
Depending on which pin your sensor is connected to, set it accordingly: Depending on which pin your sensor is connected to, set it accordingly:
environmental_measurement_plugin_sensor_pin = 13 environmental_measurement_plugin_sensor_pin = 13
:::note :::note
The device must be restarted after the settings have been changed for the plugin to take effect. The device must be restarted after the settings have been changed for the plugin to take effect.
::: :::
## Hardware ## Hardware
The sensors can be wired differently, here's one example for sensor DS18B20 https://randomnerdtutorials.com/esp32-ds18b20-temperature-arduino-ide The sensors can be wired differently, here's one example for sensor DS18B20 https://randomnerdtutorials.com/esp32-ds18b20-temperature-arduino-ide
## Known Problems ## Known Problems
* No default configuration values are currently set, so this must be done when enabling the plugin. * No default configuration values are currently set, so this must be done when enabling the plugin.

View file

@ -9,11 +9,7 @@ import TabItem from '@theme/TabItem';
## Overview ## Overview
:::caution The Environmental Measurement Plugin will allow you to connect environment sensors to report conditions to your mesh. Examples are temperature, humidity and gas pressure.
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 ## Settings
@ -50,7 +46,7 @@ Enable/Disable the environmental measurement plugin on-device display.
### environmental_measurement_plugin_sensor_pin ### 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 ### 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={[ values={[
{label: 'CLI', value: 'cli'}, {label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'}, {label: 'Android', value: 'android'},
{label: 'iOS', value: 'iOS'},
{label: 'web', value: 'web'},
]}> ]}>
<TabItem value="cli"> <TabItem value="cli">
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
</TabItem> </TabItem>
<TabItem value="android"> <TabItem value="android">
TODO TODO
</TabItem>
<TabItem value="iOS">
TODO
</TabItem>
<TabItem value="web">
TODO
</TabItem> </TabItem>
</Tabs> </Tabs>