{"id":447,"date":"2021-01-18T22:05:20","date_gmt":"2021-01-18T21:05:20","guid":{"rendered":"http:\/\/techblog.vindvejr.dk\/?p=447"},"modified":"2021-01-18T22:10:42","modified_gmt":"2021-01-18T21:10:42","slug":"velux-active-kix-300-integration","status":"publish","type":"post","link":"https:\/\/techblog.vindvejr.dk\/?p=447","title":{"rendered":"Velux Active KIX 300 integration"},"content":{"rendered":"\n

It’s been a while since my last post, so just a short one this time. I invested in VELUX ACTIVE with NETATMO in 2019 for controlling my skylights. I knew it was a cloud-based solution with all its cons, and even without any API for integration. This obviously sucks, but suddenly ClientID and ClientSecret was published in an openHAB Community thread<\/a>, so I no longer had the excuse that I didn’t want to spend time reverse engineering the APK for Android. Now it was just a matter of implementing an integration.<\/p>\n\n\n\n

Since I didn’t have experience with Python yet, I decided I wanted to try to use that for an implementation. It was my impression that it had everything I needed: HTTPS, JSON and MQTT. And I was right, so after 90 minutes of google-coding, this is my implementation for fetching my data from my sensor switch (CO2, temperature and humidity). Implementation is based on https:\/\/github.com\/nougad\/velux-cli<\/a>.<\/p>\n\n\n\n

First script is run to get a token which will be used for authentication. Script will ask for the password for the corresponding Velux account:<\/p>\n\n\n

\n#!\/usr\/bin\/python3\n\nimport getpass\nimport requests\n\nURL='https:\/\/app.velux-active.com\/oauth2\/token'\n\n# From Android app reverse engineering\nCLIENT_ID=''\nCLIENT_SECRET=''\n\n# My account\nUSERNAME='veluxaccount@email.address'\n\ntry:\n        password = getpass.getpass()\nexcept Exception as error:\n        print('Error:', error)\n\ndata = {\n        'grant_type': 'password',\n        'client_id': CLIENT_ID,\n        'client_secret': CLIENT_SECRET,\n        'username': USERNAME,\n        'password': password,\n        'user_prefix': 'velux'\n}\n\nresponse = requests.post(URL, data=data)\n\nif response.status_code == 200:\n        file = open('token.json', 'w')\n        file.write(response.text)\n        file.close()\nelse:\n        print('Error:', response)\n\n<\/pre><\/div>\n\n\n
A file ‘token.json’ will be saved in current directory. Next script will refresh the token, so this must be run once per every few hours. I don’t remember exact expiration period, but it’s in the response.<\/p>\n\n\n
\n#!\/usr\/bin\/python3\n\nimport json\nimport requests\n\nURL='https:\/\/app.velux-active.com\/oauth2\/token'\n\n# From Android app reverse engineering\nCLIENT_ID=''\nCLIENT_SECRET=''\n\nfile = open('token.json', 'r')\nbody = file.read()\nfile.close()\n\ntoken = json.loads(body)\n\ndata = {\n        'grant_type': 'refresh_token',\n        'refresh_token': token['refresh_token'],\n        'client_id': CLIENT_ID,\n        'client_secret': CLIENT_SECRET\n}\n\nresponse = requests.post(URL, data=data)\n\nif response.status_code == 200:\n        file = open('token.json', 'w')\n        file.write(response.text)\n        file.close()\nelse:\n        print('Error:', response)\n\n<\/pre><\/div>\n\n\n
And finally this last script is run every 5 minutes which seems to be the frequency for new measurements:<\/p>\n\n\n
\n#!\/usr\/bin\/python3\n\nimport json\nimport requests\nimport paho.mqtt.client as mqtt\n\nURL='https:\/\/app.velux-active.com\/api\/homestatus'\nMQTT_BROKER='192.168.0.236'\nHOME_ID='your_home_id'\n\nfile = open('token.json', 'r')\nbody = file.read()\nfile.close()\n\ntoken = json.loads(body)\n\ndata = {\n        'access_token': token['access_token'],\n        'home_id': HOME_ID\n}\n\nresponse = requests.post(URL, data=data)\n\nif response.status_code != 200:\n        print('Error:', response)\n        exit()\n\ndata = json.loads(response.text)\nhome = data['body']['home']\nrooms = home.get('rooms')\n\nif rooms:\n        room = rooms[0]\nelse:\n        print('Unexpected response:', response.text)\n        exit()\n\nclient = mqtt.Client()\nclient.connect(MQTT_BROKER)\n\nclient.publish('velux\/hallway\/co2', payload=room['co2'], qos=0, retain=False)\nclient.publish('velux\/hallway\/humidity', payload=room['humidity'], qos=0, retain=False)\nclient.publish('velux\/hallway\/temperature', payload=(room['temperature']\/10), qos=0, retain=False)\nclient.publish('velux\/hallway\/lux', payload=room['lux'], qos=0, retain=False)\n\nfor module in data['body']['home']['modules']:\n        if module['type'] == 'NXD': # Departure switch\n                client.publish('velux\/departure_switch\/battery_percent', payload=module['battery_percent'], qos=0, retain=False)\n        if module['type'] == 'NXS': # Sensor\n                client.publish('velux\/sensor1\/battery_percent', payload=module['battery_percent'], qos=0, retain=False)\n\n<\/pre><\/div>\n\n\n
In openHAB I have configured a thing to receive these MQTT updates, so I have them persisted in MySQL, shown in sitemaps, etc.<\/p>\n","protected":false},"excerpt":{"rendered":"
It’s been a while since my last post, so just a short one this time. I invested in VELUX ACTIVE with NETATMO in 2019 for controlling my skylights. I knew it was a cloud-based solution with all its cons, and … Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[10,13],"tags":[],"class_list":["post-447","post","type-post","status-publish","format-standard","hentry","category-iot","category-openhab"],"_links":{"self":[{"href":"https:\/\/techblog.vindvejr.dk\/index.php?rest_route=\/wp\/v2\/posts\/447","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/techblog.vindvejr.dk\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/techblog.vindvejr.dk\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/techblog.vindvejr.dk\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/techblog.vindvejr.dk\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=447"}],"version-history":[{"count":5,"href":"https:\/\/techblog.vindvejr.dk\/index.php?rest_route=\/wp\/v2\/posts\/447\/revisions"}],"predecessor-version":[{"id":452,"href":"https:\/\/techblog.vindvejr.dk\/index.php?rest_route=\/wp\/v2\/posts\/447\/revisions\/452"}],"wp:attachment":[{"href":"https:\/\/techblog.vindvejr.dk\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=447"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/techblog.vindvejr.dk\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=447"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/techblog.vindvejr.dk\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=447"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}