mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-11-06 09:31:39 +01:00
59 lines
2.3 KiB
ReStructuredText
59 lines
2.3 KiB
ReStructuredText
TSL2561 Ambient Light Sensor
|
|
============================
|
|
|
|
.. warning::
|
|
|
|
This sensor is experimental has not been fully tested yet as I do not own all sensors. If you
|
|
can verify it works (or if it doesn't), please notify me on `discord <https://discord.gg/KhAMKrd>`__.
|
|
|
|
The ``tsl2561`` sensor platform allows you to use your BH1750
|
|
(`datasheet <https://cdn-shop.adafruit.com/datasheets/TSL2561.pdf>`__,
|
|
`Adafruit`_)
|
|
ambient light sensor with esphomelib. The :ref:`I²C <i2c>` is required to be set up in
|
|
your configuration for this sensor to work.
|
|
|
|
.. figure:: images/tsl2561-full.jpg
|
|
:align: center
|
|
:target: `Adafruit`_
|
|
:width: 50.0%
|
|
|
|
TSL2561 Ambient Light Sensor. Image by `Adafruit`_.
|
|
|
|
.. _Adafruit: https://www.adafruit.com/product/439
|
|
|
|
.. code:: yaml
|
|
|
|
# Example configuration entry
|
|
sensor:
|
|
- platform: tsl2561
|
|
name: "TSL2561 Ambient Light"
|
|
address: 0x39
|
|
update_interval: 15s
|
|
|
|
Configuration variables:
|
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
- **name** (**Required**, string): The name for the sensor.
|
|
- **address** (*Optional*, int): Manually specify the i^2c address of the sensor. Defaults to ``0x39``.
|
|
- **integration_time** (*Optional*, :ref:`config-time`):
|
|
The time the sensor will take for each measurement. Longer means more accurate values. One of
|
|
``14ms``, ``101ms``, ``402ms``. Defaults to ``402ms``.
|
|
- **gain** (*Optional*, string): The gain of the sensor. Higher values are better in low-light conditions.
|
|
One of ``1x`` and ``16x``. Defaults to ``1x``.
|
|
- **is_cs_package** (*Optional*, boolean): The "CS" package of this sensor has a slightly different
|
|
formula for calculating the illuminance in lx. Set this to ``true`` if you're working with a CS
|
|
package. Defaults to ``false``.
|
|
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
|
|
sensor. Defaults to ``15s``. See :ref:`sensor-default_filter`.
|
|
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
- All other options from :ref:`Sensor <config-sensor>` and :ref:`MQTT Component <config-mqtt-component>`.
|
|
|
|
See Also
|
|
^^^^^^^^
|
|
|
|
- :ref:`sensor-filters`
|
|
- :doc:`bh1750`
|
|
- :doc:`adc`
|
|
- :doc:`API Reference </api/sensor/tsl2561>`
|
|
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/master/esphomeyaml/components/sensor/tsl2561.rst>`__
|