From 170f9fa40b94d3af6d70f67eafa3bfa872e3370c Mon Sep 17 00:00:00 2001 From: Z3LIFF Date: Tue, 17 Jan 2023 16:17:35 -0500 Subject: [PATCH] add "actual_gain" information (#2600) --- components/sensor/tsl2591.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/components/sensor/tsl2591.rst b/components/sensor/tsl2591.rst index cb4092d79..a7df0e95e 100644 --- a/components/sensor/tsl2591.rst +++ b/components/sensor/tsl2591.rst @@ -59,6 +59,10 @@ Since those are two different physical infrared sensor readings, there is the po If you are not happy with that built-in calculation, you have the raw data you need to do your own. The manufacturer, AMS, has a few application notes that discuss this topic. See the references. +- **actual_gain**: The actual gain value being used for values reported. Updates whenever ``gain`` is changed, + which is especially useful when the sensor is set to ``gain: auto`` to help denote relative brightness when + extreme changes in brightness are encountered. + Values reported are said to be in units of ``lux``, but there are some things to understand about that. @@ -85,6 +89,7 @@ Values reported are said to be in units of ``lux``, but there are some things to id: "my_tls2591" address: 0x29 update_interval: 60s + gain: auto device_factor: 53 glass_attenuation_factor: 14.4 visible: @@ -96,6 +101,9 @@ Values reported are said to be in units of ``lux``, but there are some things to calculated_lux: id: i_lux name: "TSL2591 Lux" + actual_gain: + id: "actual_gain" + name: "TSL2591 actual gain" Configuration variables: ------------------------ @@ -164,6 +172,11 @@ Each configured sensor is reported separately on each ``update_interval``. - **name** (**Required**, string): The name for the sensor. - All other options from :ref:`Sensor `. +- **actual_gain** (*Optional*): The value of gain used for reported values. Particularly useful when gain is set to "auto". + + - **name** (**Required**, string): The name for the sensor. + - All other options from :ref:`Sensor `. + Power save mode ............... Sensor readings are only taken when the device indicates that the ADC values are valid.