Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nvuln/homebridge-lg-thinq
A Homebridge plugin for controlling/monitoring LG ThinQ device via their ThinQ platform.
https://github.com/nvuln/homebridge-lg-thinq
homebridge homekit lg-thinq smartthinq
Last synced: 1 day ago
JSON representation
A Homebridge plugin for controlling/monitoring LG ThinQ device via their ThinQ platform.
- Host: GitHub
- URL: https://github.com/nvuln/homebridge-lg-thinq
- Owner: nVuln
- License: apache-2.0
- Created: 2021-04-20T05:57:58.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-12-01T17:11:09.000Z (about 2 months ago)
- Last Synced: 2025-01-25T19:02:28.976Z (1 day ago)
- Topics: homebridge, homekit, lg-thinq, smartthinq
- Language: TypeScript
- Homepage: https://github.com/nVuln/homebridge-lg-thinq
- Size: 788 KB
- Stars: 200
- Watchers: 13
- Forks: 49
- Open Issues: 50
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Homebridge LG ThinQ
[](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
[](https://www.npmjs.com/package/homebridge-lg-thinq)
[](https://www.npmjs.com/package/homebridge-lg-thinq)
[](https://discord.gg/wEfQpCDtS7)
## Overview
A Homebridge plugin for controlling/monitoring LG ThinQ device via their ThinQ platform.
⚠️ This library works with v2 of the LG ThinQ API. But some v1 device may backward compatible, please check table [Implementation Status](#implementation-status) below.
A plugin for interacting with the "LG ThinQ" system, which can control new LG smart device. API used in this plugin is not official, I reversed from their "LG ThinQ" mobile app.
## Installation
```
npm i -g homebridge-lg-thinq
```
# Configuration
> ✔️ I highly recommend using [homebridge-config-ui-x](https://github.com/oznu/homebridge-config-ui-x#readme) to make these changes.
1. Navigate to the Plugins page in [homebridge-config-ui-x](https://github.com/oznu/homebridge-config-ui-x).
2. Click the **Settings** button for the LG ThinQ plugin.
3. Login to your LG account
4. Add or remove which devices you want
5. Restart Homebridge for the changes to take effect.
> ⚠️ Or you can manual edit it, add json below to config.json (not recommend)
```json
{
"auth_mode": "token",
"refresh_token": "**refresh*token**",
"username": "lg username",
"password": "lg password",
"country": "US",
"language": "en-US",
"thinq1": false,
"devices": [
{
"id": "device id"
}
],
"platform": "LGThinQ"
}
```
- `auth_mode` Required. You can choose between `token` and `account`
- `refresh_token` Required if `auth_mode` = `token`. The `refresh_token` of your account.
- `username` Required if `auth_mode` = `account`. LG thinQ account
- `password` Required if `auth_mode` = `account`. LG thinQ password
- `country` Required. Your account [country alpha-2 code](https://www.countrycode.org/), e.g., US for the USA.
- `language` Required. Your account language code, e.g., en-US, vi-VN.
- `devices` List devices you want add to homebridge, leave it empty if you want add all devices. See [Wiki](https://github.com/nVuln/homebridge-lg-thinq/wiki/Wiki) for specific device configuration.
- `thinq1` Optional. Enable thinq1 device support
- `platform` value always `LGThinQ`
## Plugin Authorization Setting
* See [Wiki - Plugin Authorization Setting](https://github.com/nVuln/homebridge-lg-thinq/wiki/Plugin-Authorization-Setting)
## Device specific configuration
* See [Wiki - Device Configuration](https://github.com/nVuln/homebridge-lg-thinq/wiki/Device-Configuration)
## Implementation Status
| *Device* | *Implementation* | *Status* | *Control* | *Thinq2* | *Thinq1* |
|----------------| --- | --- | --- | --- | --- |
| Refrigerator | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| Air Purifier | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| Washer & Dryer | ✔️ | ✔️ | 🚫 | ✔️ | ✔️ |
| Dishwasher | ✔️ | ✔️ | 🚫 | ✔️ | 🚫 |
| Dehumidifier | ✔️ | ✔️ | ⚠️ | ✔️ | 🚫 |
| AC | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| Oven | ✔️ | ✔️ | ✔️ | ⚠️ | ⚠️ |
| Microwave | ✔️ | ✔️ | ✔️ | ⚠️ | ⚠️ |
for more device support please open issue request.
## Contributors ✨
- Special thank to [carlosgamezvillegas](https://github.com/carlosgamezvillegas) for implementing Oven & Microwave device support. More detail in [#87](https://github.com/nVuln/homebridge-lg-thinq/issues/87)
## Support
If you have a question, please [start a discussion](https://github.com/nVuln/homebridge-lg-thinq/discussions/new) or leave a message at [discord channel](https://discord.gg/wEfQpCDtS7).
If you would like to report a bug, please [open an issue](https://github.com/nVuln/homebridge-lg-thinq/issues/new/choose).
## CLI Usage
```
$ thinq
Usage: thinq [options] [command]
Options:
-c, --country Country code for account (default: "US")
-l, --language Language code for account (default: "en-US")
-h, --help display help for command
Commands:
login Obtain refresh_token from LG account
auth Obtain refresh_token from account logged by Google Account, Apple ID
help [command] display help for command
```