ckohrt / vlxcontrol

A lightweight JSON-based HTTP server to control the KLF 200

VlxControl

VlxControl is a lightweight service that uses PyVLX to control io-Homecontrol devices with a Velux KLF 200. It therefore utilizes JSON command/response with AIOHTTP server. Once started, it can be used to control windows, rollershutters, ... from any arbitrary home control software that can execute the curl command.

Installation

Install dependencies and make it executable:

pip3 install -r requirements.txt
chmod +x vlxcontrol.py

and either run it within a screen session or as a service.

Configuration

Please enter your KLF 200 connection information into the ./pyvlx.yaml configuration file.

Usage

usage: vlxcontrol.py [-h] [-c CONFIG] host port

positional arguments:
  host                  listening address
  port                  listen on this port

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG, --config CONFIG
                        specify the path to a pyvlx.yaml configuration file

Start the service running

./vlxcontrol.py <listen_address> <port>

and make calls using cURL. To close a window, for example, run

curl -X POST --data "{\"node\":\"windowNameInKlf\", \"position\":100}" --header "Content-Type: application/json" http://<host>:<port>/set

to set a device to a position and execute

curl -s http://<host>:<port>/position/windowNameInKlf

to get a device's current positon.

To get a list of all registered devices just issue

curl -s http://<host>:<port>/devices

Setup with OpenHAB

You can use vlxcontrol to control your io-homecontrol devices (like Somfy Dexxo garage door opener or Somfy Oximo rollershutter motor) from OpenHAB. Therefore, you should install the http binding and set up an item similar to this:

Rollershutter   MY_ROLLER { http=">[*:POST:http://<host>:<port>/set/<devicename>/%2$s] <[http://<host>:<port>/position/<devicename>:60000:JSONPATH($.position)]" }

or more enhanced to support UP, DOWN and STOP if you use it as a switch in your sitemap you may add

>[STOP:POST:http://<host>:<port>/stop/<devicename>] >[DOWN:POST:http://<host>:<port>/set/<devicename>/100] >[UP:POST:http://<host>:<port>/set/<devicename>/0] 

to the http binding definition.

This will issue commands to the device and update the device position every 60 seconds (for cases where, e.g., a rollershutter controller like Somfy smoove 1 io is being used).

Your sitemap might have entries like

Switch		item=MY_ROLLER
Slider		item=MY_ROLLER