Upstream
/
esphome-docs
mirror of https://github.com/esphome/esphome-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix format next (#1023) 

* Missing colon

* update sun

* format fix and adaptation

* fix format

* fix format 2

* fix format 3

* fix format

* fix format

* fix format

* format fix

* revert title as heads

* rename image case-sensitive

* rename again
This commit is contained in:
Guillermo Ruffino 2021-02-20 18:02:46 -03:00 committed by GitHub
parent ea65e467d0
commit 896afdcfa1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
63 changed files with 626 additions and 476 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
components/binary_sensor/ble_presence.rst
View File

@ -40,7 +40,7 @@ Configuration variables:
- **name** (**Required**, string): The name of the binary sensor.
- **mac_address** (*Optional*, MAC Address): The MAC address to track for this
binary sensor. Either this or ``service_uuid`` has to be present.
- **service_uuid** (*Optional*, string) 16 bit, 32 bit, or 128 bit BLE Service UUID
- **service_uuid** (*Optional*, string): 16 bit, 32 bit, or 128 bit BLE Service UUID
which can be tracked if the device randomizes the MAC address. Either
this or ``mac_address`` has to be present.
- **id** (*Optional*, :ref:`config-id`): Manually specify

18
components/binary_sensor/mpr121.rst
View File

@ -6,6 +6,11 @@ MPR121 Capacitive Touch Sensor
:image: mpr121.jpg
:keywords: MPR121
.. _mpr121-component:
Component/Hub
-------------
The ``mpr121`` sensor platform allows you to use your MPR121
(`datasheet <https://cdn-learn.adafruit.com/downloads/pdf/adafruit-mpr121-12-key-capacitive-touch-sensor-breakout-tutorial.pdf>`__,
`Adafruit`_) Capacitive Touch Sensor with ESPHome. The :ref:`I²C <i2c>` is
@ -43,8 +48,6 @@ Configuration variables:
The configuration is made up of two parts: The central component, and individual Binary sensors per channel.
Base Configuration:
- **address** (*Optional*, integer): The I²C address of the sensor. Defaults to ``0x5A``.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor.
- **touch_debounce** (*Optional*, integer): The minimum length before a touch is recognized. Range is from 0 to 7.
@ -55,7 +58,16 @@ Base Configuration:
and should be between 5 and 30 (lower = more sensitive). Defaults to 12. Typically the touch threshold is a little bigger than the release threshold.
- **release_threshold** (*Optional*, integer): The release defines the sensitivity for touch detection and should be between 5 and 30. Defaults to 6.
Binary Sensor Configuration:
Binary Sensor
-------------
The ``mpr121`` binary sensor allows you to use your MPR121 with ESPHome.
First, setup a :ref:`mpr121-component` and then use this binary sensor platform to create individual
binary sensors for each touch sensor.
Configuration variables:
- **name** (*Optional*, string): The name for the binary sensor.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.

71
components/binary_sensor/pn532.rst
View File

@ -28,14 +28,62 @@ You will need to switch the dip switches located on the module according to the
SPI is usually switch 1 OFF and switch 2 ON and I²C is usually switch 1 ON and switch 2 OFF.
You will need to have the :ref:`SPI Bus <spi>` or the :ref:`I²C Bus <i2c>` configured depending on your choice.
Over SPI
--------
The ``pn532_spi`` component allows you to use PN532 NFC/RFID controllers
(`datasheet <https://cdn-shop.adafruit.com/datasheets/pn532ds.pdf>`__, `Adafruit <https://www.adafruit.com/product/364>`__)
with ESPHome. This component is a global hub that establishes the connection to the PN532 via :ref:`SPI <spi>` and
outputs its data. Using the :ref:`PN532 binary sensors <pn532-tag>` you can then
create individual binary sensors that track if an NFC/RFID tag is currently detected by the PN532.
.. code-block:: yaml
# Example configuration for SPI (choose which one!)
pn532_spi:
cs_pin: D3
update_interval: 1s
# Example configuration for I²C (choose which one!)
binary_sensor:
- platform: pn532
uid: 74-10-37-94
name: "PN532 NFC Tag"
Configuration variables:
************************
- **cs_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The pin on the ESP that the chip select line
is connected to.
- **update_interval** (*Optional*, :ref:`config-time`): The duration of each scan on the PN532. This affects the
duration that the individual binary sensors stay active when they're found.
If a device is not found within this time window, it will be marked as not present. Defaults to 1s.
- **on_tag** (*Optional*, :ref:`Automation <automation>`): An automation to perform
when a tag is read. See :ref:`pn532-on_tag`.
- **spi_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`SPI Component <spi>` if you want
to use multiple SPI buses.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID for this component.
.. figure:: images/pn532-spi.jpg
:align: center
:width: 80.0%
Example for hooking up the PN532 via SPI. Notice the position of the two switches on the right.
.. _pn532-on_tag:
Over I²C
--------
The ``pn532`` component allows you to use PN532 NFC/RFID controllers
(`datasheet <https://cdn-shop.adafruit.com/datasheets/pn532ds.pdf>`__, `Adafruit <https://www.adafruit.com/product/364>`__)
with ESPHome. This component is a global hub that establishes the connection to the PN532 via :ref:`I²C <i2c>` and
outputs its data. Using the :ref:`PN532 binary sensors <pn532-tag>` you can then
create individual binary sensors that track if an NFC/RFID tag is currently detected by the PN532.
.. code-block:: yaml
pn532_i2c:
update_interval: 1s
@ -47,29 +95,18 @@ You will need to have the :ref:`SPI Bus <spi>` or the :ref:`I²C Bus <i2c>` conf
Configuration variables:
************************
- **cs_pin** (**Required for SPI**, :ref:`Pin Schema <config-pin_schema>`): The pin on the ESP that the chip select line
is connected to.
- **update_interval** (*Optional*, :ref:`config-time`): The duration of each scan on the PN532. This affects the
duration that the individual binary sensors stay active when they're found.
If a device is not found within this time window, it will be marked as not present. Defaults to 1s.
- **on_tag** (*Optional*, :ref:`Automation <automation>`): An automation to perform
when a tag is read. See :ref:`pn532-on_tag`.
- **spi_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`SPI Component <spi>` if you want
to use multiple SPI buses.
- **i2c_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`I²C Component <spi>` if you want
to use multiple I²C buses.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID for this component.
.. figure:: images/pn532-spi.jpg
:align: center
:width: 80.0%
Example for hooking up the PN532 via SPI. Notice the position of the two switches on the right.
.. _pn532-on_tag:
``on_tag``
----------
``on_tag`` Action
-----------------
This automation will be triggered when the PN532 module responds with a tag. This will only be triggered
if the tag is changed or goes away for one cycle of ``update_interval``.
@ -120,8 +157,8 @@ Alternatively you could also send the value directly to Home Assistant via a
.. _pn532-tag:
NFC/RFID Tag
------------
``pn532`` Binary Sensor
-----------------------
The ``pn532`` binary sensor platform lets you track if an NFC/RFID tag with a given
unique id (``uid``) is currently being detected by the PN532 or not.

85
components/binary_sensor/rc522.rst
View File

@ -8,30 +8,32 @@ RC522 RFID
.. _rc522-component:
Component/Hub
-------------
The ``rc522`` component allows you to use RC522 RFID controllers
(`datasheet <hthttps://www.nxp.com/docs/en/data-sheet/MFRC522.pdff>`__, `Ali Express <https://es.aliexpress.com/item/1260729519.html>`__)
with ESPHome. This component is a global hub that establishes the connection to the RC522 via either :ref:`SPI <spi>` or
:ref:`I²C <i2c>` and outputs its data. Using the :ref:`RC522 binary sensors <rc522-tag>` you can then
create individual binary sensors that track if an RFID tag is currently detected by the RC522.
.. figure:: images/rc522-full.jpg
:align: center
:width: 60.0%
with ESPHome. ESPHome can read the tag UID from it, every RFID tag comes with a unique
UID value. Each known tag can be associated to a binary sensor, or you can use the tag information directly.
See :ref:`rc522-setting_up_tags` for information on how to setup individual binary sensors for this component.
The RC522 supports SPI, I²C and UART communication protocols, ESPHome can use either SPI or I²C.
Component/Hub
-------------
* If you have a module like the image above, it can only be used in SPI mode (`unless hacked <https://forum.arduino.cc/index.php?topic=442750.0>`__)
and you need to have an :ref:`SPI bus <spi>` in your configuration with both the **miso_pin** and **mosi_pin** set.
* If you have a RC522 which communicates via I²C like in the M5 Stack then you need to have an :ref:`I²C <i2c>` bus configured.
SPI Option
**********
.. figure:: images/rc522-full.jpg
:align: center
:width: 60.0%
Over SPI
--------
The ``rc522_spi`` component allows you to use RC522 RFID controllers with ESPHome. This component is a global hub that
establishes the connection to the RC522 via :ref:`SPI <spi>` (also avilable over I²C). Using the
:ref:`RC522 binary sensors <rc522-tag>` you can then create individual binary sensors that track if
an RFID tag is currently detected by the RC522.
.. code-block:: yaml
@ -45,8 +47,29 @@ SPI Option
uid: 74-10-37-94
name: "RC522 RFID Tag"
I²C Option
**********
Configuration variables:
************************
- **cs_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The pin on the ESP that the chip select line
is connected to.
- **spi_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`SPI Component <spi>` if you want
to use multiple SPI buses.
- **on_tag** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a tag is read. See
:ref:`rc522-on_tag`.
- **reset_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The pin connected to the RST line. Some tests
shows the RC522 working okay without this.
- **update_interval** (*Optional*, :ref:`config-time`): The duration of each scan on the RC522. This affects the
duration that the individual binary sensors stay active when they're found.
If a device is not found within this time window, it will be marked as not present. Defaults to ``1s``.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID for this component.
Over I²C
--------
The ``rc522_i2c`` component allows you to use RC522 RFID controllers with ESPHome. This component is a global hub that
establishes the connection to the RC522 via :ref:`I²C <i2c>` (also avilable over SPI). Using the
:ref:`RC522 binary sensors <rc522-tag>` you can then create individual binary sensors that track if
an RFID tag is currently detected by the RC522.
.. code-block:: yaml
@ -63,36 +86,24 @@ I²C Option
Configuration variables:
************************
- **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x28``.
- **i2c_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`I²C Component <i2c>` if you want
to use multiple I²C buses.
- **on_tag** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a tag is read. See
:ref:`rc522-on_tag`.
- **reset_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The pin connected to the RST line. Some tests
shows the RC522 working okay without this.
- **update_interval** (*Optional*, :ref:`config-time`): The duration of each scan on the RC522. This affects the
duration that the individual binary sensors stay active when they're found.
If a device is not found within this time window, it will be marked as not present. Defaults to ``1s``.
- **on_tag** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a tag is read. See
:ref:`rc522-on_tag`.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID for this component.
SPI Only:
^^^^^^^^^
- **cs_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The pin on the ESP that the chip select line
is connected to.
- **spi_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`SPI Component <spi>` if you want
to use multiple SPI buses.
I²C Only:
^^^^^^^^^
- **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x28``.
- **i2c_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`I²C Component <i2c>` if you want
to use multiple I²C buses.
.. _rc522-on_tag:
``on_tag``
----------
``on_tag`` Action
-----------------
This automation will be triggered when the RC522 module responds with a tag. Please note that this
can be called quite often (with an interval of ``update_interval``) as it's triggered repeatedly
@ -124,8 +135,8 @@ using :ref:`api-homeassistant_tag_scanned_action`.
.. _rc522-tag:
RFID Tag
--------
``rc522`` Binary Sensor
-----------------------
The ``rc522`` binary sensor platform lets you track if an RFID tag with a given
unique id (``uid``) is currently being detected by the RC522 or not.

