esphome-docs/components/sensor/apds9960.rst

85 lines
2.1 KiB
ReStructuredText
Raw Normal View History

2019-01-06 18:56:14 +01:00
APDS9960 Sensor
===============
.. seo::
:description: Instructions for setting up APDS9960 sensors.
:image: apds9960.jpg
The ``apds9960`` sensor platform allows you to use your APDS9960 RGB and gesture sensors
(`datasheet <https://cdn.sparkfun.com/datasheets/Sensors/Proximity/apds9960.pdf>`__,
2020-05-10 21:27:59 +02:00
`SparkFun`_) with ESPHome.
2019-01-06 18:56:14 +01:00
The :ref:`I²C <i2c>` is
required to be set up in your configuration for this sensor to work.
.. figure:: images/apds9960-full.jpg
:align: center
:width: 80.0%
2020-05-10 21:27:59 +02:00
Image by `SparkFun`_.
2019-01-06 18:56:14 +01:00
.. code-block:: yaml
# Example configuration entry
apds9960:
address: 0x39
update_interval: 60s
sensor:
- platform: apds9960
type: CLEAR
name: "APDS9960 Clear Channel"
binary_sensor:
- platform: apds9960
direction: UP
name: "APDS960 Up Movement"
# Repeat for each direction
2020-05-10 21:27:59 +02:00
.. _SparkFun: https://www.sparkfun.com/products/12787
2019-01-06 18:56:14 +01:00
Configuration variables:
------------------------
The configuration is made up of three parts: The central component, individual sensors,
and direction binary sensors.
Base Configuration:
2020-05-10 21:27:59 +02:00
- **address** (*Optional*, integer): The I2C address of the sensor. Defaults to ``0x39``.
2019-01-06 18:56:14 +01:00
- **update_interval** (*Optional*, :ref:`config-time`): The interval
to check the sensor. Defaults to ``60s``.
Sensor Configuration:
- **name** (**Required**, string): The name for the sensor.
- **type** (**Required**, string): The type of sensor measurement. One of
- **CLEAR**
- **RED**
- **GREEN**
- **BLUE**
- **PROXIMITY**
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
2019-02-17 12:28:17 +01:00
- All other options from :ref:`Sensor <config-sensor>`.
2019-01-06 18:56:14 +01:00
Binary Sensor Configuration:
- **name** (**Required**, string): The name for the binary sensor.
- **direction** (**Required**, string): The direction to measure. One of:
- **UP**
- **DOWN**
- **LEFT**
- **RIGHT**
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
2019-02-17 12:28:17 +01:00
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
2019-01-06 18:56:14 +01:00
See Also
--------
- :ref:`sensor-filters`
2019-05-12 22:44:59 +02:00
- :apiref:`apds9960/apds9960.h`
- :ghedit:`Edit`