esphome-docs/components/sensor/tuya.rst
Jesse Hills 9892a0fce9
[sensor] Tidy up name/id (#4150)
* [sensor] Tidy up name/id

* Add missing line

* Add missing line to sen5x
2024-08-13 21:33:05 -05:00

48 lines
1.4 KiB
ReStructuredText

Tuya Sensor
===========
.. seo::
:description: Instructions for setting up a Tuya device sensor.
:image: tuya.png
The ``tuya`` sensor platform creates a sensor from a tuya component
and requires :doc:`/components/tuya` to be configured.
.. code-block:: text
[13:46:01][C][tuya:023]: Tuya:
[13:46:01][C][tuya:032]: Datapoint 1: switch (value: OFF)
[13:46:01][C][tuya:032]: Datapoint 2: switch (value: OFF)
[13:46:01][C][tuya:034]: Datapoint 3: int value (value: 19)
[13:46:01][C][tuya:034]: Datapoint 4: int value (value: 17)
[13:46:01][C][tuya:034]: Datapoint 5: int value (value: 0)
[13:46:01][C][tuya:036]: Datapoint 7: enum (value: 1)
[13:46:01][C][tuya:046]: Product: '{"p":"ynjanlglr4qa6dxf","v":"1.0.0","m":0}'
On this controller, the datapoint 5 represents the countdown timer in minutes
which is what we are interested in reading using this platform.
Based on this, you can create the sensor as follows:
.. code-block:: yaml
# Create a sensor
sensor:
- platform: "tuya"
name: "MySensor"
sensor_datapoint: 5
Configuration variables:
------------------------
- **sensor_datapoint** (**Required**, int): The datapoint id number of the sensor.
- All other options from :ref:`Sensor <config-sensor>`.
See Also
--------
- :doc:`/components/tuya`
- :doc:`/components/sensor/index`
- :apiref:`tuya/sensor/tuya_sensor.h`
- :ghedit:`Edit`