Skip to content

Homebridge Plugin providing data from ~Nibe~ MyUplink

License

Notifications You must be signed in to change notification settings

vingarzan/homebridge-nibe

 
 

Repository files navigation

homebridge-nibe

NPM version Release GitHub license Downloads

Build status

NPM

"Buy Me A Coffee"

Nibeuplink plugin for homebridge

This homebridge plugin retrieves data from a Nibe heat pump from Nibe Uplink.

Plugin configuration

Whole setup instruction is available on plugin configuration page in homebridge. There is step by step description how to get required parameters.

Supported accessories

Accessory Description
outdoor-temperature BT1 outdoor temperature (40004 or 44362).
average-outdoor-temperature BT1 average outdoor temperature (40067).
hot-water Hot water temperature (40014,40008). Active (on/off) is responsible for temporary lux (48132).
hot-water-top Top hot water temperature (40013).
ventilation-exhaust-air Ventilation/ERS exhaust air temperature (40025).
ventilation-extract-air Ventilation/ERS extract air temperature (40026).
ventilation-supply-air ERS supply air temperature (40075).
ventilation-outdoor ERS outdoor temperature (40183).
ers-fan ERS fan speed (40311, 40312) with change rotation speed (47260) and active state when rotation is grater than 0.
ventilation-fan Ventilation fan speed (10001) with change rotation speed (47260) and active state when rotation is grater than 0.
thermostat Thermostat (40008,43437) for heating and cooling (if available). Active state is calculated. Changing desired temperature will affect heating/cooling offset (47011/48739).

Roadmap

https://github.com/hp-net/homebridge-nibe/projects/1

Configuration

Whole configuration can be done via homebridge ui and this is recommended way to do it.

However, you can also make all changes directly in homebridge config.json file. Below you can find description of all options.

Name Required Default Description
platform Yes Nibe 'Nibe' is only correct value. If value will be different configuration will not match plugin.
identifier Yes Api app identifier from Nibe Uplink account. Read instructions from plugin configuration to know how to get it.
secret Yes Api app secret from Nibe Uplink account. Read instructions from plugin configuration to know how to get it.
authCode Yes Authorization code for the app from Nibe Uplink. Read instructions from plugin configuration to know how to get it.
systemIdentifier Yes System identifier for installed Nibe devices.
callbackUrl Yes https://hp-net.github.io/homebridge-nibe/nibe.html Url that will handle callback with authCode parameter. Default page is safe, it does not have any tracking scrips or additional logic to do weird stuff with the code. What is more authCode is not enough to da anything with api. Default page will only show you the code and give you a nice button to copy it to clipboard.
language No en Language to call Nibe Uplink Api and to set accessories labels. Possible values: 'en', 'pl'.
pollingPeriod No 60 Period (in seconds) for fetching device changes from api.
disabledAccessories No List of accessories to disable. Format 'id(name)' or 'id'.
showApiResponse No If set to `true` response from Nibe Uplink API will be displayed in logs.
hotwaterHeatingTemp No 40 Min heating temperature for hot water. Used to decide if hot water is active.

Sponsorship & support

If you are using this project please consider sponsoring it's further development & bug fixes

"Buy Me A Coffee"

About

Homebridge Plugin providing data from ~Nibe~ MyUplink

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 97.8%
  • HTML 2.2%