python-kasa/docs/source/smartstrip.rst
Flaviof 87730e6c4e
Fix documentation on Smart strips (#136)
Trivial Fix

Fix documentation and the corresponding command when
turning on/off example.
2021-02-15 17:59:17 +01:00

38 lines
875 B
ReStructuredText

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 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:
:undoc-members: