Python library for communicating with the TP-Link Cloud API to manage TP-Link Kasa Smart Home devices
Project description
tplink-cloud-api
A Python library for to remotely control TP-Link smart home devices using their cloud service - no need to be on the same network as your devices
Introduction
The tplinkcloud
Python module allows you to remotely control your TP-Link smartplugs (HS100, HS103, HS105, HS110, HS300), smart switches (HS200), and smartbulbs (LB100, LB110, LB120, LB130, KL60, KL110, KL120, KL130, and more) using the TP-Link cloud web service, from anywhere, without the need to be on the same wifi/lan.
It's especially useful in scenarios where you want to control your devices from public web services, like IFTTT, Thinger.io, Webtask.io, Glitch.com, Tasker (Android)...
Device Compatibility
The following devices are officially supported by the library at this time:
- HS300 (Smart Plug Power Strip with 6 Smart Outlets)
Installation
Clone the repo and cd into the directory:
git clone https://github.com/piekstra/tplink-cloud-api.git
cd tplink-cloud-api
You can install this library with pip
:
pip3 install .
I plan to provide this library via PyPi in the future.
Usage
Authenticate
Instantiating a TP Link Device Manager automatically logs in with your TP-Link credentials, caches the login token, and fetches your devices. The current TP-Link Cloud API Url (https://wap.tplinkcloud.com) is assumed if not provided explicitly.
from tplink_cloud_api import TPLinkDeviceManager
username='kasa@email.com'
password='secure'
device_manager = TPLinkDeviceManager(username, password)
Retrieve devices
To view your devices, you can run the following:
devices = device_manager.get_devices()
if devices:
print(f'Found {len(devices)} devices')
for device in devices:
print(f'{device.model_type.name} device called {device.get_alias()}')
Control your devices
Smart Power Strips (HS300)
Toggle a plug:
device_name = "My Smart Plug"
device = device_manager.find_device(device_name)
if device:
print(f'Found {device.model_type.name} device: {device.get_alias()}')
device.toggle()
else:
print(f'Could not find {device_name}')
Replace My Smart Plug
with the alias you gave to your plug in the Kasa app (be sure to give a different alias to each device). Instead of toggle()
, you can also use power_on()
or power_off()
.
To retrieve power consumption data for one of the individual plugs on the power strip:
import json
power_usage = device_manager.find_device("My Smart Plug").get_power_usage()
print(json.dumps(power_usage, indent=2))
If you want to get multiple devices with a name including a certain substring, you can use the following:
device_names_like = "plug"
devices = device_manager.find_devices(device_names_like)
if devices:
print(f'Found {len(devices)} matching devices')
for device in devices:
print(f'{device.model_type.name} device called {device.get_alias()}')
Smart Plugs (Not Power Strips) (HS100)
Not yet supported officially by this library
Smart Switches (HS200)
Not yet supported officially by this library
Smartbulbs (LB100/110/120/130, KL110/120/130)
Not yet supported officially by this library
Project details
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
Hashes for tplink_cloud_api-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6404d4e1980441a470edcd1330d76bd66c7e3878f59ca9128b74f3b124261838 |
|
MD5 | f314076d887e3925257ed1a8444ffed9 |
|
BLAKE2b-256 | c1ec189d89420959253388f3781c5f15f76d0887de46aa55652058c177c25a91 |