Code Monkey home page Code Monkey logo

hass_nibe's Introduction

Nibe - An home assistant plugin to get data from Nibe Uplink

Preparation

Register an nibe uplink application on: https://api.nibeuplink.com/

  • Set the redirect url to match <http or https>://<your_home_assistant_url_or_local_ip>:<port>/api/nibe/auth
  • Take note of the Identifer (client_id) and the Secret

Installation

  • Clone or copy the root of the repository into <config dir>/custom_components/nibe
  • Add a nibe configuration block to your <config dir>/configuration.yaml see example below
cd .homeassistant
mkdir custom_components
cd custom_components
git clone https://github.com/elupus/hass_nibe.git nibe

Configuration

Configuration description

nibe:
    systems:
        # required system identifier
        - system: <identifier>

          # list of units to retrieve data for
          units:
              # unit to retrieve data for (0 is the master unit and should always exist)
            - unit: <identifier>

              # Optional load of status entities
              categories: True

              # Optional load of status entities
              statuses: True

          # Optional list of additional parameters to retrieve, can be done here or on the sensor platform.
          sensors:
            - <parameter identifier>
            - <parameter identifier>

          # Optional list of switches (note, for ability to change, you need to use writeaccess and have payed license).
          switches:
            - hot_water_boost

          # Optional load climate entities
          climates: True

          # Optional load water_heaters entities
          water_heaters: True

          # Optional smart thermostats.
          thermostats:
            # Key in dict is external identifer in nibe uplink, it should
            # be an unique integer for this thermostat
            1:
              # Required friendly name of thermostat
              name: "Kitchen Thermostat"

              # Optional name of a home assistant entity representing current temperature
              current_temperature: input_number.current

              # Optional name of a home assistant entity representing valve position of
              # a thermostat. At the moment it's use case is unknown.
              # valve_position: input_number.valve

              # List of systems that this thermostat is affecting. This is
              # this is the sub climate system/area index (System 1, System 2, ..)
              # that the pump is controlling.
              systems: 1

            2:
              name: "Livingroom Thermostat"
              current_temperature: input_number.current
              systems: 1

Minimal configuration

nibe:
    systems:
        - system: <required system identifier>
          units:
            - unit: 0
          climates: True
          water_heaters: True

hass_nibe's People

Contributors

elupus avatar runevad avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.