Skip to content

Commit ef9cd44

Browse files
authored
Update README.md
1 parent 3c66a73 commit ef9cd44

File tree

1 file changed

+50
-1
lines changed

1 file changed

+50
-1
lines changed

README.md

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,53 @@
44
Note: there's really not much to this project except for build scripts:
55

66
- The code is simply a wrapper around the awesome [python-kasa](https://github.com/python-kasa/python-kasa) library.
7-
- The executable is built with [nuitka](https://github.com/Nuitka/Nuitka), the amazing python compiler that's written in python.
7+
- The executable is built with [nuitka](https://github.com/Nuitka/Nuitka), the amazing python compiler that's written in python.
8+
9+
# Example Usage
10+
Turn Switch OFF
11+
`.\kasa_cli.exe --host 192.168.1.118 off`
12+
13+
Turn Switch ON
14+
`.\kasa_cli.exe --host 192.168.1.118 on`
15+
16+
See [python-kasa > Command-line usage](https://python-kasa.readthedocs.io/en/latest/cli.html) for more full details.
17+
18+
`.\kasa_cli.exe --help`
19+
20+
```
21+
Usage: kasa [OPTIONS] COMMAND [ARGS]...
22+
23+
A tool for controlling TP-Link smart home devices.
24+
25+
Options:
26+
--host TEXT The host name or IP address of the device to
27+
connect to.
28+
--alias TEXT The device name, or alias, of the device to
29+
connect to.
30+
--target TEXT The broadcast address to be used for
31+
discovery. [default: 255.255.255.255]
32+
-d, --debug
33+
--type [plug|bulb|dimmer|strip|lightstrip]
34+
--version Show the version and exit.
35+
--help Show this message and exit.
36+
37+
Commands:
38+
alias Get or set the device (or plug) alias.
39+
brightness Get or set brightness.
40+
discover Discover devices in the network.
41+
effect Set an effect.
42+
emeter Query emeter for historical consumption.
43+
hsv Get or set color in HSV.
44+
led Get or set (Plug's) led state.
45+
off Turn the device off.
46+
on Turn the device on.
47+
raw-command Run a raw command on the device.
48+
reboot Reboot the device.
49+
schedule Scheduling commands.
50+
state Print out device state and versions.
51+
sysinfo Print out full system information.
52+
temperature Get or set color temperature.
53+
time Get the device time.
54+
usage Query usage for historical consumption.
55+
wifi Commands to control wifi settings.
56+
```

0 commit comments

Comments
 (0)