mirror of
https://github.com/mtan93/homebridge.git
synced 2026-03-16 05:10:56 +00:00
dbedf7fe01
* No compilation step * Beginnings of web interface * Simple express server; React-based frontend * CommonJS style across codebase; auto-converts to RequireJS for browser * Using diffsync for realtime UI * "Provider" -> "Plugin" * Plugins expose one or more Providers
42 lines
1.6 KiB
Markdown
42 lines
1.6 KiB
Markdown
|
|
# Branch in Progress
|
|
|
|
This branch contains an in-progress ground-up rewrite of HomeBridge that looks more like what we want in the [roadmap](/nfarina/homebridge/wiki/Roadmap).
|
|
|
|
To play with HomeBridge today, follow the instructions in the [master branch](/nfarina/homebridge).
|
|
|
|
## Installing
|
|
|
|
Install HomeBridge using [npm](https://npmjs.com):
|
|
|
|
```sh
|
|
npm install -g homebridge
|
|
```
|
|
|
|
## Running
|
|
|
|
You can run HomeBridge easily from the command line:
|
|
|
|
```sh
|
|
> homebridge server
|
|
```
|
|
|
|
It will look for any locally-installed plugins and load them up automatically.
|
|
|
|
## Plugins
|
|
|
|
HomeBridge does nothing by itself; in order to expose your home to HomeKit, you'll need to install one or more HomeBridge "Plugins." A Plugin is an npm module that connects with HomeBridge and registers accessories for devices in your home.
|
|
|
|
Plugins must be published to npm and tagged with `homebridge-plugin`. The package name must contain the prefix `homebridge-`. For example, a valid package might be `homebridge-lockitron`.
|
|
|
|
Plugins are automatically discovered and loaded from your home directory inside the `.homebridge` folder. For instance, the Lockitron plugin would be placed here:
|
|
|
|
```sh
|
|
~/.homebridge/plugins/homebridge-lockitron
|
|
```
|
|
|
|
Right now you must copy plugins manually (or symlink them from another location). The HomeBridge server will load and validate your Plugin on startup. You can find an example Plugin in [example-plugins/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! |