initial commit

.gitignore

@@ -0,0 +1,7 @@
+*.pyc
+
+build/
+dist/
+xknx.egg-info/
+
+.DS_Store

LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

README.md

@@ -0,0 +1,32 @@
+PyVLX - controling VELUX windows with Python
+============================================
+
+PyVLX uses the Velux KLF 200 interface to control Velux Windows.
+
+Basic Operations
+----------------
+
+```python
+from pyvlx import PyVLX
+import asyncio
+
+async def main():
+    pyvlx = PyVLX("pyvlx.yaml")
+
+    await pyvlx.load_devices()
+    print(pyvlx.devices[1])
+    print(pyvlx.devices['Fenster 4'])
+
+    await pyvlx.load_scenes()
+    print(pyvlx.scenes[0])
+    print(pyvlx.scenes['alles auf'])
+
+    # opening/ closing windows by running scenes, yay!
+    await pyvlx.scenes[1].run()
+
+loop = asyncio.get_event_loop()
+loop.run_until_complete(main())
+loop.close()
+```
+
+

pyvlx.yaml

@@ -0,0 +1,4 @@
+
+config:
+    host: "192.168.2.127"
+    password: "velux123"

pyvlx/__init__.py

@@ -0,0 +1,3 @@
+from .config import Config
+from .interface import Interface
+from .pyvlx import PyVLX

pyvlx/config.py

@@ -0,0 +1,19 @@
+import yaml
+
+class Config:
+
+    def __init__(self, path):
+        self.read_config(path)
+
+    def read_config(self, path):
+        print("Reading {0}".format(path))
+        with open(path, 'r') as filehandle:
+            doc = yaml.load(filehandle)
+            if not "config" in doc:
+                raise Exception("no element config found in: {0}".format(path))
+            if not "host" in doc["config"]:
+                raise Exception("no element host found in: {0}".format(path))
+            if not "password" in doc["config"]:
+                raise Exception("no element password found in: {0}".format(path))
+            self.host = doc["config"]["host"]
+            self.password = doc["config"]["password"]

pyvlx/device.py

@@ -0,0 +1,9 @@
+
+class Device:
+    def __init__(self, pyvlx, id, name):
+        self.pyvlx = pyvlx
+        self.id = id
+        self.name = name
+
+    def get_name(self):
+        return self.name

pyvlx/devices.py

@@ -0,0 +1,54 @@
+import json
+from .device import Device
+from .window import Window
+
+class Devices:
+
+    def __init__(self, pyvlx):
+        self.pyvlx = pyvlx
+        self.__devices = []
+
+
+    def __iter__(self):
+        yield from self.__devices
+
+
+    def __getitem__(self, key):
+        for device in self.__devices:
+            if device.name == key:
+                return device
+
+        if isinstance(key, int):
+            return self.__devices[key]
+        raise KeyError
+
+
+    def __len__(self):
+        return len(self.__devices)
+
+
+    def add(self, device):
+        if not isinstance(device, Device):
+            raise TypeError()
+        self.__devices.append(device)
+
+
+    async def load(self):
+        json_response = await self.pyvlx.interface.api_call('products','get')
+        if not 'data' in json_response:
+            raise Exception('no element data found in response: {0}'.format(json.dumps(json_response)))
+        data = json_response['data']
+
+        for item in data:
+            if not 'category' in item:
+                raise Exception('no element category in product: {0}'.format(json.dumps(item)))
+            category = item['category']
+            if(category == 'Window opener'):
+                self.load_window_opener(item)
+            else:
+                print("WARNING: Could not parse product: {0}".format(category))
+
+
+    def load_window_opener(self, item):
+        window = Window.from_config(self.pyvlx, item)
+        self.add(window)

pyvlx/interface.py

@@ -0,0 +1,74 @@
+import aiohttp
+import asyncio
+import async_timeout
+import json
+
+
+class Interface:
+    def __init__(self, config):
+        self.config = config
+        self.token = None
+
+
+    async def api_call(self, verb, action, params=None, add_authorization_token=True):
+        if add_authorization_token and not self.token:
+            await self.refresh_token()
+
+        url = self.create_api_url(verb)
+        body = self.create_body(action, params)
+        headers = self.create_headers(add_authorization_token)
+
+        async with aiohttp.ClientSession() as session:
+            with async_timeout.timeout(10):
+                async with session.post(url, data=json.dumps(body), headers=headers) as response:
+                    response = await response.text()
+                    response = self.fix_response(response)
+                    json_response = json.loads(response)
+                    self.evaluate_response(json_response)
+                    #print(json.dumps(json_response, indent=4, sort_keys=True))
+                    return json_response
+
+
+    def create_api_url(self, verb):
+        return 'http://{0}/api/v1/{1}'.format(self.config.host, verb)
+
+
+    def create_headers(self, add_authorization_token):
+        headers = {}
+        headers['Content-Type'] = 'application/json'
+        if add_authorization_token:
+            headers['Authorization'] = 'Bearer ' + self.token
+        return headers
+
+
+    def create_body(self, action, params):
+        body = {}
+        body['action'] = action
+        if params is not None:
+            body['params'] = params
+        return body  
+
+
+    def evaluate_response(self, json_response):
+        if not "result" in json_response:
+            raise Exception("no element result  found in response: {0}".format(json.dumps(json_response)))
+        if not json_response["result"]:
+            raise Exception("Request failed {0}".format(json.dumps(json_response)))
+
+
+    def fix_response(self, response):
+        # WTF: For whatever reason, the KLF 200 sometimes puts an ")]}'," in front of the response ...
+        index = response.find('{')
+        if index>0:
+            return response[index:]
+        return response
+
+
+    async def refresh_token(self):
+        json_response = await self.api_call('auth','login', {'password': self.config.password}, add_authorization_token=False)
+        if not "token" in json_response:
+            raise Exception("no element token found in response: {0}".format(json.dumps(json_response)))
+        self.token = json_response["token"]
+
+
+

pyvlx/pyvlx.py

@@ -0,0 +1,23 @@
+from .config import Config
+from .interface import Interface
+from .devices import Devices
+from .scenes import Scenes
+
+class PyVLX:
+
+    def __init__(self, path):
+        self.config = Config(path)
+        self.interface = Interface(self.config)
+        self.devices = Devices(self)
+        self.scenes = Scenes(self)
+
+    async def connect(self):
+        await self.interface.refresh_token()
+
+
+    async def load_devices(self):
+        await self.devices.load() 
+
+
+    async def load_scenes(self):
+        await self.scenes.load()