Skip to content

UniversalDevicesInc-PG3/udi-poly-kasa

BranchesTags

Repository files navigation

Build Status

UDI Polyglot V3 Kasa Nodeserver

This is the TP Link Kasa Poly for the Universal Devices Polisy with Polyglot Version 3 (PG3)

(c) JimBoCA aka Jim Searle MIT license.

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

This nodeserver relies on a mostly undocumented and unofficially supported local API which of course TP-Link could break at any time, and has in the past, but luckily others figure it out.

Help

If you have any issues are questions you can ask on PG3 Kasa SubForum or report an issue at PG3 Kasa Github issues.

Moving from PG2

There are a few ways to move.

Backup and Restore

The best way to move from PG2 to PG3 is to backup on PG2 and restore on PG3, but the only option is to do all your nodeservers at once. I don't have much information on this method, if you have questions please ask on the PG3 forum.

Delete and add

If you can't or don't want backup/restore then you can delete the NS on PG2 and install on the same slot on PG2. All node addresses will stay the same so all your programs should work after doing an update and save on each one, or rebooting the ISY, especially any using the Controller node since it's ST value has changed.

Add then delete

Another option is to install in a new slot then go edit all your programs and scenes that reference the nodes and switch to the new slots.

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. Open the admin console (close and re-open if you had it open) and you should see a new node 'Kasa Controller'
  4. 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)

Configuration Parameters

change_node_names

This defaults to false, changing to true will change node names to match what is configured in Kasa app on restart or long poll. Note: there is currently a bug in PG3 so renames during long poll are not working, you must restart the node server.

Kasa Devices

Known working

The known list of supported devices models are:

  • HS100 (US)
  • HS110 (US)
  • HS220 (US)
  • HS300 (US) SmartStrip
  • KL110 (US)
  • KL120 (US)
  • KL130 (US)
  • KL430 (US) LightStrip

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

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

Poll Device

  • If the device is going to be unplugged for a while, set this to False so node server will stop attempting to poll.

Many others

  • Depending on the type of device there will be many other drivers, which should be self explanitary.

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 [email protected] as an email attachment, or send it in a PM Universal Devices Forum

Upgrading

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

  • 3.2.3: 11/28/2024
    • BETA: Please only install to test
    • Upgrade to python-kasa>=0.8.0<0.9.0
  • 3.1.4: 12/18/2023
  • 3.1.3: 12/05/2023
  • 3.1.2: 11/28/2023
    • Force python-kasa 0.5.3 to avoid needing rust compiler for now
  • 3.1.1: 11/25/2023
  • 3.1.0: 09/22/2023
  • 3.0.21: 03/28/2023
    • Fix dumb error in print statement added in last release
  • 3.0.20: 03/19/2023
    • Fix to trap bug in current python-kasa library
  • 3.0.18: 12/10/2022
    • Try and fix issues for devices that don't respond to first discover, then come alive later.
  • 3.0.17: 12/10/2022
    • Move to new udi_interface rename_node method instead of previous hack
    • Node renames are only done on restart of the node server
  • 3.0.16: 11/17/2022
  • 3.0.14: 11/15/2022
    • Trap exception when adding a new device and it fails to update
  • 3.0.13: 11/14/2022
    • Fixed Add option to disable polling a device
      • If a device is going to be unplugged for a while, set the Poll Device to False.
    • Also, reworked how polling is done so one device not responding doesn't slow down polling other devices.
  • 3.0.12: 11/12/2022
  • 3.0.11: 07/23/2022
  • 3.0.10: 04/13/2022
  • 3.0.9: 02/20/2022
    • Profile fixes
  • 3.0.8: 02/17/2022
  • 3.0.7: 12/14/2021
    • Added conn_status to Controller so ST is properly set
      • Existing users will need to delete the controller node in the Polyglot UI and restart the NS
  • 3.0.6: 12/14/2021
    • Fixed profile for Status of all devices that have energy values
  • 3.0.5: 11/23/2021
    • Fix Set XY initial values to not use any driver to fix UDMobile error
  • 3.0.4: 11/22/2021
    • More Duration fixes (RR) in nodedef, but still not completely working
  • 3.0.3: 11/21/2021
    • Fix Duration Time, although not completly working
  • 3.0.2: 11/13/2021
    • Discover new devices added while nodeserver is already running now works
  • 3.0.1: 11/13/2021
    • Smartstrips working properly
  • 3.0.0: 11/13/2021
    • First PG3 release!
  • 2.5.0: 04/28/2021
  • 2.4.7: 12/10/2020
    • Check python version on startup
  • 2.4.6: 11/17/2020
  • 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
  • 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

About

No description, website, or topics provided.

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

0 stars

Watchers

3 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages