mirror of
https://github.com/python-kasa/python-kasa.git
synced 2024-12-22 19:23:34 +00:00
d848117384
* Add a note about socket sharing * Show inherited members for apidocs * Remove outdated note of emeters not being supported on smartstrips * Describe emeter and usage modules, add note about NTP for time sync * Describe lib design and modules * Bump sphinx version, ignore d001 (line-length) for doc8 * demote energy & usage to 3rd level, promote api for 2nd
34 lines
746 B
ReStructuredText
34 lines
746 B
ReStructuredText
Smart strips
|
|
============
|
|
|
|
.. 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 on the first socket (the indexing starts from zero):
|
|
|
|
.. code::
|
|
|
|
$ kasa --strip --host <host> on --index 0
|
|
|
|
**Example:** Turn off the socket by name:
|
|
|
|
.. code::
|
|
|
|
$ kasa --strip --host <host> off --name "Maybe Kitchen"
|
|
|
|
|
|
API documentation
|
|
*****************
|
|
|
|
.. autoclass:: kasa.SmartStrip
|
|
:members:
|
|
:inherited-members:
|
|
:undoc-members:
|