Updated readme
This commit is contained in:
parent
78f1b77d8a
commit
cc48ed354e
67
README.md
67
README.md
@ -1,41 +1,57 @@
|
|||||||
# Attention: This software is in alpha state !!!
|
|
||||||
|
|
||||||
# homebridge-smarthomeng
|
# homebridge-smarthomeng
|
||||||
Homebridge plugin for SmartHomeNG
|
Homebridge plugin for SmartHomeNG. This is work in progress and all devices are supported.
|
||||||
|
|
||||||
## Currently supported
|
## Currently supported
|
||||||
This plugin currently supports:
|
This plugin currently supports the following services (and characteristics):
|
||||||
* LightBulb with on/off and brightness characteristic
|
|
||||||
* Window Covering with currentposition and targetposition characteristic (state not yet supported)
|
* 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
|
## 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.
|
||||||
<pre>
|
You have to find out the right way for your OS.
|
||||||
|
|
||||||
|
|
||||||
|
Debian Jessie:
|
||||||
|
|
||||||
curl -sL https://deb.nodesource.com/setup_4.x | sudo bash -
|
curl -sL https://deb.nodesource.com/setup_4.x | sudo bash -
|
||||||
sudo apt-get install -y nodejs
|
sudo apt-get install -y nodejs
|
||||||
</pre>
|
|
||||||
Homebridge needs the libavahi-compat-libdnssd-dev lib (installation tested on Debian Jessie)
|
|
||||||
<pre>
|
|
||||||
sudo apt-get install libavahi-compat-libdnssd-dev
|
|
||||||
</pre>
|
|
||||||
Install homebridge from NPM repository
|
|
||||||
<pre>
|
|
||||||
npm install -g homebridge --unsafe-perm
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Install this plugin from NPM repository
|
Alpine Linux: (--no-cache example is for building a docker image)
|
||||||
<pre>
|
|
||||||
|
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
|
npm install -g homebridge-smarthomeng --unsafe-perm
|
||||||
</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.
|
|
||||||
<pre>
|
|
||||||
{
|
{
|
||||||
"bridge": {
|
"bridge": {
|
||||||
"name": "HomebridgeSH",
|
"name": "HomebridgeSH",
|
||||||
@ -69,4 +85,3 @@ This is an example config file which just uses this plugin and some example Smar
|
|||||||
],
|
],
|
||||||
"description": "This is my development config file."
|
"description": "This is my development config file."
|
||||||
}
|
}
|
||||||
</pre>
|
|
||||||
Loading…
Reference in New Issue
Block a user