====== Nibe Uplink Bridge ======

===== Description =====

The plugin is based on the script by [[https://loxwiki.atlassian.net/wiki/people/557058:75686b47-d713-47c6-b42a-fba4e0af4ed7?ref=confluence|User f4ed7]]. See also [[https://loxwiki.atlassian.net/wiki/spaces/LOX/pages/1536590488/Nibe+Gateway|Nibe Gateway]].

For the functionality, an account at [[https://api.nibeuplink.com/|Nibe Uplink]] is required. The heat pump system must be connected to the Nibe Cloud via the internet.

A Premium subscription with Nibe is required for write access.

===== Download =====

You can find the plugin on GitHub at: https://github.com/joesie/Loxberry-Nibe-Uplink-Bridge

===== Configuration =====

The setup of the plugin is done in 2 steps:

==== Setting up the Nibe Application ====

  * If you don't have a Nibe Uplink account yet, create one at [[https://www.nibeuplink.com/|https://www.nibeuplink.com]]
  * Then log in at https://api.nibeuplink.com/Account/LogIn
  * Create a new application at https://api.nibeuplink.com/Applications/Create\\
As the callback URL, enter the (local) address of the Loxberry with the plugin path (e.g., http://loxberry.fritz.box/plugins/nibeuplink/)\\
Note: The Uplink API does NOT need to be accessible from the outside!
  * Once you have created the application, you can view it under "MyApplication." It should look something like this:\\
{{plugins:nibe_uplink_bridge:1218019598.png?h=250}}
  * Now you have configured the Nibe Uplink.

==== Transferring the Nibe Application Information into the Plugin ====

  * Go to the Plugin Management and select this plugin\\
{{plugins:nibe_uplink_bridge:1218019599.png?h=150}}
  * Currently, we get the message that we are not logged in. This is correct. Now click on settings and enter the information from the Nibe Application (see above).\\
It should look something like this (with correct values):\\
{{plugins:nibe_uplink_bridge:1218019600.png?h=150}}
  * Now save the values, and we can click on "Nibe API" again.\\
Then follow the link to Nibe:\\
{{plugins:nibe_uplink_bridge:1218019599.png?h=150}}
  * Confirm the Recaptcha and click on "accept."
  * Now you will be redirected back, and you can view the status page. If you did everything correctly, it should look something like this:\\
{{plugins:nibe_uplink_bridge:1218019603.png?h=150}}
  * The plugin is now fully set up and can be used.

==== Function of the Plugin ====

The plugin handles the encrypted communication and [[https://api.nibeuplink.com/docs/v1/Authentication|authentication]] to NibeUplink. Certain "Categories" are addressed via GET parameters. The plugin delivers a JSON with the values from the system as an HTTP response. These can then be used in virtual inputs.

Nibe has provided a very good, technical [[https://api.nibeuplink.com/docs/v1/Functions|documentation]].

==== Setup in Loxone Config Software ====

[[https://loxwiki.atlassian.net/wiki/people/557058:75686b47-d713-47c6-b42a-fba4e0af4ed7?ref=confluence|User f4ed7]] has described the integration very well on the [[https://loxwiki.atlassian.net/wiki/spaces/LOX/pages/1536590488/Nibe+Gateway|Nibe Gateway]] page and has also provided [[https://github.com/DerFlash/Loxone-Nibe-Gateway/tree/master/Loxone%20Vorlagen|templates]] for the Loxone Config. Therefore, I will not go into further detail here.

==== Roadmap ====

The plugin is currently in an experimental status. The following tasks are next. Contributions are very welcome:

  * Outsource the hard-coded texts in the templates and internationalize them accordingly.
  * Design (or have designed) an icon.
  * The settings storage page should disappear.
  * The redirects between the login and free areas are not nice.
  * The config file is currently overwritten when updating the plugin. Personal settings are lost.
  * Refactoring (some parts can be solved better).

==== Ask Questions and Report Errors ====

If you have questions, suggestions, tips, and tricks, just contact me. You can also use the email address provided in the plugin.