4
components/binary_sensor/rdm6300.rst
View File

@ -83,8 +83,8 @@ using :ref:`api-homeassistant_tag_scanned_action`.
.. _rdm6300-tag:
NFC/RFID Tag
------------
``rdm6300`` Binary Sensor
-------------------------
The ``rdm6300`` binary sensor platform lets you track if an NFC/RFID tag with a given
unique id (``uid``) is currently being detected by the RDM6300 or not.

20
components/binary_sensor/ttp229.rst
View File

@ -22,8 +22,8 @@ There are two types of this sensor:
.. _RobotDyn: https://www.tinytronics.nl/shop/nl/sensoren/touch/robotdyn-touch-module-ttp229-lsf-16-kanaals
``ttp229_lsf`` Type
-------------------
``ttp229_lsf`` Component
------------------------
.. code-block:: yaml
@ -40,19 +40,20 @@ Configuration variables:
The configuration is made up of two parts: The central component, and individual Binary sensors per channel.
Base Configuration:
- **id** (*Optional*, :ref:`config-id`): Manually set the ID of this sensor.
Binary Sensor Configuration:
``ttp229_lsf`` Binary Sensor
----------------------------
Configuration variables:
- **name** (**Required**, string): The name of the binary sensor.
- **channel** (**Required**, integer): The channel number at the TTP229 the touchkey is connected to.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
``ttp229_bsf`` Type
-------------------
``ttp229_bsf`` Component
------------------------
.. code-block:: yaml
@ -79,7 +80,10 @@ Base Configuration:
SCL pin is connected to.
- **id** (*Optional*, :ref:`config-id`): Manually set the ID of this component.
Binary Sensor Configuration:
``ttp229_bsf`` Binary Sensor
----------------------------
Configuration variables:
- **name** (**Required**, string): The name of the binary sensor.
- **channel** (**Required**, integer): The channel number at the TTP229 the touchkey is connected to.

15
components/canbus.rst
View File

@ -58,7 +58,7 @@ Configuration variables:
- **can_id** (**Required**, integer): default *can id* used for transmitting frames.
- **use_extended_id** (*Optional*, boolean): default *False* identifies the type of *can_id*:
*False*: Standard 11 bits IDs, *True*: Extended 29 bits ID
- **bit_rate** (*Optional*, one of the supported bitrates= defaults to ``125KBPS``.
- **bit_rate** (*Optional*, enum): One of the supported bitrates. Defaults to ``125KBPS``.
- 5KBPS
- 10KBPS
@ -80,7 +80,7 @@ Configuration variables:
Automations:
- **on_frame** (*Optional*, :ref:`Automation <automation>`): An automation to perform when ability
CAN Frame is received. See below.
CAN Frame is received. See :ref:`canbus-on-frame`.
.. _canbus-on-frame:
@ -107,8 +107,8 @@ This automation will be triggered when a can frame is received. A variable ``x`
then:
light.toggle: light1
Transmit Frame Action
*********************
``canbus.send`` Action
**********************
The can bus can transmit frames by means of the ``canbus.send`` action.
There are several forms to use it:
@ -141,14 +141,17 @@ Configuration variables:
- **use_extended_id** (*Optional*, boolean): default *False* identifies the type of *can_id*:
*False*: Standard 11 Bit IDs, *True*: Extended 29Bit ID
MCP2515
-------
MCP2515 Component
-----------------
The MCP2515 is a spi device and therfore you must first add the configuration for the spi bus to your file.
You need to have an :ref:`SPI bus <spi>` in your configuration with both the **mosi_pin** and **miso_pin** set.
For wireing up the MSP2515 please refer to the section below.
Configuration variables:
************************
- **cs_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): Is used to tell the receiving SPI device
when it should listen for data on the SPI bus. Each device has an individual ``CS`` line.
Sometimes also called ``SS``.

4
components/climate/bang_bang.rst
View File

@ -66,8 +66,8 @@ Do note that the actions are only called when the current temperature leaves the
idle_action:
- switch.turn_off: heater
Configuration variables
-----------------------
Configuration variables:
------------------------
- **sensor** (**Required**, :ref:`config-id`): The sensor that is used to measure the current temperature.
- **default_target_temperature_low** (**Required**, float): The default low target temperature for

71
components/climate/ir_climate.rst
View File

@ -15,30 +15,30 @@ as your remote unit would do.
There is a growing list of compatible units. If your unit is not listed below you can fill a feature
request so it will be added (see FAQ).
+------------------------+---------------------+----------------------+------------------------------------+
| Name | Platform name | Supports receiver | |
| | | | |
+========================+=====================+======================+====================================+
| Coolix | ``coolix`` | yes | |
+------------------------+---------------------+----------------------+------------------------------------+
| Daikin | ``daikin`` | yes | |
+------------------------+---------------------+----------------------+------------------------------------+
| Fujitsu General | ``fujitsu_general`` | | |
+------------------------+---------------------+----------------------+------------------------------------+
| Mitsubishi | ``mitsubishi`` | | |
+------------------------+---------------------+----------------------+------------------------------------+
| TCL112, Fuego | ``tcl112`` | yes | |
+------------------------+---------------------+----------------------+------------------------------------+
| Toshiba | ``toshiba`` | yes | |
+------------------------+---------------------+----------------------+------------------------------------+
| Yashima | ``yashima`` | | |
+------------------------+---------------------+----------------------+------------------------------------+
| Whirlpool | ``whirlpool`` | yes | :ref:`more info<model_whirlpool>` |
+------------------------+---------------------+----------------------+------------------------------------+
| LG | ``climate_ir_lg`` | yes | |
+------------------------+---------------------+----------------------+------------------------------------+
| Hitachi | ``hitachi_ac344`` | yes | |
+------------------------+---------------------+----------------------+------------------------------------+
+---------------------------------------+---------------------+----------------------+
| Name | Platform name | Supports receiver |
| | | |
+=======================================+=====================+======================+
| Coolix | ``coolix`` | yes |
+---------------------------------------+---------------------+----------------------+
| Daikin | ``daikin`` | yes |
+---------------------------------------+---------------------+----------------------+
| Fujitsu General | ``fujitsu_general`` | |
+---------------------------------------+---------------------+----------------------+
| Mitsubishi | ``mitsubishi`` | |
+---------------------------------------+---------------------+----------------------+
| TCL112, Fuego | ``tcl112`` | yes |
+---------------------------------------+---------------------+----------------------+
| Toshiba | ``toshiba`` | yes |
+---------------------------------------+---------------------+----------------------+
| Yashima | ``yashima`` | |
+---------------------------------------+---------------------+----------------------+
| :ref:`Whirlpool<climate_ir_whirlpool>`| ``whirlpool`` | yes |
+---------------------------------------+---------------------+----------------------+
| :ref:`LG<climate_ir_lg>` | ``climate_ir_lg`` | yes |
+---------------------------------------+---------------------+----------------------+
| Hitachi | ``hitachi_ac344`` | yes |
+---------------------------------------+---------------------+----------------------+
This component requires that you have setup a :doc:`/components/remote_transmitter`.
@ -110,23 +110,32 @@ IR receiver.
name: "Living Room AC"
receiver_id: rcvr
.. _model_whirlpool:
.. _climate_ir_whirlpool:
Whirlpool
---------
``whirlpool`` Climate
---------------------
Additional configuration is available for this model
Configuration variables:
- **model** (*Optional*, string): There are two valid models
* ``MODEL_DG11J1_3A``: Temperature range is from 18 to 32 (default)
* ``MODEL_DG11J1_91``: Temperature range is from 16 to 30
-* ``DG11J1-3A``: Temperature range is from 18 to 32 (default)
-* ``DG11J1-91``: Temperature range is from 16 to 30
LG
---------
.. _climate_ir_lg:
``climate_ir_lg`` Climate
-------------------------
Additional configuration is available for this platform
Configuration variables:
- **header_high** (*Optional*, :ref:`config-time`): time for the high part of the header for the LG protocol. Defaults to ``8000us``
- **header_low** (*Optional*, :ref:`config-time`): time for the low part of the header for the LG protocol. Defaults to ``4000us``
- **bit_high** (*Optional*, :ref:`config-time`): time for the high part of any bit in the LG protocol. Defaults to ``600us``

10
components/climate/pid.rst
View File

@ -215,8 +215,8 @@ Configuration variables:
``climate.pid.set_control_parameters`` Action
---------------------------------------------
This action sets new values for the control parameters of the PID controller. This can be
used to manually tune the PID controller. Make sure to take update the values you want on
This action sets new values for the control parameters of the PID controller. This can be
used to manually tune the PID controller. Make sure to take update the values you want on
the YAML file! They will reset on the next reboot.
.. code-block:: yaml
@ -247,14 +247,14 @@ conditions to avoid the control loop to overshoot (or undershoot) a target.
on_...:
# Basic
- climate.pid.reset_integral_term: pid_climate
- climate.pid.reset_integral_term: pid_climate
Configuration variables:
- **id** (**Required**, :ref:`config-id`): ID of the PID Climate being reset.
PID Climate Sensor
------------------
``pid`` Sensor
--------------
Additionally, the PID climate platform provides an optional sensor platform to monitor
the calculated PID parameters to help finding good PID values.

3
components/climate/thermostat.rst
View File

@ -133,8 +133,7 @@ Examples:
Got all that? Great. Let's take a closer look at some configuration.
Configuration Variables
-----------------------
Configuration Variables:
The thermostat controller uses the sensor to determine whether it should heat or cool.

2
components/debug.rst
View File

@ -22,7 +22,7 @@ a bunch of useful information like reset reason, free heap size, ESPHome version
logger:
level: debug
There are no configuration variables for this component.
No configuration variables.
See Also
--------

7
components/deep_sleep.rst
View File

@ -33,9 +33,8 @@ Configuration variables:
- **run_duration** (*Optional*, :ref:`config-time`): The time duration the node should be active, i.e. run code.
- **sleep_duration** (*Optional*, :ref:`config-time`): The time duration to stay in deep sleep mode.
- **wakeup_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`):
Only on ESP32. A pin to wake up to once in deep sleep mode. Use the inverted property to wake up
to LOW signals.
- **wakeup_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): Only on ESP32. A pin to wake up to once
in deep sleep mode. Use the inverted property to wake up to LOW signals.
- **wakeup_pin_mode** (*Optional*): Only on ESP32. Specify how to handle waking up from a ``wakeup_pin`` if
the wakeup pin is already in the state with which it would wake up when attempting to enter deep sleep.
See :ref:`deep_sleep-esp32_wakeup_pin_mode`. Defaults to ``IGNORE``
@ -116,7 +115,7 @@ Useful for
it will no longer enter deep sleep mode and you can upload your OTA update.
Remember to turn "OTA mode" off again after the OTA update by sending a MQTT message with the payload
``OFF``. To enter the the deep sleep again after the OTA update send a message on the topic ``livingroom/sleep_mode``
``OFF``. To enter the the deep sleep again after the OTA update send a message on the topic ``livingroom/sleep_mode``
with payload ``ON``. Deep sleep will start immediately. Don't forget to delete the payload before the node
wakes up again.

10
components/dfplayer.rst
View File

