Add water heater and automation guide (#37342)

* Add automation guide

* Update sensor (home brew)

* Update debugging

* Modify delayed and event notifications

* tiny tweaks

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
LG-ThinQ-Integration 2025-03-05 14:48:00 +09:00 committed by GitHub
parent 0e145f3f74
commit 97ac558fc5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -127,29 +127,30 @@ The properties for controlling both the temperature and wind strength of the app
| Device | Property | | Device | Property |
| ------ | -------- | | ------ | -------- |
| Air Conditioner | Current temperature<br>Fan mode<br>HVAC mode<br>Preset mode<br>Temperature<br>Temperature cool<br>Temperature heat<br>Unit | | Air Conditioner | Current temperature<br>Fan mode<br>Swing mode<br>Swing horizontal mode<br>HVAC mode<br>Preset mode<br>Temperature<br>Temperature cool<br>Temperature heat<br>Unit |
| System Boiler | Current temperature<br>HVAC mode<br>Temperature<br>Temperature cool<br>Temperature heat<br>Unit | | System Boiler | Current temperature<br>HVAC mode<br>Temperature<br>Temperature cool<br>Temperature heat<br>Unit |
### Event ### Event
A notification message pushed from the server is represented as an event platform. A notification message pushed from the server is represented as an event platform. The **Notification codes** shows the full support range, and you can check the range of your device through the developer tools.
| Device | Property | | Device | Property | Notification codes |
| ------ | -------- | | ------ | -------- | ---------- |
| Air Conditioner | Notification | | Air Conditioner | Notification | water_is_full |
| Air Purifier| Notification | | Air Purifier| Notification | lack_of_water, time_to_clean_filter, pollution_is_high, time_to_change_filter |
| Air Purifier Fan | Notification | | Air Purifier Fan | Notification | time_to_change_filter |
| Dehumidifier | Notification | | Dehumidifier | Notification | water_is_full |
| Dish Washer | Error<br>Notification | | Dish Washer | Error<br>Notification | cleaning_is_complete, error_during_cleaning, water_leak_has_occurred, rinse_is_not_enough, salt_refill_is_needed |
| Humidifier | Notification | | Humidifier | Notification | time_to_change_filter, lack_of_water |
| Kimchi Refrigerator | Notification | | Kimchi Refrigerator | Notification | door_is_open |
| Microwave Oven | Notification | | Microwave Oven | Notification | none |
| Oven | Notification | | Oven | Notification | preheating_is_complete, cooking_is_complete, time_to_clean, error_has_occurred |
| Refrigerator | Notification | | Refrigerator | Notification | time_to_change_filter, time_to_change_water_filter, frozen_is_complete, door_is_open |
| Robot Cleaner | Error<br>Notification | | Robot Cleaner | Error<br>Notification | - |
| Stick Cleaner | Notification | | Stick Cleaner | Notification | charging_is_complete, time_to_clean_filter |
| Dryer<br>Styler<br>Washer<br>Washcombo Main<br>Washcombo Mini<br>Washtower<br>Washtower Dryer<br>Washtower Washer | Error<br>Notification | | Washer<br>Dryer<br>Washcombo Main<br>Washcombo Mini<br>Washtower<br>Washtower Dryer<br>Washtower Washer | Error<br>Notification | washing_is_complete, error_during_washing, drying_is_complete, drying_failed |
| Wine Cellar | Notification | | Styler | Error<br>Notification | styling_is_complete, error_has_occurred |
| Wine Cellar | Notification | door_is_open |
### Fan ### Fan
@ -172,7 +173,7 @@ A read-write property which has a numeric value is represented as a number platf
| Microwave Oven | Fan<br>Light | | Microwave Oven | Fan<br>Light |
| Oven | Temperature | | Oven | Temperature |
| Refrigerator | Temperature | | Refrigerator | Temperature |
| Dryer<br>Styler<br>Washer<br>Washcombo Main<br>Washcombo Mini<br>Washtower<br>Washtower Dryer<br>Washtower Washer | Delay ends in | | Dryer<br>Styler<br>Washer<br>Washcombo Main<br>Washcombo Mini<br>Washtower<br>Washtower Dryer<br>Washtower Washer | Delayed start/end |
| Water Heater | Temperature | | Water Heater | Temperature |
| Wine Cellar | Light<br>Temperature | | Wine Cellar | Light<br>Temperature |
@ -200,13 +201,13 @@ A read-write property which has only two states that can be toggled is represent
| Device | Property | | Device | Property |
| ------ | -------- | | ------ | -------- |
| Air Conditioner | Energy saving | | Air Conditioner | Power<br>Lighting<br>Energy saving |
| Air Purifier | Power | | Air Purifier | Power |
| Air Purifier Fan | Heating<br>Power<br>UVnano | | Air Purifier Fan | Heating<br>Power<br>UVnano |
| Dehumidifier | Power | | Dehumidifier | Power |
| Humidifier | Auto mode<br>Heating<br>Mood light<br>Power<br>Sleep mode | | Humidifier | Auto mode<br>Heating<br>Mood light<br>Power<br>Sleep mode |
| Refrigerator | Ice plus<br>Quick freeze | | Refrigerator | Express mode<br>Express cool<br>Quick freeze |
| System Boiler | Hot water | | System Boiler | Power<br>Hot water |
| Wine Cellar | Ventilation | | Wine Cellar | Ventilation |
### Vacuum ### Vacuum
@ -217,6 +218,14 @@ The properties for controlling the clean operations of the appliance are represe
| ------ | -------- | | ------ | -------- |
| Robot Cleaner | Battery<br>Current status<br>Operation | | Robot Cleaner | Battery<br>Current status<br>Operation |
### Water heater
The properties for controlling the operating mode and temperature are represented as a water_heater platform.
| Device | Property |
| ------ | -------- |
| Water heater | Mode<br>Current temperature<br>Temperature |
### Sensor ### Sensor
A read-only property which has states is represented as a sensor platform. A read-only property which has states is represented as a sensor platform.
@ -228,8 +237,8 @@ A read-only property which has states is represented as a sensor platform.
| Air Purifier Fan | Air quality sensor<br>Humidity<br>Odor<br>Overall air quality<br>PM1<br>PM10<br>PM2.5<br>Sleep timer<br>Temperature<br>Schedule turn-off<br>Schedule turn-on | | Air Purifier Fan | Air quality sensor<br>Humidity<br>Odor<br>Overall air quality<br>PM1<br>PM10<br>PM2.5<br>Sleep timer<br>Temperature<br>Schedule turn-off<br>Schedule turn-on |
| Cooktop | Current status<br>Power level | | Cooktop | Current status<br>Power level |
| Dehumidifier | Humidity<br>Operating mode | | Dehumidifier | Humidity<br>Operating mode |
| Dish Washer | Current cycle<br>Current status<br>Rinse aid dispenser level<br>Softening level<br>Delay in<br>Remaining time<br>Total time | | Dish Washer | Current cycle<br>Current status<br>Rinse aid dispenser level<br>Softening level<br>Delayed start<br>Remaining time<br>Total time |
| Home Brew| Brewing duration<br>Brewing period<br>Current status<br>Flavor<br>Homebrew recipe<br>Hops<br>Recipe progress<br>Wort<br>Yeast | | Home Brew| Brewing duration<br>Brewing period<br>Current status<br>First flavor<br>Second flavor<br>Homebrew recipe<br>First hop<br>Second hop<br>Recipe progress<br>Wort<br>Yeast |
| Humidifier | Air quality sensor<br>Humidity<br>Overall air quality<br>PM1<br>PM10<br>PM2.5<br>Schedule turn-off<br>Schedule turn-on<br>Sleep timer<br>Temperature | | Humidifier | Air quality sensor<br>Humidity<br>Overall air quality<br>PM1<br>PM10<br>PM2.5<br>Schedule turn-off<br>Schedule turn-on<br>Sleep timer<br>Temperature |
| Kimchi Refrigerator | Fresh air filter<br>Temperature | | Kimchi Refrigerator | Fresh air filter<br>Temperature |
| Microwave Oven | Current status | | Microwave Oven | Current status |
@ -238,16 +247,16 @@ A read-only property which has states is represented as a sensor platform.
| Refrigerator | Fresh air filter<br>Water filter used | | Refrigerator | Fresh air filter<br>Water filter used |
| Robot Cleaner | Current status<br>Operating mode<br>Running time | | Robot Cleaner | Current status<br>Operating mode<br>Running time |
| Stick Cleaner | Battery<br>Current status<br>Operating mode | | Stick Cleaner | Battery<br>Current status<br>Operating mode |
| Water Heater | Temperature | | System Boiler | Indoor temperature<br>Inlet temperature<br>Outlet temperature |
| Water Purifier | High-temp sterilization<br>Type<br>UVnano| | Water Purifier | High-temp sterilization<br>Type<br>UVnano|
| Dryer<br>Styler<br>Washer<br>Washcombo Main<br>Washcombo Mini<br>Washtower<br>Washtower Dryer<br>Washtower Washer | Current status<br>Delay in<br>Remaining time<br>Total time | | Dryer<br>Styler<br>Washer<br>Washcombo Main<br>Washcombo Mini<br>Washtower<br>Washtower Dryer<br>Washtower Washer | Current status<br>Delayed start/end<br>Remaining time<br>Total time<br>Cycles |
### Custom card configuration ## User guide
### 1. Custom card configuration (HACS)
#### Timer Bar Card **- Timer Bar Card**
> - Supported devices: Washer, Dryer, Styler, Dish washer
- Supported devices: Washer, Dryer, Styler, Dish washer > - Used entities: sensor.washer_**current_status**, sensor.washer_**remaining_time**, sensor.washer_**total_time**
- Entities: sensor.washer_current_status, sensor.washer_remaining_time, sensor.washer_total_time
```yaml ```yaml
type: custom:timer-bar-card type: custom:timer-bar-card
@ -274,6 +283,29 @@ entities:
invert: true invert: true
``` ```
### 2. Automation
**- Notification, Error event**
> - Guide: [Automating on event](https://www.home-assistant.io/integrations/event/#automating-on-a-button-press)
> - Important: guide's step 3, 4
> - You can select the state change you want to act as trigger in step 4
```yaml
alias: lack of water example
description: Toggle switch when air purifier's lack_of_water
triggers:
- trigger: state
entity_id:
- event.purifier_notification
actions:
- condition: state
entity_id: event.purifier_notification
attribute: event_type
state: lack_of_water
- type: toggle
device_id: xxxxxxxx
entity_id: xxxxxxxx
domain: switch
```
## Troubleshooting ## Troubleshooting
### Setup ### Setup
@ -293,5 +325,9 @@ The LG ThinQ integration will work properly after some time.
## Debugging / Issue report ## Debugging / Issue report
The LG ThinQ integration will show additional information by enabling log configuration. The LG ThinQ integration will show additional information by enabling log configuration.
1. Enable debug logging in /config/integrations/integration/lg_thinq, 1. [Enable debug logging](/docs/configuration/troubleshooting/#enabling-debug-logging).
2. Please report your device info (screenshot including name, device type, entities) and logs. - If you change **Enable** to **Disable**, the log will be saved to the download folder.
2. When reporting an issue:
- Provide screenshots of your device configuration (including device name, type, and entities).
- Include the debug logs.
- Describe the expected behavior and what's not working.