supported_hardware:tplink
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
supported_hardware:tplink [2019/11/15 17:44] – [TP-Link / Kasa] added warning of incompatibility James Sentman | supported_hardware:tplink [2023/02/13 14:52] – external edit 127.0.0.1 | ||
---|---|---|---|
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. | ||
- | ====Plugin Configuration: | ||
- | {{: | ||
- | **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. | + | ====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 | ||
- | **Default Polling Interval:** TP-Link/ | + | ====Device Configuration:==== |
+ | Add the device to your local network in the normal way using the iOS or Android app. Once the device is available | ||
- | Each Unit has a configuration option to override the default polling interval for that specific device. | + | ====Plugin Configuration: |
- | + | {{: | |
- | + | ||
- | **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 | + | |
+ | **Device Discovery: | ||
< | < | ||
tell xInterface “this interface name” to discover() | tell xInterface “this interface name” to discover() | ||
Line 25: | 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 30: | 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/ | ||
{{: | {{: | ||
+ | |||
+ | Dimmable TP-Link/ | ||
**Device Polling:** | **Device Polling:** | ||
Line 50: | Line 63: | ||
After the main powerstrip Unit is created, a separate “Powerstrip Outlet” Unit will be created for each controllable outlet in the device. For many devices they can have their own watts and KWH monitoring units created but if you create an RSSI unit for an outlet it will just log an error condition as the individual outlets do not send a separate RSSI from the main device. | After the main powerstrip Unit is created, a separate “Powerstrip Outlet” Unit will be created for each controllable outlet in the device. For many devices they can have their own watts and KWH monitoring units created but if you create an RSSI unit for an outlet it will just log an error condition as the individual outlets do not send a separate RSSI from the main device. | ||
+ | |||
+ | 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. | ||
Line 68: | Line 83: | ||
===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