@ -21,10 +21,10 @@ Overview
--------
The module can be powered by the 3.3V output of an NodeMCU. For communication you can connect only
the ``tx_pin`` of the ``uart`` bus to the module's ``RX`` but if you need feedback of playback active
the ``tx_pin`` of the ``uart`` bus to the module's ``RX`` but if you need feedback of playback active
you will also need to connect the ``rx_pin`` to the module's ``TX``.
For best quality audio a powered stereo speaker can be connected to the modules ``DAC_R``,
``DAC_I`` and ``GND``, alternatively the module features a built-in 3W audio amplifier, in that case
``DAC_L`` and ``GND``, alternatively the module features a built-in 3W audio amplifier, in that case
the pins ``SPK_1`` and ``SPK_2`` should be connected to one passive speaker and a 5V 1A power supply
will be required.
@ -115,8 +115,8 @@ Configuration options:
-------------------------------
Plays files inside numbered folders, folders must be numbered from 1 and with leading
zeros. Like `01`, `02`, ... etc. Files inside the folders must be numbered with two
leading zeros, like `001.mp3`, `002.mp3`, ... etc.
zeros. Like ``01``, ``02``, ... etc. Files inside the folders must be numbered with two
leading zeros, like ``001.mp3``, ``002.mp3``, ... etc.
Folder numbers can range from 1 to 99 and file name from 1 to 255 or folder number
from 1 to 10 and file number from 1 to 1000.
@ -178,7 +178,7 @@ Changes volume.
Configuration options:
- **volume** (**Required**, int, :ref:`templatable <config-templatable>`): The volume value.
Valid values goes from 0 to 30.
Valid values goes from ``0`` to ``30``.
``dfplayer.set_eq`` Action
--------------------------

8
components/display/ili9341.rst
View File

@ -33,13 +33,13 @@ beyond the typical SPI connections, it is better suited for use with the ESP32.
dc_pin: 27
led_pin: 32 ### see note below ###
reset_pin: 33
lambda: |-
it.fill(COLOR_BLACK);
it.print(0, 0, id(my_font), id(my_red), TextAlign::TOP_LEFT, "Hello World!");
Configuration variables
***********************
Configuration variables:
************************
- **model** (**Required**): The model of the display. Options are:

BIN
components/display/images/inkplate.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 32 KiB

63
components/display/index.rst
View File

@ -312,11 +312,41 @@ use any string you pass it, like ``"ON"`` or ``"OFF"``.
Displaying Time
***************
With ESPHome you can also display the current time using the NTP protocol. Please see the example :ref:`here <strftime>`.
You can display current time using a time component. Please see the example :ref:`here <strftime>`.
.. _config-color:
Color
*****
When using RGB-capable displays in ESPHome you may wish to use custom colors.
A ``color`` component exists for just this purpose:
.. code-block:: yaml
color:
- id: my_light_red
red: 100%
green: 20%
blue: 25%
white: 0%
Configuration variables:
- **red** (*Optional*, percentage): The percentage of the red component. Defaults to ``100%``.
- **green** (*Optional*, percentage): The percentage of the green component. Defaults to ``100%``.
- **blue** (*Optional*, percentage): The percentage of the blue component. Defaults to ``100%``.
- **white** (*Optional*, percentage): The percentage of the white component. Defaults to ``100%``.
RGB displays use red, green, and blue, while grayscale displays may use white.
Images
******
Use this component to store graphical images on the device, you can then draw the images on compatible displays.
.. code-block:: yaml
image:
@ -329,7 +359,7 @@ Configuration variables:
- **file** (**Required**, string): The path (relative to where the .yaml file is) of the image file.
- **id** (**Required**, :ref:`config-id`): The ID with which you will be able to reference the image later
in your display code.
- **resize** (*Optional*, int): If set, this will resize the image to fit inside the given dimensions ``WIDTHxHEIGHT``
- **resize** (*Optional*, string): If set, this will resize the image to fit inside the given dimensions ``WIDTHxHEIGHT``
and preserve the aspect ratio.
- **type** (*Optional*): Specifies how to encode image internally. Defaults to ``BINARY``.
@ -379,8 +409,8 @@ as the additional parameters.
Animation
*********
Animation inherits all options from the image component.
It adds an additional method to change the shown picture of a gif.
Allows to use animated images on displays. Animation inherits all options from the image component.
It adds an additional lambda method: ``next_frame()`` to change the shown picture of a gif.
.. code-block:: yaml
@ -417,6 +447,30 @@ This can be combined with all Lambdas:
lambda: |-
id(my_animation).next_frame();
Configuration variables:
^^^^^^^^^^^^^^^^^^^^^^^^
- **file** (**Required**, string): The path (relative to where the .yaml file is) of the gif file.
- **id** (**Required**, :ref:`config-id`): The ID with which you will be able to reference the animation later
in your display code.
- **resize** (*Optional*, string): If set, this will resize all the frames to fit inside the given dimensions ``WIDTHxHEIGHT``
and preserve the aspect ratio.
- **type** (*Optional*): Specifies how to encode each frame internally. Defaults to ``BINARY``.
- ``BINARY``: Two colors, suitable for 1 color displays or 2 color image in color displays. Uses 1 bit
per pixel, 8 pixels per byte.
- ``GREYSCALE``: Full scale grey. Uses 8 bits per pixel, 1 pixel per byte.
- ``RGB24``: Full RGB color stored. Uses 3 bytes per pixel.
- **dither** (*Optional*): Specifies which dither method used to process each frame, only used in GREYSCALE and BINARY type image.
Defaults to ``NONE``. You can read more about it `here <https://pillow.readthedocs.io/en/stable/reference/Image.html?highlight=Dither#PIL.Image.Image.convert>`__
and `here <https://en.wikipedia.org/wiki/Dither>`__.
- ``NONE``: Every pixel convert to its nearest color.
- ``FLOYDSTEINBERG``: Uses Floyd-Steinberg dither to approximate the original image luminosity levels.
.. _display-pages:
Display Pages
@ -486,6 +540,7 @@ You can then switch between these with three different actions:
- display.page.show_next: my_display
- component.update: my_display
See Also
--------

12
components/display/Inkplate.rst → components/display/inkplate6.rst
View File

@ -3,13 +3,13 @@ Inkplate 6
.. seo::
:description: Instructions for setting up Inkplate E-Paper displays in ESPHome.
:image: Inkplate.jpg
:image: inkplate.jpg
All-in-one e-paper display ``Inkplate 6``
Inkplate 6 is a powerful, Wi-Fi enabled ESP32 based six-inch e-paper display – recycled from a Kindle e-reader. Its main feature is simplicity.
Learn more at `Inkplate's website <https://inkplate.io/>`__
.. figure:: images/Inkplate.jpg
.. figure:: images/inkplate.jpg
:align: center
:width: 75.0%
@ -25,7 +25,7 @@ Learn more at `Inkplate's website <https://inkplate.io/>`__
address: 0x20
display:
- platform: inkplate
- platform: inkplate6
id: inkplate_display
greyscale: false
partial_updating: false
@ -66,8 +66,8 @@ Learn more at `Inkplate's website <https://inkplate.io/>`__
It just ignores the function call in that case.
Configuration variables
***********************
Configuration variables:
************************
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **greyscale** (*Optional*, boolean): Makes the screen display 3 bit colors. Defaults to ``False``
@ -224,7 +224,7 @@ Wi-Fi, API, and OTA configuration.
display:
- platform: inkplate
- platform: inkplate6
id: inkplate_display
greyscale: false
partial_updating: false

8
components/display/lcd_display.rst
View File

@ -7,8 +7,8 @@ Character-Based LCD Display
.. _lcd-pcf8574:
PCF8574
-------
lcd_pcf8574 Component
---------------------
The ``lcd_pcf8574`` display platform allows you to use standard character-based LCD displays like
`this one <https://docs.labs.mediatek.com/resource/linkit7697-arduino/en/tutorial/driving-1602-lcd-with-pcf8574-pcf8574a>`__
@ -56,8 +56,8 @@ Configuration variables:
.. _lcd-gpio:
GPIO
----
lcd_gpio Component
------------------
The ``lcd_gpio`` display platform allows you to use standard character-based LCD displays like `this one <https://www.adafruit.com/product/181>`__
with ESPHome. This integration is only for LCD displays that display individual characters on a screen (usually 16-20 columns

3
components/display/nextion.rst
View File

@ -39,8 +39,7 @@ Configuration variables:
- **uart_id** (*Optional*, :ref:`config-id`): The ID of the :ref:`UART bus <uart>` you wish to use for this display.
Use this if you want to use multiple UART buses at once.
- **brightness** (*Optional*, percentage): Set the screen brightness. Must be in range
``0%`` to ``100%`` or ``0.0`` to ``1.0``. Defaults to ``100%``.
- **brightness** (*Optional*, percentage): Set display brightness in %. Defaults to ``100%``
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`): The lambda to use for rendering the content on the nextion display.
See :ref:`display-nextion_lambda` for more information.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to call the lambda to update the display.

6
components/display/pcd8544.rst
View File

@ -53,9 +53,9 @@ To use a backlight LIGHT pin needs to be connected to ground. If connected to GP
Configuration variables:
************************
- **reset_pin** (**Required**)(:ref:`Pin Schema <config-pin_schema>`): The RESET pin.
- **cs_pin** (**Required**)(:ref:`Pin Schema <config-pin_schema>`): The CS pin.
- **dc_pin** (**Required**)(:ref:`Pin Schema <config-pin_schema>`): The DC pin.
- **reset_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The RESET pin.
- **cs_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The CS pin.
- **dc_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The DC pin.
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`): The lambda to use for rendering the content on the display.
See :ref:`display-engine` for more information.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``5s``.

5
components/display/ssd1306.rst
View File

@ -61,7 +61,7 @@ Configuration variables:
- **address** (*Optional*, int): Manually specify the :ref:`I²C <i2c>` address of the display. Defaults to 0x3C.
- **rotation** (*Optional*): Set the rotation of the display. Everything you draw in ``lambda:`` will be rotated
by this option. One of ``0°`` (default), ``90°``, ``180°``, ``270°``.
- **brightness** (*Optional*): Set the screen brightness in percents 0.0-1.0. Defaults to `1.0` that corresponds to 100%.
- **brightness** (*Optional*, percentage): Set display brightness in %. Defaults to ``100%``
- **external_vcc** (*Optional*, boolean): Set this to true if you have the VCC pin connected to an external power supply.
Defaults to ``false``.
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`): The lambda to use for rendering the content on the display.
@ -69,7 +69,6 @@ Configuration variables:
- **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``5s``.
- **pages** (*Optional*, list): Show pages instead of a single lambda. See :ref:`display-pages`.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **brightness** (*Optional*, float): Manually override display brightness in %. Defaults to ``100%``
.. note::
@ -133,6 +132,7 @@ Configuration variables:
- **reset_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The RESET pin. Defaults to not connected.
- **rotation** (*Optional*): Set the rotation of the display. Everything you draw in ``lambda:`` will be rotated
by this option. One of ``0°`` (default), ``90°``, ``180°``, ``270°``.
- **brightness** (*Optional*, percentage): Set display brightness in %. Defaults to ``100%``
- **external_vcc** (*Optional*, boolean): Set this to true if you have the VCC pin connected to an external power supply.
Defaults to ``false``.
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`): The lambda to use for rendering the content on the display.
@ -142,7 +142,6 @@ Configuration variables:
- **spi_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`SPI Component <spi>` if you want
to use multiple SPI buses.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **brightness** (*Optional*, float): Manually override display brightness in %. Defaults to ``100%``
See Also
--------

10
components/display/ssd1322.rst
View File

