Differences

This shows you the differences between two versions of the page.

--- supported_hardware:tplink [2020/02/19 21:47] – [History] added note about removing automatic discovery James Sentman
+++ supported_hardware:tplink [2023/03/04 16:33] (current) – added power recovery preset command James Sentman
@@ Line 1: / Line 1: @@
 =====TP-Link / Kasa=====
-Currently at version 0.1 beta released 11/15/2019 and included in XTension 9.4.26
+Currently at version 1.1 2/19/2020 and included in XTension 9.4.28
 The TP-Link/Kasa plugin is included in the standard XTension distribution and supports the currently shipping appliance modules, dimming modules, non-color bulbs, color bulbs and color temperature bulbs as well as their multi-controllable outlet power strips. If the device supports the energy monitor functions then some combination of current usage in watts as well as historical KWH usage may also be available.
@@ Line 8: / Line 8: @@
 **Note:** There are many and varied WiFi controllable devices out there. This one is compatible only with devices branded as TP-Link or Kasa. This is not compatible with Sonoff or any other devices that I am aware of. There may be other off brand ones that use the same local network protocol, but I wouldn’t count on it just because they are made to look like the TP-Link devices.
-====Requirements:====
-This plugin requires Python3 which is not part of the standard MacOSX install. If you haven’t already done so for one of the other plugins that also require python3 please download and install that from [[https://www.python.org/downloads/]]
 ====Device Configuration:====
@@ Line 45: / Line 42: @@
 ===TP-Link/Kasa Device:===
-{{:supported_hardware:tplink-devicesettings.png?400 |}}All single end point devices like Smart Outlets and Smart Bulbs will create a single XTension Unit of type “Kasa Device”. Depending on the capabilities discovered when the unit is created it will be properly setup as dimmable or non-dimmable, as well as having it’s color and color temperature capabilities turned on or off automatically.
-Dimmable TP-Link/Kasa devices do not appear to have any support for the “rate” parameter. There is no way to control how rapidly they dim or brighten or change color. If you wish you can use the scripted [[tutorials:slow_fade|Slow Fade]] example to emulate such a function for dimming. Color changes are not so easily adjusted that way.
+{{:supported_hardware:tplink-devicesettings.png?550 |}}All single end point devices like Smart Outlets and Smart Bulbs will create a single XTension Unit of type “Kasa Device”. Depending on the capabilities discovered when the unit is created it will be properly setup as dimmable or non-dimmable, as well as having it’s color and color temperature capabilities turned on or off automatically.
 **Device Polling:**
 If you wish you can override the Default Polling Interval you set in the Plugin Settings window above. If you have polling turned off globally you can still enable it for individual Devices by setting a value here. Enter 0 to disable polling for this Device, leave blank to use the global default setting or set to any value greater than 5 seconds. The faster you poll a device the faster the XTension database will conform to the current settings of the device. When controlling a Device from XTension the database will always be correct, if you control the Device from another control point like the mobile app those changes must be polled to be found. If you never control the Device from anywhere but XTension you can turn polling off.
+**Send Power Recovery Preset Level:**
+Some especially older Bulbs have a problem with turning on remotely to a different level or color than they were at when they were turned off. They will immediately start ramping to the last in use level before then changing to the new level you are sending them. This can be a problem if you are using the bulb somewhere you don’t want a flash of bright light when you turn on the light. Checking this box will have XTension send the brightness level you set immediately before turning it off. A low value like the default of 1% will avoid the Nova effect but it also makes it impossible to turn the lamp on by physically turning the bulb off and back on again, as it will only return to the 1% level. So for bulbs that do not nova you can turn this off.
+You can also leave this on and then whenever XTension turns the bulb off it will send whatever value is there, This makes it possible to set the power on level whenever you turn off the bulb. This value is ONLY sent if XTension turns off the light, and the light is powered on and available at the time. It cannot change the level if the bulb is offline.
+This is sent to the bulb anytime an Off is sent. The bulb does not have to be On to get this command, though you may see a momentary flicker of light from it as it starts to ramp up to the preset level before receiving it’s off command again.
+You can change this value programmatically by using the setPowerRecoveryPreset command. See the section below on scripting commands for more info on using that.
 **Manage Meta Data Units:**
@@ Line 66: / Line 72: @@
 Other multi-outlet devices such as the outdoor dual outlet module and the wired outlet devices with each outlet controllable separately will show up as powerstrips with only 2 outlets or however many outlets that they support.
+====Set Power Recovery Preset Scripting Command:====
+In the section on Kasa Device setup above the setPowerRecoveryPreset command is mentioned. This is the scripting command you can use to change the value for the Unit at any time programatically. Note that this does not actually send anything to the Unit by itself, it just sets the value in the Unit preferences so that the next time an Off is sent to the Unit it can include this value. If the lamp is already off you can then send it an Off command which will not change the visible state of the Bulb but will reset it’s preset level. If the lamp is on you cannot send it the preset except by turning it off or just dimming it to the new level. If the bulb is physically powered off then no changes of any kind can be sent to the lamp.
+This might be useful if you wanted to set a different power on level for lamps before going to bed vs in the morning and during the day or something similar to that.
+<code>
+tell xUnit “Name Of Your Kasa Bulb Unit in XTension” to setPowerRecoveryPreset( 75)
+</code>
-====Note:====
-This plugin uses an undocumented protocol to talk to the devices on the local network and therefore does not require internet access or for the devices to be connected to the cloud in order to work. This is the same protocol that the Kasa iOS and Android app use to control the devices when on the same subnet. While I hope it is unlikely, it is possible that they could change this at any moment making the plugin unusable. I would recommend that before updating any devices firmware in the future that you verify either on this site or by experimenting with one device that things continue to work properly.
-====ToDo:====
-  * Test with other multi-outlet devices such as the hardwired Electric Outlets that have 2 controllable outlets and the outside dual controllable outlet device. I have an outdoor unit on order which should arrive soon and I’ll be able to verify that these work or work on supporting them in the next version.
-  * Some of the devices that support KWH tracking can also give historical information for just this day as well as monthly or other intervals. A meta data unit that tracked the usage for the current day and month would be useful.
-  * A way to reset the KWH usage would be useful.
-  * Some devices also report the voltage level at the plug. Create an optional meta data unit to track this for supported devices.
+====Note:====
+This plugin uses an undocumented protocol to talk to the devices on the local network and therefore does not require internet access or for the devices to be connected to the cloud in order to work. This is the same protocol that the Kasa iOS and Android app use to control the devices when on the same subnet. While I hope it is unlikely, it is possible that they could change this at any moment making the plugin unusable. I would recommend that before updating any devices firmware in the future that you verify either on this site or by experimenting with one device that things continue to work properly.
 ===History===
   * The TP-Link/Kasa plugin was added as a beta version in XTension build 9.4.26 on 11/15/2019
   * The automatic discovery interval was removed in version 1.1 of the plugin which was included in XTension build 9.4.28. The discovery would cause units to be lost if it intersected with an actual control or poll of a device. If you need to discover a new device click the Discover New Devices Now button at any time or use the scripting command documented above.
+  * Added the ability to control the power recovery preset level for Bulbs in XTension 9.5.2 and plugin version 2.0.4 in March of 2023.