From e1a30f92e450196885f6c0cde3bd0c929d81a324 Mon Sep 17 00:00:00 2001 From: HankB Date: Tue, 18 Oct 2022 16:37:54 -0500 Subject: [PATCH] fix more outdated CLI examples, remove EP40 from bulb list (#383) * Fix more outdated cli examples * remove EP40 (smart strip) from bulb list --- README.md | 1 - docs/source/cli.rst | 4 ++-- docs/source/smartbulb.rst | 4 ++-- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a1fbaaa2..f56cdc9d 100644 --- a/README.md +++ b/README.md @@ -149,7 +149,6 @@ If your device is unlisted but working, please open a pull request to update the ### Bulbs -* EP40 * LB100 * LB110 * LB120 diff --git a/docs/source/cli.rst b/docs/source/cli.rst index b09ae11d..2bab9216 100644 --- a/docs/source/cli.rst +++ b/docs/source/cli.rst @@ -5,7 +5,7 @@ The package is shipped with a console tool named ``kasa``, refer to ``kasa --hel The device to which the commands are sent is chosen by ``KASA_HOST`` environment variable or passing ``--host
`` as an option. To see what is being sent to and received from the device, specify option ``--debug``. -To avoid discovering the devices when executing commands its type can be passed as an option (e.g., ``--plug`` for plugs, ``--bulb`` for bulbs, ..). +To avoid discovering the devices when executing commands its type can be passed as an option (e.g., ``--type plug`` for plugs, ``--type bulb`` for bulbs, ..). If no type is manually given, its type will be discovered automatically which causes a short delay. If no command is given, the ``state`` command will be executed to query the device state. @@ -13,7 +13,7 @@ If no command is given, the ``state`` command will be executed to query the devi .. note:: Some commands (such as reading energy meter values, changing bulb settings, or accessing individual sockets on smart strips) additional parameters are required, - which you can find by adding ``--help`` after the command, e.g. ``kasa emeter --help`` or ``kasa hsv --help``. + which you can find by adding ``--help`` after the command, e.g. ``kasa --type emeter --help`` or ``kasa --type hsv --help``. Refer to the device type specific documentation for more details. diff --git a/docs/source/smartbulb.rst b/docs/source/smartbulb.rst index 6261cb7b..8e02f89f 100644 --- a/docs/source/smartbulb.rst +++ b/docs/source/smartbulb.rst @@ -45,13 +45,13 @@ All command-line commands can be used with transition period for smooth changes. .. code:: - $ kasa --bulb --host off --transition 15000 + $ kasa --type bulb --host off --transition 15000 **Example:** Change the bulb to red with 20% brightness over 15 seconds: .. code:: - $ kasa --bulb --host hsv 0 100 20 --transition 15000 + $ kasa --type bulb --host hsv 0 100 20 --transition 15000 API documentation