├── nibe_downlink ├── __init__.py └── service.py ├── setup.py ├── examples ├── config.py.dist └── mqtt.py ├── README.md ├── .gitignore └── LICENSE /nibe_downlink/__init__.py: -------------------------------------------------------------------------------- 1 | from service import NibeDownlink 2 | 3 | __all__ = ["NibeDownlink"] -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from distutils.core import setup 2 | 3 | setup( 4 | name='nibe_downlink', 5 | version='1.0', 6 | packages=['nibe_downlink'], 7 | url='', 8 | license='LGPL 3', 9 | author='yozik04', 10 | author_email='yozik04@gmail.com', 11 | description='Fetches metrics from Nibe Uplink' 12 | ) 13 | -------------------------------------------------------------------------------- /examples/config.py.dist: -------------------------------------------------------------------------------- 1 | import logging 2 | 3 | rootLogger = logging.getLogger() 4 | rootLogger.addHandler(logging.StreamHandler()) 5 | rootLogger.setLevel(logging.DEBUG) 6 | 7 | MQTT_CONF = { 8 | 'auth': { # This block can be skipped if you do not have auth on your mqtt 9 | "username": "mqtt_auth", 10 | "password": "mqtt_password" 11 | }, 12 | 'hostname': "192.168.0.2", # MQTT IP address or hostname 13 | 'prefix': '/home_sweet_home/nibe-1255-12' 14 | } 15 | 16 | NIBE_UPLINK_CONF = { 17 | 'username': "example@example.com", 18 | 'password': "nibe_uplink_pass", 19 | "hpid": "99999", # heat pump id 20 | 'variables': [47011,48132,47041,40008,40012,40015,40016,43005,43416,43420,43424,43136,43439,43437,40004,40013,10069] # variables you want to fetch 21 | } -------------------------------------------------------------------------------- /examples/mqtt.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import time 3 | 4 | from paho.mqtt.client import Client as MQTTClient 5 | 6 | from config import NIBE_UPLINK_CONF, MQTT_CONF 7 | from nibe_downlink import NibeDownlink 8 | 9 | logger = logging.getLogger() 10 | 11 | nd = NibeDownlink(**NIBE_UPLINK_CONF) 12 | mqtt_client = MQTTClient() 13 | if 'auth' in MQTT_CONF: 14 | mqtt_client.username_pw_set(**MQTT_CONF['auth']) 15 | mqtt_client.connect(MQTT_CONF['hostname']) 16 | mqtt_client.loop_start() 17 | 18 | while True: 19 | try: 20 | online, values = nd.getValues() 21 | # print values 22 | mqtt_client.publish(MQTT_CONF['prefix'] + '/online', 1 if online else 0, retain=True) 23 | if values: 24 | for key, value in values.iteritems(): 25 | mqtt_client.publish(MQTT_CONF['prefix'] + '/variables/' + str(key), value, retain=True) 26 | except Exception as e: 27 | logger.exception("Failed to get Nibe uplink values") 28 | time.sleep(60) 29 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Nibe Downlink 2 | Get variables from Nibe Uplink 3 | 4 | # Requirements 5 | Your heatpump should be registered in Nibe Uplink. This module fetches data from Nibe Uplink 6 | 7 | # Installation 8 | 9 | pip install git+https://github.com/yozik04/nibe_downlink.git 10 | 11 | # Usage 12 | 13 | ``` python 14 | from pprint import pprint 15 | 16 | from nibe_downlink import NibeDownlink 17 | 18 | NIBE_UPLINK_CONF = { 19 | 'username': "example@example.com", 20 | 'password': "nibe_uplink_pass", 21 | "hpid": "99999", # heat pump id 22 | 'variables': [47011,48132,47041,40008,40012,40015,40016,43005,43416,43420,43424,43136,43439,43437,40004,40013,10069] # variables you want to fetch 23 | } 24 | 25 | nd = NibeDownlink(**NIBE_UPLINK_CONF) 26 | 27 | online, values = nd.getValues() 28 | 29 | print "Is online: %s" % str(online) 30 | pprint(values) 31 | ``` 32 | 33 | ### Heat Pump ID: hpid 34 | Get your **hpid** from Nibe Uplink web site. Open a heatpump and it's id will be in your address bar: 35 | https://www.nibeuplink.com/System/**99999**/Status/Overview 36 | 37 | ### Variable IDs 38 | See https://github.com/openhab/openhab1-addons/wiki/Nibe-Heat-Pump-Binding 39 | 40 | # Examples 41 | 42 | Copy *examples/config.py.dist* to *examples/config.py* and change settings inside the file 43 | 44 | ### Nibe Uplink -> MQTT bridge service 45 | 46 | See *examples/mqtt.py* 47 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | examples/config.py 2 | 3 | __pycache__/ 4 | *.py[cod] 5 | *$py.class 6 | 7 | # C extensions 8 | *.so 9 | 10 | # Distribution / packaging 11 | .Python 12 | env/ 13 | build/ 14 | develop-eggs/ 15 | dist/ 16 | downloads/ 17 | eggs/ 18 | .eggs/ 19 | lib/ 20 | lib64/ 21 | parts/ 22 | sdist/ 23 | var/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *,cover 47 | .hypothesis/ 48 | 49 | # Translations 50 | *.mo 51 | *.pot 52 | 53 | # Django stuff: 54 | *.log 55 | local_settings.py 56 | 57 | # Flask stuff: 58 | instance/ 59 | .webassets-cache 60 | 61 | # Scrapy stuff: 62 | .scrapy 63 | 64 | # Sphinx documentation 65 | docs/_build/ 66 | 67 | # PyBuilder 68 | target/ 69 | 70 | # IPython Notebook 71 | .ipynb_checkpoints 72 | 73 | # pyenv 74 | .python-version 75 | 76 | # celery beat schedule file 77 | celerybeat-schedule 78 | 79 | # dotenv 80 | .env 81 | 82 | # virtualenv 83 | venv/ 84 | ENV/ 85 | 86 | # Spyder project settings 87 | .spyderproject 88 | 89 | # Rope project settings 90 | .ropeproject 91 | 92 | .idea -------------------------------------------------------------------------------- /nibe_downlink/service.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import json 4 | import logging 5 | import re 6 | 7 | import requests 8 | 9 | logger = logging.getLogger() 10 | 11 | 12 | class NibeDownlink(object): 13 | def __init__(self, username, password, hpid, variables): 14 | self.auth_data = { 15 | "email": username, 16 | "password": password, 17 | } 18 | self.hpid = hpid 19 | self.variables = variables 20 | self.authenticated = False 21 | self.session = requests.Session() 22 | 23 | def login(self): 24 | auth_result = self.session.post('https://www.nibeuplink.com/LogIn', self.auth_data) 25 | if auth_result.status_code == 200: 26 | self.authenticated = True 27 | logger.info("Succesfully authenticated") 28 | return True 29 | else: 30 | logger.error("Failed to authenticate with status code: %d, content: %s", auth_result.status_code, 31 | auth_result.content) 32 | return False 33 | 34 | def normalize_value(self, value): 35 | try: 36 | return float(re.sub(ur'^([-\d.]+)(Hz|h|%|\u00B0C|DM|cent/kWh)?$', r'\1', value, flags=re.UNICODE)) 37 | except ValueError: 38 | pass 39 | 40 | return value 41 | 42 | def getValues(self): 43 | if not self.authenticated: 44 | if not self.login(): 45 | raise Exception("Unable to get Nibe uplink values. Authentication failed") 46 | 47 | variable_query_result = self.session.post('https://www.nibeuplink.com/PrivateAPI/Values', { 48 | "hpid": self.hpid, 49 | "variables": self.variables 50 | }) 51 | 52 | decoded = {} 53 | 54 | try: 55 | data = json.loads(variable_query_result.content) 56 | except ValueError as e: 57 | logger.exception("Failed to decode JSON object: %s. Request status code: %d", variable_query_result.content, 58 | variable_query_result.status_code) 59 | # try to reauth 60 | self.authenticated = False 61 | return None, None 62 | 63 | if 'IsOffline' in data and 'Values' in data: 64 | online = not data['IsOffline'] 65 | 66 | values = data['Values'] 67 | 68 | for value in values: 69 | if 'VariableId' in value and 'CurrentValue' in value: 70 | v = value['CurrentValue'] 71 | v = self.normalize_value(v) 72 | decoded[value['VariableId']] = v 73 | 74 | logger.info("Fetched: %s", str(decoded)) 75 | return online, decoded 76 | 77 | return None, None 78 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | --------------------------------------------------------------------------------