Python API for TP-Link Kasa Smarthome devices
Project description
python-kasa
python-kasa is a Python library to control TPLink smart home devices (plugs, wall switches, power strips, and bulbs) using asyncio. This project is a maintainer-made fork of pyHS100 project.
Getting started
You can install the most recent release using pip. Until
pip install python-kasa --pre
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
Discovering devices
After installation, the devices can be discovered either by using kasa discover or by calling kasa without any parameters.
$ kasa
No --bulb nor --plug given, discovering..
Discovering devices for 3 seconds
== My Smart Plug - HS110(EU) ==
Device state: ON
IP address: 192.168.x.x
LED state: False
On since: 2017-03-26 18:29:17.242219
== Generic information ==
Time: 1970-06-22 02:39:41
Hardware: 1.0
Software: 1.0.8 Build 151101 Rel.24452
MAC (rssi): 50:C7:BF:XX:XX:XX (-77)
Location: {'latitude': XXXX, 'longitude': XXXX}
== Emeter ==
Current state: {'total': 133.082, 'power': 100.418681, 'current': 0.510967, 'voltage': 225.600477}
Use kasa --help to get list of all available commands, or alternatively, consult the documentation.
Basic controls
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
Energy meter
Passing no options to emeter command will return the current consumption.
Possible options include --year and --month for retrieving historical state,
and reseting the counters is done with --erase.
$ kasa emeter
== Emeter ==
Current state: {'total': 133.105, 'power': 108.223577, 'current': 0.54463, 'voltage': 225.296283}
Bulb-specific commands
At the moment setting brightness, color temperature and color (in HSV) are supported depending on the device.
The commands are straightforward, so feel free to check --help for instructions how to use them.
Library usage
You can find several code examples in the API documentation.
Contributing
Contributions are very welcome! To simplify the process, we are leveraging automated checks and tests for contributions.
Setting up development environment
To get started, simply clone this repository and initialize the development environment.
We are using poetry for dependency management, so after cloning the repository simply execute
poetry install which will install all necessary packages and create a virtual environment for you.
Code-style checks
We use several tools to automatically check all contributions. The simplest way to verify that everything is formatted properly
before creating a pull request, consider activating the pre-commit hooks by executing pre-commit install.
This will make sure that the checks are passing when you do a commit.
You can also execute the checks by running either tox -e lint to only do the linting checks, or tox to also execute the tests.
Running tests
You can run tests on the library by executing pytest in the source directory.
This will run the tests against contributed example responses, but you can also execute the tests against a real device:
pytest --ip <address>
Note that this will perform state changes on the device.
Analyzing network captures
The simplest way to add support for a new device or to improve existing ones is to capture traffic between the mobile app and the device.
After capturing the traffic, you can either use the softScheck's wireshark dissector
or the parse_pcap.py script contained inside the devtools directory.
Supported devices
Plugs
- HS100
- HS103
- HS105
- HS107
- HS110
- KP115
Power Strips
- HS300
- KP303
- KP400
Wall switches
- HS200
- HS210
- HS220
Bulbs
- LB100
- LB110
- LB120
- LB130
- LB230
- KL60
- KL110
- KL120
- KL125
- KL130
Light strips
- KL430
Contributions (be it adding missing features, fixing bugs or improving documentation) are more than welcome, feel free to submit pull requests!
Resources
Links
- softScheck's github contains lot of information and wireshark dissector
- TP-Link Smart Home Device Simulator
- Unofficial API documentation
- MQTT access to TP-Link devices, using python-kasa
TP-Link Tapo support
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file python-kasa-0.4.0.dev5.tar.gz.
File metadata
- Download URL: python-kasa-0.4.0.dev5.tar.gz
- Upload date:
- Size: 71.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.8 CPython/3.9.7 Linux/5.14.5-arch1-1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a4e28c179fcf97eaac26d6b58cf2cd515a322729066a2520ee682c26d34a8abc |
|
| MD5 | 1729bb09beae13231954ef6b596622a9 |
|
| BLAKE2b-256 | 3c6a2ec294506463e577ce726a5602903800d3f5cf2e8959b5c034a440654680 |
File details
Details for the file python_kasa-0.4.0.dev5-py3-none-any.whl.
File metadata
- Download URL: python_kasa-0.4.0.dev5-py3-none-any.whl
- Upload date:
- Size: 99.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.8 CPython/3.9.7 Linux/5.14.5-arch1-1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 37ffcbd8faf87545cb24d51b182c1b878fb6092a6c810dd6f63dbd9ab45e4ed8 |
|
| MD5 | eb5485479d5e16fa0a61c4b490b5eff5 |
|
| BLAKE2b-256 | cdee9efc9b5b412605bfa267b1d2b1ef6b07196c6f7b646092434fbf9a26f583 |