@ -7,8 +7,8 @@ SSD1322 OLED Display
.. _ssd1322-spi:
Usage
-----
``ssd1322_spi`` Component
-------------------------
The ``ssd1322_spi`` display platform allows you to use
SSD1322 (`datasheet <https://www.newhavendisplay.com/specs/NHD-3.12-25664UCW2.pdf>`__,
@ -47,9 +47,9 @@ Configuration variables:
- ``SSD1322 256x64``
- **reset_pin** (:ref:`Pin Schema <config-pin_schema>`): The RESET pin.
- **cs_pin** (:ref:`Pin Schema <config-pin_schema>`): The CS pin.
- **dc_pin** (:ref:`Pin Schema <config-pin_schema>`): The DC pin.
- **dc_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The DC pin.
- **reset_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The RESET pin.
- **cs_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The CS pin.
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`): The lambda to use for rendering the content on the display.
See :ref:`display-engine` for more information.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``5s``.

14
components/display/ssd1325.rst
View File

@ -7,8 +7,8 @@ SSD1325/7 OLED Display
.. _ssd1325-spi:
Usage
-----
``ssd1325_spi`` Component
-------------------------
The ``ssd1325_spi`` display platform allows you to use
SSD1325 (`datasheet <https://cdn-shop.adafruit.com/datasheets/SSD1325.pdf>`__,
@ -44,8 +44,8 @@ that explains how to do this, if necessary.
lambda: |-
it.print(0, 0, id(font), "Hello World!");
Configuration Variables
***********************
Configuration variables:
************************
- **model** (**Required**): The model of the display. Options are:
@ -54,10 +54,10 @@ Configuration Variables
- ``SSD1325 96x16``
- ``SSD1325 64x48``
- **reset_pin** (:ref:`Pin Schema <config-pin_schema>`): The RESET pin.
- **cs_pin** (:ref:`Pin Schema <config-pin_schema>`): The pin on the ESP that that the CS line is connected to.
- **dc_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The DC pin.
- **reset_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The RESET pin.
- **cs_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The pin on the ESP that that the CS line is connected to.
The CS line can be connected to GND if this is the only device on the SPI bus.
- **dc_pin** (:ref:`Pin Schema <config-pin_schema>`): The DC pin.
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`): The lambda to use for rendering the content on the display.
See :ref:`display-engine` for more information.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``5s``.

13
components/display/ssd1327.rst
View File

@ -41,8 +41,8 @@ ESP; this is recommended as it improves reliability.
lambda: |-
it.print(0, 0, id(font), "Hello World!");
Configuration variables
***********************
Configuration variables:
************************
- **model** (**Required**): The model of the display. At present, only one option is available:
@ -52,13 +52,12 @@ Configuration variables
- **address** (*Optional*, int): Manually specify the :ref:`I²C <i2c>` address of the display. Defaults to 0x3D.
- **rotation** (*Optional*): Set the rotation of the display. Everything you draw in ``lambda:`` will be rotated
by this option. One of ``0°`` (default), ``90°``, ``180°``, ``270°``.
- **brightness** (*Optional*): Set the screen brightness in percents 0.0-1.0. Defaults to `1.0` that corresponds to 100%.
- **brightness** (*Optional*, percentage): Set display brightness in %. Defaults to ``100%``
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`): The lambda to use for rendering the content on the display.
See :ref:`display-engine` for more information.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``5s``.
- **pages** (*Optional*, list): Show pages instead of a single lambda. See :ref:`display-pages`.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **brightness** (*Optional*, float): Manually override display brightness in %. Defaults to ``100%``
.. note::
@ -101,8 +100,8 @@ available pin on the ESP; this is recommended as it improves reliability.
lambda: |-
it.print(0, 0, id(font), "Hello World!");
Configuration variables
***********************
Configuration variables:
************************
- **model** (**Required**): The model of the display. At present, only one option is available:
@ -113,6 +112,7 @@ Configuration variables
- **reset_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The RESET pin. Defaults to not connected.
- **rotation** (*Optional*): Set the rotation of the display. Everything you draw in ``lambda:`` will be rotated
by this option. One of ``0°`` (default), ``90°``, ``180°``, ``270°``.
- **brightness** (*Optional*, percentage): Set display brightness in %. Defaults to ``100%``
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`): The lambda to use for rendering the content on the display.
See :ref:`display-engine` for more information.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``5s``.
@ -120,7 +120,6 @@ Configuration variables
- **spi_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`SPI Component <spi>` if you want
to use multiple SPI buses.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **brightness** (*Optional*, float): Manually override display brightness in %. Defaults to ``100%``
Configuration examples
**********************

8
components/display/ssd1331.rst
View File

@ -39,13 +39,13 @@ require 5 volts connected to their ``+`` pin. Connect the GND or G pin to ground
lambda: |-
it.print(0, 0, id(font), "Hello World!");
Configuration variables
***********************
Configuration variables:
************************
- **reset_pin** (:ref:`Pin Schema <config-pin_schema>`): The RESET pin.
- **dc_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The DC pin.
- **reset_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The RESET pin.
- **cs_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The pin on the ESP that that the CS line is connected to.
The CS line can be connected to GND if this is the only device on the SPI bus.
- **dc_pin** (:ref:`Pin Schema <config-pin_schema>`): The DC pin.
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`): The lambda to use for rendering the content on the display.
See :ref:`display-engine` for more information.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``5s``.

15
components/display/ssd1351.rst
View File

@ -7,8 +7,8 @@ SSD1351 OLED Display
.. _ssd1351-spi:
Usage
-----
``ssd1351_spi`` Component
-------------------------
The ``ssd1351_spi`` display platform allows you to use
SSD1351 (`datasheet <https://cdn-shop.adafruit.com/datasheets/SSD1351-Revision+1.3.pdf>`__,
@ -43,18 +43,17 @@ which should be connected to 3.3 volts only. Connect the GND or G pin to GND.
lambda: |-
it.print(0, 0, id(font), "Hello World!");
Configuration variables
***********************
Configuration variables:
************************
- **model** (**Required**): The model of the display. Options are:
- ``SSD1351 128x128`` (SSD1351 with 128 columns and 128 rows)
- ``SSD1351 128x96`` (SSD1351 with 128 columns and 96 rows)
- **reset_pin** (:ref:`Pin Schema <config-pin_schema>`): The RESET pin.
- **cs_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The pin on the ESP that that the CS line is connected to.
The CS line can be connected to GND if this is the only device on the SPI bus.
- **dc_pin** (:ref:`Pin Schema <config-pin_schema>`): The DC pin.
- **dc_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The DC pin.
- **cs_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The pin on the ESP that that the CS line is connected to.
- **reset_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The RESET pin.
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`): The lambda to use for rendering the content on the display.
See :ref:`display-engine` for more information.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``5s``.

14
components/display/st7735.rst
View File

@ -6,7 +6,7 @@ ST7735 Display
:keywords: ST7735
:image: ST7735.png
ST7735 Display Driver.
ST7735 Display Driver.
Usage
-----
@ -32,7 +32,7 @@ There are numerous board types out there. Some initialize differently as well. T
model: "INITR_18BLACKTAB"
reset_pin: D4
cs_pin: D1
dc_pin: D2
dc_pin: D2
rotation: 0
device_width: 128
device_height: 160
@ -45,21 +45,21 @@ Configuration variables:
~~~~~~~~~~~~~~~~~~~~~~~~
- **model** (**Required**, "See Models Below"): This the model to use. INITR_BLACKTAB is the default
- **reset_pin** (:ref:`Pin Schema <config-pin_schema>`): The RESET pin.
- **cs_pin** (:ref:`Pin Schema <config-pin_schema>`): The CS pin.
- **dc_pin** (:ref:`Pin Schema <config-pin_schema>`): The DC pin.
- **cs_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The CS pin.
- **dc_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The DC pin.
- **device_width** (**Required**, int): The device width. 128 is default
- **device_height** (**Required**, int): The device height. 160 is default
- **col_start** (**Required**, int): The device height. 160 is default
- **row_start** (**Required**, int): The device height. 160 is default
- **eight_bit_color** (*Optional*, "True/False" ): 8bit mode. Default is False. This saves 50% of the buffer required for the display.
- **eight_bit_color** (*Optional*, "True/False" ): 8bit mode. Default is False. This saves 50% of the buffer required for the display.
- **reset_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The RESET pin.
Memory notes:
~~~~~~~~~~~~~
- 8Bit color saves 50% of the buffer required.
- eightbitcolor: True 160x128 = 20480 *Important for memory constrained devices*
- eightbitcolor: False 160x128x2 = 40960
- eightbitcolor: False 160x128x2 = 40960
Models:

12
components/display/st7789v.rst
View File

@ -50,13 +50,13 @@ hardwired programming. (OTA updates are of course possible after ESPHome is init
When using the TTGO T-Display module, the GPIO pin numbers above *cannot be changed* as they are
hardwired within the module/PCB.
Configuration variables
***********************
Configuration variables:
************************
- **backlight_pin** (:ref:`Pin Schema <config-pin_schema>`): The display's backlight pin.
- **cs_pin** (:ref:`Pin Schema <config-pin_schema>`): The CS pin.
- **dc_pin** (:ref:`Pin Schema <config-pin_schema>`): The DC pin.
- **reset_pin** (:ref:`Pin Schema <config-pin_schema>`): The RESET pin.
- **backlight_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The display's backlight pin.
- **cs_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The CS pin.
- **dc_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The DC pin.
- **reset_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The RESET pin.
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`): The lambda to use for rendering the content on the display.
See :ref:`display-engine` for more information.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``5s``.

5
components/display/waveshare_epaper.rst
View File

@ -8,9 +8,8 @@ Waveshare E-Paper Display
The ``waveshare_epaper`` display platform allows you to use
some E-Paper displays sold by `Waveshare <https://www.waveshare.com/product/displays/e-paper.htm>`__
with ESPHome. The 2.13" `TTGO module <https://github.com/lewisxhe/TTGO-EPaper-Series>`__ with an ESP32 on the board is supported as well.
Depending on your specific revision of the board you might need to try out the `-b73` version (see below).
Similar modules sold by other vendors might also work but not have been tested yet. Currently only
single-color E-Ink displays are implemented and of those only a few modules.
Depending on your specific revision of the board you might need to try out the ``-b73`` version (see below).
Similar modules sold by other vendors might also work but not have been tested yet.
.. figure:: images/waveshare_epaper-full.jpg
:align: center

8
components/esp32_ble_tracker.rst
View File

@ -154,13 +154,13 @@ variable ``x`` of type ``std::vector<uint8_t>`` is passed to the automation for
Configuration variables:
- **mac_address** (*Optional*, MAC Address): The MAC address to filter for this automation.
- **manufacturer_id** (**Required**, string) 16 bit, 32 bit, or 128 bit BLE Manufacturer ID.
- **manufacturer_id** (**Required**, string): 16 bit, 32 bit, or 128 bit BLE Manufacturer ID.
- See :ref:`Automation <automation>`.
.. _esp32_ble_tracker-on_ble_service_data_advertise:
``on_ble_on_ble_service_data_advertise``
****************************************
``on_ble_service_data_advertise``
*********************************
This automation will be triggered when a Bluetooth advertising with service data is received. A
variable ``x`` of type ``std::vector<uint8_t>`` is passed to the automation for use in lambdas.
@ -182,7 +182,7 @@ variable ``x`` of type ``std::vector<uint8_t>`` is passed to the automation for
Configuration variables:
- **mac_address** (*Optional*, MAC Address): The MAC address to filter for this automation.
- **service_uuid** (**Required**, string) 16 bit, 32 bit, or 128 bit BLE Service UUID.
- **service_uuid** (**Required**, string): 16 bit, 32 bit, or 128 bit BLE Service UUID.
- See :ref:`Automation <automation>`.
See Also

