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

document the new scripts

Browse Source
This commit is contained in:
Jon Maddox
2015-09-14 23:56:22 -04:00
parent 241b22db87
commit ae2d53262f
1 changed files with 22 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -52,26 +52,21 @@ You'll also need some patience, as Siri can be very strict about sentence struct
# Getting Started
OK, if you're still excited enough about ordering Siri to make your coffee (which, who wouldn't be!) then here's how to set things up. First, clone this repo:
OK, if you're still excited enough about ordering Siri to make your coffee (which, who wouldn't be!) then here's how to set things up. First, clone this repo and set up the project:
$ git clone https://github.com/nfarina/homebridge.git
$ cd homebridge
$ npm install
$ script/bootstrap
**Node**: You'll need to have NodeJS version 0.12.x or better installed for required submodule `HAP-NodeJS` to load.
**Node**: You'll need to have NodeJS version 0.12.x or better installed for required submodule `HAP-NodeJS` to load as well as the `forever` node package..
The server won't do anything until you've edited your `config.json` file containing your home devices (or _accessories_ in HomeKit parlance) or platforms you wish to make available to iOS. The sample configuration has been copied for you into `config.json`. It includes declarations for all supported accessories and platforms. Remove everything except for the accessories and platforms you'll be using.
Now you should be able to run the homebridge server:
$ cd homebridge
$ npm run start
Starting Homebridge server...
Couldn't find a config.json file [snip]
$ script/server
The server won't do anything until you've created a `config.json` file containing your home devices (or _accessories_ in HomeKit parlance) or platforms you wish to make available to iOS. You can start by copying and modifying the included `config-sample.json` file which includes declarations for all supported accessories and platforms.
Once you've added your devices and/or platforms, you should be able to run the server again and see them initialize:
$ npm run start
Starting Homebridge server...
Loading 6 accessories...
[Speakers] Initializing 'Sonos' accessory...
@@ -84,6 +79,22 @@ Once you've added your devices and/or platforms, you should be able to run the s
Your server is now ready to receive commands from iOS.
# Installing Homebridge to Run at Boot and in the Background
Homebridge can be run at boot and in the background on OS X and any Linux variation that uses SysVinit (/etc/init.d scripts) to launch services. To install homebridge as
a service:
$ script/install
It should load for you in the background. You can find logs in `log/logs.log`. To uninstall it you can run `script/uninstall`. To restart it you can run `script/restart`.
# Upgrading
If you want to upgrade homebridge, simply run:
$ script/upgrade
It will pull the newest version from the repo on GitHub and restart itself.
# Adding your devices to iOS
HomeKit is actually not an app; it's a "database" similar to HealthKit and PassKit. But where HealthKit has the companion _Health_ app and PassKit has _Passbook_, Apple has supplied no app for managing your HomeKit database (at least [not yet](http://9to5mac.com/2015/05/20/apples-planned-ios-9-home-app-uses-virtual-rooms-to-manage-homekit-accessories/)). However, the HomeKit API is open for developers to write their own apps for adding devices to HomeKit.