From 16e9425941c560505aaa3bbbed2126ccf77332e6 Mon Sep 17 00:00:00 2001
From: Martin <25747549+martgras@users.noreply.github.com>
Date: Tue, 10 May 2022 08:27:39 +0200
Subject: [PATCH] Document Scd4x environment compensation options (#1526)

* 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>
---
 components/sensor/scd4x.rst | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/components/sensor/scd4x.rst b/components/sensor/scd4x.rst
index a2859ba55..0a556f6a8 100644
--- a/components/sensor/scd4x.rst
+++ b/components/sensor/scd4x.rst
@@ -65,12 +65,48 @@ Configuration variables:
   *altitude_compensation* is ignored if *ambient_pressure_compensation*
   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.
   Defaults to ``0x62``.
 
 - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
   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