A HomeAssistant custom integration to monitor and control LG devices using ThinQ API based on WideQ project.
Supported devices are:
- Air Conditioner
- Air Purifier
- DishWasher
- Dryer
- Range
- Refrigerator
- Styler
- Washer
Important Version note:
- From version 0.3.x component name changed from
smartthinq_washertosmartthinq_sensorsIf you are upgrading to version 0.3.x from previous version, you must remove component configuration and uninstall component from Home Assistant before upgrade.
Important: The component will not work if you have logged into the ThinQ application and registered your devices using a social network account (Google, Facebook or Amazon). In order to use the component you need to create a new independent LG account and make sure you log into the ThinQ app and associate your devices with it. If during configuration you receive the message "No SmartThinQ devices found", probably your devices are still associated with the social network account. To solve the problem perform the following step:
- remove your devices from the ThinQ app
- logout from the app and login again with the independent LG account
- reconnect the devices in the app
Important 2: If you receive an "Invalid Credential" error during component configuration/startup, check in the LG mobile app if is requested to accept new Term Of Service.
Note: some device status may not be correctly detected, this depends on the model. I'm working to map all possible status developing the component in a way to allow to configure model option in the simplest possible way and provide update using Pull Requests. I will provide a guide on how update this information.
You can install this component in two ways: via HACS or manually.
If you have HACS, just go in the Integration Tab and search the "SmartThinQ LGE Sensors" component to install it.
Prerequisite: SSH into your server. Home Assistant Add-on: SSH server
-
Clone the git master branch.
git clone https://github.com/ollo69/ha-smartthinq-sensors.git -
If missing, create a
custom_componentsdirectory where your configuration.yaml file resides. This is usually in the config directory of homeassistant.
mkdir ~/.homeassistant/custom_components -
Copy the smartthinq_sensors directory within the
custom_componentsdirectory of your homeassistant installation from step 2.
cp -R ha-smartthinq-sensors/custom_components/smartthinq_sensors/ ~/.homeassistant/custom_components -
(Optional) Delete the git repo.
rm -R ha-smartthinq-sensors/After a correct installation, your configuration directory should look like the following.
└── ... └── configuration.yaml └── secrects.yaml └── custom_components └── smartthinq_sensors └── __init__.py └── config_flow.py └── const.py └── ... -
Reboot HomeAssistant
Once the component has been installed, you need to configure it in order to make it work. There are two ways of doing so:
- Using the web interface (Lovelace) [recommended]
- Manually editing the configuration.yaml file
Simply add a new "integration" and look for "SmartThinQ LGE Sensors" among the proposed ones and
follow setup worflow.
Important: use your country and language code: SmartThinQ accounts are associated with a specific locale,
so be sure to use the country and language you originally created your account with.
Reference for valid code:
- Country code: ISO 3166-1 alpha-2 code
- Language code: ISO 639-1 code
Follow these steps only if the previous configuration method did not work for you.
Note: with this configuration the integration will use APIv1 that cannot connect to new LG devices.
This configuration option is deprecated and is not possible starting from version 0.5.4
-
Enable the component by editing the configuration.yaml file (within the config directory as well). Edit it by adding the following lines:
smartthinq_sensors: token: my_smartthinq_token region: my_smartthinq_region #(ISO 3166-1 alpha-2, e.g. US) language: my_smartthinq_language #(ISO-639-1, e.g. en) -
Reboot HomeAssistant
In this example, "My [insert thing]" will just be the placeholder
| Entity ID | Entity Name | Description |
|---|---|---|
| sensor.my_washer | My Washer | Washer, turns On when on, turns Off when off |
| binary_sensor.my_washer_wash_completed | My Washer Wash Completed | Turns On when washer completed wash. You can use it in automations by triggering them when it goes from Off to On. |
| binary_sensor.my_washer_error_state | My Washer Error State | Off/OK means that it's fine. On/Error means there's an error. |
| sensor.my_dryer | My Dryer | Dryer, turns On when on, turns Off when off |
| binary_sensor.my_dryer_dry_completed | My Dryer Dry Completed | Turns On when dryer completed wash. You can use it in automations by triggering them when it goes from Off to On. |
| binary_sensor.my_dryer_error_state | My Dryer Error State | Off/OK means that it's fine. On/Error means there's an error. |
Note: When something doesn't apply and/or is off, it may have a - as its value. Also, these are for @KTibow's washer, values may differ for yours. Feel free to open an issue/PR.
Hidden, click to expand
| Attribute ID | Description |
|---|---|
| model | Model ID of washer |
| mac_address | Mac address of washer |
| run_completed | Turns On when washer completed wash, just like binary_sensor.my_washer_wash_completed. |
| error_state | Off/OK means that it's fine. On/Error means there's an error, just like binary_sensor.my_washer_error_state. |
| error_message | When there is an error, this is what it is. (Format unknown) |
| run_state | Current state of washer in words |
| pre_state | Previous state of washer in words |
| current_course | Current washing cycle in words |
| spin_speed | Current cycle's spin mode in words |
| water_temp | Current cycle's water temperature in words |
| dry_level | Unknown attribute, might be used in combined washers and dryers for the current cycle's dry level |
| tubclean_count | How many cycles have been ran without running the Tub Clean cycle |
| remain_time | How much more time is remaining, H:MM |
| initial_time | The orginal amount of time, H:MM |
| reserve_time | When in Delay Start mode, the delay amount, H:MM |
| door_lock | Whether washer door is locked, on/off |
| child_lock | Whether child lock is on, on/off |
| remote_start | Whether remote start is enabled, on/off |
| steam | Whether steam is enabled on supported washers, on/off |
| pre_wash | Whether using prewash cycle, on/off |
| turbo_wash | Whether Turbowash is enabled, on/off |
Note: When something doesn't apply and/or is off, it may have a - as its value. Also, these are for @KTibow's dryer, values may differ for yours. Feel free to open an issue/PR.
Hidden, click to expand
| Attribute ID | Description |
|---|---|
| model | Model ID of dryer |
| mac_address | Mac address of dryer |
| run_completed | Turns On when dryer completed dry, just like binary_sensor.my_dryer_dry_completed. |
| error_state | Off/OK means that it's fine. On/Error means there's an error, just like binary_sensor.my_dryer_error_state. |
| error_message | When there is an error, this is what it is. (Format unknown) |
| run_state | Current state of dryer in words |
| pre_state | Previous state of dryer in words |
| current_course | Current drying cycle in words |
| temp_control | Current option for dryer temperature in words |
| dry_level | Current level for how much to dry |
| remain_time | How much more time is remaining, H:MM |
| initial_time | The orginal amount of time, H:MM |
| reserve_time | Unknown attribute, it could be this behaves the same as the washer's reserve_time, H:MM |
| child_lock | Child lock, on/off |
- Get a notification when the clothes are done drying (or when the clothes are done washing, automation)
- id: 'dry_clothes_notification'
alias: Dry clothes notification
description: Alert when dryer finishes
trigger:
- entity_id: binary_sensor.my_dryer_dry_completed
platform: state
from: 'off'
to: 'on'
condition: []
action:
- data:
title: 'The clothes are dry!'
message: 'Get them while they're hot!'
service: notify.notifySubstitute "dry" and "dryer" for "wet" and "washer" if you want to use with a washer.
- Custom card for dryer and washer (
)
Hidden, click to expand
Put this file in /config/www/laundry.js, and add a custom resource in HA UI > Sidebar > Config > Dashboards > Resources > Plus > Add /local/laundry.js.
class LaundryCard extends HTMLElement {
// Whenever states are updated
set hass(hass) {
const entityId = this.config.entity;
const state = hass.states[entityId];
// Set data definitions
const friendlyName = state.attributes["friendly_name"] || state.entity_id;
const icon = state.attributes["icon"];
if (!this.content) {
this.innerHTML = `
<ha-card header="${friendlyName}">
<div class="main">
<ha-icon icon="${icon}"></ha-icon>
<span></span>
</div>
</ha-card>
`;
this.querySelector(".main").style.display = "grid";
this.querySelector(".main").style.gridTemplateColumns = "33% 66%";
this.querySelector("ha-icon").style.setProperty("--mdc-icon-size", "100%");
}
if (state.state == "on") {
const totalTime = state.attributes["initial_time"];
const remainTime = state.attributes["remain_time"];
const totalMinutes = (parseInt(totalTime.split(":")[0]) * 60) + parseInt(totalTime.split(":")[1]);
const remainMinutes = (parseInt(remainTime.split(":")[0]) * 60) + parseInt(remainTime.split(":")[1]);
this.querySelector("ha-icon").style.color = "var(--paper-item-icon-active-color)";
this.querySelector("span").innerHTML = `
${friendlyName} is running ${state.attributes["current_course"]}<br>
Currently ${state.attributes["run_state"]}<br>
${state.attributes["initial_time"]} total, ${state.attributes["remain_time"]} to go
<div class="progress-wrapper" style="height: 20px; width: 100%;">
<div class="progress" style="display: inline-block; height: 20px;">
</div>
<span style="color: var(--paper-item-icon-color); position: absolute; right: 33%;">50%</span>
</div>
`;
this.querySelector(".progress-wrapper").style.backgroundColor = "var(--paper-item-icon-color)";
this.querySelector(".progress").style.backgroundColor = "var(--paper-item-icon-active-color)";
this.querySelector(".progress").style.width = (totalMinutes - remainMinutes) / totalMinutes * 100 + "%";
this.querySelector(".progress-wrapper span").innerHTML = Math.round((totalMinutes - remainMinutes) / totalMinutes * 100) + "%";
} else {
this.querySelector("ha-icon").style.color = "var(--paper-item-icon-color)";
this.querySelector("span").innerHTML = `${friendlyName} is off`;
}
}
// On updated config
setConfig(config) {
const states = document.querySelector("home-assistant").hass.states;
if (!config.entity || !states[config.entity] || !states[config.entity].state) {
throw new Error("You need to define an valid entity (eg sensor.my_washing_machine)");
}
this.config = config;
}
// HA card size to distribute cards across columns, 50px
getCardSize() {
return 3;
}
// Return default config
static getStubConfig() {
for (var state of Object.values(document.querySelector("home-assistant").hass.states)) {
if (state.attributes["run_state"] !== undefined) {
return { entity: state.entity_id };
}
}
return { entity: "sensor.my_washing_machine" };
}
}
customElements.define('laundry-card', LaundryCard);
window.customCards.push(
{
type: "laundry-card",
name: "Laundry Card",
preview: true
}
);Lovelace:
type: 'custom:laundry-card'
entity: 'sensor.the_dryer_dryer' # Washers work too!- Alternative: Washer picture status card (LG전자 / CC BY (https://creativecommons.org/licenses/by/2.0) for image. Find the images here)
Hidden, click to expand
configuration.yaml:
sensor:
- platform: template
sensors:
washer_cycle_state:
value_template: '{{state_attr(''sensor.my_washer'', ''remain_time'')}}'
friendly_name: Washer Cycle State
icon_template: 'mdi:washing-machine'lovelace:
cards:
- type: conditional
conditions:
- entity: sensor.my_washer
state: "on"
card:
aspect_ratio: '1'
entity: sensor.washer_cycle_state
image: /local/washerrunning.gif
type: picture-entity
- type: conditional
conditions:
- entity: sensor.my_washer
not_state: "on"
card:
aspect_ratio: '1'
entity: sensor.my_washer
image: /local/washer.jpg
type: picture-entity
type: vertical-stackIf you like the component, why don't you support me by buying me a coffee? It would certainly motivate me to further improve this work.
This component is developed by Ollo69 based on WideQ API.
Original WideQ API was developed by Adrian Sampson under license MIT.