From a8b5f85f6e947be3ca3305c3877ffa3429d1b37d Mon Sep 17 00:00:00 2001 From: Pavlo Dudnytskyi Date: Sun, 3 Mar 2024 10:01:48 +0100 Subject: [PATCH] Update README.rst --- README.rst | 79 ++++++++++++++++++++++++------------------------------ 1 file changed, 35 insertions(+), 44 deletions(-) diff --git a/README.rst b/README.rst index 512a150..920185a 100644 --- a/README.rst +++ b/README.rst @@ -74,35 +74,26 @@ The module board looks like this: :align: center :width: 50.0% -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 the 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: `How to backup the -original image and flash ESPHome to the ESP32 Haier -module <#how-to-backup-the-original-image-and-flash-esphome-to-the-esp32-haier-module>`__ - -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) +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 the 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: `How to backup the original image and flash ESPHome to the ESP32 Haier module <#how-to-backup-the-original-image-and-flash-esphome-to-the-esp32-haier-module>`__ + +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) Configuration ------------- -The configuration will be a little bit different for different -protocols. For example, the SmartAir2 protocol doesn’t support cleaning, -setting air direction (just swing on/off) etc. +The configuration will be a little bit different for different protocols. +For example, the SmartAir2 protocol doesn’t support cleaning, setting air direction (just swing on/off), etc. hOn configuration example ~~~~~~~~~~~~~~~~~~~~~~~~~ -:: +.. code-block:: yaml uart: baud_rate: 9600 @@ -158,7 +149,7 @@ hOn configuration example SmartAir2 configuration example ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:: +.. code-block:: yaml uart: baud_rate: 9600 @@ -201,10 +192,10 @@ Configuration variables ~~~~~~~~~~~~~~~~~~~~~~~ - **id - (Optional,**\ `ID `__\ **):** + (Optional, **\ `ID `__\ **):** Manually specify the ID used for code generation - **uart_id - (Optional,**\ `ID `__\ **):** + (Optional, **\ `ID `__\ **):** ID of the UART port to communicate with AC - **protocol (Required, string):** Defines communication protocol with AC. Possible values: hon or smartair2 @@ -214,7 +205,7 @@ Configuration variables - **beeper (Optional, boolean):** (supported only by hOn) Can be used to disable beeping on commands from AC - **answer_timeout - (Optional,**\ `Time `__\ **):** + (Optional, **\ `Time `__\ **):** Can be used to change default answer timeout. It helps in case AC takes longer to answer requests. - **alternative_swing_control (Optional, boolean):** (supported by @@ -242,11 +233,11 @@ Configuration variables (use quotes in opposite case ESPHome will convert it to False), VERTICAL, HORIZONTAL, BOTH - **on_alarm_start - (Optional,**\ `Automation `__\ **):** + (Optional, **\ `Automation `__\ **):** (supported only by hOn) Automation to perform when AC activates a new alarm. See `on_alarm_start <#on_alarm_start-trigger>`__ - **on_alarm_end - (Optional,**\ `Automation `__\ **):** + (Optional, **\ `Automation `__\ **):** (supported only by hOn) Automation to perform when AC deactivates a new alarm. See `on_alarm_end <#on_alarm_end-trigger>`__ - All other options from @@ -267,7 +258,7 @@ variables can be used in `lambdas `__. Supported only by hOn protocol. -:: +.. code-block:: yaml climate: - protocol: hOn @@ -276,7 +267,7 @@ Supported only by hOn protocol. - logger.log: level: WARN format: "Alarm activated. Code: %d. Message: \"%s\"" - args: [ code, message] + args: [ code, message ] on_alarm_end Trigger ~~~~~~~~~~~~~~~~~~~~ @@ -288,7 +279,7 @@ variable “code” (type uint8_t), error message in the variable “message” `lambdas `__. Supported only by hOn protocol. -:: +.. code-block:: yaml climate: - protocol: hOn @@ -297,14 +288,14 @@ Supported only by hOn protocol. - logger.log: level: INFO format: "Alarm deactivated. Code: %d. Message: \"%s\"" - args: [ code, message] + args: [ code, message ] climate.haier.power_on Action ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This action turns the AC power on -:: +.. code-block:: yaml on_...: then: @@ -315,7 +306,7 @@ climate.haier.power_off Action This action turns AC power off -:: +.. code-block:: yaml on_...: then: @@ -326,7 +317,7 @@ climate.haier.power_toggle Action This action toggles AC power -:: +.. code-block:: yaml on_...: then: @@ -337,7 +328,7 @@ climate.haier.display_on Action This action turns the AC display on -:: +.. code-block:: yaml on_...: then: @@ -348,7 +339,7 @@ climate.haier.display_off Action This action turns the AC display off -:: +.. code-block:: yaml on_...: then: @@ -360,7 +351,7 @@ climate.haier.health_on Action Turn on health mode (`UV light sterilization `__) -:: +.. code-block:: yaml on_...: then: @@ -371,7 +362,7 @@ climate.haier.health_off Action Turn off health mode -:: +.. code-block:: yaml on_...: then: @@ -383,7 +374,7 @@ 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: @@ -396,7 +387,7 @@ climate.haier.beeper_off Action command sent to AC (keep in mind that this will not work for IR remote commands) -:: +.. code-block:: yaml on_...: then: @@ -408,7 +399,7 @@ climate.haier.set_vertical_airflow Action (supported only by hOn) Set direction for vertical airflow if the vertical swing is disabled. Possible values: Up, Center, Down. -:: +.. code-block:: yaml on_...: then: @@ -422,7 +413,7 @@ climate.haier.set_horizontal_airflow Action (supported only by hOn) Set direction for horizontal airflow if the horizontal swing is disabled. Possible values: Left, Center, Right. -:: +.. code-block:: yaml on_...: then: @@ -436,7 +427,7 @@ climate.haier.start_self_cleaning Action (supported only by hOn) Start `self-cleaning `__ -:: +.. code-block:: yaml on_...: then: @@ -447,7 +438,7 @@ climate.haier.start_steri_cleaning Action (supported only by hOn) 56°C steri-cleaning -:: +.. code-block:: yaml on_...: then: