mtan93/homebridge
1
0
Fork 0
mirror of https://github.com/mtan93/homebridge.git synced 2026-03-18 05:10:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Unify example accessory

Browse Source 
Using Lockitron for first new-style example accessory, since it has a
very simple and public API.
This commit is contained in:
Nick Farina
2015-07-07 19:40:14 -07:00
parent dc2579894f
commit 0e9d237d03
4 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -27,15 +27,15 @@ It will look for any locally-installed providers and load them up automatically.
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-philips-hue`.
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 Philips Hue Provider would be placed here:
Providers are automatically discovered and loaded from your home directory inside the `.homebridge` folder. For instance, the Lockitron provider would be placed here:
```sh
~/.homebridge/providers/node_modules/homebridge-philips-hue
~/.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-liftmaster]().
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

3
example-providers/homebridge-liftmaster/index.js
View File

@@ -1,3 +0,0 @@
// Demonstrate that we were loaded
console.log("LiftMaster provider loaded!");

3
example-providers/homebridge-lockitron/index.js Normal file
View File

@@ -0,0 +1,3 @@
// Demonstrate that we were loaded
console.log("Lockitron provider loaded!");

4
example-providers/homebridge-liftmaster/package.json → example-providers/homebridge-lockitron/package.json
View File

@@ -1,7 +1,7 @@
{
"name": "homebridge-liftmaster",
"name": "homebridge-lockitron",
"version": "0.0.0",
"description": "LiftMaster Support for HomeBridge",
"description": "Lockitron Support for HomeBridge",
"license": "ISC",
"engines": {
"homebridge": ">=0.0.0"