diff --git a/README.md b/README.md index 75f07e7..c7a0982 100755 --- a/README.md +++ b/README.md @@ -1,72 +1,87 @@ -# Attention: This software is in alpha state !!! - # homebridge-smarthomeng -Homebridge plugin for SmartHomeNG +Homebridge plugin for SmartHomeNG. This is work in progress and all devices are supported. ## Currently supported -This plugin currently supports: -* LightBulb with on/off and brightness characteristic -* Window Covering with currentposition and targetposition characteristic (state not yet supported) +This plugin currently supports the following services (and characteristics): + +* LightBulb (on/off, brightness, hue, saturation) +* Fan (on/off) +* Temperature sensor (current temperature) +* Thermostat (current- / target temperature) +* Window Covering (current- / target position) +* Motion sensor (motion detected) +* Occupancy sensor (motion detected) ## Requirements -* SmartHomeNG: https://github.com/smarthomeNG/smarthome -* homebridge: https://www.npmjs.com/package/homebridge +* [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_4.x | sudo bash -
-sudo apt-get install -y nodejs
-
-Homebridge needs the libavahi-compat-libdnssd-dev lib (installation tested on Debian Jessie) -
-sudo apt-get install libavahi-compat-libdnssd-dev
-
-Install homebridge from NPM repository -
-npm install -g homebridge --unsafe-perm
-
+### Install nodejs >= 0.12. +You have to find out the right way for your OS. + + +Debian Jessie: + + curl -sL https://deb.nodesource.com/setup_4.x | sudo bash - + sudo apt-get install -y nodejs + +Alpine Linux: (--no-cache example is for building a docker image) + + apk --no-cache add nodejs + +### Install libavahi-compat-libdnssd-dev lib +Debian Jessie: + + sudo apt-get install libavahi-compat-libdnssd-dev + +Alpine Linux: (--no-cache example is for building a docker image) + + apk --no-cache add dbus nodejs avahi avahi-compat-libdns_sd avahi-dev + +### Install homebridge from NPM repository + + npm install -g homebridge --unsafe-perm + + +### Install this plugin from NPM repository + + npm install -g homebridge-smarthomeng --unsafe-perm -Install this plugin from NPM repository -
-npm install -g homebridge-smarthomeng --unsafe-perm
-
## 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"
-    },
+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.
 
-    "platforms": [
-        {
-            "platform": "SmartHomeNG",
-             
-            "name": "SmartHomeNG",
-            "host": "myshngserver.mydomain",
-            "accessories": [
-                {
-                    "name": "Licht Büro",
-                    "type": "Lightbulb",
-                    "onoff": "EG.Buero.Licht"
-                },
-                {
-                    "name": "Rolladen Büro",
-                    "type": "WindowCovering",
-                    "updown": "EG.Buero.Rolladen.AufAb",
-                    "currentposition": "EG.Buero.Rolladen.Position",
-                    "targetposition": "EG.Buero.Rolladen.Position",
-                    "inverted": true
-                }
-            ]
-        }
-    ],
-    "description": "This is my development config file."
-}
-
\ No newline at end of file + { + "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": "Licht Büro", + "type": "Lightbulb", + "onoff": "EG.Buero.Licht" + }, + { + "name": "Rolladen Büro", + "type": "WindowCovering", + "updown": "EG.Buero.Rolladen.AufAb", + "currentposition": "EG.Buero.Rolladen.Position", + "targetposition": "EG.Buero.Rolladen.Position", + "inverted": true + } + ] + } + ], + "description": "This is my development config file." + }