python-kasa/docs/source/smartstrip.rst
HankB b386485ab0
Update smartstrip.rst (#382)
```text
hbarta@pilog3b:~$ kasa --type strip --host 192.168.20.215 on
Turning on TP-LINK_Smart Plug_83A6
hbarta@pilog3b:~$ kasa --strip --host 192.168.20.215 on
Usage: kasa [OPTIONS] COMMAND [ARGS]...
Try 'kasa --help' for help.

Error: No such option: --strip (Possible options: --host, --type)
hbarta@pilog3b:~$
```
2022-10-19 01:16:11 +02:00

37 lines
791 B
ReStructuredText

Smart strips
============
.. contents:: Contents
:local:
.. 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 --type strip --host <host> on --index 0
**Example:** Turn off the socket by name:
.. code::
$ kasa --type strip --host <host> off --name "Maybe Kitchen"
API documentation
*****************
.. autoclass:: kasa.SmartStrip
:members:
:inherited-members:
:undoc-members: