Branch in Progress

This branch contains an in-progress ground-up rewrite of HomeBridge that looks more like what we want in the roadmap.

To play with HomeBridge today, follow the instructions in the master branch.

Installing

Install HomeBridge using npm:

npm install -g homebridge

Running

You can run HomeBridge easily from the command line:

> homebridge server

It will look for any locally-installed providers and load them up automatically.

Providers

HomeBridge does nothing by itself; in order to expose your home to HomeKit, you'll need to install one or more HomeBridge "Providers." A Provider is an npm module that connects with HomeBridge and registers accessories for devices in your home.

Providers must be published to npm and tagged with homebridge-provider. The package name must contain the prefix homebridge-. For example, a valid package might be homebridge-lockitron.

Providers are automatically discovered and loaded from your home directory inside the .homebridge folder. For instance, the Lockitron provider would be placed here:

~/.homebridge/providers/node_modules/homebridge-lockitron

Right now you must copy providers manually (or symlink them from another location). The HomeBridge server will load and validate your Provider on startup. You can find an example Provider stub in example-providers/homebridge-lockitron.

Running from Source

You can run HomeBridge directly from source by cloning this repo and running the executable bin/homebridge. Remember to npm install dependencies first!