5
components/gps.rst
View File

@ -33,10 +33,7 @@ in your configuration - only the RX pin should be necessary.
time:
- platform: gps
Configuration variables:
------------------------
The component is split up in platforms.
The component is split up in platforms. No configuration variables.
First you need to define a global GPS module hub (as seen above).

8
components/i2c.rst
View File

@ -11,9 +11,9 @@ I²C Bus
This component sets up the I²C bus for your ESP32 or ESP8266. In order for these components
to work correctly, you need to define the I²C bus in your configuration. Please note the ESP
will enable its internal 10kΩ pullup resistors for these pins, so you usually don't need to
put on external ones. You can use multiple devices on one I²C bus as each device is given a
unique address for communicating between between it and the ESP. You can do this by hopping
wires from the two lines (SDA and SCL) from each device board to the next device board or by
put on external ones. You can use multiple devices on one I²C bus as each device is given a
unique address for communicating between between it and the ESP. You can do this by hopping
wires from the two lines (SDA and SCL) from each device board to the next device board or by
connecting the wires from each device back to the two I²C pins on the ESP.
.. code-block:: yaml
@ -37,7 +37,7 @@ Configuration variables:
Defaults to ``True``.
- **frequency** (*Optional*, float): Set the frequency the I²C bus should operate on.
Defaults to ``50kHz``. Values are ``50kHz``, ``100kHz``, ``200kHz``, ... ``800kHz``
- **id** (*Optional*, :ref:`config-id`) Manually specify the ID for this I²C bus if you need multiple I²C buses.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID for this I²C bus if you need multiple I²C buses.
.. note::

43
components/light/index.rst
View File

@ -77,7 +77,7 @@ This action toggles a light with the given ID when executed.
# Shorthand:
- light.toggle: light_1
Configuration options:
Configuration variables:
- **id** (**Required**, :ref:`config-id`): The ID of the light.
- **transition_length** (*Optional*, :ref:`config-time`, :ref:`templatable <config-templatable>`): The length of the transition
@ -121,7 +121,7 @@ This action turns a light with the given ID on when executed.
# Shorthand
- light.turn_on: light_1
Configuration options:
Configuration variables:
- **id** (**Required**, :ref:`config-id`): The ID of the light.
- **transition_length** (*Optional*, :ref:`config-time`, :ref:`templatable <config-templatable>`): The length of the transition
@ -180,7 +180,7 @@ This action turns a light with the given ID off when executed.
# Shorthand
- light.turn_off: light_1
Configuration options:
Configuration variables:
- **id** (**Required**, :ref:`config-id`): The ID of the light.
- **transition_length** (*Optional*, :ref:`config-time`, :ref:`templatable <config-templatable>`): The length of the transition
@ -214,7 +214,7 @@ is essentially just a combination of the turn_on and turn_off calls.
id: light_1
state: on
Configuration options:
Configuration variables:
- **id** (**Required**, :ref:`config-id`): The ID of the light.
- **state** (*Optional*, :ref:`templatable <config-templatable>`, boolean): Change the ON/OFF
@ -238,10 +238,10 @@ by a relative amount.
id: light_1
relative_brightness: 5%
Configuration options:
Configuration variables:
- **id** (**Required**, :ref:`config-id`): The ID of the light.
- **relative_brightness** (**Required***, :ref:`templatable <config-templatable>`, percentage):
- **relative_brightness** (**Required**, :ref:`templatable <config-templatable>`, percentage):
The relative brightness to dim the light by.
- **transition_length** (*Optional*, :ref:`config-time`, :ref:`templatable <config-templatable>`): The length of the transition.
@ -817,8 +817,10 @@ Configuration variables:
- **sequence** (*Optional*, :ref:`Action <config-action>`): The actions to perform in sequence
until the effect is stopped.
E1.31
*****
.. _e131-light-effect:
E1.31 Effect
************
This effect enables controlling addressable lights using UDP-based
E1.31_ protocol.
@ -840,16 +842,15 @@ JINX_ can be used to control E1.31_ enabled ESPHome.
Configuration variables:
- **method** (*Optional*): Listening method, one of ``multicast`` or ``unicast``. Defaults to ``multicast``.
- **universe** (**Required**, integer): The value of universe, between 1 to 512.
- **channels** (*Optional*): The type of data. This is used to specify if it is a ``MONO``,
``RGB`` or ``RGBW`` light and in which order the colors are. Defaults to ``RGB``.
There are three modes of operation:
- `MONO`: this supports 1 channel per LED (luminance), up-to 512 LEDs per universe
- `RGB`: this supports 3 channels per LED (RGB), up-to 170 LEDs (3*170 = 510 bytes) per universe
- `RGBW`: this supports 4 channels per LED (RGBW), up-to 128 LEDs (4*128 = 512 bytes) per universe
- ``MONO``: this supports 1 channel per LED (luminance), up-to 512 LEDs per universe
- ``RGB``: this supports 3 channels per LED (RGB), up-to 170 LEDs (3*170 = 510 bytes) per universe
- ``RGBW``: this supports 4 channels per LED (RGBW), up-to 128 LEDs (4*128 = 512 bytes) per universe
If there's more LEDs than allowed per-universe, additional universe will be used.
In the above example of 189 LEDs, first 170 LEDs will be assigned to 1 universe,
@ -858,11 +859,21 @@ the rest of 19 LEDs will be automatically assigned to 2 universe.
It is possible to enable multiple light platforms to listen to the same universe concurrently,
allowing to replicate the behaviour on multiple strips.
E1.31 Component
^^^^^^^^^^^^^^^
The :ref:`e131-light-effect` requires a component hub for the ``e131`` light effect.
Configuration variables:
- **method** (*Optional*): Listening method, one of ``multicast`` or ``unicast``. Defaults to ``multicast``.
.. _E1.31: https://www.doityourselfchristmas.com/wiki/index.php?title=E1.31_(Streaming-ACN)_Protocol
.. _JINX: http://www.live-leds.de/jinx-v1-3-with-resizable-mainwindow-real-dmx-and-sacne1-31/
Adalight
********
Adalight Effect
***************
This effect enables controlling addressable lights using UART-based
Adalight_ protocol, allowing to create realtime ambient lighting effects.
@ -899,8 +910,8 @@ Configuration variables:
.. _Adalight: https://learn.adafruit.com/adalight-diy-ambient-tv-lighting
.. _Prismatik: https://github.com/psieg/Lightpack
WLED
****
WLED Effect
***********
This effect enables controlling addressable lights using UDP-based
`UDP Realtime Control`_ protocol used by WLED_, allowing to create realtime ambient

3
components/logger.rst
View File

@ -37,6 +37,9 @@ Advanced settings:
Defaults to ``UART0``.
- **esp8266_store_log_strings_in_flash** (*Optional*, boolean): If set to false, disables storing
log strings in the flash section of the device (uses more memory). Defaults to true.
- **on_message** (*Optional*, :ref:`Automation <automation>`): An action to be
performed when a message is to be looged. The vairables ``int level``, ``const char* tag`` and
``const char* message`` are available for lambda processing.
.. _logger-hardware_uarts:

12
components/mcp230xx.rst
View File

