mirror of
https://github.com/esphome/esphome-docs.git
synced 2025-01-11 20:02:12 +01:00
merge all ir climates in a single doc (#385)
* merge all ir climates in a single doc * Add links to h headers * Run svgo over SVG Optional, but removes the inkscape metadata * Update seo image * Link to FAQ Don't want to have people open those in the normal repo. * Add explicit no to the table * Sort configuration variables by assumed use frequency * Update tag * Add more info to Using a Receiver * Minor change Co-authored-by: Otto Winter <otto@otto-winter.com>
This commit is contained in:
Guillermo Ruffino
GitHub
parent
dd754ca63f
commit
f0b82ad1a0
@ -1,80 +0,0 @@
|
||||
Coolix IR Remote Climate
|
||||
========================
|
||||
|
||||
.. seo::
|
||||
:description: Controls a Coolix compatible Climate via IR
|
||||
:image: air-conditioner.png
|
||||
|
||||
The ``coolix`` climate platform allows you to control a Coolix 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.
|
||||
|
||||
Optionally you can add a :doc:`/components/remote_receiver` component so the climate state will be
|
||||
tracked when it is operated with the original remote controller unit.
|
||||
|
||||
.. 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: coolix
|
||||
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 heat mode 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.
|
||||
- **receiver_id** (*Optional*, :ref:`config-id`): The remote_receiver id, see: :ref:`coolix-receiver_id`.
|
||||
- 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.
|
||||
|
||||
.. _coolix-receiver_id:
|
||||
|
||||
Using a receiver
|
||||
----------------
|
||||
|
||||
When using a receiver it is recommended to put the IR receiver as close as possible to the equipment's
|
||||
IR receiver.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
remote_receiver:
|
||||
id: rcvr
|
||||
pin:
|
||||
number: GPIO14
|
||||
inverted: True
|
||||
mode: INPUT_PULLUP
|
||||
tolerance: 55 # high tolerance required for some remote control units
|
||||
|
||||
climate:
|
||||
- platform: coolix
|
||||
name: "Living Room AC"
|
||||
receiver_id: rcvr
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :doc:`/components/climate/index`
|
||||
- :doc:`/components/remote_transmitter`
|
||||
- :apiref:`coolix/coolix.h`
|
||||
- :ghedit:`Edit`
|
||||
@ -1,52 +0,0 @@
|
||||
Fujitsu General Remote Climate
|
||||
==============================
|
||||
|
||||
.. seo::
|
||||
:description: Controls a Fujitsu General compatible Climate via IR
|
||||
:image: air-conditioner.png
|
||||
|
||||
The ``fujitsu_general`` climate platform allows you to control a Fujitsu General 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: fujitsu_general
|
||||
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:`fujitsu_general/fujitsu_general.h`
|
||||
- :ghedit:`Edit`
|
||||
112
components/climate/ir_climate.rst
Normal file
112
components/climate/ir_climate.rst
Normal file
@ -0,0 +1,112 @@
|
||||
IR Remote Climate
|
||||
=================
|
||||
|
||||
.. seo::
|
||||
:description: Controls a variety of compatible Climate via IR
|
||||
:image: air-conditioner-ir.png
|
||||
|
||||
The climate component allows you to control a variety of compatible AC units by sending IR signals
|
||||
as your remote unit would do.
|
||||
|
||||
.. figure:: images/climate-ui.png
|
||||
:align: center
|
||||
:width: 60.0%
|
||||
|
||||
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 |
|
||||
+------------------------+---------------------+----------------------+
|
||||
| Fujitsu General | ``fujitsu_general`` | no |
|
||||
+------------------------+---------------------+----------------------+
|
||||
| Mitsubishi | ``mitsubishi`` | no |
|
||||
+------------------------+---------------------+----------------------+
|
||||
| TCL112, Fuego | ``tcl112`` | yes |
|
||||
+------------------------+---------------------+----------------------+
|
||||
| Yashima | ``yashima`` | no |
|
||||
+------------------------+---------------------+----------------------+
|
||||
|
||||
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.
|
||||
|
||||
However, when receiver is supported, you can optionally you can add a
|
||||
:doc:`/components/remote_receiver` component so the climate state will be tracked when it is operated
|
||||
with the original remote controller unit.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
remote_transmitter:
|
||||
pin: GPIO32
|
||||
carrier_duty_percent: 50%
|
||||
|
||||
climate:
|
||||
- platform: coolix # adjust to match your AC unit!
|
||||
name: "Living Room AC"
|
||||
|
||||
Configuration variables:
|
||||
------------------------
|
||||
|
||||
- **name** (**Required**, string): The name for the climate device.
|
||||
- **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.
|
||||
- **supports_cool** (*Optional*, boolean): Enables setting cooling mode for this climate device. Defaults to ``True``.
|
||||
- **supports_heat** (*Optional*, boolean): Enables setting heating mode for this climate device. Defaults to ``True``.
|
||||
- **receiver_id** (*Optional*, :ref:`config-id`): The id of the remote_receiver if this platform supports
|
||||
receiver. see: :ref:`ir-receiver_id`.
|
||||
- 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.
|
||||
|
||||
.. _ir-receiver_id:
|
||||
|
||||
Using a Receiver
|
||||
----------------
|
||||
|
||||
.. note::
|
||||
|
||||
This is only supported with select climate devices, see "Supports receiver" in the table at the top of the page.
|
||||
|
||||
Optionally, some platforms can listen to data the climate device sends over infrared to update their state (
|
||||
for example what mode the device is in). By setting up a :doc:`remote_receiver </components/remote_receiver>`
|
||||
and passing its ID to the climate platform you can enable this mode.
|
||||
|
||||
When using a receiver it is recommended to put the IR receiver as close as possible to the equipment's
|
||||
IR receiver.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
remote_receiver:
|
||||
id: rcvr
|
||||
pin:
|
||||
number: GPIO14
|
||||
inverted: True
|
||||
mode: INPUT_PULLUP
|
||||
tolerance: 55% # high 55% tolerance is recommended for some remote control units
|
||||
|
||||
climate:
|
||||
- platform: coolix
|
||||
name: "Living Room AC"
|
||||
receiver_id: rcvr
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :doc:`/components/climate/index`
|
||||
- :doc:`/components/remote_transmitter`
|
||||
- :apiref:`coolix.h <coolix/coolix.h>`,
|
||||
:apiref:`fujitsu_general.h <fujitsu_general/fujitsu_general.h>`,
|
||||
:apiref:`mitsubishi.h <mitsubishi/mitsubishi.h>`,
|
||||
:apiref:`tcl112.h <tcl112/tcl112.h>`,
|
||||
:apiref:`yashima.h <yashima/yashima.h>`
|
||||
- :ghedit:`Edit`
|
||||
@ -1,77 +0,0 @@
|
||||
Tcl112 Remote Climate
|
||||
=====================
|
||||
|
||||
.. seo::
|
||||
:description: Controls a Tcl112 compatible Climate via IR
|
||||
:image: air-conditioner.png
|
||||
|
||||
The ``tcl112`` climate platform allows you to control a TCL112 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: tcl112
|
||||
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 heat mode 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.
|
||||
- **receiver_id** (*Optional*, :ref:`config-id`): The remote_receiver id, see: :ref:`tcl112-receiver_id`.
|
||||
- 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.
|
||||
|
||||
.. _tcl112-receiver_id:
|
||||
|
||||
Using a receiver
|
||||
----------------
|
||||
|
||||
When using a receiver it is recommended to put the IR receiver as close as possible to the equipment's
|
||||
IR receiver.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Example configuration entry
|
||||
remote_receiver:
|
||||
id: rcvr
|
||||
pin:
|
||||
number: GPIO14
|
||||
inverted: True
|
||||
mode: INPUT_PULLUP
|
||||
tolerance: 45 # high tolerance required for some remote control units
|
||||
|
||||
climate:
|
||||
- platform: tcl112
|
||||
name: "Living Room AC"
|
||||
receiver_id: rcvr
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
- :doc:`/components/climate/index`
|
||||
- :doc:`/components/remote_transmitter`
|
||||
- :apiref:`tcl112/tcl112.h`
|
||||
- :ghedit:`Edit`
|
||||
@ -1,52 +0,0 @@
|
||||
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 heat mode 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`
|
||||
1
images/air-conditioner-ir.svg
Normal file
1
images/air-conditioner-ir.svg
Normal file
@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24"><path d="M.139.409h24v24h-24z" fill="none"/><path d="M9.988 11.894c.923-.714 1.926.158 2.15 1.515.17 0 .336.048.486.135.205-.237.387-.56.316-.924-.166-.848.785-1.535 1.689-.363.714.923-.158 1.926-1.52 2.15 0 .17-.043.34-.134.49.237.201.56.383.924.312.84-.166 1.53.781.359 1.689-.924.714-1.926-.158-2.15-1.516a.946.946 0 0 1-.482-.138c-.206.237-.391.565-.32.928.166.844-.785 1.535-1.689.363-.718-.928.158-1.93 1.52-2.151 0-.17.05-.335.137-.485-.236-.202-.56-.387-.927-.316-.84.166-1.53-.781-.359-1.689m-.627 6.053h.789a.79.79 0 0 1 .79.79v2.367h-.79v-.789h-.79v.79h-.789v-2.368a.79.79 0 0 1 .79-.79m0 .79v.789h.789v-.79h-.79m3.13-.789h.817l-1.156 3.157h-.817l1.156-3.157m2 0h1.184v.79h-1.183v1.578h1.183v.79h-1.183a.79.79 0 0 1-.79-.79v-1.578a.79.79 0 0 1 .79-.79zm.649-8.538h-6c-.55 0-1 .45-1 1v12c0 .55.45 1 1 1h6c.55 0 1-.45 1-1v-12c0-.55-.45-1-1-1zm-7.95-2.95l1.41 1.41a5.022 5.022 0 0 1 7.08 0l1.41-1.41a6.976 6.976 0 0 0-4.95-2.05c-1.93 0-3.68.78-4.95 2.05zm4.95-6.05c-3.04 0-5.79 1.23-7.78 3.22l1.41 1.41a9.011 9.011 0 0 1 6.37-2.63c2.49 0 4.74 1.01 6.36 2.64l1.41-1.41c-1.98-2-4.73-3.23-7.77-3.23z"/></svg>
|
||||
|
After Width: | Height: | Size: 1.1 KiB |
@ -295,10 +295,7 @@ Climate Components
|
||||
Climate Core, components/climate/index, folder-open.svg
|
||||
Bang Bang Controller, components/climate/bang_bang, air-conditioner.svg
|
||||
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
|
||||
Fujitsu General IR Remote, components/climate/fujitsu_general, air-conditioner.svg
|
||||
IR Remote Climate, components/climate/ir_climate, air-conditioner-ir.svg
|
||||
|
||||
Misc Components
|
||||
---------------
|
||||
|
||||
Loading…
Reference in New Issue
Block a user