Skip to content

Latest commit

 

History

History
259 lines (205 loc) · 20.1 KB

lg_thinq.markdown

File metadata and controls

259 lines (205 loc) · 20.1 KB
Raw
title description ha_category ha_release ha_iot_class ha_code_owners ha_config_flow ha_domain ha_platforms ha_integration_type
LG ThinQ
Setup for LG ThinQ Integration.
Hub
2024.10
Cloud Push
@LG-ThinQ-Integration
true
lg_thinq
switch
binary_sensor
climate
event
fan
number
sensor
select
vacuum
integration

The LG ThinQ integration allows you to connect LG ThinQ devices to Home Assistant. The features of this integration include:

Prerequisites

Personal Access Token (PAT)

  1. Access the personal access token page (requires an LG ThinQ account).
  2. Select ADD NEW TOKEN.
  3. Enter a new token name and select the following authorized scopes:
    • Permission to view all devices
    • Permission to view all device statuses
    • All device control rights
    • All device event subscription rights
    • All device push notification permissions
  4. Select CREATE TOKEN.
  5. Once all the steps are completed, you will see that a PAT has been generated.

{% include integrations/config_flow.md %}

  1. Enter the information to use LG ThinQ Connect API:
    • The Token Value obtained through the PAT issuance process. (Required)
    • The entry name.
  2. Choose the region (country).

Supported Devices

Appliance

Support LG Appliances as follows:

Platforms

LG ThinQ represents devices as a set of profiles. And these are mapped to entities in Home Assistant.

A list of all Entity Platforms provided by LG ThinQ Integration:

Binary sensor

A read-only property which has only two states that can be toggled is represented as a binary sensor platform.

Device Property
Cooktop
Dryer
Oven
Styler
Washcombo Main
Washcombo Mini
Washer
Washtower Dryer
Washtower
Washtower Washer
 Enable remote control
Dish Washer Rinse refill needed
Refrigerator Eco-friendly mode
Power saving mode
Enable Sabbath mode
Wine Cellar Enable Sabbath mode

Sensor

A common read-only property is represented as a sensor platform.

Device Property
Air Conditioner PM1
PM2
PM10
Humidity
Odor level
Total pollution level
Filter lifetime
Start timer
Stop timer
Sleep timer
Air Purifier Fan PM1
PM2
PM10
Humidity
Temperature
Monitoring always or on operation
Odor level
Total pollution level
Sleep timer
Air Purifier PM1
PM2
PM10
Humidity
Monitoring always or on operation
Odor level
Total pollution level
Current job mode
Personalizaion mode (preset)
Cooktop Current state
Power level
Remained time
Dehumidifier Current job mode
Current state
Dish Washer Current course
Rinse level
Softening level
Current state
Start timer
Remained time
Total time
Dryer Current state
Start timer
Stop timer
Remained time
Total time
Home Brew Recipe
Wort info
Yeast info
Hop oil info
Flavor
Remained beer
Current state
Elapsed days on state
Elapsed days in total
Humidifier PM1
PM2
PM10
Humidity
Temperature
Monitoring always or on operation
Total pollution level
Start timer
Stop timer
Sleep timer
Kimchi Refrigerator Air filter mode
Target temperature
Microwave Oven Current state
Remained time
Oven Current state
Target temperature
Remained time
Target time
Plant Cultivator Light level
Duration
Current state
Growth mode
Wind volume
Daytime target temperature
Night target temperature
Temperature state
Light start time
Light end time
Refrigerator Air filter mode
Filter used time
Robot Cleaner Current state
Current job mode
Running time
Stick Cleaner Battery percent
Current job mode
Current state
Styler Current state
Start timer
Stop timer
Remained time
Total timer
Washcombo Main Current state
Start timer
Stop timer
Remained time
Total timer
Washcombo Mini Current state
Start timer
Stop timer
Remained time
Total timer
Washer Current state
Start timer
Stop timer
Remained time
Total timer
Washtower Dryer Current state
Start timer
Stop timer
Remained time
Total timer
Washtower Current state
Start timer
Stop timer
Remained time
Total timer
Washtower Washer Current state
Start timer
Stop timer
Remained time
Total timer
Water Heater Temperature
Water Purifier Purification mode
Sterilizing mode
Water type

