mirror of
https://github.com/esphome/esphome-docs.git
synced 2025-02-28 03:41:57 +01:00
Add documentation for new Tuya cover component (#1466)
This commit is contained in:
parent
b000524b55
commit
08d76a66aa
80
components/cover/tuya.rst
Normal file
80
components/cover/tuya.rst
Normal file
@ -0,0 +1,80 @@
|
||||
Tuya Cover
|
||||
==========
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up a Tuya cover motor.
|
||||
|
||||
The ``tuya`` cover platform creates a simple position-only cover from a
|
||||
tuya serial component.
|
||||
|
||||
There are two components, the Tuya bus and the cover that uses it. The :doc:`/components/tuya`
|
||||
component requires a :ref:`UART bus <uart>` to be configured. Put the ``tuya`` component in
|
||||
the config and it will list the possible devices for you in the config log.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
# Make sure your WiFi will connect
|
||||
wifi:
|
||||
ssid: "ssid"
|
||||
password: "password"
|
||||
|
||||
# Make sure logging is not using the serial port
|
||||
logger:
|
||||
baud_rate: 0
|
||||
|
||||
# Enable Home Assistant API
|
||||
api:
|
||||
|
||||
# Make sure you can upload new firmware OTA
|
||||
ota:
|
||||
|
||||
# My dimmer used the hardware serial port on the alternate pins
|
||||
uart:
|
||||
rx_pin: GPIO13
|
||||
tx_pin: GPIO15
|
||||
baud_rate: 9600
|
||||
|
||||
# Register the Tuya MCU connection
|
||||
tuya:
|
||||
|
||||
Here is an example output for a Tuya dimmer:
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
[21:50:28][C][tuya:024]: Tuya:
|
||||
[21:50:28][C][tuya:031]: Datapoint 2: int value (value: 53)
|
||||
[21:50:28][C][tuya:029]: Datapoint 5: switch (value: OFF)
|
||||
|
||||
On this cover motor, the position control is datapoint 2.
|
||||
Now you can create the cover.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Create a cover using the dimmer
|
||||
cover:
|
||||
- platform: "tuya"
|
||||
name: "motor1"
|
||||
position_datapoint: 2
|
||||
|
||||
Configuration variables:
|
||||
------------------------
|
||||
|
||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
||||
- **name** (**Required**, string): The name of the cover.
|
||||
- **position_datapoint** (**Required**, int): The datapoint id number of the cover position value.
|
||||
- **min_value** (*Optional*, int, default 0): The lowest position value, meaning cover closed.
|
||||
- **max_value** (*optional*, int, default 255): the highest position value, meaning cover opened.
|
||||
- **invert_position** (*optional*, boolean): invert the meaning of ``min_value`` and ``max_value``.
|
||||
When set to ``true``, ``min_value`` will mean opened and ``max_value`` is closed.
|
||||
- All other options from :ref:`Cover <config-cover>`.
|
||||
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :doc:`/components/tuya`
|
||||
- :doc:`/components/cover/index`
|
||||
- :apiref:`tuya/cover/tuya_cover.h`
|
||||
- :ghedit:`Edit`
|
||||
|
@ -502,6 +502,7 @@ Cover Components
|
||||
Time-Based Cover, components/cover/time_based, timer.svg
|
||||
Custom Cover, components/cover/custom, language-cpp.svg
|
||||
AM43 Cover, components/cover/am43, am43.jpg
|
||||
Tuya Cover, components/cover/tuya, tuya.png
|
||||
|
||||
Text Sensor Components
|
||||
----------------------
|
||||
|
Loading…
Reference in New Issue
Block a user