BME680 BSEC: Document per sensor T/P/H sample rate overrides (#1108)

* Document per sensor T/P/H sample rate overrides

* Typo
This commit is contained in:
Trevor North 2021-06-01 19:02:52 +01:00 committed by GitHub
parent 6af99cd78d
commit a611a4c1f5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -62,8 +62,7 @@ The :ref:`I²C <i2c>` is required to be set up in your configuration for this se
Configuration variables:
- **address** (*Optional*, int): Manually specify the I^2C address of
the sensor. Defaults to ``0x76``. Another address can be ``0x77``.
- **address** (*Optional*, int): Manually specify the I^2C address of the sensor. Defaults to ``0x76``. Another address can be ``0x77``.
- **temperature_offset** (*Optional*, float): Temperature offset if device is in enclosure and reads too high.
Defaults to ``0``.
@ -73,6 +72,8 @@ Configuration variables:
- **sample_rate** (*Optional*, string): Sample rate. Default is ``lp`` for low power consumption, sampling every 3 seconds.
Can be ``ulp`` for ultra low power, sampling every 5 minutes.
This controls the sampling rate for gas-dependant sensors and will govern the interval at which the sensor heater is operated.
By default this rate will also be used for temperature, pressure and humidity sensors but these can be overridden on a per-sensor level if required.
- **state_save_interval** (*Optional*, :ref:`config-time`): The minimum interval at which to save calibrated BSEC algorithm state to
flash so that calibration does have to start from zero on device restart. Defaults to ``6h``.
@ -86,18 +87,21 @@ Configuration variables:
- **name** (**Required**, string): The name for the temperature sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- **sample_rate** (*Optional*, string): Optional sample rate override for this sensor. Can be ``lp`` for low power consumption, sampling every 3 seconds or ``ulp`` for ultra low power, sampling every 5 minutes.
- All other options from :ref:`Sensor <config-sensor>`.
- **pressure** (*Optional*): The information for the pressure sensor.
- **name** (**Required**, string): The name for the pressure sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- **sample_rate** (*Optional*, string): Optional sample rate override for this sensor. Can be ``lp`` for low power consumption, sampling every 3 seconds or ``ulp`` for ultra low power, sampling every 5 minutes.
- All other options from :ref:`Sensor <config-sensor>`.
- **humidity** (*Optional*): The information for the humidity sensor.
- **name** (**Required**, string): The name for the humidity sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- **sample_rate** (*Optional*, string): Optional sample rate override for this sensor. Can be ``lp`` for low power consumption, sampling every 3 seconds or ``ulp`` for ultra low power, sampling every 5 minutes.
- All other options from :ref:`Sensor <config-sensor>`.
- **gas_resistance** (*Optional*): The information for the gas sensor.
@ -187,7 +191,7 @@ For each sensor all other options from :ref:`Sensor <config-sensor>` and :ref:`T
# - lp (low power - samples every 3 seconds)
# - ulp (ultra low power - samples every 5 minutes)
# Default: lp
sample_rate: lp
sample_rate: ulp
# Interval at which to save BSEC state
# ------------------------------------
@ -199,16 +203,19 @@ For each sensor all other options from :ref:`Sensor <config-sensor>` and :ref:`T
temperature:
# Temperature in °C
name: "BME680 Temperature"
sample_rate: lp
filters:
- median
pressure:
# Pressure in hPa
name: "BME680 Pressure"
sample_rate: lp
filters:
- median
humidity:
# Relative humidity %
name: "BME680 Humidity"
sample_rate: lp
filters:
- median
gas_resistance:

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 11 KiB