mirror of
https://github.com/esphome/esphome-docs.git
synced 2025-01-27 22:31:37 +01:00
LTR390 - Multiple fixes (sensor name, descriptions and notes) (#3585)
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
This commit is contained in:
parent
80884a1d11
commit
46790fd346
@ -21,10 +21,14 @@ The :ref:`I²C Bus <i2c>` is required to be set up in your configuration for thi
|
|||||||
|
|
||||||
sensor:
|
sensor:
|
||||||
- platform: ltr390
|
- platform: ltr390
|
||||||
uv:
|
uv_index:
|
||||||
name: "UV Index"
|
name: "UV Index"
|
||||||
|
uv:
|
||||||
|
name: "UV Sensor Counts"
|
||||||
light:
|
light:
|
||||||
name: "Light"
|
name: "Light"
|
||||||
|
ambient_light:
|
||||||
|
name: "Light Sensor Counts"
|
||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
@ -33,8 +37,8 @@ Configuration variables:
|
|||||||
- **uv** (*Optional*): Sensor counts for the UV sensor (#). All options from :ref:`Sensor <config-sensor>`.
|
- **uv** (*Optional*): Sensor counts for the UV sensor (#). All options from :ref:`Sensor <config-sensor>`.
|
||||||
- **light** (*Optional*): Lux of ambient light (lx). All options from :ref:`Sensor <config-sensor>`.
|
- **light** (*Optional*): Lux of ambient light (lx). All options from :ref:`Sensor <config-sensor>`.
|
||||||
- **ambient_light** (*Optional*): Sensor counts for the Ambient light sensor (#). All options from :ref:`Sensor <config-sensor>`.
|
- **ambient_light** (*Optional*): Sensor counts for the Ambient light sensor (#). All options from :ref:`Sensor <config-sensor>`.
|
||||||
- **gain** (*Optional*, string): Adjusts the sensitivity of the sensor. A larger value means higher sensitivity. See table below for details. Default is ``"X3"``.
|
- **gain** (*Optional*, string): Adjusts the sensitivity of the sensor. A larger value means higher sensitivity. Default is ``"X18"``, see table below for options.
|
||||||
- **resolution** (*Optional*, int): ADC resolution. Higher resolutions require longer sensor integration times. See table below for details. Default is ``18``.
|
- **resolution** (*Optional*, int): ADC resolution. Higher resolutions require longer sensor integration times. Default is ``20``, see table below for options.
|
||||||
- **window_correction_factor** (*Optional*, float): Window correction factor. Use larger values when using under tinted windows. Default is ``1.0``, must be ``>= 1.0``.
|
- **window_correction_factor** (*Optional*, float): Window correction factor. Use larger values when using under tinted windows. Default is ``1.0``, must be ``>= 1.0``.
|
||||||
- **address** (*Optional*, int): Manually specify the I²C address of the sensor. Default is ``0x53``.
|
- **address** (*Optional*, int): Manually specify the I²C address of the sensor. Default is ``0x53``.
|
||||||
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
|
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
|
||||||
@ -45,7 +49,7 @@ Lux and UVI Formulas
|
|||||||
|
|
||||||
.. math::
|
.. math::
|
||||||
|
|
||||||
\text{lux} = \frac{0.6 \times \text{als}}{\text{gain} \times \text{int}} \times \text{wfac}
|
\text{lux} = \frac{0.6 \times \text{als}}{\text{gain} \times \frac{\text{int}}{100} } \times \text{wfac}
|
||||||
|
|
||||||
.. math::
|
.. math::
|
||||||
|
|
||||||
@ -53,11 +57,22 @@ Lux and UVI Formulas
|
|||||||
|
|
||||||
where:
|
where:
|
||||||
|
|
||||||
- ``als`` and ``uv`` are the sensor values
|
- ``als`` and ``uv`` are the sensor values.
|
||||||
- ``gain`` is the amount of gain, see the table below for details
|
- ``gain`` is the sensor gain, see the table below for details.
|
||||||
- ``int`` is the integration time in 100s of ms and is tied to the resolution, see the table below for details
|
- ``int`` is the integration time in ms and is tied to the resolution, see the table below for details.
|
||||||
- ``sensitivity`` has the value ``2300`` and is the sensor's count per UVI
|
- ``sensitivity`` is the sensor's count per UVI. See note below for details.
|
||||||
- ``wfac`` is the window correction factor
|
- ``wfac`` is the window correction factor.
|
||||||
|
|
||||||
|
It is recommended to use the defaults of ``X18`` gain and resolution of 20 bits when UV Index sensing is required since
|
||||||
|
the data sheet only provides accurate conversion formula for this combination. The UVI value is linearly scaled from
|
||||||
|
this reference point when using other combinations of gain and resolution, which may be slightly inaccurate. The scaling
|
||||||
|
formula is:
|
||||||
|
|
||||||
|
.. math::
|
||||||
|
|
||||||
|
\text{sensitivity} = 2300 \times \frac{\text{gain}}{18} \times \frac{\text{int}}{400}
|
||||||
|
|
||||||
|
where :math:`2300` is the sensor count per UVI at the default configuration.
|
||||||
|
|
||||||
Gain
|
Gain
|
||||||
----
|
----
|
||||||
@ -66,7 +81,7 @@ Gain
|
|||||||
:widths: 25 25
|
:widths: 25 25
|
||||||
:header-rows: 1
|
:header-rows: 1
|
||||||
|
|
||||||
* - Gain Parameter
|
* - Configuration value
|
||||||
- gain
|
- gain
|
||||||
* - X1
|
* - X1
|
||||||
- 1
|
- 1
|
||||||
@ -83,28 +98,28 @@ Gain
|
|||||||
Resolution
|
Resolution
|
||||||
----------
|
----------
|
||||||
|
|
||||||
.. list-table:: Resolution
|
.. list-table::
|
||||||
:widths: 25 25 10
|
:widths: 25 25 10
|
||||||
:header-rows: 1
|
:header-rows: 1
|
||||||
|
|
||||||
* - Resolution Parameter (bits)
|
* - Configuration value
|
||||||
|
- Resolution (bits)
|
||||||
- Integration Time (ms)
|
- Integration Time (ms)
|
||||||
- int
|
|
||||||
* - 16
|
* - 16
|
||||||
|
- 16
|
||||||
- 25
|
- 25
|
||||||
- 0.25
|
|
||||||
* - 17
|
* - 17
|
||||||
|
- 17
|
||||||
- 50
|
- 50
|
||||||
- 0.5
|
|
||||||
* - 18
|
* - 18
|
||||||
|
- 18
|
||||||
- 100
|
- 100
|
||||||
- 1
|
|
||||||
* - 19
|
* - 19
|
||||||
|
- 19
|
||||||
- 200
|
- 200
|
||||||
- 2
|
|
||||||
* - 20
|
* - 20
|
||||||
|
- 20
|
||||||
- 400
|
- 400
|
||||||
- 4
|
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
--------
|
--------
|
||||||
|
Loading…
Reference in New Issue
Block a user