2020-06-30 00:29:52 +00:00
Command-line usage
==================
The package is shipped with a console tool named kasa, please refer to `` kasa --help `` for detailed usage.
2020-12-09 09:13:14 +00:00
The device to which the commands are sent is chosen by `` KASA_HOST `` environment variable or passing `` --host <address> `` as an option.
2020-06-30 00:29:52 +00:00
To see what is being sent to and received from the device, specify option `` --debug `` .
2020-12-09 09:13:14 +00:00
To avoid discovering the devices when executing commands its type can be passed as an option (e.g., `` --plug `` for plugs, `` --bulb `` for bulbs, ..).
If no type is manually given, its type will be discovered automatically which causes a short delay.
2020-06-30 00:29:52 +00:00
If no command is given, the `` state `` command will be executed to query the device state.
2020-12-09 09:13:14 +00:00
.. 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 `` .
Refer to the device type specific documentation for more details.
2020-06-30 00:29:52 +00:00
Provisioning
2020-12-09 09:13:14 +00:00
***** ***** **
2020-06-30 00:29:52 +00:00
You can provision your device without any extra apps by using the `` kasa wifi `` command:
1. If the device is unprovisioned, connect to its open network
2. Use `` kasa discover `` (or check the routes) to locate the IP address of the device (likely 192.168.0.1)
3. Scan for available networks using `` kasa wifi scan ``
4. Join/change the network using `` kasa wifi join `` command, see `` --help `` for details.
`` kasa --help ``
2020-12-09 09:13:14 +00:00
***** ***** *****
2020-06-30 00:29:52 +00:00
.. program-output :: kasa --help
