From 92975768afae0ab9eb45d18e42496ff871634f31 Mon Sep 17 00:00:00 2001 From: Guillermo Ruffino Date: Mon, 9 Sep 2019 13:01:50 -0300 Subject: [PATCH] add coolix receiver (#288) * add coolix receiver * add example --- components/climate/coolix.rst | 30 +++++++++++++++++++++++++++++- components/climate/tcl112.rst | 2 +- components/climate/yashima.rst | 2 +- 3 files changed, 31 insertions(+), 3 deletions(-) diff --git a/components/climate/coolix.rst b/components/climate/coolix.rst index 52849353f..a9b7071f5 100644 --- a/components/climate/coolix.rst +++ b/components/climate/coolix.rst @@ -13,6 +13,9 @@ This component requires that you have setup a :doc:`/components/remote_transmitt 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% @@ -33,9 +36,10 @@ 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``. +- **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 `. Advanced options: @@ -43,6 +47,30 @@ 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 -------- diff --git a/components/climate/tcl112.rst b/components/climate/tcl112.rst index 465286c4a..26d78168a 100644 --- a/components/climate/tcl112.rst +++ b/components/climate/tcl112.rst @@ -33,7 +33,7 @@ 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``. +- **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 `. diff --git a/components/climate/yashima.rst b/components/climate/yashima.rst index 0bacdcc3b..738c0bf82 100644 --- a/components/climate/yashima.rst +++ b/components/climate/yashima.rst @@ -33,7 +33,7 @@ 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``. +- **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 `.