https://github.com/whitslack/kasa
Kasa Smart API documentation and tools
https://github.com/whitslack/kasa
automation home kasa smart tp-link
Last synced: over 1 year ago
JSON representation
Kasa Smart API documentation and tools
- Host: GitHub
- URL: https://github.com/whitslack/kasa
- Owner: whitslack
- Created: 2023-05-19T05:13:01.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-05-20T00:12:13.000Z (about 3 years ago)
- Last Synced: 2025-01-23T17:19:59.931Z (over 1 year ago)
- Topics: automation, home, kasa, smart, tp-link
- Language: C
- Homepage:
- Size: 12.7 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Kasa Smart
This **UNOFFICIAL** repository contains information about TP-Link's Kasa Smart API and a C-language tool for interacting with Kasa devices via the local control protocol (not via the cloud service).
* [Kasa API Documentation](API.md)
* [Known Firmware URLs](FIRMWARE.md)
GitHub issues and pull requests are very welcome to help refine and expand this knowledge base.
## Compiling
The tool should compile and run on just about any POSIX-compliant system. Linux and macOS are known to be supported.
Windows users are probably out of luck — sorry, not sorry.
```
$ cc -O3 -o kasa kasa.c
```
## Usage
```
$ echo '{"system":{"get_sysinfo":{}}}' | ./kasa
```
The tool establishes a TCP connection on port 9999 to the Kasa device specified on the command line by host name or IP address.
Each line that is written to the tool's standard input is sent as a separate request to the connected Kasa device,
and the tool writes each response received from the device as a separate line to its standard output.
**Tip:** You can pipe the output of the tool into [jq](https://stedolan.github.io/jq/) to extract the information that interests you.
### Example in Bash
```bash
#!/bin/bash
if [[ ! -v 1 ]] ; then
echo 'Toggles the relay state of a Kasa plug/switch.'
echo
echo "usage: ${0} [...]"
exit 1
fi >&2
kasa_call() {
local - ; set -o pipefail
echo "${2:?}" | "${KASA:-./kasa}" "${1:?}" |
jq -r "if [ .[][].err_code != 0 ] | any then halt_error else ${3:-empty} end"
}
for each ; do
{ read -r alias ; read -r relay_state ; } < <(
kasa_call "${each}" '{"system":{"get_sysinfo":{}}}' \
'.system.get_sysinfo | ( .alias, .relay_state )')
case "${relay_state}" in
0)
echo "${alias} is switched off; switching on."
kasa_call "${each}" '{"system":{"set_relay_state":{"state":1}}}'
;;
1)
echo "${alias} is switched on; switching off."
kasa_call "${each}" '{"system":{"set_relay_state":{"state":0}}}'
;;
*)
exit "${?}"
;;
esac
done
```
## Disclaimer
The information and code contained in this repository is provided “as is,” without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement.
In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the information and code contained in this repository or the use or other dealings therewith.
The information contained in this repository may be incorrect or incomplete. Any use of what you find here is undertaken solely at your own risk.
Kasa is a [registered trademark](https://uspto.report/TM/87867268) of the TP-Link Research America Corporation.
TP-Link have not endorsed or contributed to this repository and are not affiliated with it in any way.