Climate

The properties for controlling both the temperature and wind strength of the appliance are represented as a climate platform.

Device Property
Air Conditioner Fan mode
HVAC mode
Preset mode
Current temperature
Target temperature
Target temperature high
Target temperature low
Unit
System Boiler HVAC mode
Current temperature
Target temperature
Target temperature high
Target temperature low
Unit

Event

A notification message pushed from the server is represented as a event platform. Supported devices:

Device Property
Air Conditioner
Air Purifier Fan
Air Purifier
Dehumidifier
Humidifier
Kimchi Refrigerator
Microwave Oven
Oven
Refrigerator
Stick Cleaner
Wine Cellar		 Notification
Dish Washer
Dryer
Robot Cleaner
Styler
Washcombo Main
Washcombo Mini
Washer
Washtower Dryer
Washtower
Washtower Washer		 Error message
Notification

Fan

The properties for controlling the wind strength of the appliance are represented as a fan platform.

Device Property
Celing Fan Operation mode
Wind strength

Number

A read-wirte property which has numeric value is represensted as a number platform.

Device Property
Air Conditioner Start timer
Stop timer
Air Purifier Fan Wind temperature
Stop timer
Dryer
Washcombo Main
Washcombo Mini
Washer
Washtower Dryer
Washtower
Washtower Washer		 Start timer
Stop timer
Hood Lamp brightness
Fan speed
Humidifier Target humidity
Stop timer
Microwave Oven Lamp brightness
Fan speed
Oven
Refrigerator
Water Heater		 Target temperature
Styler Stop timer
Wine Cellar Light status
Target temperature

Vacuum

The properties for controlling the clean operations of the appliance are represented as a vacuum platform.

Device Property
Robot Cleaner Battery level
Operation mode
Current state

Select

A writable property which has a list of selectable values is represensted as a select platform.

Device Property
Air Conditioner Monitoring always or on operation
Air clean mode
Air Purifier Fan Wind strength
Wind angle
Warm mode
Light level
Current job mode
Air Purifier Wind strength
Current job mode
Dehumidifier Wind strength
Dish Washer Operation mode
Dryer
Washtower Dryer		 Operation mode
Humidifier Warm mode
Wind strength
Light level
Current job mode
Hygiene dry mode
Oven Cook mode
Operation mode
Refrigerator Express mode
Rapid freeze
Styler Operation mode
Washcombo Main
Washcombo Mini
Washer
Washtower Washer		 Operation mode
Washtower Dryer operation mode
Washer operation mode
Water Heater Current job mode
Wine Cellar Light brightness

Switch

A read-wirte property which has only two states that can be toggled is represensted as a switch platform.

Device Property
Air Conditioner Enable power save mode
Air Purifier Fan Fan operation mode
UV sterilization
Air Purifier Air purifier operation mode
Dehumidifier Dehumidifier operation mode
Humidifier Humidifier operation mode
Warm mode
Mood lamp state
Auto mode
Sleep mode
Refrigerator Express mode
Rapid freeze
System Boiler Operation mode
Enable hot water mode

Troubleshooting

Setup

Aborted: The token is not valid

This error occurs when the Personal Access Token (PAT) is invalid or entered incorrectly. Please visit the Personal Access Token Page page to check if your token is valid.

Aborted: The country is not supported

Check your PAT's valid country in the Choose the region / Country section.

Error: The number of API calls has been exceeded

This error occurs when there's an abnormal number of API calls made using the PAT. The LG ThinQ integration will work properly after some time.

Debugging

The LG ThinQ integration will show additional information by enabling log configuration. Add the line to your {% term "configuration.yaml" %}: Don't forget to remove the line again once you are done debugging.

logger:
  default: info
  logs:
    homeassistant.components.lg_thinq: debug