Haier climate documentation updated to reflect new code changes (#4228)

Co-authored-by: Pavlo Dudnytskyi <pdudnytskyi@astrata.eu>
This commit is contained in:
Pavlo Dudnytskyi 2024-09-19 06:09:30 +02:00 committed by GitHub
parent 1d001eb858
commit 10996e384d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 45 additions and 5 deletions

View File

@ -53,7 +53,7 @@ Newer Haier models using a module called ESP32-for-Haier. It is an ESP32 single-
Also, you can use any other ESP32, ESP8266, or an 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.
This component requires a :ref:`UART bus <uart>` to be setup.
.. code-block:: yaml
@ -65,7 +65,6 @@ This component requires a :ref:`uart` to be setup.
name: Haier AC
uart_id: ac_port
wifi_signal: true
beeper: true
display: true
visual:
min_temperature: 16 °C
@ -85,7 +84,6 @@ This component requires a :ref:`uart` to be setup.
- BOTH
supported_presets:
- AWAY
- ECO
- BOOST
- SLEEP
on_alarm_start:
@ -124,7 +122,7 @@ Configuration variables:
- **beeper** (*Optional*, boolean): Can be used to disable beeping on commands from AC. Supported only by hOn protocol.
- **supported_modes** (*Optional*, list): Can be used to disable some of AC modes. Possible values: ``'OFF'``, ``HEAT_COOL``, ``COOL``, ``HEAT``, ``DRY``, ``FAN_ONLY``.
- **supported_swing_modes** (*Optional*, list): Can be used to disable some swing modes if your AC does not support it. Possible values: ``'OFF'``, ``VERTICAL``, ``HORIZONTAL``, ``BOTH``.
- **supported_presets** (*Optional*, list): Can be used to disable some presets. Possible values for smartair2 are: ``AWAY``, ``BOOST``, ``COMFORT``. Possible values for hOn are: ``AWAY``, ``ECO``, ``BOOST``, ``SLEEP``. ``AWAY`` preset can be enabled only in ``HEAT`` mode, it is disabled by default.
- **supported_presets** (*Optional*, list): Can be used to disable some presets. Possible values for smartair2 are: ``AWAY``, ``BOOST``, ``COMFORT``. Possible values for hOn are: ``AWAY``, ``BOOST``, ``SLEEP``. ``AWAY`` preset can be enabled only in ``HEAT`` mode, it is disabled by default.
- **on_alarm_start** (*Optional*, :ref:`Automation <automation>`): (supported only by hOn) Automation to perform when AC activates a new alarm. See :ref:`haier-on_alarm_start`.
- **on_alarm_end** (*Optional*, :ref:`Automation <automation>`): (supported only by hOn) Automation to perform when AC deactivates a new alarm. See :ref:`haier-on_alarm_end`.
- **on_status_message** (*Optional*, :ref:`Automation <automation>`): Automation to perform when status message received from AC. See :ref:`haier-on_status_message`.
@ -343,6 +341,7 @@ See Also
- :doc:`Haier Climate Binary Sensors </components/binary_sensor/haier>`
- :doc:`Haier Climate Text Sensors </components/text_sensor/haier>`
- :doc:`Haier Climate Buttons </components/button/haier>`
- :doc:`Haier Climate Switches </components/switch/haier>`
- :doc:`/components/climate/index`
- :apiref:`haier/climate/haier.h`
- :apiref:`haier/climate/haier_base.h`
- :ghedit:`Edit`

View File

@ -0,0 +1,41 @@
Haier Climate Switches
======================
.. seo::
:description: Instructions for setting up additional switches for Haier climate devices.
:image: haier.svg
Additional switches to support additional features for Haier AC.
.. code-block:: yaml
# Example configuration entry
switch:
- platform: haier
beeper:
name: Haier beeper
health_mode:
name: Haier health mode
display:
name: Haier display
quiet_mode:
name: Haier quiet mode
Configuration variables:
------------------------
- **haier_id** (**Required**, :ref:`config-id`): The id of Haier climate component
- **beeper** (*Optional*): (supported only by hOn) A switch that enables or disables Haier climate sound feedback.
All options from :ref:`Switch <config-switch>`.
- **health_mode** (*Optional*): A switch that enables or disables Haier climate health mode (`UV light sterilization <https://www.haierhvac.eu/en/node/1809>`__).
All options from :ref:`Switch <config-switch>`.
- **display** (*Optional*): A switch that enables or disables Haier climate led display.
All options from :ref:`Switch <config-switch>`.
- **quiet_mode** (*Optional*): (supported only by hOn) A switch that enables or disables Haier climate quiet mode. Quiet mode not supported in Fan only mode.
All options from :ref:`Switch <config-switch>`.
See Also
--------
- :doc:`Haier Climate </components/climate/haier>`
- :ghedit:`Edit`