Mirrored_Repos/python-kasa
1
0
Fork 0
mirror of https://github.com/python-kasa/python-kasa.git synced 2025-10-15 20:08:06 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Improve cli documentation for bulbs and power strips (#123)

Browse Source
This commit is contained in:
Teemu R
2020-12-09 10:13:14 +01:00
committed by GitHub
parent a926ff5980
commit 98b40b5072
10 changed files with 126 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/source/smartstrip.rst
View File

@@ -1,6 +1,37 @@
Smart strips
============
.. note::
The emeter feature is currently not implemented for smart strips. See https://github.com/python-kasa/python-kasa/issues/64 for details.
.. note::
Feel free to open a pull request to improve the documentation!
Command-line usage
******************
To command a single socket of a strip, you will need to specify it either by using ``--index`` or by using ``--name``.
If not specified, the commands will act on the parent device: turning the strip off will turn off all sockets.
**Example:** Turn off the first socket (the indexing starts from zero):
.. code::
$ kasa --strip --host <host> on --index 0
**Example:** Turn on the socket by name:
.. code::
$ kasa --strip --host <host> off --name "Maybe Kitchen"
API documentation
*****************
.. autoclass:: kasa.SmartStrip
:members:
:undoc-members: