Mirrored_Repos/python-kasa
1
0
Fork 0
mirror of https://github.com/python-kasa/python-kasa.git synced 2024-12-22 19:23:34 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Document cli tool --target for discovery (#497)

Browse Source 
This adds rudimentary documentation on the `--target` option of the cli tool.
This commit is contained in:
Teemu R 2023-08-14 14:32:24 +02:00 committed by GitHub
parent 064e3fe560
commit 24da24efad
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/source/cli.rst
View File

@ -16,6 +16,18 @@ If no command is given, the ``state`` command will be executed to query the devi
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.
Discovery
*********
The tool can automatically discover supported devices using a broadcast-based discovery protocol.
This works by sending an UDP datagram on port 9999 to the broadcast address (defaulting to ``255.255.255.255``).
On multihomed systems, you can use ``--target`` option to specify the broadcsat target.
For example, if your devices reside in network ``10.0.0.0/24`` you can use ``kasa --target 10.0.0.255 discover`` to discover them.
.. note::
When no command is specified when invoking ``kasa``, a discovery is performed and the ``state`` command is executed on each discovered device.
Provisioning
************