Skip to content

Commit

Permalink
Badges & heading emojis
Browse files Browse the repository at this point in the history
  • Loading branch information
viral32111 committed Aug 20, 2023
1 parent dc26539 commit 1a9e6f4
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,23 @@
# Kasa Smart Plug

This is a command-line utility for controlling, and [Prometheus exporter](https://prometheus.io/docs/instrumenting/exporters/) for monitoring, [TP-Link's Kasa Smart Plugs](https://tp-link.com/uk/smarthome).
[![CI](https://github.com/viral32111/kasa-smart-plug/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/viral32111/kasa-smart-plug/actions/workflows/ci.yml)
[![CodeQL](https://github.com/viral32111/kasa-smart-plug/actions/workflows/codeql.yml/badge.svg)](https://github.com/viral32111/kasa-smart-plug/actions/workflows/codeql.yml)
![GitHub tag (with filter)](https://img.shields.io/github/v/tag/viral32111/kasa-smart-plug?label=Latest)
![GitHub repository size](https://img.shields.io/github/repo-size/viral32111/kasa-smart-plug?label=Size)
![GitHub release downloads](https://img.shields.io/github/downloads/viral32111/kasa-smart-plug/total?label=Downloads)
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/viral32111/kasa-smart-plug?label=Commits)

This is a command-line utility for controlling and monitoring (via a [Prometheus exporter](https://prometheus.io/docs/instrumenting/exporters/)) [TP-Link's Kasa Smart Plugs](https://tp-link.com/uk/smarthome).

I test this against my [Kasa KP115](https://www.tp-link.com/uk/home-networking/smart-plug/kp115/).

## Background
## 📜 Background

I wanted to remote control and monitor the energy usage of a few devices in my house using custom software, so I bought a few of TP-Link's Kasa Smart Plugs as reviews online said they had an open API that exposed lots of data and did not require linking an online account (both of which turned out to be true).
I wanted to remote control and monitor the energy usage of a few devices in my house using custom software, so I bought a few of [TP-Link's Kasa Smart Plugs](https://tp-link.com/uk/smarthome) as online reviews mentioned they had an open API which exposed lots of data and did not require linking an online account, both of which turned out to be true.

I originally made this around February 2022 as my first actual Go project, however I only recently got around to improving & publishing it here, hence why my [RCON](https://github.com/viral32111/rcon) and [Healthcheck](https://github.com/viral32111/healthcheck) projects were published before this one.
I originally made this in February of 2022 as my first Go project. However, it was not published here straight away, hence why my [kasa-smart-plug](https://github.com/viral32111/kasa-smart-plug) and [Healthcheck](https://github.com/viral32111/healthcheck) projects were published before this.

## License
## ⚖️ License

Copyright (C) 2022-2023 [viral32111](https://viral32111.com).

Expand Down

0 comments on commit 1a9e6f4

Please sign in to comment.