python-kasa is a Python library to control TPLink's smart home devices (plugs, wall switches, power strips, and bulbs).
This is a voluntary, community-driven effort and is not affiliated, sponsored, or endorsed by TPLink.
Contributions in any form (adding missing features, reporting issues, fixing or triaging existing ones, improving the documentation, or device donations) are more than welcome!
You can install the most recent release using pip:
pip install python-kasa
For enhanced cli tool support (coloring, embedded shell) install with [shell]:
pip install python-kasa[shell]
If you are using cpython, it is recommended to install with [speedups] to enable orjson (faster json support):
pip install python-kasa[speedups]
or for both:
pip install python-kasa[speedups, shell]
With [speedups], the protocol overhead is roughly an order of magnitude lower (benchmarks available in devtools).
Alternatively, you can clone this repository and use poetry to install the development version:
git clone https://github.com/python-kasa/python-kasa.git
cd python-kasa/
poetry install
If you have not yet provisioned your device, you can do so using the cli tool.
Running kasa discover will send discovery packets to the default broadcast address (255.255.255.255) to discover supported devices.
If your system has multiple network interfaces, you can specify the broadcast address using the --target option.
The discover command will automatically execute the state command on all the discovered devices:
$ kasa discover
Discovering devices on 255.255.255.255 for 3 seconds
== Bulb McBulby - KL130(EU) ==
Host: 192.168.xx.xx
Port: 9999
Device state: True
== Generic information ==
Time: 2023-12-05 14:33:23 (tz: {'index': 6, 'err_code': 0}
Hardware: 1.0
Software: 1.8.8 Build 190613 Rel.123436
MAC (rssi): 1c:3b:f3:xx:xx:xx (-56)
Location: {'latitude': None, 'longitude': None}
== Device specific information ==
Brightness: 16
Is dimmable: True
Color temperature: 2500
Valid temperature range: ColorTempRange(min=2500, max=9000)
HSV: HSV(hue=0, saturation=0, value=16)
Presets:
index=0 brightness=50 hue=0 saturation=0 color_temp=2500 custom=None id=None mode=None
index=1 brightness=100 hue=299 saturation=95 color_temp=0 custom=None id=None mode=None
index=2 brightness=100 hue=120 saturation=75 color_temp=0 custom=None id=None mode=None
index=3 brightness=100 hue=240 saturation=75 color_temp=0 custom=None id=None mode=None
== Current State ==
<EmeterStatus power=2.4 voltage=None current=None total=None>
== Modules ==
+ <Module Schedule (smartlife.iot.common.schedule) for 192.168.xx.xx>
+ <Module Usage (smartlife.iot.common.schedule) for 192.168.xx.xx>
+ <Module Antitheft (smartlife.iot.common.anti_theft) for 192.168.xx.xx>
+ <Module Time (smartlife.iot.common.timesetting) for 192.168.xx.xx>
+ <Module Emeter (smartlife.iot.common.emeter) for 192.168.xx.xx>
- <Module Countdown (countdown) for 192.168.xx.xx>
+ <Module Cloud (smartlife.iot.common.cloud) for 192.168.xx.xx>
If your device requires authentication to control it,
you need to pass the credentials using --username and --password options.
All devices support a variety of common commands, including:
statewhich returns state informationonandofffor turning the device on or offemeter(where applicable) to return energy consumption informationsysinfoto return raw system information
The syntax to control device is kasa --host <ip address> <command>.
Use kasa --help (or consult the documentation) to get a list of all available commands and options.
Some examples of available options include JSON output (--json), defining timeouts (--timeout and --discovery-timeout).
Each individual command may also have additional options, which are shown when called with the --help option.
For example, --transition on bulbs requests a smooth state change, while --name and --index are used on power strips to select the socket to act on:
$ kasa on --help
Usage: kasa on [OPTIONS]
Turn the device on.
Options:
--index INTEGER
--name TEXT
--transition INTEGER
--help Show this message and exit.
Common commands for bulbs and light strips include:
brightnessto control the brightnesshsvto control the colorstemperatureto control the color temperatures
When executed without parameters, these commands will report the current state.
Some devices support --transition option to perform a smooth state change.
For example, the following turns the light to 30% brightness over a period of five seconds:
$ kasa --host <addr> brightness --transition 5000 30
See --help for additional options and the documentation for more details about supported features and limitations.
Each individual socket can be controlled separately by passing --index or --name to the command.
If neither option is defined, the commands act on the whole power strip.
For example:
$ kasa --host <addr> off # turns off all sockets
$ kasa --host <addr> off --name 'Socket1' # turns off socket named 'Socket1'
See --help for additional options and the documentation for more details about supported features and limitations.
Running kasa emeter command will return the current consumption.
Possible options include --year and --month for retrieving historical state,
and reseting the counters can be done with --erase.
$ kasa emeter
== Emeter ==
Current state: {'total': 133.105, 'power': 108.223577, 'current': 0.54463, 'voltage': 225.296283}
If you want to use this library in your own project, a good starting point is the tutorial in the documentation.
You can find several code examples in the API documentation of each of the implementation base classes, check out the documentation for the base class shared by all supported devices.
The library design and module structure is described in a separate page.
The device type specific documentation can be found in their separate pages:
Contributions are very welcome! The easiest way to contribute is by creating a fixture file for the automated test suite if your device hardware and firmware version is not currently listed as supported. Please refer to our contributing guidelines.
The following devices have been tested and confirmed as working. If your device is unlisted but working, please consider contributing a fixture file.
- Plugs: EP10, EP25*, HS100**, HS103, HS105, HS110, KP100, KP105, KP115, KP125, KP125M*, KP401
- Power Strips: EP40, HS107, HS300, KP200, KP303, KP400
- Wall Switches: ES20M, HS200, HS210, HS220, KP405, KS200M, KS205*, KS220M, KS225*, KS230, KS240*
- Bulbs: KL110, KL120, KL125, KL130, KL135, KL50, KL60, LB110
- Light Strips: KL400L5, KL420L5, KL430
- Hubs: KH100*
- Hub-Connected Devices***: KE100*
- Plugs: P100, P110, P125M, P135, TP15
- Power Strips: P300, TP25
- Wall Switches: S500D, S505
- Bulbs: L510B, L510E, L530E
- Light Strips: L900-10, L900-5, L920-5, L930-5
- Hubs: H100
- Hub-Connected Devices***: T110, T300, T310, T315
* Model requires authentication
** Newer versions require authentication
*** Devices may work across TAPO/KASA branded hubs
See supported devices in our documentation for more detailed information about tested hardware and software versions.
- softScheck's github contains lot of information and wireshark dissector
- TP-Link Smart Home Device Simulator
- Unofficial API documentation
- Another unofficial API documentation
- pyHS100 provides synchronous interface and is the unmaintained predecessor of this library.
This library has recently added a limited supported for devices that carry Tapo branding.
That support is currently limited to the cli. The package kasa.smart is in flux and if you
use it directly you should expect it could break in future releases until this statement is removed.
Other TAPO libraries are: