Kasa Server 🖥💡🔌

Kasa Server was developed to create a client agnostic lightweight approach to controlling your TP-Link Kasa smart home devices.

Built in Python using Flask this RESTful server application wraps the Python Kasa library and allows you to control your TP-Link Kasa smart home devices through web based endpoints.

Setup & Installation 🔧

The application is tested on Python 3.9

Get started by cloning the repository

$ git clone https://github.com/jas588/kasa-server

I reccommend creating a virtual environment. You can create one and activate it by

$ python3.9 -m venv .venv
$ source .venv/bin/activate

Install the required packages

$ pip install -r requirements.txt

Starting the server 🏁

Using the default configuration

Launching the application on your computer is simple. By default Flask will look for a file named app.py so there's no need to specify anything else. You can launch the application with

$ flask run

Custom configuration

If you want to rename app.py to something else e.g: server.py you can do so just as long you specify the FLASK_APP environment variable.

$ export FLASK_APP=server.py

and then you can run the application as normal with

$ flask run

Alternatively you can also substitute flask run for python3.9 -m flask run

To run the server and connect to it from other devices on your local network you'll need to specify the host flag as such

$ flask run --host=0.0.0.0

For more help, support and documentation about Flask please see their helpful guide here.

Running the code without starting the Flask server

You can always choose to run the code without starting the Flask server since the business logic is seperate from the server logic. See main.py for examples on directing calling the logic. You can edit it and then simply run it with

$ python3.9 main.py

Example usage 🕹

You can access the server by using the base url http://127.0.0.1:5000 or http://localhost:5000 on your computer or by substituting for the local IP address of the computer running the application on your network, in which case remember to specify the host flag. The examples below will just be using localhost.

Get all devices

Request

GET /devices HTTP/1.1
Host: 127.0.0.1:5000

Response

{
  "count": 2,
  "_links": {
    "self": {
      "href": "/devices"
    },
    "rediscover": {
      "href": "/devices/rediscover"
    }
  },
  "_embedded": {
    "devices": [
      {
        "name": "Family Room Light",
        "ip_address": "192.168.1.9",
        "is_on": false,
        "_links": {
          "self": {
            "href": "/devices/Family%20Room%20Light"
          },
          "toggle": {
            "href": "/devices/Family%20Room%20Light/toggle"
          },
          "on": {
            "href": "/devices/Family%20Room%20Light/on"
          },
          "off": {
            "href": "/devices/Family%20Room%20Light/off"
          }
        }
      },
      {
        "name": "Living Room Plug",
        "ip_address": "192.168.1.10",
        "is_on": true,
        "_links": {
          "self": {
            "href": "/devices/Living%20Room%20Plug"
          },
          "toggle": {
            "href": "/devices/Living%20Room%20Plug/toggle"
          },
          "on": {
            "href": "/devices/Living%20Room%20Plug/on"
          },
          "off": {
            "href": "/devices/Living%20Room%20Plug/off"
          }
        }
      }
    ]
  }
}

Toggle a device

Request

PUT /devices/Family%20Room%20Light/toggle HTTP/1.1
Host: 127.0.0.1:5000

Response

204 NO CONTENT

Contributing 📝

Please see the contributing guideline here

License 📄

This project uses the MIT License

jas588 / kasa-server