supported_hardware:tplink
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
supported_hardware:tplink [2019/11/17 13:47] James Sentman added requirements and note about not supporting the rate parameter and link to the slow fade example |
supported_hardware:tplink [2020/02/19 22:05] (current) James Sentman updated version numbers |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| =====TP-Link / Kasa===== | =====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. | 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 18: | Line 18: | ||
| {{:supported_hardware:tplink-settings.png?400 |}}Only a single instance of the plugin is necessary to control all the devices on the local subnet. | {{:supported_hardware:tplink-settings.png?400 |}}Only a single instance of the plugin is necessary to control all the devices on the local subnet. | ||
| - | **Automatically Create Units In XTension:** defaults to On. If checked then any devices discovered on the local network will automatically have a Unit in XTension created for them when they are discovered. If you do not wish all the units on the network to be in the XTension database then turn this off after creating the ones that you need. | + | **Device Discovery:** If the “Automatically Create Units In XTension” checkbox is checked then any new device discovered on the network will automatically have a corresponding unit created in XTension. The “Discover New Devices Now” button should be clicked after you add new devices to the network so that they can be added to XTension’s database. There is also a scripting command to trigger a discovery process: |
| + | <code> | ||
| + | tell xInterface “this interface name” to discover() | ||
| + | </code> | ||
| + | |||
| + | 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/Kasa devices do not send a message when their state is controlled locally or via the iOS or other app. The only way to know if you have controlled a device through another channel is to poll them regularly. Set to 0 to make the default to not poll a device or any number of seconds larger than 10. This is a very small amount of network traffic and doing it even as much as every 30 seconds should not cause any problematic usage on your network unless you have hundreds of devices. If you never control your devices from any other place than XTension you can turn this off entirely. The other purpose that regularly polling devices serves is to check for them to actually be online. When a device is controlled or polled and it is not responding, either because it has been manually turned off in the case of a bulb or unplugged in the case of an outlet it will figure that out and set a unit error at the poll. If you are not polling the devices then you will not have an indication that the device is not available until you try to control it and it is not there. | **Default Polling Interval:** TP-Link/Kasa devices do not send a message when their state is controlled locally or via the iOS or other app. The only way to know if you have controlled a device through another channel is to poll them regularly. Set to 0 to make the default to not poll a device or any number of seconds larger than 10. This is a very small amount of network traffic and doing it even as much as every 30 seconds should not cause any problematic usage on your network unless you have hundreds of devices. If you never control your devices from any other place than XTension you can turn this off entirely. The other purpose that regularly polling devices serves is to check for them to actually be online. When a device is controlled or polled and it is not responding, either because it has been manually turned off in the case of a bulb or unplugged in the case of an outlet it will figure that out and set a unit error at the poll. If you are not polling the devices then you will not have an indication that the device is not available until you try to control it and it is not there. | ||
| Line 24: | Line 29: | ||
| Each Unit has a configuration option to override the default polling interval for that specific device. | Each Unit has a configuration option to override the default polling interval for that specific device. | ||
| - | |||
| - | **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 they will create a new Unit in XTension as soon as they are found. This also creates only a small amount of network traffic and should not cause a problem unless you have very many devices. You can use the “Discover Devices Now” button to run a discovery manually at any time. There is also a scripting command to run a discovery. In AppleScript you would do something like: | ||
| - | |||
| - | <code> | ||
| - | tell xInterface “this interface name” to discover() | ||
| - | </code> | ||
| - | |||
| - | 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. | ||
| ====XTension Unit Types:==== | ====XTension Unit Types:==== | ||
| Line 86: | Line 83: | ||
| ===History=== | ===History=== | ||
| * The TP-Link/Kasa plugin was added as a beta version in XTension build 9.4.26 on 11/15/2019 | * 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. | ||
supported_hardware/tplink.1573998460.txt.gz · Last modified: 2019/11/17 13:47 by James Sentman
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
