@mp-consulting/homebridge-lg-thinq 1.0.0

package/.claude/settings.local.json

@@ -0,0 +1,15 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(git add:*)",
+      "Bash(git commit:*)",
+      "Bash(npm run build:*)",
+      "Bash(npm test:*)",
+      "Bash(npm run test:coverage:*)",
+      "Bash(npm install:*)",
+      "Bash(tree:*)",
+      "Bash(mkdir:*)",
+      "Bash(npm run lint)"
+    ]
+  }
+}

package/CHANGELOG.md

@@ -0,0 +1,98 @@
+# Change Log
+
+## v1.8.0
+
+### Washer is fixed now
+* Washer should be appear in Home app now, so sorry for my mistake in previous version.
+* Reset Homebridge accesssory cache is required to make it work.
+
+### New Device Supported
+
+* New kind of washer is supported also (device type 223)
+
+## v1.7.0
+
+- fix: washer service name  a9fa96a
+- fix: air purifier service name  6a7937f
+- fix: refrigerator service name  4faca7f
+- fix: AC warning message  b53642d
+- add: refrigerator water filter status #260  d0ef884
+- fix: dishwasher crashed #270  7efddaf
+- fix: AC temperature not updated #177  e934f81
+- revert: server.js in custom UI  e11b2a6
+- fix: retrieve sale model if possible #275  d6df494
+
+## v1.6.0
+
+### New Device Supported
+
+* Oven
+* Microwave
+
+## v1.5.0
+
+### IMPORTANT: AC temperature unit need to be set in plugin setting
+- if your AC is in Fahrenheit, please change it in plugin setting to make sure the temperature value is correct, otherwise it will be converted to Celsius by default.
+- in previous version, the temperature unit is auto detected, but it's not reliable, so we have to change it to manual setting.
+
+## v1.4.0
+
+- fix: AC humidity value on some device #224  c4227b4
+- add: custom characteristic for AC energy consumption #222  6b36c7a
+- add: dishwasher data sample  3805ce1
+- enable refrigerator door sensor on thinq 1  1d99daf
+- fix: Washer tub clean coach event triggered multiple times  aaa8920
+
+## v1.3.0
+
+### New Device Supported
+
+* Range Hood
+* AeroTower
+
+### Bug fixes
+
+* Air Conditioner fahrenheit unit (US region)
+* Washer/Dryer as water faucet appear again on ios 16
+
+### New feature
+
+* Filter status on Air Purifier
+* Tub clean event on Washer/Dryer (trigger at 30 cycle)
+
+## v1.2.0
+
+### Changes
+
+* Real-time device data update via MQTT (thinq2 only)
+* More device support
+
+### Bug fixes
+
+* Update login workflow: preLogin step
+
+### Other Changes
+
+* Washer door lock disable by default, need enable it in plugin setting
+* Refrigerator: Express Freezer (Ice Plus), Express Fridge, Eco Friendly
+* UI device list: changed to tabarray
+
+## v1.1.0
+
+### Changes
+
+* AC supported
+* Refrigerator thinq1
+
+### Bug fixes
+
+* washer program finished trigger (as Occupancy Sensor)
+* thinq1 device monitor
+
+## v1.0.0
+
+### stable release
+
+* config UI with 3rd party login support (Google, Facebook ...)
+* devices support: Air Purifier, Dehumidifier, Dishwasher, Refrigerator, Washer & Dryer
+* more device support in future

package/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,114 @@
+
+<p align="center">
+<img src="https://raw.githubusercontent.com/homebridge/branding/latest/logos/homebridge-wordmark-logo-vertical.png" width="150">
+</p>
+
+
+# Homebridge LG ThinQ
+
+[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
+[![npm](https://img.shields.io/npm/v/homebridge-lg-thinq/latest?label=latest)](https://www.npmjs.com/package/homebridge-lg-thinq)
+[![npm](https://img.shields.io/npm/dt/homebridge-lg-thinq)](https://www.npmjs.com/package/homebridge-lg-thinq)
+[![join-discord](https://badgen.net/badge/icon/discord?icon=discord&label=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/mp-consulting/homebridge-lg-thinq/wiki/Wiki) for specific device configuration.
+- `thinq1` Optional. Enable thinq1 device support
+- `platform` value always `LGThinQ`
+
+## Plugin Authorization Setting
+
+* See [Plugin Authorization Setting](docs/authorization.md)
+
+## Device specific configuration
+
+* See [Device Configuration](docs/device-configuration.md)
+
+## 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/mp-consulting/homebridge-lg-thinq/issues/87)
+
+## Support
+
+If you have a question, please [start a discussion](https://github.com/mp-consulting/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/mp-consulting/homebridge-lg-thinq/issues/new/choose).
+
+## CLI Usage
+
+```
+$ thinq
+Usage: thinq [options] [command]
+
+Options:
+  -c, --country <type>         Country code for account (default: "US")
+  -l, --language <type>        Language code for account (default: "en-US")
+  -h, --help                   display help for command
+
+Commands:
+  login <username> <password>  Obtain refresh_token from LG account
+  auth                         Obtain refresh_token from account logged by Google Account, Apple ID
+  help [command]               display help for command
+```