Coder Social home page Coder Social logo

leondragon / ha-smartthinq-sensors Goto Github PK

View Code? Open in Web Editor NEW

This project forked from ollo69/ha-smartthinq-sensors

0.0 1.0 0.0 327 KB

Home Assistant custom integration for SmartThinQ LG devices configurable with Lovelace User Interface.

License: Apache License 2.0

Python 100.00%

ha-smartthinq-sensors's Introduction

hacs_badge

LG ThinQ Washer, Dryer and Refrigerators integration for HomeAssistant

A Homeassistant custom component to monitor LG Washer, Dryer and Refrigerators using ThinQ API based on WideQ project.

Important Version note: From version 0.3.x component name changed from smartthinq_washer to smartthinq_sensors If you are upgrading to version 0.3.x from previous version, you must remove component configuration and uninstall component from Home Assistant before upgrade.
Refrigerator support start from version 0.3.0 and is under testing. If you have problem rollback to version 0.2.x and wait for new release.

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

Note: some device status may not be correctly detected, this depend on 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.

Installation

You can install this component in two ways: via HACS (as custom repository for the moment) or manually.

Option A: Installing via HACS

If you have HACS, just go in the Integration Tab and search the "SmartThinQ LG Sensors" component to install it.

Option B: Manually installation (custom_component)

  1. Clone the git master branch.

  2. Unzip/copy the smartthinq_sensors direcotry within the custom_components directory of your homeassistant installation. The custom_components directory resides within your homeassistant configuration directory. Usually, the configuration directory is within your home (~/.homeassistant/). In other words, the configuration directory of homeassistant is where the configuration.yaml file is located. 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
            └── ...
    

    Note: if the custom_components directory does not exist, you need to create it.

  3. Reboot HomeAssistant

Component configuration

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

Option A: Configuration using the web UI [recommended]

Simply add a new "integration" and look for "SmartThinQ LGE Sensors" among the proposed ones.

Using UI you have the option to generate a new access token if you don't already have one. Just leave empty the token field 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 you originally created your account with.

Option B: Configuration via editing configuration.yaml (only possible using APIv1)

Follow these steps only if the previous configuration method did not work for you.

  1. 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 (e.g. US)
      language: my_smartthinq_language (e.g. en-US)
    
  2. Reboot HomeAssistant

Be nice!

If you like the component, why don't you support me by buying me a coffe? It would certainly motivate me to further improve this work.

Buy me a coffe!

Credits

This component is developed by Ollo69 based on WideQ API.
Original WideQ API was developed by Adrian Sampson under license MIT.

ha-smartthinq-sensors's People

Contributors

ollo69 avatar kenmaples avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.