Skip to content
/ wideq-js Public

A Node.JS(TypeScript) port of wideq, a reverse-engineered client for the LG SmartThinQ API

License

Notifications You must be signed in to change notification settings

ssut/wideq-js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

c00aaeb · Aug 21, 2019

History

23 Commits
Aug 21, 2019
Aug 16, 2019
Aug 21, 2019
Aug 21, 2019
Aug 21, 2019
Aug 21, 2019
Aug 15, 2019
Aug 21, 2019
Aug 21, 2019
Aug 21, 2019
Aug 16, 2019
Aug 16, 2019

Repository files navigation

WideQ

npm version Build Status

A Node.JS port of wideq.

# To get started
$ npm install wideq

Why WideQ.js

wideq.js is a pure javascript rewrite of the original wideq library (written in Python). It has a great support for working with SmartThinQ devices, but I wanted to connect it to HomeBridge without python processes, so this is why I've created wideq.js.

Highlights

  • All possible asynchronous functions return Promise.
  • Better development experience with TypeScript typings.

CLI Usage

$ wideq
Usage: WideQJS [options] [command]

Options:
  -V, --version            output the version number
  -C, --country <type>     Country code for account (default: "US")
  -l, --language <type>    Language code for account (default: "en-US")
  -S, --state-path <type>  State file path (default: "wideq-state.json")
  -h, --help               output usage information

Commands:
  auth                     Authenticate
  ls                       List devices
  monitor <deviceId>       Monitor any device, displaying generic information about its status.

$ wideq ls
00000000-0000-0000-0000-000000000000: 제습기 (DEHUMIDIFIER DHUM_056905_WW)

$ wideq monitor 00000000-0000-0000-0000-000000000000
polling...
no status
polling...
no status
polling...
- mode: @AP_MAIN_MID_OPMODE_SMART_DEHUM_W
- windStrength: @AP_MAIN_MID_WINDSTRENGTH_DHUM_HIGH_W
- isAirRemovalOn: true
- targetHumidity: 50
- currentHumidity: 50
- isOn: true

Implementation Status

Device Control Status
Dehumidifer ✔️ ✔️

Credits

This is like a slightly modified(ported) version of wideq. Some APIs could be very different.