Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

modify Climate IR document for enhanced hitach_ac344 platform #4626

Open
wants to merge 4 commits into
base: current
Choose a base branch
from
+76 −2
Open

modify Climate IR document for enhanced hitach_ac344 platform #4626

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cb59402
modify Climate IR document for enhanced hitach_ac344 platform
js4jiang5 Jan 31, 2025
b0d16c8
fix link name for hitachi_ac344
js4jiang5 Jan 31, 2025
6f7a355
change "horizontal_default" to "horizontal_position"
js4jiang5 Jan 31, 2025
4176493
Merge branch 'current' into current
js4jiang5 Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 76 additions & 2 deletions components/climate/climate_ir.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,9 @@ submit a feature request (see FAQ).
+---------------------------------------+---------------------+----------------------+
| :ref:`GREE<gree_ir>` | ``gree`` | |
+---------------------------------------+---------------------+----------------------+
| Hitachi | ``hitachi_ac344``, | yes |
| | ``hitachi_ac424`` | |
| :ref:`Hitachi AC344<hitachi_ac344>` | ``hitachi_ac344`` | yes |
+---------------------------------------+---------------------+----------------------+
| Hitachi AC424 | ``hitachi_ac424`` | yes |
Comment on lines +40 to +42
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix the reference link and maintain consistency in table entries.

Two issues need to be addressed:

  1. The reference link hitachi_ac344 is undefined, causing a pipeline failure.
  2. The Hitachi AC424 entry is inconsistent with AC344 as it lacks a reference link.

Apply this diff to fix both issues:

-| :ref:`Hitachi AC344<hitachi_ac344>`   | ``hitachi_ac344``   | yes                  |
+| :ref:`Hitachi AC344<hitachi_ir>`      | ``hitachi_ac344``   | yes                  |
-| Hitachi AC424                         | ``hitachi_ac424``   | yes                  |
+| :ref:`Hitachi AC424<hitachi_ir>`      | ``hitachi_ac424``   | yes                  |
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
| :ref:`Hitachi AC344<hitachi_ac344>` | ``hitachi_ac344`` | yes |
+---------------------------------------+---------------------+----------------------+
| Hitachi AC424 | ``hitachi_ac424`` | yes |
| :ref:`Hitachi AC344<hitachi_ir>` | ``hitachi_ac344`` | yes |
+---------------------------------------+---------------------+----------------------+
| :ref:`Hitachi AC424<hitachi_ir>` | ``hitachi_ac424`` | yes |
🧰 Tools
🪛 GitHub Actions: Lint

[error] 41-41: Undefined label 'hitachi_ac344' referenced in documentation

+---------------------------------------+---------------------+----------------------+
| :ref:`LG<climate_ir_lg>` | ``climate_ir_lg`` | yes |
+---------------------------------------+---------------------+----------------------+
Expand Down Expand Up @@ -173,6 +174,79 @@ The Daikin ARC remotes (``daikin_arc`` climate, ``daikin_arc417``, ``daikin_arc4
sensor: room_temperature
model: yan

.. _hitachi_ac344:

``hitachi_ac344`` **Climate**:

Hitachi AC344 are used by Hitachi AC with payload length 344 bits.

- **horizontal_position** (*Optional*, string): Default position when horizontal swing is off. Default to ``middle``.

- Options are: ``left_max``, ``left``, ``middle``, ``right``, ``right_max``
- **mildewproof** (*Optional*, boolean): Mildewproof control for cool mode. Default to ``False``.

- Options are: ``True``, ``False``
- **custom_cool** (Optional): Custom cool mode with designated temperature, swing, and fan mode

- **temperature** (*Optional*, int): Target temperature. Default to 28
- **swing** (*Optional*, string): Horizontal setting. Default to "horizontal"

- Options are: ``horizontal``, ``off``
- **fan_mode** (*Optional*, string): Fan mode setting. Default to "auto"

- Options are: ``auto``, ``low``, ``medium``, ``high``, ``quiet``
- **custom_heat** (Optional): Custom heat mode with designated temperature, swing, and fan mode

- **temperature** (*Optional*, int): Target temperature. Default to 24
- **swing** (*Optional*, string): Horizontal setting. Default to "off"

- Options are: ``horizontal``, ``off``
- **fan_mode** (*Optional*, string): Fan mode setting. Default to "auto"

- Options are: ``auto``, ``low``, ``medium``, ``high``, ``quiet``
- **custom_dry** (Optional): Custom dry mode with designated temperature, swing, and fan mode

- **temperature** (*Optional*, int): Target temperature. Default to 28
- **swing** (*Optional*, string): Horizontal setting. Default to "horizontal"

- Options are: ``horizontal``, ``off``
- **fan_mode** (*Optional*, string): Fan mode setting. Default to "low"

- Options are: ``auto``, ``low``, ``medium``, ``high``, ``quiet``
- **custom_fan_only** (Optional): Custom fan_only mode with designated swing and fan mode

- **swing** (*Optional*, string): Horizontal setting. Default to "off"

- Options are: ``horizontal``, ``off``
- **fan_mode** (*Optional*, string): Fan mode setting. Default to "low"

- Options are: ``auto``, ``low``, ``medium``, ``high``, ``quiet``

.. code-block:: yaml

# Example configuration entry
climate:
- platform: hitachi_ac344
name: "AC"
sensor: room_temperature
horizontal_position: "right"
mildewproof: True
custom_cool:
temperature: 28
swing: "horizontal"
fan_mode: "auto"
custom_heat:
temperature: 24
swing: "off"
fan_mode: "auto"
custom_dry:
temperature: 28
swing: "horizontal"
fan_mode: "low"
custom_fan_only:
swing: "off"
fan_mode: "low"

.. _midea_ir:

``midea_ir`` **Climate**:
Expand Down