esphome-docs/esphomeyaml/components/sensor/bh1750.rst
2018-08-24 22:44:01 +02:00

54 lines
2.0 KiB
ReStructuredText

BH1750 Ambient Light Sensor
===========================
The ``bh1750`` sensor platform allows you to use your BH1750
(`datasheet <http://www.mouser.com/ds/2/348/bh1750fvi-e-186247.pdf>`__, `Aliexpress`_, `mklec`_)
ambient light sensor with esphomelib. The :ref:`I²C bus <i2c>` is required to be set up in
your configuration for this sensor to work.
.. figure:: images/bh1750-full.jpg
:align: center
:width: 50.0%
BH1750 Ambient Light Sensor.
.. _Aliexpress: https://www.adafruit.com/product/1603
.. _mklec: http://mklec.com/modules/micro-controller-modules/bh1750-bh1750fvi-digital-light-sensor-module
.. figure:: images/bh1750-ui.png
:align: center
:width: 80.0%
.. code:: yaml
# Example configuration entry
sensor:
- platform: bh1750
name: "BH1750 Illuminance"
address: 0x23
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 ``0x23`` (address if address pin is pulled low). If the address pin is pulled high,
the address is ``0x5C``.
- **resolution** (*Optional*, string): The resolution of the sensor in lx. One of ``4.0``,
``1.0``, ``0.5``. Defaults to ``0.5`` (the maximum resolution).
- **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:`tsl2561`
- :doc:`API Reference </api/sensor/bh1750>`
- `BH1750 Library <https://github.com/claws/BH1750>`__ by `@claws <https://github.com/claws>`__
- `Edit this page on GitHub <https://github.com/OttoWinter/esphomedocs/blob/current/esphomeyaml/components/sensor/bh1750.rst>`__