jimboca / udi-poly-kasa

UDI ISY Polyglot NodeServer for TP-Link Kasa

kasa-polyglot

This is the TP Link Kasa Poly for the Universal Devices ISY994i Polyglot interface with Polyglot V2 (c) JimBoCA aka Jim Searle MIT license.

This node server is intended to support all devices supported by the pyHS100 Python Library

This nodeserver relies on a mostly undocumented and officially supported local API which of course TP-Link could break at any time.

Installation

This nodeserver will only work on a machine running on your local network, it will not work with Polyglot Cloud until TP-Link releases a public API for their cloud interface.

1. Backup Your ISY in case of problems!
   • Really, do the backup, please
2. Go to the Polyglot Store in the UI and install.
3. Add NodeServer in Polyglot Web
4. Open the admin console (close and re-open if you had it open) and you should see a new node 'Kasa Controller'
5. The auto-discover should automatically run and find your devices and add them. Verify by checking the nodeserver log
   • While this is running you can view the nodeserver log in the Polyglot UI to see what it's doing

Usage

This node server makes every attempt to handle devices which are not responding for any reason, like they are unplugged or powered off. When a device is Discovered it is remembered, so if it doesn't respond on the next discovery it will still be an active device and when powered up it will be seen as connected.

The node server does not require that you reserve IP addresses for the devices, the device address is remembered based on it's MAC address, so if the IP address changes, it will be properly handled. (This has not been extensively tested, needs more verification)

Kasa Devices

Known working

The known list of supported devices models are:

• HS100 (US)
• HS110 (US)
• HS300 (US)
• KL110 (US)
• KL120 (US)
  • Currently limited to on/off and brightness. Can not set temperature yet.
• KL130 (US)
  • Currently limited to on/off and brightness. Can not set colors or temperature yet.

If you have another device not listed and it is working properly please let me know.

Unknown devices

All other simple plug and bulb devices should work, the nodeserver attempts to figure out the capabilities of the device instead of hardcoding based on the model. But if you have an issue please add to UDI Poly Kasa Issues Feel free to Fork this repo and add support as you like and send me a pull request.

Kasa Controller

This is the main node created by this nodeserver and manages the devices.

Node Drivers

The settings for this node are

Node Server Connected

• Status of nodeserver process, this should be monitored by a program if you want to know the status

TODO: Devices

• The number of devices currently managed

TODO: Debug Mode

• The debug printing mode

TODO: Short Poll

• This is how often it will Poll the Devices to get status

TODO: Long Poll

• Updates other device status like emeter.

Node Commands

The commands for this node

Query

• Poll's all devices and sets all status in the ISY

Discover

• Run's the auto-discover to find your devices

Install Profile

• This uploads the current profile into the ISY.
• Typically this is not necessary, but sometimes the ISY needs the profile uploaded twice.

Kasa Devices

The supported Kasa devices can have different status and commands, but these are the common ones.

Node Drivers

The settings for this node are

Status (ST)

• Status of device, on, off, or brightness.

Connected (GV0)

• True if device is communicating

Node Commands

The commands for these nodes

Query

• Poll's all devices and sets all status in the ISY

On, Off

• Turn device on or off

Issues

If you have an issue where the nodes are not showing up properly, open the Polyglot UI and go to Kasa -> Details -> Log, and click 'Download Log Package' and send that to [e-mail] as an email attachment, or send it in a PM Universal Devices Forum

Upgrading

Open the Polyglot web page, go to nodeserver store and click "Update" for "Kasa".

Then restart the Kasa nodeserver by selecting it in the Polyglot dashboard and select Control -> Restart, then watch the log to make sure everything goes well.

Release Notes

• 2.5.0: 04/28/2021
  • Added HS220 support Thanks to @albrandwood
• 2.4.7: 12/10/2020
  • Check python version on startup
• 2.4.6: 11/17/2020
  • Power Strip Plugs status reverts
• 2.4.5: 11/16/2020
  • Many fixes for KL430 LED light strips
  • Fixes for Power on all devices
• 2.4.4: 10/30/2020
  • Fixed bulb on off status
• 2.4.3: 10/29/2020
  • SmartPlugStrip working better now
• 2.4.2: 10/19/2020
  • SmartPlugStrip now working again
• 2.4.1: 10/01/2020
  • Added Support for Smart Light Strip
• 2.4.0: 08/15/2020
  • Issue 6 Convert to new python-kasa library
    • Currently must install manually: pip3 install --user python-kasa --pre --no-warn-script-location
    • And for Polyisy: sudo -u polyglot pip3 install --user python-kasa --pre --no-warn-script-location
  • Now requires Python 3.7 which is available on Polisy by default, but it means your RPi must be on Buster!
• 2.3.3: 02/18/2020
  • Fixed #5
• 2.3.2: 02/01/2020
  • Make sure bulb is on before adjusting other values. Temporary workaround to be fixed better later.
• 2.3.1: 01/27/2020
  • Fix race condition between discover adding smart strip and shortPoll accessing it
  • Dim and Brighten should be working, although tested minimally
• 2.3.0: 01/05/2020
  • Full Color control working on KL130
  • Small speed improvement when setting brightness and color temp at the same time.
• 2.2.6: 01/02/2019
  • Controller long/short Poll runs in threads so main program is more responsive
• 2.2.5: 12/31/2019
  • Moved main short/long poll into threads so main thread is more responsive
• 2.2.4: 12/30/2019
  • KL110 and KL120 can be added to scenes, but still more functions to implement
• 2.2.3: 12/27/2019
  • Add support for KL120 (Dimmable Color Temperature with Energy)
  • Switch to locally checked out pyHS100 with discovery fix for Polisy
• 2.2.2 11/06/2019
  • Fix to reconnect to device that wasn't responding when nodeserver started
• 2.2.1 10/15/2019
  • Fix crash when discover takes a long time to complete and devices are not yet initialized for shortPoll
• 2.2.0 10/13/2019
  • Lot's of rework to allow supporting any Kasa device based on the capabilities instead of hardcoding the model names.
  • Set Brightness also working.
• 2.1.1 10/01/2019
  • Remove from cloud
• 2.1.0 09/21/2019
  • Merge changes from @eagleco to support plugs, thank you!
  • Fixed to work for those with emeter (HS110) and those without (HS100)
  • Adding support for SmartBulbs, only limited support currently.
• 2.0.3 04/21/2019
  • Fixed controller naming, sorry if you are using this you will need to:
    • Go to Polyglot Web page
    • Update the Nodeserver in the Store
    • Delete the Nodeserver
    • Add it again
• 2.0.2 03/29/2019
  • Fixed shortPoll to properly update
• 2.0.1 03/28/2019
  • Update ST on shortPoll, added heartbeat
• 2.0.0 03/27/2019
  • Initial version