Skip to content

Commit

Permalink
Documentation updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Pavlo Dudnytskyi committed Aug 22, 2024
1 parent 576cf10 commit 64ff6c9
Show file tree
Hide file tree
Showing 4 changed files with 73 additions and 3 deletions.
34 changes: 32 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -499,9 +499,39 @@ Configuration variables:

- **haier_id** (**Required**, `ID <https://esphome.io/guides/configuration-types.html#config-id>`_): The id of Haier climate component
- **self_cleaning** (*Optional*): A button that starts Haier climate self cleaning.
All options from `Text Sensor <https://esphome.io/components/button/index.html#base-button-configuration>`_.
All options from `Button <https://esphome.io/components/button/index.html#base-button-configuration>`_.
- **steri_cleaning** (*Optional*): A button that starts Haier climate 56°C Steri-Clean.
All options from `Text Sensor <https://esphome.io/components/button/index.html#base-button-configuration>`_.
All options from `Button <https://esphome.io/components/button/index.html#base-button-configuration>`_.

.. Generated from esphome-docs/switch/haier.rst
Haier Climate Switches
======================

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
Configuration variables:
------------------------

- **haier_id** (**Required**, `ID <https://esphome.io/guides/configuration-types.html#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 `Switch <https://esphome.io/components/switch/index.html#base-switch-configuration>`_.
- **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 `Switch <https://esphome.io/components/switch/index.html#base-switch-configuration>`_.
- **display** (*Optional*): A switch that enables or disables Haier climate led display.
All options from `Switch <https://esphome.io/components/switch/index.html#base-switch-configuration>`_.

.. Generated from esp32_backup.rst
Expand Down
1 change: 1 addition & 0 deletions docs/esphome-docs/climate/haier.rst
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,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`
- :ghedit:`Edit`
37 changes: 37 additions & 0 deletions docs/esphome-docs/switch/haier.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
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
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>`.

See Also
--------

- :doc:`Haier Climate </components/climate/haier>`
- :ghedit:`Edit`
4 changes: 3 additions & 1 deletion docs/script/make_doc.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"/".join(["esphome-docs", "binary_sensor", "haier.rst"]),
"/".join(["esphome-docs", "text_sensor", "haier.rst"]),
"/".join(["esphome-docs", "button", "haier.rst"]),
"/".join(["esphome-docs", "switch", "haier.rst"]),
"esp32_backup.rst",
"additional_information.rst",
]
Expand All @@ -26,7 +27,8 @@ def process_esphome_refs(line, l_num):
(":ref:`Sensor <config-sensor>`", "`Sensor <https://esphome.io/components/sensor/index.html#config-sensor>`_"),
(":ref:`Binary Sensor <config-binary_sensor>`", "`Binary Sensor <https://esphome.io/components/binary_sensor/index.html#base-binary-sensor-configuration>`_"),
(":ref:`Text Sensor <config-text_sensor>`", "`Text Sensor <https://esphome.io/components/text_sensor/index.html#base-text-sensor-configuration>`_"),
(":ref:`Button <config-button>`", "`Text Sensor <https://esphome.io/components/button/index.html#base-button-configuration>`_"),
(":ref:`Button <config-button>`", "`Button <https://esphome.io/components/button/index.html#base-button-configuration>`_"),
(":ref:`Switch <config-switch>`", "`Switch <https://esphome.io/components/switch/index.html#base-switch-configuration>`_"),

]
res = line
Expand Down

0 comments on commit 64ff6c9

Please sign in to comment.