esphome-docs/components/sensor/am43.rst
Otto Winter 6053f490b5
Update svg2png and seo.py (#1380)
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
2021-11-16 15:19:33 +13:00

72 lines
2.0 KiB
ReStructuredText

AM43 Sensor
===========
.. seo::
:description: Sensors on AM43/BLE covers in ESPHome.
:image: am43.jpg
The ``am43`` sensor platform allows you to read the light and
battery sensors on an AM43 BLE cover motor. The platform connects
to the device over the ESP32's BLE peripheral.
.. note::
This component does NOT support Tuya-based versions of this device,
as the protocol is completely different. If your device is controlled
with the SmartLife app, then it will not work.
.. figure:: images/am43.jpg
:align: right
.. code-block:: yaml
# Example configuration entry
esp32_ble_tracker:
ble_client:
- mac: AA:BB:CC:DD:EE:FF
id: am43_device
sensor:
- platform: am43
ble_client_id: am43_device
battery_level:
name: "Kitchen blinds battery"
illuminance:
name: "Kitchen blinds light"
For more details on setting up this device, see the
:doc:`/components/cover/am43` component.
Configuration variables:
------------------------
- **ble_client_id** (**Required**, :ref:`config-id`): The id of the ``ble_client`` entry associated with the device.
- **battery_level** (*Optional*): The information for the battery level sensor.
- **name** (**Required**, string): The name for the battery level sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **illuminance** (*Optional*): The information for the light level sensor.
- **name** (**Required**, string): The name for the light level sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
sensor. Defaults to ``60s``.
.. note::
It is recommended to also setup the :doc:`/components/cover/am43`.
See Also
--------
- :doc:`index`
- :doc:`/components/cover/am43`
- :ref:`automation`
- :apiref:`sensor/am43/am43.h`
- :ghedit:`Edit`