It was only the older NIBE F-series heat pumps that used NIBE Uplink anyway; the newer S-series have always used myUplink. Other people have had good success using variants of the NIBE Uplink scripts to access myUplink since the APIs are similar and the authentication requirements are the same, but the structure of the API calls is different (arguably better and simpler – more logical and fewer calls required to return the same data).<\/p>\n\n\n\n
This page intentionally duplicates a lot of the content from the earlier NIBE Heat Pump Monitoring via NIBE Uplink API (Python Version)<\/a> since I expect most new users will arrive at this page and it’s less confusing if the instructions are self-contained and if the screenshots reflect the myUplink look-and-feel.<\/p>\n\n\n\n This procedure works for me and I\u2019m publishing it here as a Proof of Concept in case it helps other people trying to accomplish the same objective. It may not work for you. It may not get updated in line with changes to the myUplink API service. You are responsible for complying with the terms of the myUplink API Services Agreement and for keeping the application Identifier, Secret and any generated user Tokens confidential.<\/p>\n\n\n\n I have an 8kW NIBE F1145 Ground Source Heat Pump which was installed in 2016 and was originally configured to send data to the NIBE Uplink service. Towards the end of 2023 NIBE have been migrating NIBE Uplink users over to the newer myUplink service and these notes were written in support of that migration.<\/p>\n\n\n\n The uploaded data is accessible via the myUplink website and the myUplink smartphone app, but those apps use the API \u2018under the covers\u2019 and it\u2019s possible to call the API directly from a custom program or script to access all the same data \u2013 and then do more interesting things with it.<\/p>\n\n\n\n I have a script which invokes the myUplink API on a timed schedule (every few minutes) to download the parameters I\u2019m interested in which I then re-publish using\u00a0MQTT<\/a>\u00a0(my personal preference; in no sense essential) to integrate them with data from other sources (Meter-Bus electricity and heat meters, Dallas Semiconductor One-Wire sensors, Oregon Scientific temperature \/ humidity sensors \u2013 see other pages on this Blog for more details of those if you\u2019re interested). Everything then gets loaded into an\u00a0InfluxDB<\/a>\u00a0time-series database from which it can be extracted and graphed with\u00a0Grafana<\/a>\u00a0(again my personal preferences but these tools work well for me).<\/p>\n\n\n\n At the risk of straying even further off-topic, some of my myUplink data gets further re-published to HeatpumpMonitor.org<\/a> (a community dashboard of heat pump performance data). Since that also needs a feed of Electricity Consumption and Heat Output data, which are not part of the myUplink dataset, I found it easier to source the data from InfluxDB and upload to emoncms.org<\/a> (which drives HeatPumpMonitor.org) in one go.<\/p>\n\n\n\n At a bare minimum you will need the following to use this procedure:<\/p>\n\n\n\n The official documentation for the myUplink API is at\u00a0https:\/\/dev.myuplink.com\/<\/a>\u00a0(note you need to login to access that page). The detail is described on those pages but in summary:<\/p>\n\n\n\n The older NIBE Uplink API only supported OAuth2’s Authorization Code Grant Flow<\/a> (also known as the Web Application Flow); the myUplink API also supports OAuth2’s Client Credentials Grant Flow<\/a> (also known as the Backend Application Flow) which appears somewhat simpler. The current page concentrates on the Authorization Code Grant Flow since that replicates the old NIBE Uplink behaviour. There’s more info on the Authentication options at https:\/\/dev.myuplink.com\/auth<\/a> and probably the simpler Client Credentials Grant Flow would be a better match to the requirements of most hobbyist users. Maybe I’ll address that in a future update to this page.<\/p>\n\n\n\n Personally I found the biggest barrier to getting the API working was understanding what the OAuth2 Callback URL<\/strong> was all about and what would be an acceptable value to use for that (there are several constraints). Actually it\u2019s not all that<\/em> complicated and it only needs to be used once, in order to initially get an Access Token. Importantly, it\u2019s possible to run some steps in the procedure on different machines (as long as they\u2019re done in quick succession). Here\u2019s a summary of how it works:<\/p>\n\n\n\n I believe it\u2019s necessary for the Callback URL<\/strong> to use HTTPS<\/strong> and since that can be problematic to configure I\u2019m hosting a simple script on the same server as this Blog which anyone should be able to specify as their Callback URL<\/strong> \u2013 it will simply print out the generated Authorization Code (or any error message). That URL is: https:\/\/www.marshflattsfarm.org.uk\/nibeuplink\/oauth2callback\/index.php<\/a> (which will complain unless you call it with the right parameters \u2013 see later).<\/p>\n\n\n\n If you want to host your own installation of the\u00a0Callback URL<\/strong>\u00a0the PHP script code I\u2019m using can be download from GitHub\u00a0here<\/a>.<\/p>\n\n\n\n The Python library\u00a0Requests-OAuthlib<\/a>\u00a0is used to hide much of the complexity of OAuth2 processing. The documentation at that link explains how to use it though in principle if you exactly follow the procedure outlined below you don\u2019t need to understand in detail how it works.<\/p>\n\n\n\n The computer which will run the script that calls the myUplink API needs some preparation to ensure the Python environment and the necessary supporting Python libraries are available.<\/p>\n\n\n\n The Python script you are about to create that will call the myUplink API is what the API calls an \u2018Application\u2019 so start by Registering a new Application at the myUplink website so that you get allocated your various unique ID strings which will be required later.<\/p>\n\n\n\n Now we have an Access Token we can actually<\/em> call the API \u2013 and now things are less time-critical because the Token will be automatically renewed as required.<\/p>\n\n\n\n If that worked OK then you can also try the third sample Python script in the GitHub repository, called:\u00a0 You will have to edit These details are simply printed out but the script could be adapted to publish them as MQTT messages or re-formatted as XML or JSON or similar and sent to a Home Automation system or database.<\/p>\n\n\n\n If this procedure works for you, great! Please leave a Comment to let me know. If it doesn\u2019t work or doesn\u2019t makes sense please also leave a Comment and I\u2019ll try to help.<\/p>\n\n\n\n Clearly just printing out the systemIds isn\u2019t very interesting but the myUplink API Documentation describes the other API calls in some detail.<\/p>\n\n\n\n I found the following resources useful for understanding how to get OAuth2 working:<\/p>\n\n\n\n Introduction The other pages on this site which describe using scripts to interact with the NIBE Uplink API have proved quite popular, especially in explaining the requirements for OAuth2 Authentication. In late 2023, the NIBE Uplink service is being decommissioned … Continue reading Disclaimer<\/h1>\n\n\n\n
My Use Case<\/h1>\n\n\n\n
Pre-Requisites<\/h1>\n\n\n\n
\n
\n
\n
\n
myUplink API \u2013 Documentation and Underpinning Technologies<\/h1>\n\n\n\n
\n
\n
Step-By-Step Procedure<\/h1>\n\n\n\n
Step 0 \u2013 Prepare the Python Computer<\/h2>\n\n\n\n
\n
\n
sudo apt-get install python3<\/code><\/li>\n<\/ul>\n<\/li>\n\n\n\n\n
pip3 install requests-oauthlib<\/code><\/li>\n\n\n\nsudo pip3 install requests-oauthlib<\/code>\n\n
sudo apt-get install python3-pip<\/code><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n\n\n\nStep 1 – Register your \u2018Application\u2019<\/h2>\n\n\n\n
\n
\n
![\"\"](\"https:\/\/www.marshflattsfarm.org.uk\/wordpress\/wp-content\/uploads\/2023\/12\/myUplink-CreateApplication.png\")
<\/li>\n\n\n\nStep 2 – Create an Access Token using an Authorization Code<\/h2>\n\n\n\n
\n
\n
request_token.py<\/code>\u00a0file<\/li>\n\n\n\nwget https:\/\/github.com\/MarshFlattsFarm\/myUplink-API\/raw\/main\/request_token.py<\/code><\/li>\n<\/ul>\n<\/li>\n\n\n\nclient_id<\/code>\u00a0and\u00a0client_secret<\/code>\u00a0with the\u00a0Client Identifier<\/strong>\u00a0and\u00a0Client Secret<\/strong>\u00a0strings from Step 1<\/li>\n\n\n\npython3 request_token.py<\/code><\/li>\n\n\n\n![\"\"](\"https:\/\/www.marshflattsfarm.org.uk\/wordpress\/wp-content\/uploads\/2023\/12\/myUplink-Allow-1.png\")
<\/li>\n\n\n\n![\"\"](\"https:\/\/www.marshflattsfarm.org.uk\/wordpress\/wp-content\/uploads\/2023\/12\/myUplink-CODE.png\")
<\/li>\n\n\n\nStep 3 – Call the NIBE Uplink API<\/h2>\n\n\n\n
\n
simple_call_to_protected_api.py<\/code><\/li>\n\n\n\nclient_id<\/code> and client_secret<\/code> as before<\/li>\n\n\n\npython3 simple_call_to_protected_api.py<\/code><\/li>\n\n\n\nget_DevicePoints_for_Devices_for_Systems.py<\/code><\/p>\n\n\n\nclient_id<\/code> and client_secret<\/code> as before (the first part of this script is identical to the previous script). This third script:<\/p>\n\n\n\n\n
Next Steps<\/h2>\n\n\n\n
Further Reading<\/h2>\n\n\n\n
\n