noe/homebridge-smarthomeng
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
Foxi352 2016-07-02 17:37:41 +02:00
parent 1b99e693d1
commit 6aa724948b
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -2,29 +2,34 @@
#homebridge-smarthomeng #homebridge-smarthomeng
Homebridge plugin for SmartHomeNG Homebridge plugin for SmartHomeNG
##Currently supported ##Currently supported
This plugin currently supports: This plugin currently supports:
* LightBulb with on/off and brightness characteristic * LightBulb with on/off and brightness characteristic
* Window Covering with currentposition and targetposition characteristic (state not yet supported) * Window Covering with currentposition and targetposition characteristic (state not yet supported)
##Requirements ##Requirements
SmartHomeNG: https://github.com/smarthomeNG/smarthome * SmartHomeNG: https://github.com/smarthomeNG/smarthome
homebridge: https://www.npmjs.com/package/homebridge * homebridge: https://www.npmjs.com/package/homebridge
##Installation ##Installation
Install nodejs >= 0.12. You have to find out the right way for your OS. The following commands have been tested on Debian Jessie. Install nodejs >= 0.12. You have to find out the right way for your OS. The following commands have been tested on Debian Jessie.
<pre> <pre>
curl -sL https://deb.nodesource.com/setup_0.12 | sudo bash - curl -sL https://deb.nodesource.com/setup_0.12 | sudo bash -
sudo apt-get install -y nodejs sudo apt-get install -y nodejs
</pre> </pre>
Install homebridge from NPM repository Install homebridge from NPM repository
<pre> <pre>
npm install -g homebridge npm install -g homebridge
</pre> </pre>
Install this plugin from NPM repository Install this plugin from NPM repository
*** ATTENTION: NOT YET PUBLISHED *** *** ATTENTION: NOT YET PUBLISHED ***
<pre> <pre>
npm install -g homebridge-smarthomeng npm install -g homebridge-smarthomeng
</pre> </pre>
##Configuration ##Configuration
You have to create a config.json in .homebridge directory. You'll find that directory in your home folder. You have to create a config.json in .homebridge directory. You'll find that directory in your home folder.
This is an example config file which just uses this plugin and some example SmartHomeNG items. This is an example config file which just uses this plugin and some example SmartHomeNG items.
@ -50,12 +55,13 @@ This is an example config file which just uses this plugin and some example Smar
"onoff": "EG.Buero.Licht" "onoff": "EG.Buero.Licht"
}, },
{ {
"name": "Rollladen Büro", "name": "Rolladen Büro",
"type": "WindowCovering", "type": "WindowCovering",
"updown": "EG.Buero.Rolladen.AufAb",
"currentposition": "EG.Buero.Rolladen.Position", "currentposition": "EG.Buero.Rolladen.Position",
"targetposition": "EG.Buero.Rolladen.Position" "targetposition": "EG.Buero.Rolladen.Position",
"inverted": true
} }
] ]
} }
], ],