From adea6a835fd98a2fd2308839e281e2145a87c904 Mon Sep 17 00:00:00 2001 From: ave Date: Thu, 18 Jan 2024 12:41:57 +0100 Subject: [PATCH 1/2] Improve SGP30 compensation documentation --- components/sensor/sgp30.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/components/sensor/sgp30.rst b/components/sensor/sgp30.rst index 65494c952..d6b556133 100644 --- a/components/sensor/sgp30.rst +++ b/components/sensor/sgp30.rst @@ -72,12 +72,12 @@ Advanced: - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - All other options from :ref:`Sensor `. -- **compensation** (*Optional*): The block containing sensors used for compensation. +- **compensation** (*Optional*): The block containing sensors used for compensation. Both values should be supplied in order to be able to generate the absolute humidity to be reported to the sensor. - **temperature_source** (*Optional*, :ref:`config-id`): Give an external temperature sensor ID - here. This can improve the sensor's internal calculations. + here. The data should be in Celcius. This can improve the sensor's internal calculations. - - **humidity_source** (*Optional*, :ref:`config-id`): Give an external humidity sensor ID + - **humidity_source** (*Optional*, :ref:`config-id`): Give an external relative humidity sensor ID here. This can improve the sensor's internal calculations. .. _sgp30-calibrating: From 2527a41bad642f37d8abf7a89a1d50b282463728 Mon Sep 17 00:00:00 2001 From: ave Date: Tue, 19 Mar 2024 10:53:22 +0100 Subject: [PATCH 2/2] Use must instead of should, fix celsius spelling --- components/sensor/sgp30.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/components/sensor/sgp30.rst b/components/sensor/sgp30.rst index d6b556133..e54b4021e 100644 --- a/components/sensor/sgp30.rst +++ b/components/sensor/sgp30.rst @@ -72,10 +72,10 @@ Advanced: - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - All other options from :ref:`Sensor `. -- **compensation** (*Optional*): The block containing sensors used for compensation. Both values should be supplied in order to be able to generate the absolute humidity to be reported to the sensor. +- **compensation** (*Optional*): The block containing sensors used for compensation. Both values must be supplied in order to be able to generate the absolute humidity to be reported to the sensor. - **temperature_source** (*Optional*, :ref:`config-id`): Give an external temperature sensor ID - here. The data should be in Celcius. This can improve the sensor's internal calculations. + here. The data must be in Celsius. This can improve the sensor's internal calculations. - **humidity_source** (*Optional*, :ref:`config-id`): Give an external relative humidity sensor ID here. This can improve the sensor's internal calculations.