Upstream
/
esphome-docs
mirror of https://github.com/esphome/esphome-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Haier climate documentation updated to support new functionality (#2809) 

Co-authored-by: H. Árkosi Róbert <robreg@zsurob.hu>
Co-authored-by: Pavlo Dudnytskyi <pdudnytskyi@astrata.eu>
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
This commit is contained in:
Pavlo Dudnytskyi 2023-06-19 00:40:01 +02:00 committed by GitHub
parent 5e18c9eed0
commit 6088b03b2f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 225 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

266
components/climate/haier.rst
View File

@ -5,47 +5,11 @@ Haier Climate
:description: Instructions for setting up a Haier climate devices.
:image: air-conditioner.svg
The ``haier`` climate platform creates a Haier climate device.
The component can be used as a replacement of a Haier proprietary WiFi modules such as KZW-W001 and KZW-W002.
This is an implementation of the ESPHome component to control HVAC on the base of the SmartAir2 and hOn Haier protocols (AC that is controlled by the hOn or SmartAir2 application).
This component requires a :ref:`uart` to be setup.
There are two versions of the Haier protocol. The older one is using an application called SmartAir2 and the newer one - an application called hOn. Both protocols are compatible on the transport level but have different commands to control appliances.
.. code-block:: yaml
logger:
baud_rate: 0 #Disable UART logging for ESP8266
uart:
rx_pin: GPIO3
tx_pin: GPIO1
baud_rate: 9600
climate:
platform: haier
name: Haier AC
supported_swing_modes:
- VERTICAL
- HORIZONTAL
- BOTH
Configuration variables:
------------------------
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **name** (**Required**, string): The name of the climate device.
- **update_interval** (*Optional*, :ref:`config-time`): How often device will be polled for status. Defaults to ``5s``.
- **supported_swing_modes** (*Optional*, list): List of supported swing modes. Possible values are: ``VERTICAL``, ``HORIZONTAL``, ``BOTH``.
- All other options from :ref:`Climate <config-climate>`.
Hardware setup
--------------
Most units will have a dedicated USB-A port for Haier WiFi module.
The physical USB port is in fact UART and does not "speak" USB protocol.
It uses four USB pins as 5V, GND, RX, TX.
You can use spare male USB cable to connect esphome device directly to the climate appliance.
Other units will not have USB ports, but will still probably have UART exposed somewhere on the main board.
Older Haier models controlled by the SmartAir2 application are using the KZW-W002 module. This module can’t be reused, and you need to replace it with an ESP (RPI pico w) module. The USB connector on a board doesn’t support the USB protocol. It is a UART port that just uses a USB connector. To connect the ESP board to your AC you can cut a USB type A cable and connect wires to the climate connector.
.. list-table:: Haier UART pinout
:header-rows: 1
@ -75,12 +39,232 @@ Other units will not have USB ports, but will still probably have UART exposed s
:align: center
:width: 70.0%
USB Pinout
KZW-W002 module pinout
Newer Haier models using a module called ESP32-for-Haier. It is an ESP32 single-core board with an ESP32-S0WD chip. In some cases, you can reuse this module and flash it with ESPHome, but some new modules don’t support this. They look the same but have encryption enabled.
**Warning!** The new generation of ESP32-Haier devices has encryption enabled, so they can only be flashed with firmware that is signed with a private key. There is no way to make them work with ESPHome, so if you try to do it, the board will get into a boot loop with error ``rst:0x10 (RTCWDT_RTC_RESET),boot:0x13 (SPI_FAST_FLASH_BOOT)`` The only way to recover this board is to flash it with the original image. So before starting your experiments make a backup image.
.. figure:: images/haier_pinout.jpg
:align: center
:width: 70.0%
ESP32-for-Haier UART0 pinout
Also, you can use any other ESP32, ESP8266 or a RPI pico W board. In this case, you will need to cut the original wire or make a connector yourself (the board has a JST SM04B-GHS-TB connector)
This component requires a :ref:`uart` to be setup.
.. code-block:: yaml
# Example configuration entry
uart:
baud_rate: 9600
tx_pin: 17
rx_pin: 16
id: ac_port
climate:
- platform: haier
id: haier_ac
protocol: hOn
name: Haier AC
uart_id: ac_port
wifi_signal: true
beeper: true
outdoor_temperature:
name: Haier AC outdoor temperature
visual:
min_temperature: 16 °C
max_temperature: 30 °C
temperature_step: 1 °C
supported_modes:
- 'OFF'
- AUTO
- COOL
- HEAT
- DRY
- FAN_ONLY
supported_swing_modes:
- 'OFF'
- VERTICAL
- HORIZONTAL
- BOTH
Configuration variables:
------------------------
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **uart_id** (*Optional*, :ref:`config-id`): ID of the UART port to communicate with AC.
- **protocol** (*Optional*, string): Defines protocol of communication with AC. Possible values: hon or smartair2. Default value is smartair2.
- **name** (**Required**, string): The name of the climate device.
- **wifi_signal** (*Optional*, boolean): If true - send wifi signal level to AC. Supported only by hOn protocol.
- **beeper** (*Optional*, boolean): Can be used to disable beeping on commands from AC. Supported only by hOn protocol.
- **outdoor_temperature** (*Optional*): Temperature sensor for outdoor temperature. Supported only by hOn protocol.
- **name** (**Required**, string): The name of the sensor.
- **id** (*Optional*, :ref:`config-id`): ID of the sensor, can be used for code generation
- All other options from :ref:`Sensor <config-sensor>`.
- **supported_modes** (*Optional*, list): Can be used to disable some of AC modes. Possible values: 'OFF', AUTO, COOL, HEAT, DRY, FAN_ONLY
- **supported_swing_modes** (*Optional*, list): Can be used to disablesome swing modes if your AC does not support it. Possible values: 'OFF', VERTICAL, HORIZONTAL, BOTH
- All other options from :ref:`Climate <config-climate>`.
Automations
-----------
climate.haier.power_on Action
*****************************
This action turns AC power on.
.. code-block:: yaml
on_...:
then:
climate.haier.power_on: device_id
climate.haier.power_off Action
******************************
This action turns AC power off
.. code-block:: yaml
on_...:
then:
climate.haier.power_off: device_id
climate.haier.power_toggle Action
*********************************
This action toggles AC power
.. code-block:: yaml
on_...:
then:
climate.haier.power_toggle: device_id
climate.haier.display_on Action
*******************************
This action turns the AC display on
.. code-block:: yaml
on_...:
then:
climate.haier.display_on: device_id
climate.haier.display_off Action
********************************
This action turns the AC display off
.. code-block:: yaml
on_...:
then:
climate.haier.display_off: device_id
climate.haier.health_on Action
******************************
Turn on health mode (`UV light sterilization <https://www.haierhvac.eu/en/node/1809>`__)
.. code-block:: yaml
on_...:
then:
climate.haier.health_on: device_id
climate.haier.health_off Action
*******************************
Turn off health mode
.. code-block:: yaml
on_...:
then:
climate.haier.health_off: device_id
climate.haier.beeper_on Action
******************************
(supported only by hOn) This action enables beep feedback on every command sent to AC
.. code-block:: yaml
on_...:
then:
climate.haier.beeper_on: device_id
climate.haier.beeper_off Action
*******************************
(supported only by hOn) This action disables beep feedback on every command sent to AC (keep in mind that this will not work for IR remote commands)
.. code-block:: yaml
on_...:
then:
climate.haier.beeper_off: device_id
climate.haier.set_vertical_airflow Action
*****************************************
(supported only by hOn) Set direction for vertical airflow if the vertical swing is disabled. Possible values: Health_Up, Max_Up, Up, Center, Down, Health_Down.
.. code-block:: yaml
on_...:
then:
- climate.haier.set_vertical_airflow:
id: device_id
vertical_airflow: Up
climate.haier.set_horizontal_airflow Action
*******************************************
(supported only by hOn) Set direction for horizontal airflow if the horizontal swing is disabled. Possible values: Max_Left, Left, Center, Right, Max_Right.
.. code-block:: yaml
on_...:
then:
- climate.haier.set_horizontal_airflow:
id: device_id
vertical_airflow: Right
climate.haier.start_self_cleaning Action
****************************************
(supported only by hOn) Start `self-cleaning <https://www.haier.com/in/blogs/beat-the-summer-heat-with-haier-self-cleaning-ac.shtml>`__
.. code-block:: yaml
on_...:
then:
- climate.haier.start_self_cleaning: device_id
climate.haier.start_steri_cleaning Action
*****************************************
(supported only by hOn) Start 56°C steri-cleaning
.. code-block:: yaml
on_...:
then:
- climate.haier.start_steri_cleaning: device_id
See Also
--------
- `esphaier <https://github.com/MiguelAngelLV/esphaier>`__
- `haier-esphome <https://github.com/paveldn/haier-esphome>`__
- :doc:`/components/climate/index`
- :apiref:`haier/climate/haier.h`
- :ghedit:`Edit`

BIN
components/climate/images/haier_pinout.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 414 KiB