mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-12-25 17:17:54 +01:00
Add Yashima Climate component docs (#275)
* new yashima climate component docs * updated main index
This commit is contained in:
parent
72d455dcaa
commit
0a3ad5416f
52
components/climate/yashima.rst
Normal file
52
components/climate/yashima.rst
Normal file
@ -0,0 +1,52 @@
|
||||
Yashima Remote Climate
|
||||
======================
|
||||
|
||||
.. seo::
|
||||
:description: Controls a Yashima compatible Climate via IR
|
||||
:image: air-conditioner.png
|
||||
|
||||
The ``yashima`` climate platform allows you to control a Yashima compatible AC unit by sending IR signals
|
||||
as your remote unit would do.
|
||||
|
||||
This component requires that you have setup a :doc:`/components/remote_transmitter`.
|
||||
|
||||
Due to the unidirectional nature of IR remote controllers, this component cannot determine the
|
||||
actual state of the device, and will assume the state of the device is the latest state requested.
|
||||
|
||||
.. figure:: images/climate-ui.png
|
||||
:align: center
|
||||
:width: 60.0%
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
remote_transmitter:
|
||||
pin: GPIO32
|
||||
carrier_duty_percent: 50%
|
||||
|
||||
climate:
|
||||
- platform: yashima
|
||||
name: "Living Room AC"
|
||||
|
||||
Configuration variables:
|
||||
------------------------
|
||||
|
||||
- **name** (**Required**, string): The name for the climate.
|
||||
- **supports_cool** (*Optional*, boolean): Enables setting cool mode for this climate device. Defaults to ``True``.
|
||||
- **supports_heat** (*Optional*, boolean): Enables setting cool heat for this climate device. Defaults to ``True``.
|
||||
- **sensor** (*Optional*, :ref:`config-id`): The sensor that is used to measure the ambient
|
||||
temperature. This is only for reporting the current temperature in the frontend.
|
||||
- All other options from :ref:`Climate <config-climate>`.
|
||||
|
||||
Advanced options:
|
||||
|
||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
||||
- **transmitter_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the remote transmitter.
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :doc:`/components/climate/index`
|
||||
- :doc:`/components/remote_transmitter`
|
||||
- :apiref:`yashima/yashima.h`
|
||||
- :ghedit:`Edit`
|
@ -269,6 +269,7 @@ Climate Components
|
||||
Custom Climate, components/climate/custom, language-cpp.svg
|
||||
Coolix IR Remote, components/climate/coolix, air-conditioner.svg
|
||||
Tcl112 IR Remote, components/climate/tcl112, air-conditioner.svg
|
||||
Yashima IR Remote, components/climate/yashima, air-conditioner.svg
|
||||
|
||||
Misc Components
|
||||
---------------
|
||||
|
Loading…
Reference in New Issue
Block a user