homebox

An API that provides a uniform interface for interacting with IOT and home automation devices

WARNING: This project has been renamed to devlator. Install using devlator instead.
Last updated 3 years ago by richardwillars .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install homebox 
SYNC missed versions from official npm registry.

Homebox

Homebox makes home automation simple and flexible. It provides a uniform interface for interacting with IOT and home automation devices. Most home automation devices have their own communication protocols and standards, which make it a nightmare to integrate into home automation hubs (you have to build, maintain and support each and every device individually). Homebox acts as a translator and provides a consistent and standard way for accessing home automation devices.

The result is that home automation hubs no longer have to have knowledge of how to work with each device - they just need to know how to communicate with types of devices (speakers, lights, switches etc) on Homebox and they'll have support for potentially unlimited devices!

The really cool thing is that the Homebox ecosystem is entirely open source and based around npm. Developers, manufacturers (or anyone with knowledge of JavaScript) can add support for a particular device by creating a driver (this is an npm package that tells Homebox how to communicate with the device in question). Homebox will then expose the device using REST APIs and websockets.

So for example, to make a LIFX lightbulb turn on over 2 seconds and go blue..

POST http://localhost:3000/devices/:deviceId/setState
{
  "colour": {
    "hue": 230,
    "saturation": 1,
    "brightness": 0.5
  },
  "duration": 2,
  "on": true
}

.. and to make a Philips Hue lightbulb turn on over 2 seconds and go blue..

POST http://localhost:3000/devices/:deviceId/setState
{
  "colour": {
    "hue": 230,
    "saturation": 1,
    "brightness": 0.5
  },
  "duration": 2,
  "on": true
}

(no it's not a mistake - both requests are identical (apart from the device ID)!) Homebox takes away knowledge of different types of devices and how their different APIs and networking technologies. Instead they're exposed using a uniform REST API.

Requirements

  • mongodb
  • node.js

Installation

npm install homebox

Run

node app.js

This should launch a REST API and websocket server on http://localhost:3000

Test

npm run test

100% code coverage is aimed for on this project. We're almost there! codecov codecoverage

##Getting started Out of the box Homebox has no knowledge of any devices on your network or how to talk to them. The first thing you need to do is to get some drivers - these allow Homebox to search and communicate with specific devices on your network. Check out https://github.com/richardwillars/homebox/wiki/Drivers to learn how to search for and add drivers.

Once you have some drivers installed you can make calls to the APIs documented at https://github.com/richardwillars/homebox/wiki/devices. These APIs are used to discover devices on your network (using the drivers you just installed) and find out information each device.

If a driver doesn't exist for the device you want to talk to then you need to create a driver. More information on this can be found at https://github.com/richardwillars/homebox/wiki/Drivers

You can keep your home automation user interface up to date using the events API. More information on this can be found at https://github.com/richardwillars/homebox/wiki/events

Video

You can see an introduction to Homebox and how to use the various APIs at https://www.youtube.com/watch?v=qeveomS1i5k

Todo

Important features to build..

  • documentation
  • zwave adapter
  • openzwave interface
  • bluetooth adapter
  • zigbee adapter

Current Tags

  • 0.1.2                                ...           latest (3 years ago)

2 Versions

  • 0.1.2 [deprecated]           ...           3 years ago
  • 0.1.1 [deprecated]           ...           3 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 2
Dependencies (14)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |