Domoticz RPC for NIBE Uplink

[BakSeeDaa]

The Domoticz RPC for NIBE Uplink presents the status of your NIBE heating and hot water system in Domoticz. Depending on what NIBE system you will be able to add up to 50 different virtual sensors in Domoticz. A dream for a home automation enthusiast, don't you think? Currently the Domoticz RPC for NIBE Uplink supports monitoring your heating and hot water system. A vision for the future is to extend the functionality to also being able to control various parameters.

The following picture gives you an idea about how it may look like overviewing the sensors in the Domoticz Gui

DAPINUL.png

Technical details
The Domoticz RPC for NIBE Uplink runs as a scheduled job (cron) every 5 minutes fetching data about your Nibe system(s). Doing that, it will not interfere with or delay your Domoticz event system while waiting for various servers to respond. Domoticz RPC for NIBE Uplink is written in python. By answering questions in the setup process, Domoticz RPC for NIBE Uplink will create virtual hardware, virtual devices and a room plan in Domoticz for you. Domoticz RPC for NIBE Uplink has been designed to only update a Domoticz device in case the value has changed. Some devices need regular updates though and these are updated at least once an hour even if there is no change of the actual value. Domoticz RPC for NIBE Uplink is logging to your Domoticz log (filter events on "nibeuplink"). Some heat pumps can have slaves attached to the master unit. Domoticz RPC for NIBE Uplink doesn't currently support slave devices.

Prerequisites

• Domoticz version 4834 or later running on linux (For example Raspbian on a Raspberry Pi).
• Python 2.0 at version 2.7.9 or higher. Check by running

  Code: Select all

  python -V

• A Nibe heating system supported by NIBE Uplink. The following models should work according to Nibe: F1126, F1226, F1145, F1245, F1155, F1255, F1345, F370, F470, F750, VVM310, VVM320, VVM325, VVM500, SMO20, SMO40.
• Your Nibe system should already be connected to Nibe Uplink. You have an account, can log in and see the system status. By looking at Service Info you should decide what parameters You would like to include into Domoticz as virtual devices. You probably won't find it useful to include all of them. Print them out, consider them and decide before going ahead installing. (In my system, which is a F750 the system alarm can be fetched by including a device named "X7") You can change your mind afterwards but it will require you to edit config files. You'd want to avoid that if possible.
• You need to access the NIBE Uplink API pages to create an "application". Log in using your NIBE Uplink user credentials. In "My Applications" choose to "Create Application". Name it myNibeSystem. Use Your fantasy to write something in the "Description". For "Callback URL" you should write http://showquerystring.000webhostapp.com/index.php Now when Your application has been created, the 2 pieces of information you will need in the setup process is the value of the Identifier and the Secret fields. Note them or keep the web page open so You can copy and paste them later.
• Optional. Set up a RAM drive on Raspberry Pi. You can use the RAM drive to store access tokens if You wish. Please read other considerations below.
• A good backup of your system including a backup of your Domoticz database in case something goes wrong.

Installation

• Access the Domoticz server command line using a terminal software such as PuTTY.
• Issue the following command:

  Code: Select all

  mkdir /home/pi/domoticz/scripts/NibeUplink

• Copy the source code at the end of this post and put it in a file that you name nibeuplink.py and place it in the /home/pi/domoticz/scripts/NibeUplink folder.
• Update the list of available packages on your system and upgrade them. Below is an example command that would typically work on a Raspbian on a Raspberry Pi.

  Code: Select all

  sudo apt-get update && sudo apt-get upgrade -y

• Install python-pip and the complementary python module named "requests". Below are some command examples that would typically work on Raspbian. The requests module is mandatory and if you encounter any kind of problems when installing requests, do not try to continue before solving the issues first.

  Code: Select all

  sudo apt-get install python-pip
  pip install requests

• Check that the request module is available from the standard user account (typically user pi at a Raspbian system) , working and is at version 2.5.0 or above. Older versions of requests won't work. If you need help how to determine the version of the requests module, have a look at the following page: Finding the module version. (Do not use the sudo command at all when checking and be logged in as the standard user, not root) If the version is not version 2.5.0 or above, things won't work.
• Issue the following command to start the setup process:

  Code: Select all

  python /home/pi/domoticz/scripts/NibeUplink/nibeuplink.py

• You will be asked a lot of questions. Answer them. (If You enter something wrong, press CTRL-C, delete the incomplete config file at /home/pi/domoticz/scripts/NibeUplink/config.json and start over again) Below is an example dialogue.
  setup_1.png
  Now when you have reached the Authorization Code retrieval stage, you need to copy the URL that is displayed in your terminal window and open it in a web browser. (This is a one time process) The URL will lead to Nibe's API validation server where you will grant Domoticz access to the Nibe application that You created before. When you have completed that, your browser will redirect you to another web site that will display your Authorization Code. Copy the Authorization Code. (The Authorization Code expires after 30 minutes... don't pause!)
• Enter the Authorization Code in the terminal window and continue the setup. For every resource that is found in Your Nibe system(s) you will be asked if You like to create that as a virtual device in Domoticz. It will also immediately assign a value to it.
• When the script finishes You will see some brief information about Your Nibe system(s)
• Run the script in verbose mode to check that everything seems to work.

  Code: Select all

  python /home/pi/domoticz/scripts/NibeUplink/nibeuplink.py -v

• Now add the script to run automatically in the scheduler. Issue the command

  Code: Select all

  crontab -e

  and add the following line at the end of the file:

  Code: Select all

  */5 * * * * /usr/bin/python /home/pi/domoticz/scripts/NibeUplink/nibeuplink.py

• Exit and save.

Now You can open the Domoticz GUI in the web browser. Look at the log. You may use a filter on NIBEUplink You can find a new Domoticz Dummy hardware named NIBEUplink. You can also find that a new Room Plan has been created. There will be some virtual devices created as well depending on what you have chosen in the setup process. All the virtual devices are assigned to the new room named (Yes! You guessed right!) NIBEUplink. If You go to the Domoticz Dashboard and select the NIBEUplink room You can see all the created virtual devices in a single page. You are ready to go! Some devices, especially the counter devices need some time to collect data before the statistics make any sense so be patient.

Remove a device that You included when doing the initial setup

• Remove the virtual device in Domoticz
• From the console run the following command:

  Code: Select all

  python /home/pi/domoticz/scripts/NibeUplink/nibeuplink.py --redefine -v

  For every device found in your Nibe system, you will be asked if You'd like to redefine it. Answer 'Yes' only for the device that you wish to remove. Then You will be asked if You would like to create a Domoticz device for it, answer 'No'.

Add a device that You did not include when doing the initial setup

• From the console run the following command:

  Code: Select all

  python /home/pi/domoticz/scripts/NibeUplink/nibeuplink.py --redefine -v

  For every device found in your Nibe system, you will be asked if You'd like to redefine it. Answer 'Yes' only for the device that you wish to enable and add in Domoticz. Then You will be asked if You would like to create a Domoticz device for it, answer 'Yes'.

Redefine a device
This will update the device's configuration file entry. It's normally only necessary to redefine the device in case you are asked to do so.

• Remove the virtual device in Domoticz
• From the console run the following command:

  Code: Select all

  python /home/pi/domoticz/scripts/NibeUplink/nibeuplink.py --redefine -v

  For every device found in your Nibe system, you will be asked if You'd like to redefine it. Answer 'Yes' only for the device that you wish to redefine. Then You will be asked if You would like to create a Domoticz device for it, answer 'Yes'.

Reauthenticate with Nibe server (In case Your nibeUpLink.plist get lost)
If for some reason the file nibeUpLink.plist get lost (Normally resides in /tmp or /var/tmp depending on your choise at initial setup) you will see a message in the Domoticz log that you need to reauthenticate with the Nibe server.

• Issue the following command

  Code: Select all

  python /home/pi/domoticz/scripts/NibeUplink/nibeuplink.py -v

  You need to copy the URL that is displayed in your terminal window and open it in a web browser. The URL will lead to Nibe's API validation server where you will grant Domoticz access to the Nibe application. When you have completed that, your browser will redirect you to another web site that will display your Authorization Code. Copy the Authorization Code.