@ -15,8 +15,8 @@ The Microchip MCP230xx series of general purpose, parallel I/O expansion for I²
.. _mcp23008-label:
MCP23008
--------
MCP23008 Component
------------------
The MCP23008 component (`datasheet <http://ww1.microchip.com/downloads/en/devicedoc/21919e.pdf>`__,
`Adafruit <https://www.adafruit.com/product/593>`__) has 8 GPIOs that can be configured independently.
@ -63,8 +63,8 @@ Configuration variables:
.. _mcp23016-label:
MCP23016
--------
MCP23016 Component
------------------
The MCP23016 component (`datasheet <http://ww1.microchip.com/downloads/en/devicedoc/20090c.pdf>`__)
has 16 GPIOs and can be configured the same way than the other variants.
@ -112,8 +112,8 @@ Configuration variables:
.. _mcp23017-label:
MCP23017
--------
MCP23017 Component
------------------
The MCP23017 component allows you to use MCP23017 I/O expanders
(`datasheet <http://ww1.microchip.com/downloads/en/devicedoc/20001952c.pdf>`__,

8
components/mcp23Sxx.rst
View File

@ -15,8 +15,8 @@ This is exactly the same API as the MCP23SXX I/O Expander except talks on the SP
.. _mcp23S08-label:
MCP23S08
--------
MCP23S08 Component
------------------
The MCP23S08 component (`datasheet <http://ww1.microchip.com/downloads/en/DeviceDoc/MCP23008-MCP23S08-Data-Sheet-20001919F.pdf>`__,
`Digi-Key <https://www.digikey.com/product-detail/en/microchip-technology/MCP23S08-E-P/MCP23S08-E-P-ND/735954>`__) has 8 GPIOs that can be configured independently.
@ -64,8 +64,8 @@ Configuration variables:
.. _mcp23S17-label:
MCP23S17
--------
MCP23S17 Component
------------------
The MCP23S17 component allows you to use MCP23S17 I/O expanders
(`datasheet <http://ww1.microchip.com/downloads/en/DeviceDoc/20001952C.pdf>`__,

2
components/mqtt.rst
View File

@ -48,7 +48,7 @@ Configuration variables:
- **topic_prefix** (*Optional*, string): The prefix used for all MQTT
messages. Should not contain trailing slash. Defaults to
``<APP_NAME>``.
- **log_topic** (*Optional*, :ref:`mqtt-message`) The topic to send MQTT log
- **log_topic** (*Optional*, :ref:`mqtt-message`): The topic to send MQTT log
messages to.
- **birth_message** (*Optional*, :ref:`mqtt-message`): The message to send when
a connection to the broker is established. See :ref:`mqtt-last_will_birth` for more information.

13
components/output/index.rst
View File

@ -39,12 +39,13 @@ Configuration variables:
automatically be switched on too.
- **inverted** (*Optional*, boolean): If the output should be treated
as inverted. Defaults to ``False``.
- **min_power** (*Optional*, float): Only for float outputs. Sets the
minimum output value of this output platform.
Must be in range from 0 to max_power. Defaults to 0.
- **max_power** (*Optional*, float): Only for float outputs. Sets the
maximum output value of this output platform.
Must be in range from min_power to 1. Defaults to 1.
Float outputs only:
- **min_power** (*Optional*, float): Sets the minimum output value of this output platform.
Must be in range from 0 to max_power. Defaults to ``0``.
- **max_power** (*Optional*, float): Sets the maximum output value of this output platform.
Must be in range from min_power to 1. Defaults to ``1``.
.. _output-turn_on_action:

33
components/output/mcp4725.rst
View File

@ -10,11 +10,10 @@ The MCP4725 output component allows to use `12bit external DAC
in order to have analog output(s) on any board by using I2C. Devices default address is ``0x60``
and configurable alternative is ``0x61``.
Example Usage with defaults
***************************
.. code-block:: yaml
# Example configuration entry
# Set a global i2c connection
i2c:
sda: 21
@ -32,34 +31,6 @@ Example Usage with defaults
id: dac_output
level: 100%
Example Usage with a custom configuration
*****************************************
.. code-block:: yaml
# Set a custom i2c connection
i2c:
- id: bus_a
sda: 21
scl: 22
scan: True
- id: bus_b
sda: 23
scl: 25
scan: True
# Set the output
output:
- platform: mcp4725
id: dac_output
address: 0x61
i2c_id: bus_b
on_...:
then:
- output.set_level:
id: dac_output
level: 100%
Configuration variables:
------------------------

70
components/output/my9231.rst
View File

@ -8,8 +8,8 @@ MY9231/MY9291 LED driver
.. _my9231-component:
Component
---------
Component/Hub
-------------
The MY9231/MY9291 component represents a MY9231/MY9291 LED diver chain
(`MY9231 description <http://www.my-semi.com.tw/file/MY9231_BF_0.91.pdf>`__,
@ -57,6 +57,40 @@ Configuration variables:
this ``my9231`` component. Use this if you have multiple MY9231/MY9291 chains
connected at the same time.
.. _my9231-output:
Output
------
The MY931/MY9291 output component exposes a MY931/MY9291 channel of a global
:ref:`my9231-component` as a float output.
.. code-block:: yaml
# Example configuration entry
my9231:
- data_pin: GPIO12
clock_pin: GPIO14
# Individual outputs
output:
- platform: my9231
id: 'my9231_output1'
channel: 0
Configuration variables:
************************
- **id** (**Required**, :ref:`config-id`): The id to use for this output component.
- **channel** (**Required**, int): Chose the channel of the MY9231/MY9291 chain of
this output component. Channel 0 is the most close channel.
- **my9231_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the
:ref:`my9231-component`.
Use this if you have multiple MY9231/MY9291 chains you want to use at the same time.
- All other options from :ref:`Output <config-output>`.
Sonoff B1 configuration example
-------------------------------
@ -172,38 +206,6 @@ And here is a complete configuration for the AiThinker AiLight:
white: output_cold_white
.. _my9231-output:
Driver Output
-------------
The MY931/MY9291 output component exposes a MY931/MY9291 channel of a global
:ref:`my9231-component` as a float output.
.. code-block:: yaml
# Example configuration entry
my9231:
- data_pin: GPIO12
clock_pin: GPIO14
# Individual outputs
output:
- platform: my9231
id: 'my9231_output1'
channel: 0
Configuration variables:
************************
- **id** (**Required**, :ref:`config-id`): The id to use for this output component.
- **channel** (**Required**, int): Chose the channel of the MY9231/MY9291 chain of
this output component. Channel 0 is the most close channel.
- **my9231_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the
:ref:`my9231-component`.
Use this if you have multiple MY9231/MY9291 chains you want to use at the same time.
- All other options from :ref:`Output <config-output>`.
See Also
--------

8
components/output/sm16716.rst
View File

@ -8,8 +8,8 @@ SM16716 LED driver
.. _sm16716-component:
Component
---------
Component/Hub
-------------
The SM16716 component represents a SM16716 LED diver chain
(`SM16716 description <https://github.com/sowbug/sm16716/blob/master/SM16716%20Datasheet%20%5BChinese%5D.pdf>`__,
@ -61,8 +61,8 @@ Configuration variables:
.. _sm16716-output:
Driver Output
-------------
Output
------
The SM16716 output component exposes a SM16716 channel of a global
:ref:`sm16716-component` as a float output.

10
components/output/template.rst
View File

@ -38,8 +38,8 @@ Configuration variables:
- **id** (**Required**, :ref:`config-id`): The id to use for this output component.
- **type** (**Required**, string): The type of output. One of ``binary`` and ``float``.
- **on_write_action** (**Required**, :ref:`Action <config-action>`): The action that should
be performed when the state of the output is updated.
- **write_action** (**Required**, :ref:`Automation <automation>`): An automation to perform
when the state of the output is updated.
- All other options from :ref:`Output <config-output>`.
See :apiclass:`output::BinaryOutput` and :apiclass:`output::FloatOutput`.
@ -51,10 +51,10 @@ See :apiclass:`output::BinaryOutput` and :apiclass:`output::FloatOutput`.
.. _output-template-on_write_action:
``output.template.on_write`` Action
-----------------------------------
``write_action`` Trigger
------------------------
When the state for this output is updated, the on_write action is executed.
When the state for this output is updated, the ``write_action`` is triggered.
It is possible to access the state value inside Lambdas:
.. code-block:: yaml

4
components/remote_receiver.rst
View File

@ -211,10 +211,10 @@ Remote code selection (exactly one of these has to be included):
remote_transmitter:
pin: 5
carrier_duty_percent: 100%
.. note::
To caputure the codes more effectively with directly connected receiver like tsop38238 you can try to use `INPUT_PULLUP`:
To caputure the codes more effectively with directly connected receiver like tsop38238 you can try to use ``INPUT_PULLUP``:
.. code-block:: yaml

22
components/sensor/apds9960.rst
View File

@ -5,6 +5,12 @@ APDS9960 Sensor
:description: Instructions for setting up APDS9960 sensors.
:image: apds9960.jpg
.. _apds9960-component:
Component/Hub
-------------
The ``apds9960`` sensor platform allows you to use your APDS9960 RGB and gesture sensors
(`datasheet <https://cdn.sparkfun.com/datasheets/Sensors/Proximity/apds9960.pdf>`__,
`SparkFun`_) with ESPHome.
@ -49,7 +55,13 @@ Base Configuration:
- **update_interval** (*Optional*, :ref:`config-time`): The interval
to check the sensor. Defaults to ``60s``.
Sensor Configuration:
Sensor
------
The ``apds9960`` sensor allows you to use your :doc:`apds9960` to perform different
measurements.
Configuration variables:
- **name** (**Required**, string): The name for the sensor.
- **type** (**Required**, string): The type of sensor measurement. One of
@ -63,7 +75,13 @@ Sensor Configuration:
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
Binary Sensor Configuration:
Binary Sensor
-------------
The ``apds9960`` binary sensor allows you to use your :doc:`apds9960` to perform different
measurements.
Configuration variables:
- **name** (**Required**, string): The name for the binary sensor.
- **direction** (**Required**, string): The direction to measure. One of:

121
components/sensor/as3935.rst
View File

@ -6,7 +6,7 @@ AMS AS3935 Franklin Lightning Sensor
:image: images/as3935.jpg
:keywords: as3935
The ``as3935`` sensor platform allows you to use your AS3935 sensor
The **AS3935** sensor platform allows you to use your AS3935 sensor
(`AliExpress`_, `AMS_AS3935`_)
in order to get notified when a thunderstorm is getting close.
@ -14,6 +14,9 @@ The AS3935 can detect the presence of lightning activity and provide an estimati
on the distance to the head of the storm. The chip issues a notification through an interrupt
pin.
Component/Hub
-------------
The AS3935 can be configured to use either the SPI **or** I²C protocol for data communication.
First choose which communication method you want to use for the sensor, set the SI pin for the appropriate
level and set up the ESPhome integration for the chosen communication method.
@ -46,17 +49,20 @@ A1 I²C address selection MSB
.. _AliExpress: https://de.aliexpress.com/af/as3935.html?SearchText=as3935
.. _AMS_AS3935: https://ams.com/as3935
Over SPI
--------
The ``as3935_spi`` sensor platform allows you to use your AS3935 sensor
(`AliExpress`_, `AMS_AS3935`_) in order to get notified when a thunderstorm is getting close.
.. code-block:: yaml
# Example configuration for SPI (decide for one!)
as3935_spi:
cs_pin: GPIO12
irq_pin: GPIO13
# Example configuration for I²C (decide for one!)
as3935_i2c:
irq_pin: GPIO12
# Example configuration for creating sensors
# Example lightning and energy sensor
sensor:
- platform: as3935
lightning_energy:
@ -68,9 +74,10 @@ A1 I²C address selection MSB
name: "Storm Alert"
Configuration variables (shared):
---------------------------------
Configuration variables:
************************
- **cs_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The chip select pin.
- **irq_pin** (**Required**, :ref:`config-pin`): The IRQ pin, which indicates if a lightning strike has been detected.
- **indoor** (*Optional*, boolean): Indicates if the sensor is used indoor. Defaults to ``true``.
- **noise_level** (*Optional*, integer): Noise floor level is compared to known reference voltage.
@ -90,34 +97,16 @@ Configuration variables (shared):
- **capacitance** (*Optional*, integer): This setting will add capacitance to the series RLC antenna on the product
to help tune its resonance. The datasheet specifies being within 3.5 percent of 500kHz to get optimal lightning
detection and distance sensing. It's possible to add up to 120pF in steps of 8pF to the antenna. Defaults to ``0``.
- **watchdog_threshold** (*Optional*, integer): Determines the threshold for events that trigger the IRQ pin.
Defaults to ``2``.
Sensor entries:
- **lightning_energy** (*Optional*): Lightning energy value. According to the datasheet this is only a pure value that doesn't have any physical meaning.
Over I²C
--------
- **name** (**Required**, string): The name for the lightning energy sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **distance** (*Optional*): Distance in km to the front of the storm and not the distance to a lightning strike.
The ``as3935_i2c`` sensor platform allows you to use your AS3935 sensor
(`AliExpress`_, `AMS_AS3935`_) in order to get notified when a thunderstorm is getting close.
- **name** (**Required**, string): The name for the distance sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **binary sensor** (*Optional*): Binary sensor that indicates if a lightning strike was detected.
- **name** (**Required**, string): The name of the binary sensor.
- **id** (*Optional*,
:ref:`config-id`): Manually specify
the ID used for code generation.
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
Configuration variables (I²C):
-------------------------------
Use this if you want to use your AS3935 in I²C mode.
.. code-block:: yaml
@ -135,33 +124,67 @@ Use this if you want to use your AS3935 in I²C mode.
- platform: as3935
name: "Storm Alert"
Configuration variables:
************************
- **address** (*Optional*, int): Manually specify the I²C address of
the sensor. Defaults to ``0x03`` (``A0` and ``A1`` pins pulled low).
Another address can be ``0x02``.
- **irq_pin** (**Required**, :ref:`config-pin`): The IRQ pin, which indicates if a lightning strike has been detected.
- **indoor** (*Optional*, boolean): Indicates if the sensor is used indoor. Defaults to ``true``.
- **noise_level** (*Optional*, integer): Noise floor level is compared to known reference voltage.
If this level is exceeded the chip will issue an interrupt to the IRQ pin, broadcasting that it can not
operate properly due to noise (INT_NH). Defaults to ``2``.
- **spike_rejection** (*Optional*, integer): Helps to differentiate between real events and actual lightning.
Increasing this value increases robustness at the cost of sensitivity to distant events. Defaults to ``2``.
- **lightning_threshold** (*Optional*, integer): The number of lightnings that must appear in a 15-minute time
window before a lightning storm is detected.
15 minutes is the window of time before the number of detected lightning events is reset.
The number of lightning strikes can be set to 1,5,9, or 16. Defaults to ``1``.
- **mask_disturber** (*Optional*, boolean): This setting will return whether or not disturbers trigger
the IRQ Pin. Defaults to ``false``.
- **div_ratio** (*Optional*, integer): The antenna is designed to resonate at 500kHz and so can be tuned
with the following setting. The accuracy of the antenna must be within 3.5 percent of that value for
proper signal validation and distance estimation. Defaults to ``0``.
- **capacitance** (*Optional*, integer): This setting will add capacitance to the series RLC antenna on the product
to help tune its resonance. The datasheet specifies being within 3.5 percent of 500kHz to get optimal lightning
detection and distance sensing. It's possible to add up to 120pF in steps of 8pF to the antenna. Defaults to ``0``.
- **watchdog_threshold** (*Optional*, integer): Determines the threshold for events that trigger the IRQ pin.
Defaults to ``2``.
Configuration variables (SPI):
------------------------------
Use this if you want to use your AS3935 in SPI mode.
Sensor
------
.. code-block:: yaml
A sensor platform to read lightning data
# Example configuration for SPI (decide for one!)
as3935_spi:
cs_pin: GPIO12
irq_pin: GPIO13
# Example lightning and energy sensor
sensor:
- platform: as3935
lightning_energy:
name: "Lightning Energy"
distance:
name: "Distance Storm"
binary_sensor:
- platform: as3935
name: "Storm Alert"
Configuration variables:
- **lightning_energy** (*Optional*): Lightning energy value. According to the datasheet this is only a pure value that doesn't have any physical meaning.
- **name** (**Required**, string): The name for the lightning energy sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **distance** (*Optional*): Distance in km to the front of the storm and not the distance to a lightning strike.
- **name** (**Required**, string): The name for the distance sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
Binary Sensor
-------------
Binary sensor that indicates if a lightning strike was detected.
Configuration variables:
- **name** (**Required**, string): The name of the binary sensor.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
- **cs_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The chip select pin.
See Also
--------

13
components/sensor/custom.rst
View File

@ -76,7 +76,7 @@ Let's now also take a closer look at this line, which you might not be too used
.. code-block:: cpp
class MyCustomSensor : public Component, public Sensor {
class MyCustomSensor : public Component, public Sensor {
What this line is essentially saying is that we're defining our own class that's called ``MyCustomSensor``
which is also a subclass of :apiclass:`Component` and :apiclass:`Sensor <sensor::Sensor>`.
@ -137,7 +137,7 @@ One last thing. Some sensors, such as the BMP180 were are going to explain later
.. code-block:: cpp
float get_setup_priority() const override { return esphome::setup_priority::HARDWARE; }
Where HARDWARE can be any of:
.. code-block:: cpp
@ -161,7 +161,7 @@ Where HARDWARE can be any of:
extern const float AFTER_CONNECTION;
/// For components that should be initialized at the very end of the setup process.
extern const float LATE;
Now don't let the wording confuse you. The ``get_setup_priority()`` method is an override. Instead of fetching the setup priority setup for us, it instead fetches the setup priority for esphome, while being defined by us. The BMP180 would for instance need to be setup with a priority of IO or lower. A serial streaming (TCP) server would require a working WIFI setup and therefore get AFTER_WIFI.
This finalizes our example as:
@ -172,9 +172,9 @@ This finalizes our example as:
public:
// constructor
MyCustomSensor() : PollingComponent(15000) {}
float get_setup_priority() const override { return esphome::setup_priority::XXXX; }
void setup() override {
// This will be called by App.setup()
}
@ -182,7 +182,7 @@ This finalizes our example as:
// This will be called every "update_interval" milliseconds.
}
};
Step 2: Registering the custom sensor
-------------------------------------
@ -403,6 +403,7 @@ Note that the number of arguments you put in the curly braces *must* match the n
``sensors:`` block - *and* they must be in the same order.
Configuration variables:
************************
- **lambda** (**Required**, :ref:`lambda <config-lambda>`): The lambda to run for instantiating the
sensor(s).

4
components/sensor/dallas.rst
View File

@ -45,8 +45,8 @@ Configuration variables:
.. _dallas-sensor:
Sensors
-------
Sensor
------
The ``dallas`` sensor allows you to use DS18B20 and similar sensors.
First, you need to define a :ref:`dallas sensor component <dallas-component>`.

24
components/sensor/mcp3008.rst
View File

@ -8,15 +8,17 @@ MCP3008 I/O Expander
The Microchip Technology Inc. MCP3008
devices are successive approximation 10-bit Analogto-Digital (A/D) converters with on-board sample and
hold circuitry.
hold circuitry.
.. figure:: images/mcp3008.jpg
:align: center
:width: 50.0%
MCP3008
-------
.. _mcp3008-component:
Component/Hub
-------------
The MCP3008 component allows you to use MCP3008 8-Channel 10-Bit A/D Converter
(`datasheet <http://ww1.microchip.com/downloads/en/DeviceDoc/21295d.pdf>`__,
@ -65,14 +67,20 @@ If you want just the scaled value you can use the read_data function
name: Freezer Temperature
Configuration variables:
~~~~~~~~~~~~~~~~~~~~~~~~
MCP3008 Component
*****************
- **id** (**Required**, :ref:`config-id`): The id to use for this MCP3008 component.
- **cs_pin** (**Required**, int): The SPI cable select pin to use
MCP3008 Sensor Component
************************
Sensor
------
The ``mcp3008`` sensor allows you to use your MCP3008 10-Bit A/D Converter sensors with ESPHome.
First, setup a :ref:`MCP3008 Hub <mcp3008-component>` for your MCP3008 sensor and then use this
sensor platform to create individual sensors that will report the voltage to Home Assistant.
Configuration variables:
- **id** (**Required**, :ref:`config-id`): The id of the parent MCP3008 component.
- **number** (**Required**, int): The pin number of the MCP3008
- **reference_voltage** (*Optional*, float): The reference voltage. Defaults to ``3.3V``.

10
components/sensor/mcp9808.rst
View File

@ -32,15 +32,11 @@ required to be set up in your configuration for this sensor to work.
Configuration variables:
------------------------
- **temperature** (**Required**): The information for the temperature sensor.
- **name** (**Required**, string): The name for the temperature sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **name** (**Required**, string): The name for the temperature sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x18``.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``.
- All other options from :ref:`Sensor <config-sensor>`.
See Also
--------

2
components/sensor/ruuvitag.rst
View File

@ -129,7 +129,7 @@ Configuration variables:
- All other options from :ref:`Sensor <config-sensor>`.
- Only available if RAWv2 protocol is used.
- **movement_count** (*Optional*): The information for the movement count
- **movement_counter** (*Optional*): The information for the movement count
sensor
- **name** (**Required**, string): The name for the movement count sensor.

4
components/sensor/tmp117.rst
View File

@ -34,8 +34,8 @@ If accuracy is a must, see section 8.2.2.2 of the `datasheet <https://www.ti.com
name: "Living Room Temperature"
update_interval: 60s
Configuration variables
-----------------------
Configuration variables:
------------------------
- **name** (**Required**, string): The name for the temperature sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for lambdas/multiple sensors.

78
components/stepper/index.rst
View File

@ -16,8 +16,27 @@ and ULN2003 (`datasheet <http://www.ti.com/lit/ds/symlink/uln2003a.pdf>`__) are
This component will not show up in the Home Assistant front-end automatically because
Home Assistant doesn't have support for steppers. Please see :ref:`stepper-ha-config`.
A4988 Configuration
-------------------
.. _base_stepper_config:
Base Stepper Configuration
--------------------------
All stepper configuration schemas inherit these options.
Configuration variables:
- **max_speed** (**Required**, float): The maximum speed in ``steps/s`` (steps per seconds) to drive the
stepper at. Note most steppers can't step properly with speeds higher than 250 steps/s.
- **acceleration** (*Optional*, float): The acceleration in ``steps/s^2`` (steps per seconds squared)
to use when starting to move. The default is ``inf`` which means infinite acceleration, so the
stepper will try to drive with the full speed immediately. This value is helpful if that first motion of
the motor is too jerky for what it's moving. If you make this a small number, it will take the motor a
moment to get up to speed.
- **deceleration** (*Optional*, float): The same as ``acceleration``, but for when the motor is decelerating
shortly before reaching the set position. Defaults to ``inf`` (immediate deceleration).
A4988 Component
---------------
Put this code into the configuration file on ESPhome for this device.
@ -43,16 +62,11 @@ Configuration variables:
stepper driver.
- **dir_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The ``DIRECTION`` pin of the A4988
stepper driver.
- **max_speed** (**Required**, float): The maximum speed in ``steps/s`` (steps per seconds) to drive the
stepper at. Note most steppers can't step properly with speeds higher than 250 steps/s.
- **sleep_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): Optionally also use the ``SLEEP`` pin
of the A4988 stepper driver. If specified, the driver will be put into sleep mode as soon as the stepper
reaches the target steps.
- **acceleration** (*Optional*, float): The acceleration in ``steps/s^2`` (steps per seconds squared)
to use when starting to move. The default is ``inf`` which means infinite acceleration, so the
stepper will try to drive with the full speed immediately.
- **deceleration** (*Optional*, float): The same as ``acceleration``, but for when the motor is decelerating
shortly before reaching the set position. Defaults to ``inf`` (immediate deceleration).
- All other from :ref:`base_stepper_config`.
.. note::
@ -67,8 +81,8 @@ Configuration variables:
number: D1
inverted: True
ULN2003 Configuration
---------------------
ULN2003 Component
-----------------
Put this code into the configuration file on ESPHome for this device.
@ -92,8 +106,10 @@ Put this code into the configuration file on ESPHome for this device.
Configuration variables:
- **id** (**Required**, :ref:`config-id`): Specify the ID of the stepper so that you can control it.
- **pin_a**, **pin_b**, **pin_c**, **pin_d** (**Required**, :ref:`Pin Schema <config-pin_schema>`):
The four pins of the stepper control board.
- **pin_a** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The pin **a** of the stepper control board.
- **pin_b** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The pin **b** of the stepper control board.
- **pin_c** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The pin **c** of the stepper control board.
- **pin_d** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The pin **d** of the stepper control board.
- **sleep_when_done** (*Optional*, boolean): Whether to turn off all coils when the stepper has
reached the target position
- **step_mode** (*Optional*, string): The step mode to operate the motor with. One of:
@ -102,15 +118,7 @@ Configuration variables:
- ``HALF_STEP``
- ``WAVE_DRIVE``
- **max_speed** (**Required**, float): The maximum speed in ``steps/s`` (steps per seconds) to drive the
stepper at. Note most steppers can't step properly with speeds higher than 250 steps/s.
- **acceleration** (*Optional*, float): The acceleration in ``steps/s^2`` (steps per seconds squared)
to use when starting to move. The default is ``inf`` which means infinite acceleration, so the
stepper will try to drive with the full speed immediately. This value is helpful if that first motion of
the motor is too jerky for what it's moving. If you make this a small number, it will take the motor a
moment to get up to speed.
- **deceleration** (*Optional*, float): The same as ``acceleration``, but for when the motor is decelerating
shortly before reaching the set position. Defaults to ``inf`` (immediate deceleration).
- All other from :ref:`base_stepper_config`.
.. _stepper-set_target_action:
@ -141,7 +149,7 @@ position (in steps). The stepper will always run towards the target position and
Configuration options:
- **id** (**Required**, :ref:`config-id`): The ID of the stepper.
- **target** (*Optional*, int, :ref:`templatable <config-templatable>`): The target position in steps.
- **target** (**Required**, int, :ref:`templatable <config-templatable>`): The target position in steps.
.. warning::
@ -195,10 +203,10 @@ the target again.
return -1000;
}
Configuration options:
Configuration variables:
- **id** (**Required**, :ref:`config-id`): The ID of the stepper.
- **target** (*Optional*, int, :ref:`templatable <config-templatable>`): The target position in steps.
- **position** (**Required**, int, :ref:`templatable <config-templatable>`): The position to report in steps.
.. _stepper-set_speed_action:
@ -225,11 +233,11 @@ Configuration variables:
Home Assistant Configuration
----------------------------
This component will not show up in the Home Assistant front-end (Overview) automatically because
This component will not show up in the Home Assistant front-end (Overview) automatically because
Home Assistant does not support steppers natively.
You can add the stepper component code below to your Home Assistant configuration (``configuration.yaml``) to
be able to control the stepper from the front-end.
be able to control the stepper from the front-end.
.. code-block:: yaml
@ -242,7 +250,7 @@ be able to control the stepper from the front-end.
max: 1000
step: 1
mode: slider
# Do something when the slider changes
automation:
- alias: Write Stepper Value to ESP
@ -255,18 +263,18 @@ be able to control the stepper from the front-end.
data_template:
target: '{{ trigger.to_state.state | int }}'
In the above code, "stepper_control" is the ID of a numeric input field. It must be unique and it is
used in the automation section as a reference name. The display name for this field is in
stepper_control's ``name`` key.
In the above code, "stepper_control" is the ID of a numeric input field. It must be unique and it is
used in the automation section as a reference name. The display name for this field is in
stepper_control's ``name`` key.
If you want your user interface to give you more control over your stepper controller, such as
If you want your user interface to give you more control over your stepper controller, such as
setting the acceleration, deceleration, etc, then you can add more input fields after ``stepper_control``
but before ``automation``. They can be a simple number-entry field (mode: box) or a slider like this.
Each of these extra input fields needs an associated input parameter defined on the ESPHome device's
API service.
The automation section tells Home Assistant what to do when the slider changes. It needs a trigger
(state of the ``stepper_control`` slider) and an action. In the trigger section, ``entity_id`` must refer
(state of the ``stepper_control`` slider) and an action. In the trigger section, ``entity_id`` must refer
back to the configuration ID that triggers the automation. For us, that is the ``stepper_control``
field in the ``input_number`` item. That's why the value is ``input_number.stepper_control``.
@ -276,7 +284,7 @@ the correct syntax is to join the device ID to the API service ID with an unders
as in ``esphome.livingroom_control_stepper`` where "Livingroom" is a device in ESPHome and "control_stepper" is an
API service for that device.
The template string is used to get the "state" value from the ``target`` field (defined in the target section) on the
The template string is used to get the "state" value from the ``target`` field (defined in the target section) on the
``input_number`` component of the Home Assistant front-end. This value is then passed to the API service as defined in
the ESPHome device's configuration. The ``data_template`` section lists one value for each of the input parameters on
the service being called by the automation. In our case, the ESPHome device has an API service with a single parameter,
@ -285,7 +293,7 @@ Getting this linkage right is very important.
The following code needs to go in the ESPHome configuration file for this device. Above, we mention "API service"
a lot. This code is where that is defined. You may have already added it (or something similar). Note
that the input variable for the ``control_stepper`` service is called ``target``. That's what matches with the
that the input variable for the ``control_stepper`` service is called ``target``. That's what matches with the
automation configuration above. Also note that the variable ``target`` is defined as an integer. That means it
must be an integer number, not a string.

8
components/sun.rst
View File

@ -57,8 +57,8 @@ Automation:
- **elevation** (*Optional*, float): The elevation to cross. Defaults to 0° (horizon).
Sensor Platform
---------------
``sun`` Sensor
--------------
Additionally, the sun component exposes its values over a sensor platform.
@ -85,8 +85,8 @@ Configuration variables:
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Sensor <config-sensor>`.
Text Sensor Platform
--------------------
``sun`` Text Sensor
-------------------
Other properties like the next sunset time can be read out with the sun text_sensor platform.

13
components/sx1509.rst
View File

@ -41,8 +41,8 @@ complicated components that use the pin schema will not work. For example the I
scan_time: 2
debounce_time: 1
Configuration variables for the SX1509 device:
----------------------------------------------
Configuration variables:
------------------------
- **id** (**Required**, :ref:`config-id`): The id to use for this SX1509 component.
- **address** (*Optional*, int): The I²C address of the driver.
@ -53,7 +53,7 @@ up to 8x8 matrix (i.e. 64 keys).
- **keypad** (*Optional*): Add this to enable the keypad.
- **key_row** (**Required**, int): The number of keypad rows to use. This enables any number of the first 7 pins.
- **key_rows** (**Required**, int): The number of keypad rows to use. This enables any number of the first 7 pins.
So a value of 3 enables pins 0,1,2 to be used as the rows for the keypad matrix. This value must be between 1 and 8.
- **key_columns** (**Required**, int): The number of keypad columns to use. This enables any number of the last 7 pins.
So a value of 4 enables pins 8,9,10,11 to be used as the columns for the keypad matrix. This value must be between 1 and 8.
@ -108,6 +108,9 @@ Attention should be paid to the capabilities of the I/O pins.
| 15 | ✓ | | ✓ |
+-----+------------------+-----+--------+
Binary Sensor
-------------
To use the individual keys on the keypad you need to add individual binary_sensor entries in the config.
.. code-block:: yaml
@ -125,8 +128,8 @@ To use the individual keys on the keypad you need to add individual binary_senso
row: 0
col: 1
Configuration variables for the SX1509 keypad keys:
---------------------------------------------------
Configuration variables:
------------------------
- **row** (**Required**, int): The row number for this key on the keypad.
- **col** (**Required**, int): The column number for this key on the keypad.

6
components/time.rst
View File

@ -215,8 +215,8 @@ Configuration variables:
- All other from :ref:`base_time_config`.
SNTP Configuration
------------------
SNTP Time Source
----------------
.. code-block:: yaml
@ -234,7 +234,7 @@ Configuration variables:
.. note::
If your are using :ref:`wifi-manual_ip` make sure to configure a DNS Server (dns1, dns2) or use only IP addresses for the NTP servers.
.. warning::
Due to limitations of the SNTP implementation, this component will trigger ``on_time_sync`` only once when it detects that the

2
components/wifi.rst
View File

@ -38,7 +38,7 @@ Configuration variables:
that is reachable will be connected to. See :ref:`wifi-networks`.
- **manual_ip** (*Optional*): Manually configure the static IP of the node.
- **static_ip** (**Required***, IPv4 address): The static IP of your node.
- **static_ip** (**Required**, IPv4 address): The static IP of your node.
- **gateway** (**Required**, IPv4 address): The gateway of the local network.
- **subnet** (**Required**, IPv4 address): The subnet of the local network.
- **dns1** (*Optional*, IPv4 address): The main DNS server to use.

0
components/text_sensor/uart.rst → cookbook/uart_text_sensor.rst
View File

3
custom/custom_component.rst
View File

@ -54,6 +54,9 @@ Configuration variables:
- **lambda** (**Required**, :ref:`lambda <config-lambda>`): The lambda to run for instantiating the
binary sensor(s).
- **components** (*Optional*, list): A list of components to initialize. The length here
must equal the number of items in the ``return`` statement of the ``lambda``. This is useful
if you need to give an ``id`` to the component you created.
See also :apiclass:`Component`.

24
guides/automations.rst
View File

@ -256,8 +256,8 @@ all of the usual lambda syntax.
.. _config-globals:
Bonus 2: Global Variables
*************************
Global Variables
----------------
In some cases you might require to share a global variable across multiple lambdas. For example,
global variables can be used to store the state of a garage door.
@ -284,7 +284,7 @@ global variables can be used to store the state of a garage door.
ESP_LOGD(TAG, "Global value is: %d", id(my_global_int));
Configuration options:
Configuration variables:
- **id** (**Required**, :ref:`config-id`): Give the global variable an ID so that you can refer
to it later in :ref:`lambdas <config-lambda>`.
@ -300,7 +300,7 @@ Configuration options:
.. _automation-networkless:
Do Automations Work Without a Network Connection
************************************************
------------------------------------------------
YES! All automations you define in ESPHome are execute on the ESP itself and will continue to
work even if the WiFi network is down or the MQTT server is not reachable.
@ -517,7 +517,7 @@ turns on a light for 5 seconds. Otherwise, the light is turned off immediately.
- light.turn_off: my_light
Configuration options:
Configuration variables:
- **condition** (**Required**, :ref:`config-condition`): The condition to check which branch to take. See :ref:`Conditions <config-condition>`.
- **then** (*Optional*, :ref:`config-action`): The action to perform if the condition evaluates to true.
@ -545,7 +545,7 @@ a block until a given condition evaluates to false.
- light.toggle: some_light
- delay: 5s
Configuration options:
Configuration variables:
- **condition** (**Required**): The condition to check whether to execute. See :ref:`Conditions <config-condition>`.
- **then** (**Required**, :ref:`config-action`): The action to perform until the condition evaluates to false.
@ -610,8 +610,8 @@ Configuration variables:
variable to.
``script``
----------
``script`` Component
--------------------
With the ``script:`` component you can define a list of steps in a central place, and then
execute the script with a single call.
@ -627,7 +627,7 @@ execute the script with a single call.
- switch.turn_off: my_switch
Configuration options:
Configuration variables:
- **id** (**Required**, :ref:`config-id`): The :ref:`config-id` of the script. Use this
to interact with the script using the script actions.
@ -759,8 +759,8 @@ Configuration variables:
.. _interval:
``interval``
------------
``interval`` Component
----------------------
This component allows you to run actions at fixed time intervals.
For example if you want to toggle a switch every minute, you can use this component.
@ -775,7 +775,7 @@ trigger, but this technique is more light-weight and user-friendly.
then:
- switch.toggle: relay_1
Configuration options:
Configuration variables:
- **interval** (**Required**, :ref:`config-time`): The interval to execute the action with.
- **then** (**Required**, :ref:`config-action`): The action to perform.

19
guides/configuration-types.rst
View File

@ -108,25 +108,6 @@ More exotic Pin Modes are also supported, but rarely used:
- ``FUNCTION_5`` (only on ESP32)
- ``FUNCTION_6`` (only on ESP32)
.. _config-color:
Color
-----
When using RGB-capable displays or LEDs/lighting in ESPHome you may wish to use custom colors.
A ``color`` component exists for just this purpose:
.. code-block:: yaml
color:
- id: my_light_red
red: 100%
green: 20%
blue: 25%
white: 0%
RGB displays use red, green, and blue, while grayscale displays may use white. LEDs or LED-based light bulbs
may use all four color elements depending on their capabilities.
.. _config-time:

BIN
images/inkplate.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 32 KiB

4
index.rst
View File

@ -293,7 +293,7 @@ Display Components
ST7789V, components/display/st7789v, st7789v.jpg
ILI9341, components/display/ili9341, ili9341.jpg
Waveshare E-Paper, components/display/waveshare_epaper, waveshare_epaper.jpg
Inkplate 6, components/display/Inkplate, Inkplate.jpg
Inkplate 6, components/display/inkplate, inkplate.jpg
PCD8544 (Nokia 5110/ 3310), components/display/pcd8544, pcd8544.jpg
Cover Components
@ -320,7 +320,6 @@ Text Sensor Components
BLE Scanner, components/text_sensor/ble_scanner, bluetooth.svg
Template Text Sensor, components/text_sensor/template, description.svg
Custom Text Sensor, components/text_sensor/custom, language-cpp.svg
Custom UART Text Sensor, components/text_sensor/uart, language-cpp.svg
Climate Components
------------------
@ -412,6 +411,7 @@ Cookbook
Sonoff light switch options, cookbook/sonoff-light-switch, light_switch.png
ESP32 Water Leak Detector, cookbook/leak-detector-m5stickC, leak-detector-m5stickC_main_index.jpg
IAQ (Indoor Air Quality) Board, cookbook/iaq_board, iaq_board2.jpg
Custom UART Text Sensor, cookbook/uart_text_sensor, language-cpp.svg
Do you have other awesome automations or cool setups? Please feel free to add them to the
documentation for others to copy. See :doc:`Contributing </guides/contributing>`.