Skip to content

Drivers

Richard Willars edited this page Sep 15, 2016 · 10 revisions

What is a driver?

A driver in Homebox has several responsibilities:

  • discover and connect to particular devices on the network
  • tell Homebox about the capabilities of each of those devices
  • provide Homebox with the ability to control each of those capabilities
  • expose events to Homebox (where necessary) based on things that happen to devices (a sensor may report a new value)

A driver in Homebox is almost like a translator. It takes the language of a particular home automation device and translates that language into a language that Homebox can understand. In reality this is done using a series of methods and events that Homebox exposes.

Each driver has it's own git repository and is added to your Homebox system using npm.

How to find drivers

Each driver is it's own git repository and registered in npm. You can find all the available Homebox drivers at https://www.npmjs.com/search?q=homebox-driver-

How to add a driver to Homebox

Navigate to the root of the homebox directory and run

npm install homebox-driver-xxx

where xxx is the name of the driver you want to install. Then restart Homebox by re-running 'node app.js'

Clone this wiki locally