• Enter the Authorization Code in the terminal window.

Getting the Domoticz RPC for NIBE Uplink version
From the console run the following command:

Code: Select all

python /home/pi/domoticz/scripts/NibeUplink/nibeuplink.py -V

Getting debug information
From the console run the following command:

Code: Select all

python /home/pi/domoticz/scripts/NibeUplink/nibeuplink.py -d

Getting verbose information Useful if You like to check if everything works
From the console run the following command:

Code: Select all

python /home/pi/domoticz/scripts/NibeUplink/nibeuplink.py -v

Comments and suggestions
If you have any comments, questions or suggestions, please use this thread. Feel more than welcome to show us how it looks on your system, that's always nice.

Getting alarms
Most Nibe systems have a physical alarm output that will reflect the Nibe Systems alarm status, e.g. if there is an error that prevents the system from doing what it normally does (producing heat for example). A dirty filter alarm for example is not considered to be such an error. This alarm output is also watched by Nibe Uplink and can be represented by a virtual device on Domoticz. Its typically called something similar to "F750 X7". It's currently not so well documented by Nibe exactly what kind of alarms that will be passed in the Nibe Uplink API. In addition to the alarm output information (X7) that we receive from Nibe Uplink API, we also get an overall alarm status named "HasAlarmed" (An alarm indication that something in your system's operation is not working as intended). Introduced in version 1.2.0, a new Domoticz virtual alert device is available named "System Alarm" that will reflect the system's current "HasAlarmed" status.

Other considerations
All requests to the NIBE Uplink API are authenticated via the OAuth 2 protocol and Authorization Code Grant flow. Access tokens has to be sent and received. There's a need for the Domoticz RPC for NIBE Uplink to store these access tokens on the disk (SD-card). The directory used for that is the one that you entered at "Directory for app logging and storing access tokens". You may have entered /tmp or /var/tmp. The file nibeUpLink.plist will contain the important refresh token needed for the next API call. If You delete that file You would need to reauthenticate with the Nibe Uplink and You can see a reminder for that in the Domoticz log file. If You have chosen to store the access tokens on a RAM drive they will definitely be lost if You reboot the Raspberry Pi. Personally I store my access tokens on a RAM drive in order to minimize writing to the Raspberry Pi's SD card.

License
This software licensed under the GNU General Public License v3.0

Source code, for nibeuplink.py

Code: Select all

#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# This software has been designed to work with Nibe Uplink API https://api.nibeuplink.com/Home/About
# It's aimed for Domoticz running on Raspberry Pi
#
# This software licensed under the GNU General Public License v3.0

import json
import os
import plistlib
import requests
from urllib import urlencode
import sys, getopt
from datetime import datetime
import time
import logging

# Global (module) namespace variables
redirect_uri = "http://showquerystring.000webhostapp.com/index.php" # Don't alter this or anything else!
baseEndPointUrl = 'https://api.nibeuplink.com'
authorizeEndpointUrl = baseEndPointUrl + '/oauth/authorize'
tokenEndpointUrl = baseEndPointUrl + '/oauth/token'
cfgFile = sys.path[0] + '/config.json'
configChanged = False
newDevicesList = [] # This is a python list
PROGRAMNAME = 'Domoticz RPC for NIBE Uplink'
VERSION = '2.0.0'
MSG_ERROR = 'Error'
MSG_INFO = 'Info'
MSG_EXEC = 'Exec info'
tty = True if os.isatty(sys.stdin.fileno()) else False
isDebug = False
isVerbose = False

def query_yes_no(question, default="no"):
  """
  Ask a yes/no question via raw_input() and return their answer.

  "question" is a string that is presented to the user.
  "default" is the presumed answer if the user just hits <Enter>.
    It must be "yes" (the default), "no" or None (meaning
    an answer is required of the user).

  The "answer" return value is True for "yes" or False for "no".
  """
  valid = {"yes": True, "y": True, "ye": True,
           "no": False, "n": False}
  if default is None:
    prompt = " [y/n] "
  elif default == "yes":
    prompt = " [Y/n] "
  elif default == "no":
    prompt = " [y/N] "
  else:
    raise ValueError("invalid default answer: '%s'" % default)

  while True:
    sys.stdout.write(question + prompt)
    choice = raw_input().lower()
    if default is not None and choice == '':
      return valid[default]
    elif choice in valid:
      return valid[choice]
    else:
      sys.stdout.write("Please respond with 'yes' or 'no' "
                             "(or 'y' or 'n').\n")

def connected_to_internet(url='http://www.google.com/', timeout=5):
  try:
    _ = requests.head(url, timeout=timeout)
    return True
  except requests.ConnectionError:
    print('No internet connection available.')
  return False

def default_input(message, defaultVal):
  if defaultVal:
    return raw_input( "%s [%s]:" % (message, defaultVal) ) or defaultVal
  else:
    return raw_input( "%s :" % (message) )

def create_config():
  global cfg;cfg = {}

  import socket
  s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
  s.connect(('8.8.8.8', 0))  # connecting to a UDP address doesn't send packets
  local_ip_address = s.getsockname()[0]
  cfg['domoticz'] = {}
  cfg['domoticz']['hostName'] = default_input('Domoticz web service IP address (or host name)', local_ip_address)
  cfg['domoticz']['portNumber'] = default_input('Domoticz web service port number', 8080)
  cfg['domoticz']['protocol'] = ''
  while cfg['domoticz']['protocol'] <> 'http' and cfg['domoticz']['protocol'] <> 'https':
    cfg['domoticz']['protocol'] = default_input('Domoticz web service communication protocol (http or https)', 'http')
    if cfg['domoticz']['protocol'] <> 'http' and cfg['domoticz']['protocol'] <> 'https':
      print 'Invalid value given for Domoticz web service communication protocol. It must be \'http\' or \'https\''
  cfg['domoticz']['httpBasicAuth'] = {}
  cfg['domoticz']['httpBasicAuth']['userName'] = \
          default_input('Domoticz web service user name (leave blank if no username is needed)', '')
  cfg['domoticz']['httpBasicAuth']['passWord'] = \
          default_input('Domoticz web service password (leave blank if no passord is needed)', '')
  cfg['domoticz']['devices'] = {}
  cfg['domoticz']['devices']['device'] = []
  cfg['system'] = {}
  tmpdir = '/var/tmp' if os.path.isdir('/var/tmp') else '/tmp'
  cfg['system']['tmpFolder'] = '/xxxx/yyyy'
  while not os.path.isdir(cfg['system']['tmpFolder']):
    cfg['system']['tmpFolder'] = default_input('Directory for app logging and storing access tokens', tmpdir)
    if not os.path.isdir(cfg['system']['tmpFolder']):
      print 'That isn\'t a valid directory name on Your system! Please try again.'
  cfg['oAuth2ClientCredentials'] = {}
  cfg['oAuth2ClientCredentials']['authorizationCode'] = 'xxxx'
  cfg['oAuth2ClientCredentials']['clientId'] = ''
  while len(cfg['oAuth2ClientCredentials']['clientId']) <> 32:
    cfg['oAuth2ClientCredentials']['clientId'] = default_input('Your Nibe UpLink Application\'s Identifier', '')
    if len(cfg['oAuth2ClientCredentials']['clientId']) <> 32:
      print 'That doesn\'t look like a valid Identifier. Have a look at https://api.nibeuplink.com/Applications'
      print 'Please try again'
  cfg['oAuth2ClientCredentials']['clientSecret'] = ''
  while len(cfg['oAuth2ClientCredentials']['clientSecret']) <> 44:
    cfg['oAuth2ClientCredentials']['clientSecret'] = default_input('Your Nibe UpLink Application\'s secret', '')
    if len(cfg['oAuth2ClientCredentials']['clientSecret']) <> 44:
      print 'That doesn\'t look like a valid secret. Have a look at https://api.nibeuplink.com/Applications'
      print 'Please try again'
  # Do we already have a hardware device named 'NIBEUplink' in Domoticz?
  payload = dict([('type', 'hardware')])
  r = domoticzAPI(payload)
  hwIdx = '0'
  HWNAME = 'NIBEUplink'
  if 'result' in r.keys():
    for hw in r['result']:
      if hw['Name'] == HWNAME and hw['Enabled'] == 'true':
        hwIdx = hw['idx']
        break
  if hwIdx <> '0':
    cfg['domoticz']['virtualHwDeviceIdx'] = int(hwIdx)
  else:
    # Create a new Hardware Device. We wants it, we needs it. Must have the precious. They stole it from us!
    payload = dict([('type', 'command'), ('param', 'addhardware'), ('htype', 15), \
                    ('port', 1), ('name', HWNAME), ('enabled', 'true'), ('datatimeout', 0)])
    r = domoticzAPI(payload)
    # Now go fishing for the hardware device Idx
    payload = dict([('type', 'hardware')])
    r = domoticzAPI(payload)
    for hw in r['result']:
      if hw['Name'] == HWNAME and hw['Enabled'] == 'true':
        hwIdx = hw['idx']
        break
    if hwIdx <> '0':
      cfg['domoticz']['virtualHwDeviceIdx'] = int(hwIdx)
    else:
      print 'Can not find the newly created virtual hardware device.'
      sys.exit(0)

  # ROOM PLAN
  # Do we already have a room plane named 'NIBEUplink' in Domoticz?
  payload = dict([('type', 'plans')])
  r = domoticzAPI(payload)
  roomIdx = '0'
  ROOMPLAN = 'NIBEUplink'
  if 'result' in r.keys(): # Can happen if there are no room plans
    for room in r['result']:
      if room['Name'] == ROOMPLAN:
        roomIdx = room['idx']
        break
  if roomIdx <> '0':
    cfg['domoticz']['roomPlan'] = int(roomIdx)
  else:
    # Create a new Room Plan
    payload = dict([('type', 'command'), ('param', 'addplan'), ('name', ROOMPLAN)])
    r = domoticzAPI(payload)
    # Now go fishing for the room plan Idx
    payload = dict([('type', 'plans')])
    r = domoticzAPI(payload)
    for room in r['result']:
      if room['Name'] == ROOMPLAN:
        roomIdx = room['idx']
        break
    if roomIdx <> '0':
      cfg['domoticz']['roomPlan'] = int(roomIdx)
    else:
      print 'Can not find the newly created room plan.'
      sys.exit(0)
  with open(cfgFile, 'w') as outfile:
    json.dump(cfg, outfile, indent=2, sort_keys=True, separators=(',', ':'))
  return cfg

def load_config():
  try:
    with open(cfgFile) as json_data_file:
      cfg = json.load(json_data_file)
  except IOError:
    # Create a new config file
    if tty:
      cfg = create_config()
    else:
      sys.exit(0)
  except:
    logMessage = 'Can not open the config file ' + cfgFile
    print logMessage, sys.exc_info()[0]
    sys.exit(0)
  return cfg

def domoticzAPI(payload):
  try:
    r = requests.get(cfg['domoticz']['protocol'] + '://' + cfg['domoticz']['hostName'] + ':' + \
                     str(cfg['domoticz']['portNumber']) + '/json.htm', \
                     verify=False, \
                     auth=(cfg['domoticz']['httpBasicAuth']['userName'], cfg['domoticz']['httpBasicAuth']['passWord']), \
                     params=payload)
  except:
    print('Can not open domoticz URL: \'' + cfg['domoticz']['protocol'] + '://' + cfg['domoticz']['hostName'] + ':' + \
                     str(cfg['domoticz']['portNumber']) + '/json.htm\'', sys.exc_info()[0])
    sys.exit(0)
  if r.status_code <> 200:
    print 'Unexpected status code from Domoticz: ' + str(r.status_code)
    sys.exit(0)
  try:
    rJsonDecoded = r.json()
  except:
    print('Can\'t Json decode response from Domoticz.', sys.exc_info()[0])
    sys.exit(0)
  if rJsonDecoded['status'] <> 'OK':
    print 'Unexpected response from Domoticz: ' + rJsonDecoded['status']
    sys.exit(0)
  return rJsonDecoded

def logToDomoticz(messageType, logMessage):
  payload = dict([('type', 'command'), ('param', 'addlogmessage'), \
                ('message', '(' + messageType+ ') ' + os.path.basename(sys.argv[0]) + ': ' + logMessage)])
  r = domoticzAPI(payload)
  return r

def truncate(x, d):
  return int(x*(10.0**d))/(10.0**d)

def findTruncatedValue(rawValue, displayValue):
  # Handle a case like this:
  # "displayValue": "1339.3kWh", "rawValue": 133931
  # "displayValue": "0.314kWh", "rawValue": 314931
  # "displayValue": "-245DM", "rawValue": -2456
  # "displayValue": "1341.6kWh", "rawValue": 134157
  
  xTest = ''.join(ch for ch in displayValue if ch.isdigit() or ch == '.') # Now "1339.3"
  if not xTest.lstrip('-').replace('.','',1).isdigit():
    return ''
  displayValueNum = float(xTest)
  rawValue = abs(rawValue) # Now a positive number
  if displayValueNum == rawValue or displayValueNum == 0 or rawValue == 0: return 1
  # displayValueNum is now a number and it's not 0
  if displayValueNum >= 1:
    if int(rawValue / 10) == int(displayValueNum):
      return 0.1
    elif int(rawValue / 100) == int(displayValueNum):
      return 0.01
    elif int(rawValue / 1000) == int(displayValueNum):
      return 0.001
  else:
    numDecimalPlaces = len(str(displayValueNum).split('.')[1]) # How many decimal places is there in displayValueNum ?
    rawValueFloat = float(rawValue)
    if truncate(rawValueFloat / 10, numDecimalPlaces) == displayValueNum:
      return 0.1
    elif truncate(rawValueFloat / 100, numDecimalPlaces) == displayValueNum:
      return 0.01
    elif truncate(rawValueFloat / 1000, numDecimalPlaces) == displayValueNum:
      return 0.001
    elif truncate(rawValueFloat / 10000, numDecimalPlaces) == displayValueNum:
      return 0.0001
    elif truncate(rawValueFloat / 100000, numDecimalPlaces) == displayValueNum:
      return 0.00001
    elif truncate(rawValueFloat / 1000000, numDecimalPlaces) == displayValueNum:
      return 0.000001
  return ''

def redefineDomoDevice(nibeSystem, nibeResource, nibeCategoryName):
  global newDevicesList
  global configChanged
  for c in cfg['domoticz']['devices']['device']:
    if c['nibeSystemId'] == nibeSystem['systemId'] and c['nibeParameterId'] == nibeResource['parameterId']:
      devNameLong = ((nibeSystem['productName'] + ' ' + nibeResource['title'] + ' ' + nibeResource['designation']).title()).strip()
      if not c['enabled']:
        devNameLong += ' (Currently not enabled)'
      elif c['domoticzIdx'] > 0:
        devNameLong += ' (Enabled and current Domoticz idx: ' + str(c['domoticzIdx']) + ')'
      if query_yes_no('Redefine : ' + devNameLong, 'no'):
        configChanged = True # Do not append to newDevicesList
      else:
        newDevicesList.append(c)

def getDomoDevice(nibeSystem, nibeResource, nibeCategoryName):
  unsupportedDevices = [ 0, 47214, 48745]
  if nibeResource['parameterId'] in unsupportedDevices:
    #print str(nibeResource['parameterId']) + ' is not a supported device'
    return {}
  #print str(nibeResource['nibeResourceId']) + ' is a supported device'
  for c in cfg['domoticz']['devices']['device']:
    if c['nibeSystemId'] == nibeSystem['systemId'] and c['nibeParameterId'] == nibeResource['parameterId']:
      #print 'Found : ' + c['nibeTitle']
      return c

  if not tty:
    return {}
  nibeResource['title'] = nibeResource['title'].strip()
  devNameLong = ((nibeSystem['productName'] + ' ' + nibeResource['title'] + ' ' + nibeResource['designation']).title()).strip()
  
  nibeResource['title'] = nibeResource['title'].replace('compressor', 'compr')
  nibeResource['title'] = nibeResource['title'].replace('compr.', 'compr')
  if len(nibeResource['title']) > 17:
    nibeResource['title'] = nibeResource['title'].replace('operating', 'op')
  if nibeResource['unit'] == 'kWh':
    # Counter incremental has very little space in the title
    if len(nibeResource['title']) > 17:
      nibeResource['title'] = nibeResource['title'].replace('factor', 'fc')
    if len(nibeResource['title']) > 21:
      nibeResource['title'] = nibeResource['title'][0:21].strip()
  elif nibeResource['unit'] == 'A':
    # Current meter, Add phase number to name 
    nibeResource['title'] = nibeResource['title'] + ' (Phase-' + nibeResource['designation'][-1:] + ')'
  else:
    if len(nibeResource['title']) > 36:
      nibeResource['title'] = nibeResource['title'][0:36].strip()
  # Avoid dulicate device names for 'heat medium flow'
  if nibeResource['title'] == 'heat medium flow': nibeResource['title'] = nibeResource['title'] + ' ' + nibeResource['designation']
  productNameShort = nibeSystem['productName'][5:] if nibeSystem['productName'][0:5] == 'NIBE ' else nibeSystem['productName']
  devName = (productNameShort + ' ' + nibeResource['title']).title() # Capitalize the first letter of each word
  createDev = default_input('\n\nFound a new Nibe Uplink resource: \'' + devNameLong + '\'\nShall I enable it and create a Domoticz Virtual Device for it? : Y/N', 'N')
  createDev = (createDev.upper() == 'Y' or createDev.upper() == 'YES') and True or False

  entry = {}
  entry['enabled'] = False
  entry['domoticzIdx'] = 0

  if (nibeResource['displayValue'] == 'no' and nibeResource['rawValue'] == 0) \
  or (nibeResource['displayValue'] == 'yes' and nibeResource['rawValue'] == 1):
    entry['domoticzSensorType'] = 6 # Switch
  elif nibeResource['parameterId'] in {9999999,47412} :# Hard coded for alarm 
    entry['domoticzSensorType'] = 7 # Alert
  elif nibeResource['parameterId'] == 43416: # Hard coded for compressor starts, nibeResource['unit'] = ''
    entry['domoticzSensorType'] = 113 # Counter sensor (Ordinary)
  elif nibeResource['parameterId'] == 10069: # Hard coded for Smart Price Adaption
    entry['domoticzSensorType'] = 1004 # Custom sensor
  elif nibeResource['unit'] == '%':
    entry['domoticzSensorType'] = 2 # Percentage
  elif unicode(nibeResource['unit']) == u'\xb0'+'C':
    entry['domoticzSensorType'] = 80 # Temp
  elif nibeResource['unit'] == 'h' or nibeResource['unit'] == 's':
    entry['domoticzSensorType'] = 113 # Counter sensor (Ordinary)
  elif nibeResource['unit'] == 'Hz':
    entry['domoticzSensorType'] = 1004 # Custom sensor
  elif nibeResource['unit'] == 'kWh':
    entry['domoticzSensorType'] = 113 # Counter sensor (Ordinary)
  elif nibeResource['unit'] == 'kW':
    entry['domoticzSensorType'] = 248 # Usage Electric
  elif nibeResource['unit'] == 'A':
    entry['domoticzSensorType'] = 19 # (Ampere 1-Phase)
  elif nibeResource['unit'] == 'DM': # Degree minutes
    entry['domoticzSensorType'] = 1004 # Custom sensor
  elif nibeResource['parameterId'] in {40050,43124} : # Hard coded for some unit-less devices
    entry['domoticzSensorType'] = 1004 # Custom sensor
  elif nibeResource['unit'] == '':
    entry['domoticzSensorType'] = 5 # Text
  else:
    print 'Unknown Domoticz type: \'' + unicode(nibeResource['unit']) + '\''
    entry['domoticzSensorType'] = 0

  if createDev and entry['domoticzSensorType'] > 0:
    # Create a Virtual Device
    payload = dict([('type', 'createvirtualsensor'), ('idx', cfg['domoticz']['virtualHwDeviceIdx']), \
                    ('sensorname', devName), ('sensortype', entry['domoticzSensorType'])])
    if entry['domoticzSensorType'] == 1004:
      payload['sensoroptions'] = '1;' + nibeResource['unit']
    r = domoticzAPI(payload)
    # Now go fishing for the newly created device idx
    payload = dict([('type', 'devices')])
    r = domoticzAPI(payload)
    devIdx = 0
    for dev in reversed(r['result']):
      if dev['Name'] == devName and dev['HardwareID'] == cfg['domoticz']['virtualHwDeviceIdx']:
        devIdx = dev['idx']
        break
    if devIdx <> '0':
      entry['domoticzIdx'] = int(devIdx)
      entry['enabled'] = True
      print 'Created Domoticz virtual device (idx) : ' + str(devIdx)
    else:
      print 'Error: Can not find the newly created virtual device.'
      sys.exit(0)
    # Add the device to the Domoticz room plan
    payload = dict([('type', 'command'), ('param', 'addplanactivedevice'), ('idx', cfg['domoticz']['roomPlan']), \
                    ('activetype', 0), ('activeidx', devIdx)])
    r = domoticzAPI(payload)

  entry['nibeSystemId'] = nibeSystem['systemId']
  entry['nibeParameterId'] = nibeResource['parameterId']
  entry['nibeTitle'] = nibeResource['title']
  entry['nibeDesignation'] = nibeResource['designation']
  entry['nibeCategoryName'] = nibeCategoryName.strip()

  if nibeResource['parameterId'] == 43084: # This guy may be 0 for the moment making it hard to guess the factor
    entry['valueFactor'] = 0.01
  elif nibeResource['parameterId'] == 40016: # Brine out should have 0.1
    entry['valueFactor'] = 0.1
  elif nibeResource['parameterId'] == 40079: # Current should have 0.1
    entry['valueFactor'] = 0.1
  elif nibeResource['parameterId'] == 40081: # Current should have 0.1
    entry['valueFactor'] = 0.1
  elif nibeResource['parameterId'] == 40083: # Current should have 0.1
    entry['valueFactor'] = 0.1
  elif nibeResource['displayValue'] == '---':
    entry['valueFactor'] = 1
  elif nibeResource['displayValue'] == 'no' or nibeResource['displayValue'] == 'yes' or \
       nibeResource['rawValue'] == -32768:
    entry['valueFactor'] = 0
  elif (nibeResource['rawValue'] == 0) and ('0.000' in nibeResource['displayValue']):
    entry['valueFactor'] = 0.001
  elif (nibeResource['rawValue'] == 0) and ('0.00' in nibeResource['displayValue']):
    entry['valueFactor'] = 0.01
  elif (nibeResource['rawValue'] == 0) and ('0.0' in nibeResource['displayValue']):
    entry['valueFactor'] = 0.1 # This may not always be correct
  elif (nibeResource['rawValue'] == 0):
    entry['valueFactor'] = 1
  elif str(nibeResource['rawValue'] * 1000) in nibeResource['displayValue']:
    entry['valueFactor'] = 1000
  elif str(nibeResource['rawValue'] * 100) in nibeResource['displayValue']:
    entry['valueFactor'] = 100
  elif str(nibeResource['rawValue'] * 10) in nibeResource['displayValue']:
    entry['valueFactor'] = 10
  elif str(nibeResource['rawValue']) in nibeResource['displayValue']:
    entry['valueFactor'] = 1
  elif str(nibeResource['rawValue'] / 10) in nibeResource['displayValue']:
    entry['valueFactor'] = 0.1
  elif str(nibeResource['rawValue'] / 100) in nibeResource['displayValue']:
    entry['valueFactor'] = 0.01
  elif findTruncatedValue(nibeResource['rawValue'], nibeResource['displayValue']) <> '':
    entry['valueFactor'] = findTruncatedValue(nibeResource['rawValue'], nibeResource['displayValue'])
  else:
    entry['valueFactor'] = 1

  # Change the Domoticz device if it was just created above
  # We put this here because now we can access the entry['valueFactor'] now
  if createDev and entry['domoticzSensorType'] > 0:
    # When there is a counter created, there is a possibility to change the units and set the offset value
    domoSurpriseFc = 1000 if nibeResource['unit'] == 'kWh' else 1
    if entry['domoticzSensorType'] == 113:
      payload = dict([('type', 'setused'), ('idx', devIdx), ('description', 'Virtual sensor device for ' + devNameLong), \
                    ('switchtype', 0 if nibeResource['unit'] == 'kWh' else 3), \
                    ('addjvalue', nibeResource['rawValue']*entry['valueFactor'] * -1), \
                    ('used', 'true'), ('name', devName), \
                    ('options', 'VmFsdWVRdWFudGl0eSUzQVRpbWUlM0JWYWx1ZVVuaXRzJTNBaCUzQg==' if nibeResource['unit'] == 'h' else '')])
      r = domoticzAPI(payload)
      # The options sent above is the string 'ValueQuantity:Time;ValueUnits:h;' that has been URL encoded + Base64 encoded
  cfg['domoticz']['devices']['device'].append(entry)
  with open(cfgFile, 'w') as outfile:
    json.dump(cfg, outfile, indent=2, sort_keys=True, separators=(',', ':'))
  configChanged = True

  return entry

def updateDomoDevice(domoDevice, nibeResource):
  if not domoDevice['enabled']:
    return
  # Only update if the new value differs from the device value
  # or if the device has not been updated for a while
  payload = dict([('type', 'devices'), ('rid', domoDevice['domoticzIdx'])])
  r = domoticzAPI(payload)

  # Domoticz has another surprise going on when it comes to counters ... Energy (kWh) Gas (m3) Water (m3)
  # The counter will be treated with the divider which is defined in the parameters in the application settings.
  # For example if the counter is set to "Water" and the value is passed as liters, the divider must set to 1000
  # (as the unit is m3).
  # It should be used both when reading and writing values
  domoSurpriseFc = 1000 if nibeResource['unit'] == 'kWh' else 1

  # TODO check more cases

  #print r['result'][0]['Data'] #data
  #print r['result'][0]['LastUpdate']

  if not 'result' in r.keys():
    errMess = 'Failure getting data for domoticz device idx: ' + str(domoDevice['domoticzIdx'])
    print errMess
    logToDomoticz(MSG_ERROR, errMess)
    return

  xTest = ''.join(ch for ch in r['result'][0]['Data'] if ch.isdigit() or ch == '.' or ch == '-') # Now "-1339.3"
  if xTest.lstrip('-').replace('.','',1).isdigit():
    domoValueNum = float(xTest) * domoSurpriseFc # This contains the Domoticz device's value as a number
  else: 
    domoValueNum = 0

  # Now, looking for a reason to update the sensor
  
  # Does the Domotic's sensor need an update in order not to time out?
  sensorTimedOut = False
  if 'HaveTimeout' in r['result'][0]:
    if (r['result'][0]['HaveTimeout'] and ((datetime.now() - datetime.strptime(r['result'][0]['LastUpdate'], '%Y-%m-%d %H:%M:%S')).seconds >= 3000)):
      sensorTimedOut = True

  # Does the value reported from Nibe differ from the Domoticz device's value?
  valueChanged = False
  if domoDevice['domoticzSensorType'] == 7: # Handling the ALERT Device type
    domoCompareValue = r['result'][0]['Level']
    testValue = r['result'][0]['Data']
    if testValue == 'Everything seems to be fine':
        domoCompareValue = '9' # Old version used 'Everything seems to be fine', it's to long to fit. This test can be removed in next version. 
    nibeCompareValue = 4 if nibeResource['rawValue'] <> 0 else 1
  elif domoDevice['domoticzSensorType'] == 6: # Handling the SWITCH Device type
    domoCompareValue = r['result'][0]['Status']
    nibeCompareValue = 'On' if nibeResource['rawValue'] == 1 else 'Off'
  elif domoDevice['domoticzSensorType'] == 113:# These guys use an offset value that we need to deal with
    # Comparing floats in Python is not as simple as it sounds, using str() as a workaround
    if nibeResource['unit'] == 'kWh':
      nibeCompareValue = str(float(nibeResource['rawValue']*domoDevice['valueFactor']*domoSurpriseFc))
      domoCompareValue = str((domoValueNum / domoSurpriseFc - r['result'][0]['AddjValue'])*domoSurpriseFc)
    else:
      # Don't use fractionals
      nibeCompareValue = int(nibeResource['rawValue']*domoDevice['valueFactor'])
      domoCompareValue = int(domoValueNum / domoSurpriseFc - r['result'][0]['AddjValue'])
  elif domoDevice['domoticzSensorType'] == 248 and nibeResource['unit'] == 'kW': # Usage Electric
    nibeCompareValue = str(float(nibeResource['rawValue']*domoDevice['valueFactor']*1000))
    domoCompareValue = str(domoValueNum)
  else:
    nibeCompareValue = str(float(nibeResource['rawValue']*domoDevice['valueFactor']))
    domoCompareValue = str(domoValueNum)

  if nibeCompareValue <> domoCompareValue: valueChanged = True

  if isDebug:
    print r['result'][0]['Name']
    print 'N: ' + str(nibeCompareValue)
    print 'D: ' + str(domoCompareValue)
    print
  elif isVerbose and (valueChanged or sensorTimedOut):
    sayThis = 'Updating Domoticz device \'' + r['result'][0]['Name'] + '\' idx: ' + str(domoDevice['domoticzIdx']) + ' due to:'
    if valueChanged: sayThis += ' <value changed>. New value is: ' + str(nibeCompareValue) + \
                                '. Old value was: ' + str(domoCompareValue) + '.'
    if sensorTimedOut: sayThis += ' <time condition>'
    print sayThis

  if not valueChanged and not sensorTimedOut:
    return

  if domoDevice['domoticzSensorType'] == 7: # Handling the ALERT Device type
    payload = dict([('type', 'command'), ('param', 'udevice'), ('idx', domoDevice['domoticzIdx']), \
                  ('nvalue', nibeCompareValue), ('svalue', 'OK' if nibeCompareValue == 1 else 'Alert!')])
  elif domoDevice['domoticzSensorType'] == 6: # Handling the SWITCH Device type
    payload = dict([('type', 'command'), ('param', 'switchlight'), ('idx', domoDevice['domoticzIdx']), \
                  ('switchcmd', nibeCompareValue)])
  else: # All other sensor types
    payload = dict([('type', 'command'), ('param', 'udevice'), ('idx', domoDevice['domoticzIdx']), \
                  ('nvalue', 0), ('svalue', nibeCompareValue)])
  r = domoticzAPI(payload)

# Retrieve the authorization code
# It will only run if the variable cfg['oAuth2ClientCredentials']['authorizationCode'] has not been set
def retrieve_authorization_code():
  authorization_code_req = {
    "response_type": 'code',
    "client_id": cfg['oAuth2ClientCredentials']['clientId'],
    "state": 'xyz',
    "access_type": 'offline',
    "redirect_uri": redirect_uri,
    "scope": (r'READSYSTEM' +
              r' WRITESYSTEM')
    }

  r = requests.get(authorizeEndpointUrl + "?%s" % urlencode(authorization_code_req),
                   allow_redirects=False)
  print '\nAuthorization Code retrieval\n==========================\nCopy the URL below and paste into the adress bar of a web browser. After granting access on Nibe Uplink, Your browser will show You the Authorization Code. Then enter that code below .\n'
  url = r.headers.get('location')
  print baseEndPointUrl + url + '\n'

  while len(cfg['oAuth2ClientCredentials']['authorizationCode']) <> 401:
    cfg['oAuth2ClientCredentials']['authorizationCode'] = default_input('Authorization Code', '')
    if len(cfg['oAuth2ClientCredentials']['authorizationCode']) <> 401:
      print 'That doesn\'t look like a valid Authorization Code. Please try again.'
  with open(cfgFile, 'w') as outfile:
    json.dump(cfg, outfile, indent=2, sort_keys=True, separators=(',', ':'))
  configChanged = True
  return

# Request new OAuth2 tokens
def requestTokens(grant_type, refreshToken):
  logToDomoticz(MSG_INFO, 'Requesting acess tokens using the ' + grant_type + ' grant type')
  logging.basicConfig(filename=logFile,level=logging.DEBUG,format='%(asctime)s %(levelname)s %(message)s',filemode='w')
  data={}
  try:
    if grant_type == 'authorization_code':
      data={'grant_type' : grant_type, 'code' : cfg['oAuth2ClientCredentials']['authorizationCode'], 'client_id' : cfg['oAuth2ClientCredentials']['clientId'], 'client_secret' : cfg['oAuth2ClientCredentials']['clientSecret'], 'redirect_uri' : redirect_uri}
    elif grant_type == 'refresh_token':
      logging.info('Using Refresh Token: %s' % refreshToken)
      data={'grant_type' : grant_type, 'refresh_token' : refreshToken, 'client_id' : cfg['oAuth2ClientCredentials']['clientId'], 'client_secret' : cfg['oAuth2ClientCredentials']['clientSecret']}
    getTokens = requests.post(tokenEndpointUrl, data)
    getTokens.raise_for_status()
    newTokens = getTokens.json()
    accessToken = newTokens['access_token']
    expiresIn = newTokens['expires_in']
    expiration = int(time.time()) + expiresIn 
    refreshToken = newTokens['refresh_token']
    plistlib.writePlist({'Access Token':accessToken,'Refresh Token':refreshToken,'Expiration': expiration,}, tokenDictionaryFile)

    logging.info('Got Access Token: %s' % accessToken)
    logging.info('The Access Token is valid for : %s seconds' % expiresIn)
    logging.info('Got Refresh Token: %s' % refreshToken)
    #tokenPlist = plistlib.readPlist(tokenDictionaryFile)
  except requests.exceptions.RequestException, e:
    logMessage = 'Can\'t generate tokens: %s' % e
    logging.error('========== ' + logMessage + ' ==========')
    logToDomoticz(MSG_ERROR, logMessage)
    if tty:
      print logMessage
      print 'The Authorization Code might be too old. Clearing it out so that You can request a new. Please run this script again.'
      cfg['oAuth2ClientCredentials']['authorizationCode'] = 'xxxx'
      with open(cfgFile, 'w') as outfile:
        json.dump(cfg, outfile, indent=2, sort_keys=True, separators=(',', ':'))
      print '\n\nBelow is some debugging help:\n=============================='
      for k, v in data.iteritems():
        print k, ' = ',  v
      print '\n\n'
    sys.exit(0)
  except:
    logMessage = 'Can\'t create the token dictionary file'
    logging.error('========== ' + logMessage + ' ==========')
    logToDomoticz(MSG_ERROR, logMessage)
    if tty:
      print logMessage
    sys.exit(0)
  return accessToken

# Validate the OAuth2 tokens
def validateTokens():
  # First let's read the Token Dictionary plist
  accessTokenValid = False
  try:
    tokenPlist = plistlib.readPlist(tokenDictionaryFile)
    refreshToken = tokenPlist["Refresh Token"]
    accessToken = tokenPlist["Access Token"]
    expiration = tokenPlist["Expiration"]
    if expiration - time.time() > 30:
      accessTokenValid = True
      logMessage = 'Current access token valid for ' + str(int(expiration - time.time())) + ' seconds'
      if isVerbose:
        logToDomoticz(MSG_INFO, logMessage)
  except:
    if not tty:
      logToDomoticz(MSG_ERROR, 'You need to run \'python ' + os.path.realpath(__file__) + '\' from a console to obtain a new Authorization Code')
      sys.exit(0)
    # No file!? Man that's bad. Maybe this is the first time the script runs. Let's make an Authorization Request
    errorText = 'There is no dictionary file ' + tokenDictionaryFile + ''  \
              + ' (That is perfectly normal if this is the first time that the script runs)'
    logToDomoticz(MSG_ERROR, errorText)
    if tty:
      print errorText
    accessToken = requestTokens('authorization_code', '')
    accessTokenValid = True
  if not accessTokenValid:
    # The old refresh token is used to obtain a new access token and a new refresh token
    accessToken = requestTokens('refresh_token', refreshToken)
  return accessToken

def get_system_list(accessToken):
  authorization_header = {"Authorization": "Bearer %s" % accessToken}
  r = requests.get(baseEndPointUrl + "/api/v1/systems", headers=authorization_header)
  if r.status_code == requests.codes.ok:
    if isDebug: print 'HTTP/1.1 200 OK'
  else:
    print "Nibe server responded with an error code: ", r.status_code
    sys.exit(0)
  if isDebug: print "get_system_list: ", r.text, "\n"
  return r.text

def get_system_status(accessToken, systemid):
  authorization_header = {"Authorization": "Bearer %s" % accessToken}
  r = requests.get(baseEndPointUrl + "/api/v1/systems/" + str(systemid) + "/status/system", headers=authorization_header)
  if isDebug: print "get_system_status: ", r.text, "\n"
  return r.text

def get_system_config(accessToken, systemid):
  authorization_header = {"Authorization": "Bearer %s" % accessToken}
  r = requests.get(baseEndPointUrl + "/api/v1/systems/" + str(systemid) + "/config", headers=authorization_header)
  if isDebug: print "get_system_config: ", r.text, "\n"
  return r.text

def get_system_unit_status(accessToken, systemid, systemUnitId):
  authorization_header = {"Authorization": "Bearer %s" % accessToken}
  r = requests.get(baseEndPointUrl + "/api/v1/systems/" + str(systemid) + "/status/systemUnit/" + systemUnitId, headers=authorization_header)
  if isDebug: print "get_system_unit_status: ", r.text, "\n"
  return r.text

def get_serviceinfoCategories(accessToken, systemid):
  authorization_header = {"Authorization": "Bearer %s" % accessToken}
  r = requests.get(baseEndPointUrl + "/api/v1/systems/" + str(systemid) + "/serviceinfo/categories?parameters=true", headers=authorization_header)
  if isDebug: print "get_serviceinfoCategories: ", r.text + '\n'
  return r.text

def list_systems(accessToken):
  systemlist = json.loads(get_system_list(accessToken))
  if isVerbose: print 'Number of systems: ' + str(systemlist['numItems'])
  if isVerbose: print ''
  for nibeSystem in systemlist['objects']:
    if isVerbose: print 'Product Name: ' + nibeSystem['productName']
    if isVerbose: print 'Serial number: ' + nibeSystem['serialNumber']
    if isVerbose: print 'System ID: ' + str(nibeSystem['systemId'])
    if isVerbose: print 'Has alarmed: ' + str(nibeSystem['hasAlarmed'])
    if isVerbose: print ''

    # climate system 1
    systemUnitId = 0
    if isDebug: systemUnitStatus0 = json.loads(get_system_unit_status(accessToken, nibeSystem['systemId'], str(systemUnitId)))
    if isDebug: systemStatus = json.loads(get_system_status(accessToken, nibeSystem['systemId']))
    serviceinfoCategories = json.loads(get_serviceinfoCategories(accessToken, nibeSystem['systemId']))

    # Append the hasAlarmed to the serviceinfoCategories parameters
    has_alarmed_dict = {'parameterId': 9999999,
		'name': '9999999',
		'title': 'system alarm',
		'designation': '',
		'unit': '',
		'displayValue': str(int(nibeSystem['hasAlarmed'])),
		'rawValue': int(nibeSystem['hasAlarmed'])
	}
    for s in serviceinfoCategories:
        if s['categoryId'] == 'STATUS' :
            s['parameters'].append(has_alarmed_dict)

    if redefineDevices:
      for s in serviceinfoCategories:
        for nibeResource in s['parameters']: # nibeResources:
          redefineDomoDevice(nibeSystem, nibeResource, s['name'])
      if configChanged:
        cfg['domoticz']['devices']['device'] = newDevicesList # Replace the devices list in config file
        with open(cfgFile, 'w') as outfile:
          json.dump(cfg, outfile, indent=2, sort_keys=True, separators=(',', ':'))
        print '\n\n\n'
    for s in serviceinfoCategories:
      for nibeResource in s['parameters']: # nibeResources:
        #catResources = json.loads(p)
        domoDevice = getDomoDevice(nibeSystem, nibeResource, s['name'])
        if domoDevice: updateDomoDevice(domoDevice, nibeResource)
        #print "Unit: " + p['unit']
  if configChanged:
    logMessage = 'Updated the config file at ' + cfgFile
    logToDomoticz(MSG_INFO, logMessage)
    if isVerbose: print logMessage

def print_help(argv):
  print 'usage: ' + os.path.basename(__file__) + ' [option]  [-C domoticzDeviceidx|all] \nOptions and arguments'
  print '-d     : debug output (also --debug)'
  print '-h     : print this help message and exit (also --help)'
  print '-v     : verbose'
  print '-V     : print the version number and exit (also --version)'
  print '-R     : redefines devices in the config file (also --redefine)'

def main(argv):
  global isDebug
  global isVerbose
  global redefineDevices;redefineDevices = False
  try:
    opts, args = getopt.getopt(argv, 'dhvVR', ['help', 'debug', 'version', 'redefine'])
  except getopt.GetoptError:
    print_help(argv)
    sys.exit(2)
  for opt, arg in opts:
    if opt in ('-h', '--help'):
      print_help(argv)
      sys.exit(0)
    elif opt in ('-d', '--debug'):
      isDebug = True
    elif opt in ('-v'):
      isVerbose = True
    elif opt in ('-V', '--version'):
      print PROGRAMNAME + ' ' + VERSION
      sys.exit(0)
    elif opt in ("-R", "--redefine"):
      redefineDevices = True

  if isDebug: print 'Debug is on'
  if not tty: time.sleep( 5 ) # Give Domoticz some time to settle down from other commands running exactly at the 00 sec
  global cfg; cfg = load_config()
  global logFile; logFile = os.path.join(cfg['system']['tmpFolder'], os.path.basename(sys.argv[0]) + '.log')
  global tokenDictionaryFile; tokenDictionaryFile = os.path.join(cfg['system']['tmpFolder'], 'nibeUpLink.plist')

  if not connected_to_internet():
    logToDomoticz(MSG_ERROR, 'No internet connection available')
    sys.exit(0)

  msgProgInfo = PROGRAMNAME + ' Version ' + VERSION
  msgProgInfo += ' running on TTY console...' if tty else ' running as a CRON job...'
  if isVerbose:
    print msgProgInfo
    logToDomoticz(MSG_EXEC, msgProgInfo)


  if len(cfg['oAuth2ClientCredentials']['authorizationCode']) <> 401:
    if tty:
      retrieve_authorization_code()
    else:
      sys.exit(0)

  accessToken = validateTokens()
  if redefineDevices and tty:
    print '\nYou have requested to redefine the devices. By doing that, for each device found in your Nibe system, you will be asked if you want to redefine it. After going through the complete list, for any device that You answered \'Yes\' You will be asked if You want to create a Domoticz device for it.\n'
    if not query_yes_no('Are You sure that you\'d like to redefine the devices', 'no'):
      sys.exit(0)
  list_systems(accessToken)
  sys.exit(0)

if __name__ == '__main__':
  main(sys.argv[1:])
 

[BakSeeDaa]

RELEASE NOTICES

Version 0.9.3 (Critical) Released 2016-11-02

• Corrected a problem that caused a "generate tokens 400 Client Error" first time requesting access tokens.
• Improved debug messages when running script from TTY

Version 0.9.4 (Critical) Released 2016-11-02

• Software name changed to Domoticz RPC for NIBE Uplink.
• Setup process made easier by using an external server that will help displaying the Authorization Code.
• Introduced a string length constraint when entering Authorization Code. It should be 401 characters long.

Version 0.9.6 (Critical) Released 2016-11-06

• Added support for command line options
• Reimplemented the logic that figures out the factor used to calculate the sensor values.
• Removed the "Nibe " part from virtual device names due to that device names became to long in some cases.
• This version will require Domoticz V 3.5837 or later.
• Utilizing new sensor types.
• Allowing redefinition of devices.

Version 1.0.0 Released 2016-11-07

• Corrected a problem that caused offset value for Domoticz counter sensor (kWh type only) to be 1000 times too high.
• Always abbreviate "Compressor" when creating a device in Domoticz.
• Set Value Quantity (e.g. Time) and Value Units (e.g. h) when creating an hour counter device device in Domoticz.

Version 1.0.1 Released 2016-11-10

• Code for checking if the Domoticz Device will time out has been improved.
• Miscellaneous code improvements.
• Hard coded the value factor to 0.01 for Nibe device "electrical addition power".
• Use Domoticz sensor type "Electric (Instant+Counter)" when the Nibe device uses the unit "kW"
• Fixed a problem where 2 different Nibe devices with identical names ("Heat Medium Flow") lead to that 2 devices in the config file was referencing the same Domoticz device. One of them was left orphant.
• Fixed a problem with Counter type sensors in Domoticz other than those counting 'kWh' are reporting integers back. Therefore a new algorithm is used for determining if the value read from Domoticz sensor differs from the actual Nibe values.
• Mesuring kW (E.g. "Electrical Addition Power") According to the documentation for the "Electricity (instant and counter)" sensor, " all counting must be done by client". Nibe is not counting the totals for "Electrical Addition Power". Therefore we are changing to a "Usage Electric" sensor for Nibe devices reporting values using "kW" as unit.

Version 1.0.2 Released 2016-11-22

• Corrected a problem that occurred when installing for first time and no hardware devices has been created in Domoticz.

Version 1.0.3 Released 2016-11-26

• Added support for Smart Price Adaption (When available at the Nibe device)

Version 1.0.4 (The Christmas version) Released 2016-12-24

• Added additional error checking to be sure that Domoticz has responded with accurate device data upon request.

Version 1.1.2 Released 2017-08-31

• Properly shows an error message if Nibe servers doesn't respond.

Version 1.2.0 Released 2017-10-07

• A new System Alarm device is introduced. See initial post.

Version 2.0.0 Released 2017-12-31

• New license model

Next version (Work in progress, not released yet)

• Nothing yet

[BakSeeDaa]

FAQ

Q: Will this work on a Domoticz Server running on Windows?
A: No.

Q: Some sensors are of the Domoticz type "Text Sensor" Why don't you use custom sensor instead?
A: I plan to change that very soon. Domoticz RPC for NIBE Uplink has been developed on a machine with Domoticz version 4834 and some new Sensor types hasn't been introduced in that version yet.

Q: I may have entered some wrong values during the setup. Can I start over again?
A: Sure. If a configuration file named config.json has been created in the same directory as you placed nibeuplink.pyc, you can just remove the config.json file and start over again.

Q: Can I rename the Domoticz devices created?
A: Yes. They are referred to by their Domoticz idx number.

Q: I see there is a new version available. Do I really need to upgrade now?
A: Normally not unless there are new features that You need. If an upgrade is marked "critical" you are advised to upgrade as soon as possible.

Q: My Nibe device got a "Filter Alarm" telling methat the filter needs cleaning but it wasn't shown in the Domoticz Alarm Device?
A: NIBE Supports says that even though the "Filter Alarm" sounds like it's an alarm it's not. NIBE Support says that it's actually just an information message and that the cause of this message doesn't cause the NIBE Device to stop functioning. Personally I suggest that the rename the "Filter Alarm" to "Filter Message" or even better, let the "Filter Alarm" get through in the API.

[BakSeeDaa]

Hi guys. Regarding the new Version 0.9.4

The instruction has changed. The port 8080-thing was confusing and the codes could get URL-encoded which was not a good thing. It's been solved with an external help server.

Only for "old" installations: If You have already set up everything and you now have upgraded to version 0.9.4, you will now need to access the NIBE Uplink API pages to edit your "application". Log in using your NIBE Uplink user credentials. In "My Applications" choose your application that you probably named myNibeSystem. Then choose 'Edit'. Change "Callback URL" to

Code: Select all

http://showquerystring.000webhostapp.com/index.php 

Click save. That's all.

[device33]

Awesome stuff!

Nibe F750 Extract Air seems to be logged as ex -21C when in reality it's -2.1C.
Nibe F750 Evaporator has the same issue.

[BakSeeDaa]

Awesome stuff!

Thank You @device33

Nibe F750 Extract Air seems to be logged as ex -21C when in reality it's -2.1C.
Nibe F750 Evaporator has the same issue.

That's strange. That's not the case here. I will send you an updated version of the program which supports command line options.
Please run it like this from a terminal:

Code: Select all

python /home/pi/domoticz/scripts/NibeUplink/nibeuplink.pyc -d

It will output some debug information that I need to investigate the issue. Please send the debug info to me via PM.

[foogy]

Really nice!

One thing...
My Nibe F1245 Outdoor Temp. is -0.16 degrees celcius. It should be -1.6 degrees celcius

[BakSeeDaa]

Really nice!

One thing...
My Nibe F1245 Outdoor Temp. is -0.16 degrees celcius. It should be -1.6 degrees celcius

Thanks for reporting. I will have a look at it today. I might need a debug output (See description in the first post), but I will tell you.

[foogy]

Really nice!

One thing...
My Nibe F1245 Outdoor Temp. is -0.16 degrees celcius. It should be -1.6 degrees celcius

Thanks for reporting. I will have a look at it today. I might need a debug output (See description in the first post), but I will tell you.

I changed "valueFactor" from 0.01 to 0.1 in config.json and now it seems to be correct.

[BakSeeDaa]

Really nice!

One thing...
My Nibe F1245 Outdoor Temp. is -0.16 degrees celcius. It should be -1.6 degrees celcius

Thanks for reporting. I will have a look at it today. I might need a debug output (See description in the first post), but I will tell you.

I changed "valueFactor" from 0.01 to 0.1 in config.json and now it seems to be correct.

Yes that will work.

[BakSeeDaa]

Hi there!

As You may have noticed, I've just released an update.

RELEASE NOTICES
Version 0.9.6 (Critical) Released 2016-11-06

• Added support for command line options
• Reimplemented the logic that figures out the factor used to calculate the sensor values.
• Removed the "Nibe " part from virtual device names due to that device names became to long in some cases.
• This version will require Domoticz V 3.5837 or later.
• Utilizing new sensor types.
• Allowing redefinition of devices.

Please note that the new version will require Domoticz V 3.5837 or later.

EXISTING USERS UPGRADING FROM PREVIOUS VERSIONS

For those of You that have a problem like the following

My Nibe F1245 Outdoor Temp. is -0.16 degrees celcius. It should be -1.6 degrees celcius

I'd recommend to use the new redefine procedure*. It will update the config file with newly calculated values for the device. But You'd probably want to redefine all your devices anyway so keep on reading below.

For those of You that would like to start using the new sensor types introduced
I'd recommend to redefine* the device. Easiest would be to delete ALL of the NIBEUplink Virtual devices in Domoticz. Then run the redefine function* answering 'Yes' to redefine them all.

* The redefine procedure is described in the initial post.

Cheers !

[BakSeeDaa]

I noted that Domoticz Counter sensors (kWh type only) has the wrong offset value when created in Domoticz RPC for NIBE Uplink Version 0.9.6. If You experience that, you can change the value in Domoticz by editing the device. Move the decimal point 3 steps to the left for the value in "Meter Offset". But it only affects the counter devices for kWh, other counter devices are not affected by this.

Corrected that and a few more things, tested it all out by recreating all my devices without any problems, I feel it's time that ...

I'm releasing version 1.0.0.

[BakSeeDaa]

Hello there!

I'm releasing a new version. After installing this update You will need to follow the procedure Redefine a device for all Domoticz RPC for NIBE Uplink sensors that uses the unit "kW" and "kWh".

Version 1.0.1 Released 2016-11-10

• Code for checking if the Domoticz Device will time out has been improved.
• Miscellaneous code improvements.
• Hard coded the value factor to 0.01 for Nibe device "electrical addition power".
• Use Domoticz sensor type "Electric (Instant+Counter)" when the Nibe device uses the unit "kW"
• Fixed a problem where 2 different Nibe devices with identical names ("Heat Medium Flow") lead to that 2 devices in the config file was referencing the same Domoticz device. One of them was left orphant.
• Fixed a problem with Counter type sensors in Domoticz other than those counting 'kWh' are reporting integers back. Therefore a new algorithm is used for determining if the value read from Domoticz sensor differs from the actual Nibe values.
• Mesuring kW (E.g. "Electrical Addition Power") According to the documentation for the "Electricity (instant and counter)" sensor, " all counting must be done by client". Nibe is not counting the totals for "Electrical Addition Power". Therefore we are changing to a "Usage Electric" sensor for Nibe devices reporting values using "kW" as unit.

[deennoo]

What a job, as usual for you, this make me want to get a NIBE boiler...if my Bullet ones doesn't have only 3 years old...

[BakSeeDaa]

What a job, as usual for you, this make me want to get a NIBE boiler...if my Bullet ones doesn't have only 3 years old...

Thanks!

[BakSeeDaa]

Hi all! I write a note here to let You know that in case You'd need support, I will have very limited possibilities to help You during 12-Nov to 22 Nov. Thanks for understanding.

[Leonard]

Works great!

I have an F1255 with geothermal heating and runs Domoticz on a RPi1.

The only small issue I had was that the "Brine Out" were displaying 16C instead of 1,6C but just as foogy, I changed the "valueFactor" in the config.json.

[BakSeeDaa]

Works great!

I have an F1255 with geothermal heating and runs Domoticz on a RPi1.

The only small issue I had was that the "Brine Out" were displaying 16C instead of 1,6C but just as foogy, I changed the "valueFactor" in the config.json.

Thanks for your report! I'm very happy to hear it.

I'd like to fix the "valueFactor" for the "Brine Out" device so it will work from start. If You have the time, I'd appreciate if You can send me the debug output (The debug part for the "Brine Out" device would be enough)

Cheers!

[Leonard]

I suppose you need this info:

{"parameterId":40016,"name":"40016","title":"brine out","designation":"EB100-EP14-BT11","unit":"°C","displayValue":"1.0°C","rawValue":10},

Another small matter, or perhaps a question;
I notice some values don't update that often, e.g. Degree Minutes, once per hour or so. Could it be that Nibe don't get the values from my system more frequently than that? I also notice that Nibe have some maintenance with Uplink lately,

[BakSeeDaa]

I suppose you need this info:
{"parameterId":40016,"name":"40016","title":"brine out","designation":"EB100-EP14-BT11","unit":"°C","displayValue":"1.0°C","rawValue":10},

Thanks, that's exactly what I needed and it will help me.

Another small matter, or perhaps a question;
I notice some values don't update that often, e.g. Degree Minutes, once per hour or so. Could it be that Nibe don't get the values from my system more frequently than that? I also notice that Nibe have some maintenance with Uplink lately,

I don't know but maybe Degree Minutes is not calculated so often. You can have a look at your systems service info at https://www.nibeuplink.com and the value that is displayed there will be fetched by Domoticz RPC for NIBE Uplink every 5 minutes. I know that some properties are updated very frequently.