diff --git a/README.md b/README.md old mode 100644 new mode 100755 index dfae5c1..05fca0d --- a/README.md +++ b/README.md @@ -1,2 +1,64 @@ -# homebridge-smarthomeng +#Attention: This software is not yet ready, it is in alpha state !!! Do not use it yet !!! + +#homebridge-smarthomeng Homebridge plugin for SmartHomeNG +##Requirements +SmartHomeNG: https://github.com/smarthomeNG/smarthome +homebridge: https://www.npmjs.com/package/homebridge +##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. +
+curl -sL https://deb.nodesource.com/setup_0.12 | sudo bash - +sudo apt-get install -y nodejs ++Install homebridge from NPM repository +
+npm install -g homebridge ++Install this plugin from NPM repository +*** ATTENTION: NOT YET PUBLISHED *** +
+npm install -g homebridge-smarthomeng ++##Configuration +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. +
+{
+ "bridge": {
+ "name": "HomebridgeSH",
+ "username": "CC:22:3D:E3:CE:32",
+ "port": 51826,
+ "pin": "031-45-154"
+ },
+
+ "platforms": [
+ {
+ "platform": "SmartHomeNG",
+
+ "name": "SmartHomeNG",
+ "host": "myshngserver.mydomain",
+ "accessories": [
+ {
+ "name": "Bureaulicht",
+ "type": "Lightbulb",
+ "onoff": "EG.Buero.Licht"
+ },
+ {
+ "name": "Stubenlicht",
+ "type": "Lightbulb",
+ "onoff": "EG.Stube.Licht"
+ },
+ {
+ "name": "Schlafzimmerlicht",
+ "type": "Lightbulb",
+ "onoff": "OG.SZSS.Licht",
+ "brightness": "OG.SZSS.Licht.dimmen"
+ }
+
+ ]
+ }
+ ],
+ "description": "This is my development config file."
+}
+
\ No newline at end of file