Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-12-26 17:27:47 +01:00
Code Issues Projects Releases Wiki Activity

Add auto gain setting to tsl2591 docs (#1843)

Browse Source
This commit is contained in:
Nicholas Peters 2022-01-26 04:48:59 -05:00 committed by GitHub
parent 9f07ad671e
commit f37b031f8f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
components/sensor/tsl2591.rst
View File

@ -30,6 +30,9 @@ The TSL2591 device is available on breakout boards from a few vendors
The sensor claims a dynamic range of 600 million to 1 with an effective maximum of 88000 lux. The sensor claims a dynamic range of 600 million to 1 with an effective maximum of 88000 lux.
It achieves that large range by having a configurable ``gain`` value. It achieves that large range by having a configurable ``gain`` value.
For many applications, you can use AUTO gain to have the ESP select a suitable gain setting based on
the previous measurement. If light levels change dramatically this may cause the next reading to saturate,
after which the gain will adjust down and subsequent readings will be in range.
Use a higher gain value when measuring less intense light sources. Use a higher gain value when measuring less intense light sources.
On the other hand, if you get ADC readings of 65,535 for either physical sensor, On the other hand, if you get ADC readings of 65,535 for either physical sensor,
you may be saturating that sensor and need to reduce the gain. you may be saturating that sensor and need to reduce the gain.
@ -121,9 +124,10 @@ For the TSL2591 device:
You cannot specify an arbitrary gain multiplier. It must be one of: You cannot specify an arbitrary gain multiplier. It must be one of:
- ``low``, ``1x`` - ``low``, ``1x``
- ``medium``, ``med``, ``25x`` *(default)* - ``medium``, ``med``, ``25x``
- ``high``, ``400x`` - ``high``, ``400x``
- ``maximum``, ``max``, ``9500x`` - ``maximum``, ``max``, ``9500x``
- ``auto`` *(default)*
- **update_interval** (*Optional*, :ref:`config-time`): The interval for checking the sensors. - **update_interval** (*Optional*, :ref:`config-time`): The interval for checking the sensors.
Defaults to ``60s``. Defaults to ``60s``.