document new options for scd4x (#2032)

This commit is contained in:
Martin 2022-05-10 11:25:49 +02:00 committed by GitHub
parent deec25b09a
commit 99af70c048
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -65,6 +65,17 @@ Configuration variables:
*altitude_compensation* is ignored if *ambient_pressure_compensation*
is set.
- **measurement_mode** (*Optional*): Set measurement mode for scd4x.
- **periodic** : The sensor takes a new measurement every 5 seconds. This is the default mode.
- **low_power_periodic**: The sensor takes a new measurement every 30 seconds. Make sure ``update_interval`` is at least 30 seconds.
- **single_shot**: A measurement is started in every update interval. A measurement takes 5 seconds. This mode is only available on scd41 and useful if low power consumption is required.
The automatic self-calibration is optimized for single shot measurements performed every 5 minutes.
To reduce noise levels, you can can perform several single shot measurements in a row and average the output values using a :ref:`sensor-filters`.
- **single_shot_rht_only**: A measurement is started in every update interval. A measurement takes 50 ms. Only humidity and temperature is measured. CO2 is reported as 0 ppm. This mode is only available on scd41 and useful if low power consumption is required.
- **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.
@ -74,6 +85,50 @@ Configuration variables:
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
sensor. Defaults to ``60s``.
Actions:
--------
.. _perform_forced_calibration_action:
``_perform_forced_calibration_action`` Action
---------------------------------------------
This :ref:`action <config-action>` manually calibrates the sensor to the provided value in ppm.
Operate the SCD4x in the operation mode later used in normal sensor operation (periodic measurement, low power periodic measurement or single shot) for > 3 minutes in an environment with homogenous and constant CO2 concentration before performing a forced recalibration.
As of April 2022 the average fresh air Co² concentration is 419 ppm.
.. code-block:: yaml
on_...:
then:
- scd4x._perform_forced_calibration_action:
value: 419 # outside average April 2022
id: my_scd41
value can be a template
.. code-block:: yaml
on_...:
then:
- scd4x._perform_forced_calibration_action:
value: !lambda "{ return 419 };"
id: my_scd41
.. _factory_reset_action:
``_factory_reset_action`` Action
--------------------------------
This :ref:`action <config-action>` triggers a factory reset of the sensor. Calibration settings are restored from factory settings.
.. code-block:: yaml
on_...:
then:
- scd4x._factory_reset_action: my_scd41
Automation
-----------------