Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2025-01-28 22:42:05 +01:00
Code Issues Projects Releases Wiki Activity

Document Scd4x environment compensation options (#1526)

Browse Source 
* add documentation for modbus controller

* remove words from blacklist

* esp32 modbus controller

* doc update

* add epever cookbook

* fix merge failure

* documenting code changes

* updating examples

* remove offset

* fix formatting errors

* lint

* fix errors in links

* documenting modbus number and output

* updates with code changes

* fix indentation

* Improve doc

* Apply suggestions from code review

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>

* Review suggestions part 2

* Fix Optional labels

* Rename files

* Fix index

* Fix doc links

* update scd4x to document new compensation options

* change indented to 4 spaces

* document changes after CR

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
This commit is contained in:
Martin 2022-05-10 08:27:39 +02:00 committed by GitHub
parent d5efc54bec
commit 16e9425941
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
components/sensor/scd4x.rst
View File

@ -65,12 +65,48 @@ Configuration variables:
*altitude_compensation* is ignored if *ambient_pressure_compensation* *altitude_compensation* is ignored if *ambient_pressure_compensation*
is set. is set.
- **ambient_pressure_compensation_source** (*Optional*, :ref:`config-id`): Set an external pressure sensor ID used for ambient pressure compensation.
The pressure sensor must report pressure in hPa. the correction is applied before updating the state of the co2 sensor.
- **address** (*Optional*, int): Manually specify the I²C address of the sensor. - **address** (*Optional*, int): Manually specify the I²C address of the sensor.
Defaults to ``0x62``. Defaults to ``0x62``.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
sensor. Defaults to ``60s``. sensor. Defaults to ``60s``.
Automation
-----------------
Ambient pressure compensation compensation can be changed from :ref:`lambdas <config-lambda>`
``set_ambient_pressure_compensation( <pressure in bar)"``
Example
*******
Note: that the pressure from bme280 is in hPa and must be converted to bar.
.. code-block:: yaml
sensor:
- platform: scd4x
id: scd41
i2c_id: bus_a
co2:
name: co2
id: co2
- platform: bme280
pressure:
name: "BME280-Pressure"
id: bme280_pressure
oversampling: 1x
on_value:
then:
- lambda: "id(scd41)->set_ambient_pressure_compensation(x / 1000.0);"
See Also See Also