supported_hardware:tplink
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
supported_hardware:tplink [2019/11/15 17:50] – [TP-Link/Kasa Powerstrip] James Sentman | supported_hardware:tplink [2023/03/04 16:23] – [TP-Link/Kasa Device:] added power recovery preset info and new screenshot James Sentman | ||
---|---|---|---|
Line 1: | Line 1: | ||
=====TP-Link / Kasa===== | =====TP-Link / Kasa===== | ||
- | Currently at version | + | Currently at version |
The TP-Link/ | The TP-Link/ | ||
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. | **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:// | ||
====Device Configuration: | ====Device Configuration: | ||
Line 15: | Line 18: | ||
{{: | {{: | ||
- | **Automatically Create Units In XTension:** defaults to On. If checked then any devices | + | **Device Discovery: |
- | + | ||
- | **Default Polling Interval:** TP-Link/ | + | |
- | + | ||
- | Each Unit has a configuration option to override | + | |
- | + | ||
- | + | ||
- | **Discovery Interval:** The number of seconds between automatic discovery intervals. Set to 0 to disable automatic discovery. This will do a discovery looking for new devices at this interval. If this is running then if you add new devices | + | |
< | < | ||
tell xInterface “this interface name” to discover() | tell xInterface “this interface name” to discover() | ||
Line 29: | Line 24: | ||
That will return immediately as the discovery is an async process. If the “Create New Units” checkbox above is selected then any new units discovered will be created in XTension. | That will return immediately as the discovery is an async process. If the “Create New Units” checkbox above is selected then any new units discovered will be created in XTension. | ||
+ | |||
+ | **Default Polling Interval:** TP-Link/ | ||
+ | |||
+ | Each Unit has a configuration option to override the default polling interval for that specific device. | ||
+ | |||
====XTension Unit Types:==== | ====XTension Unit Types:==== | ||
Line 34: | Line 34: | ||
In XTension a Unit will be created for each Device discovered. You can manually create other units for the energy monitor functions if available. The Units when created will be given the same name that you have configured in the Kasa app when you set them up. After that you can change the name of the XTension unit to anything you wish. These changes are not sent back to the Devices. The names are only read when creating the units. Once the unit is created you can change the name of either the XTension Unit or the Device without affecting the other. | In XTension a Unit will be created for each Device discovered. You can manually create other units for the energy monitor functions if available. The Units when created will be given the same name that you have configured in the Kasa app when you set them up. After that you can change the name of the XTension unit to anything you wish. These changes are not sent back to the Devices. The names are only read when creating the units. Once the unit is created you can change the name of either the XTension Unit or the Device without affecting the other. | ||
- | The address of the XTension Units will be the MAC address of the device with the exception of the powerstrip outlet Units which will be the MAC address followed by a period and then the index of the outlet starting at 0. | + | The address of the XTension Units will be the MAC address of the device with the exception of the powerstrip outlet Units which will be the MAC address followed by a period and then the index of the outlet starting at 0. So something like 12: |
+ | All units support the [[dictionary: | ||
+ | |||
+ | < | ||
+ | query “name of unit you wish to query” | ||
+ | </ | ||
+ | |||
+ | Remember that the query is done async. The query command returns immediately and if there is any change to the unit status then the unit will update when that is received back from the device. | ||
===TP-Link/ | ===TP-Link/ | ||
- | {{: | + | |
+ | {{: | ||
**Device Polling:** | **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. | 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:** | **Manage Meta Data Units:** | ||
Line 74: | Line 92: | ||
===History=== | ===History=== | ||
* The TP-Link/ | * The TP-Link/ | ||
+ | * 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. |
supported_hardware/tplink.txt · Last modified: 2023/03/04 16:33 by James Sentman