node-hivehome v0.1.0

node-Hivehome

An (unofficial) NodeJS SDK for Hivehome smarthome products.

This uses Hivehome's web API, which isn't officially designated for public consumption. Therefore, this may break randomly if the Hivehome team make breaking changes. Nevertheless, we'll try and fix things as fast as possible.

⚠️ This is still a WIP, and we're still working to expand the feature support for the range of Hivehome's smarthome platform. Start a discussion to help me identify which parts should be focused next.

TOC

• Installation
• Documentation
• Quick Start
• TODO
• Alternative(s)

Installation

$ yarn add node-hivehome # or, npm install node-hivehome

Documentation

The documentation can be viewed at https://tgallacher.github.io/node-hivehome/. This is auto-generated from the code, using typedoc.

Quick Start

As a quick example for getting going, with your email and password you can view the heating product(s) and their current state (e.g. temperature) by running the following:

// index.js
const { Hivehome } = require('node-hivehome');

(async ()=>{
  const hive = new Hivehome('hello@example.com');
  // Note: Doesn't support MFA yet. Need to disable in Hivehome's App for first login.
  await hive.auth.login('supersecretpassword');

  const heatingData = await hive.heating.get();

  console.log(JSON.stringify(heatingData, null, 2));
})()

Once installed, and with the above script, running:

node index.js

should print out the current state of all Hivehome heating product(s) registered to the account used for logging in.

TODO

• Add support for MFA flow
• Add support for devices
• Add support for heating products (excl. trvs)
• Add support for light products
• Add support for camera products
• Add support for sensor products
• Add support for plug products
• Add support for shield products

Alternative(s)

• Pyhive/Pyhiveapi - Python library interface for Hivehome