Mirrored_Repos/python-kasa
1
0
Fork 0
mirror of https://github.com/python-kasa/python-kasa.git synced 2024-12-22 19:23:34 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
🏠🤖 Python API for TP-Link smarthome products
217 Commits 43 Branches 47 Tags 12 MiB
Python 100%
44e2998705
Go to file
Teemu R 44e2998705
Improve bulb API, force turn on for all light changes as offline changes are not supported (#76) 
* Add ignore_default to lights to allow setting to specific light state, force bulb on when changing the settings, allow defining brightness for set_color_temp, add a couple of new API methods

* Fix and simplify transition_light_state to make tests pass
2020-07-06 16:09:30 +02:00
docs Simplify API documentation by using doctests (#73) 2020-06-30 02:29:52 +02:00
kasa Improve bulb API, force turn on for all light changes as offline changes are not supported (#76) 2020-07-06 16:09:30 +02:00
.flake8 Simplify API documentation by using doctests (#73) 2020-06-30 02:29:52 +02:00
.gitchangelog.rc Add changelog & add .gitchangelog.rc (#28) 2017-03-17 14:38:58 +01:00
.gitignore run pre-commit run --all 2019-12-12 10:41:52 +01:00
.hound.yml use tox.ini in hound 2019-11-15 14:31:01 +01:00
.pre-commit-config.yaml Convert to use poetry & pyproject.toml for dep & build management (#54) 2020-05-12 12:11:47 +02:00
azure-pipelines.yml Convert to use poetry & pyproject.toml for dep & build management (#54) 2020-05-12 12:11:47 +02:00
CHANGELOG run pre-commit run --all 2019-12-12 10:41:52 +01:00
HOWTO_RELEASE Release 0.2.4 preparations (#43) 2017-03-25 23:04:32 +01:00
LICENSE Update LICENSE 2016-10-18 09:40:42 +08:00
pyproject.toml Simplify API documentation by using doctests (#73) 2020-06-30 02:29:52 +02:00
README.md Simplify API documentation by using doctests (#73) 2020-06-30 02:29:52 +02:00
tox.ini Convert to use poetry & pyproject.toml for dep & build management (#54) 2020-05-12 12:11:47 +02:00

README.md

python-kasa

PyPI version Build Status Coverage Status

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.

Supported devices

  • Plugs
    • HS100
    • HS103
    • HS105
    • HS107
    • HS110
  • Power Strips
    • HS300
    • KP303
  • Wall switches
    • HS200
    • HS210
    • HS220
  • Bulbs
    • LB100
    • LB110
    • LB120
    • LB130
    • LB230
    • KL60
    • KL110
    • KL120
    • KL130

Contributions (be it adding missing features, fixing bugs or improving documentation) are more than welcome, feel free to submit pull requests! See below for instructions for setting up a development environment.

Discovering devices

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}

Basic controls

All devices support a variety of common commands, including:

  • state which returns state information
  • on and off for turning the device on or off
  • emeter (where applicable) to return energy consumption information
  • sysinfo to 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](broken link).

Contributing

Contributions are very welcome! To simplify the process, we are leveraging automated checks and tests for contributions.

Resources

Setting up development environment

poetry install
pre-commit install

Code-style checks

We use several tools to automatically check all contributions, which are run automatically when you commit your code.

If you want to manually execute the checks, you can run tox -e lint to do the linting checks or tox to also execute the tests.