added UIs and auto generated list of bindings

Signed-off-by: Kai Kreuzer <[email protected]>
ekmixon · May 17, 2016 · 531cc8b · 531cc8b
1 parent 8412506
commit 531cc8b
Show file tree

Hide file tree

Showing 18 changed files with 317 additions and 198 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+_site
+.sass-cache
diff --git a/_data/bindings.csv b/_data/bindings.csv
@@ -1,36 +1,37 @@
-id,label
-digitalstrom, digitalSTROM
-fsinternetradio, FS Internet Radio
-hue, Philips Hue
-lifx, LIFX
-ntp, NTP
-sonos, Sonos
-wemo, Belkin Wemo
-yahooweather, YahooWeather
-astro, Astro
-autelis, Autelis Pool Control
-avmfritz, AVM FRITZ!
-dscalarm,DSC Alarm
-freebox, Freebox Configuration
-harmonyhub, Logitech Harmony Hub
-homematic, Homematic
-ipp, IPP
-keba, Keba
-kostalinverter, Kostal inverter
-lutron, Lutron
-max,MAX!
-netatmo, Netatmo
-network, Network
-opensprinkler, OpenSprinkler
-orvibo, Orvibo
-pioneeravr, PioneerAVR Configuration
-pulseaudio, Pulseaudio
-rfxcom, RFXCOM
-rme, RME
-samsungtv, Samsung TV
-smaenergymeter, SMA Energy Meter
-squeezebox, Logitech Squeezebox
-tesla, Tesla
-urtsi, Somfy URTSI II
-vitotronic, vitotronic
-zwave, ZWave
+id,label,description
+digitalstrom,digitalSTROM,"This binding integrates the [digitalSTROM-System](http://www.digitalstrom.de/)."
+fsinternetradio,FS Internet Radio,"This binding integrates internet radios based on the [Frontier Silicon chipset](http://www.frontier-silicon.com/)."
+hue,Philips Hue,"This binding integrates the [Philips Hue Lighting system](http://www.meethue.com)."
+lifx,LIFX,"This binding integrates the [LIFX LED Bulb](http://www.lifx.com/). All LIFX bulbs are directly connected to the WLAN and the binding communicates with them over a UDP protocol."
+ntp,NTP,"The NTP binding is used for displaying the local date and time based update from an NTP server."
+sonos,Sonos,"This binding integrates the [Sonos Multi-Room Audio system](http://www.sonos.com)."
+wemo,Belkin Wemo,"This binding integrates the [Belkin WeMo Family](http://www.belkin.com/us/Products/c/home-automation/)."
+yahooweather,YahooWeather,"This binding uses the [Yahoo Weather service](https://developer.yahoo.com/weather/) for providing current weather information."
+astro,Astro,"The Astro binding is used for calculating many DateTime and positional values for sun and moon."
+autelis,Autelis Pool Control,"Autelis manufactures a network enabled pool interface for many popular pool systems.  See [the Autelis website](http://www.autelis.com) and the  [Autelis Command Protocol](http://www.autelis.com/wiki/index.php?title=Pool_Control_(PI)_HTTP_Command_Reference) for more information."
+avmfritz,AVM FRITZ!,"The binding integrates the AHA ( [AVM Home Automation](http://avm.de/ratgeber/smart-home/) ) system."
+dscalarm,DSC Alarm,"This is an OpenHAB binding for a DSC PowerSeries Alarm System utilizing the EyezOn Envisalink 3/2DS interface or the DSC IT-100 RS-232 interface."
+freebox,Freebox,"This binding integrates the [Freebox Revolution](http://www.free.fr/adsl/freebox-revolution.html) to your openHab installation."
+harmonyhub,Logitech Harmony Hub,"The Harmony Hub binding is used to enable communication between openHAB2 and multiple Logitech Harmony Hub devices. The API exposed by the Harmony Hub is relatively limited, but it does allow for reading the current activity as well as setting the activity and sending device commands."
+homematic,Homematic,"This is the binding for the [eQ-3 Homematic Solution](http://www.eq-3.de/)."
+ipp,IPP,"This binding integrates printers, which implement the Internet Printing protocol (IPP). This is the successor of the CUPS binding."
+keba,Keba,"This binding integrates the [Keba KeContact EV Charging Stations](http://www.keba.com)."
+kostalinverter,Kostal inverter,"![LIFX E27](doc/kostalpico.jpg)"
+lutron,Lutron,"This binding integrates with [Lutron](http://www.lutron.com) light control systems."
+max,MAX!,"This is the binding for the [eQ-3 MAX! Home Solution](http://www.eq-3.de/)."
+netatmo,Netatmo,"The Netatmo binding integrates the following Netatmo products :"
+network,Network,"This binding integrates a way to check whether a device is currently available on the network and the required ping time."
+opensprinkler,OpenSprinkler,"This binding allows allows basic control of the OpenSprinkler and OpenSprinkler PI (Plus) devices. Stations can be controlled to be turned on or off and rain sensor state can be read."
+orvibo,Orvibo,"This binding integrates Orvibo devices that communicate using UDP. Primarily this was designed for S20 Wifi Sockets but other products using the same protocol may be implemented in future."
+pioneeravr,PioneerAVR Configuration,"The binding can auto-discover the Pioneer AVRs present on your local network. The auto-discovery is enabled by default. To disable it, you can create a file in the services directory called pioneeravr.cfg with the following content:"
+pulseaudio,Pulseaudio,"This binding integrates pulseaudio devices."
+rfxcom,RFXCOM,"This binding integrates large number of sensors and actuators from several different manufactures throug the [RFXCOM transceivers](http://www.rfxcom.com)."
+rme,RME,"This binding integrates the RME RainManager rain water pump and management system"
+samsungtv,Samsung TV,"This binding integrates the [Samsung TV's](http://www.samsung.com)."
+smaenergymeter,SMA Energy Meter,"This Binding is used to display the measured values of a SMA Energy Meter device. It shows purchased and grid feed-in power and energy."
+squeezebox,Logitech Squeezebox,"This binding integrates the [Logitech Media Server](http://www.mysqueezebox.com) and compatible Squeeze players."
+systeminfo,Systeminfo,"System information Binding provides operating system and hardware information including:"
+tesla,Tesla,"This binding integrates the [Tesla Electrical Vehicle](http://www.teslamotors.com)."
+urtsi,Somfy URTSI II,"The addressable Universal RTS Interface II (URTSI II) can be used to communicate between home automation or other third party systems and SOMFY’s RTS Motors and controls. It is capable of individual or group control, and can be operated via infrared remote, RS232 and RS485 serial communication. Once an input is activated, an RTS radio command is sent to the automated window treatment."
+vitotronic,vitotronic,"Viessmann heating systems with vitotronic has a optolink Interface for maintenance."
+zwave,ZWave,"The ZWave binding supports an interface to a wireless ZWave home automation network."
diff --git a/features/addons.md b/features/addons.md
@@ -4,124 +4,17 @@ layout: documentation
 
 {% include base.html %}
 
-# List of available Add-ons
+# Available Add-ons
 
-All optional add-ons for openHAB 2 are part of the distribution. This includes all new 2.0 bindings as well as all 1.x add-ons that were reported to be compatible. If you are successfully using a 1.x add-on with the 2.0 runtime, which is not yet on this list, please create a PR for adding it.
+All optional add-ons for openHAB 2 are part of the distribution. This includes all new 2.0 bindings as well as all 1.x add-ons that were reported to be compatible. 
+_Note_: If you are successfully using a 1.x add-on with the 2.0 runtime, which is not yet on this list, please create a PR for adding it!
 
-## 2.0 Bindings
+| Add-on Type | Description |
+|-------------|----------------------|
+|[Bindings](bindings.html)| Bindings integrate physical hardware, external systems and web services in openHAB |
+|[User Interfaces](uis.html)| User interfaces are either native smartphone apps or web applications that access the openHAB server through the REST API |
 
-| Binding | Description |
-|-------|----------------------|
-| [Astro Binding](bindings/astro/readme.html) | Astronomical calculations for sun and moon positions |
-| [Autelis Binding](bindings/autelis/readme.html) | Pool controller |
-| [AVM Fritz!Box Binding](bindings/avmfritz/readme.html) | currently only supports FRITZ AHA devices |
-| [DSCAlarm Binding](bindings/dscalarm/readme.html) | DSC PowerSeries alarm systems |
-| [Freebox Binding](bindings/freebox/readme.html) | the french [Freebox Revolution](http://www.free.fr/adsl/freebox-revolution.html) server |
-| [HDanywhere Binding](bindings/hdanywhere/) | HDMI matrix |
-| [IPP Binding](bindings/ipp/readme.html) | Internet Printing Protocol (replaces 1.x CUPS Binding) |
-| [KEBA Binding](bindings/keba/readme.html) | Electric vehicle charging station |
-| [Kostal Inverter Binding](bindings/kostalinverter/readme.html) | Photovoltaic converter |
-| [FS Internet Radio Binding](bindings/fsinternetradio/readme.html) | Internet radios with chip from Frontier Silicon |
-| [LIFX Binding](bindings/lifx/readme.html) | Wifi-enabled LED bulbs |
-| [Lutron Binding](bindings/lutron/readme.html) | Dimmers And Lighting Controls |
-| [MAX! Binding](bindings/max/readme.html) | Heater control solution by eQ-3 |
-| [Network Binding](bindings/network/) | Scans local network (replaces 1.x networkhealth Binding) |
-| [NTP Binding](bindings/ntp/readme.html) | NTP time servers |
-| [OpenSprinkler Binding](bindings/opensprinkler/readme.html) | Open sprinkler system |
-| [PioneerAVR Binding](bindings/pioneeravr/readme.html) | AV receivers by Pioneer |
-| [Philips Hue Binding](bindings/hue/readme.html) | LED lighting system |
-| [Pulseaudio Binding](bindings/pulseaudio/readme.html) | software-based audio distribution |
-| [Rfxcom Binding](bindings/rfxcom/readme.html) | 433MHz radio transceiver and devices |
-| [SamsungTV Binding](bindings/samsungtv/readme.html) | Samsung Smart TVs |
-| [SMAEnergyMeter Binding](bindings/smaenergymeter/readme.html) | SMA Energy Meter for photovoltaic systems |
-| [Sonos Binding](bindings/sonos/readme.html) | Multi-room audio system |
-| [Squeezebox Binding](bindings/squeezebox/readme.html) | Logitech's connected speakers |
-| [Tesla Binding](bindings/tesla/readme.html) | Teslas Model S Electric Vehicle |
-| [Vitotronic Binding](bindings/vitotronic/readme.html) | Heating systems by Viessmann |
-| [WeMo Binding](bindings/wemo/readme.html) | Switchable sockets by Belkin |
-| [YahooWeather Binding](bindings/yahooweather/readme.html) | Weather information from Yahoo |
-| [Z-Wave Binding](bindings/zwave/readme.html) | Z-Wave radio controlled devices |
-
-## Compatible 1.x Add-ons
-
-| Add-on | Type |
-|--------|------|
-| Anel | Binding |
-| Astro | Binding |
-| Comfo Air | Binding |
-| Denon | Binding |
-| DMX (OLA) | Binding |
-| Ecobee | Action |
-| Ecobee | Binding |
-| EDS OWServer | Binding |
-| Energenie | Binding |
-| Enocean | Binding |
-| Enphaseenergy | Binding |
-| Epsonprojector | Binding |
-| Exec | Binding |
-| Freebox | Binding |
-| Freeswitch | Binding |
-| FS20 | Binding |
-| Heatmiser | Binding |
-| Homematic | Binding |
-| HTTP | Binding |
-| IHC | Binding |
-| Intertechno | Binding |
-| IRtrans | Binding |
-| KNX | Binding |
-| LCN | Binding |
-| Milight | Binding |
-| MiOS | Binding |
-| Modbus | Binding |
-| MQTT | Binding |
-| MyQ | Binding |
-| NeoHub | Binding |
-| Nest | Binding |
-| Netatmo | Binding |
-| Networkhealth | Binding |
-| Nibeheatpump | Binding |
-| NTP | Binding |
-| Onkyo | Binding |
-| OpenEnergyMonitor | Binding |
-| OneWire | Binding |
-| RFXCOM | Binding |
-| RWE SmartHome | Binding |
-| Samsung AC | Binding |
-| Sapp | Binding |
-| Satel | Binding |
-| Serial | Binding |
-| SNMP | Binding |
-| SwegonVentilation | Binding |
-| SystemInfo | Binding |
-| TCP | Binding |
-| Tellstick | Binding |
-| Tinkerforge | Binding |
-| Weather | Binding |
-| WOL | Binding |
-| XBMC | Binding |
-| ZWave | Binding |
-| InfluxDB | Persistence |
-| rrd4j | Persistence |
-| MySQL | Persistence |
-| MongoDB | Persistence |
-| JPA | Persistence |
-| Mail | Action |
-| MiOS | Action |
-| Pushover | Action |
-| Telegram | Action |
-| XBMC | Action |
-| XMPP | Action |
-| GoogleTTS | TTS engine |
-| MaryTTS | TTS engine |
-
-## Currently incompatible 1.x Add-ons:
-
-| Add-on | Type | Reason
-|--------|------|------|
-| CalDAV | Binding | see [issue 4074](https://github.com/openhab/openhab/issues/4074) |
-| InsteonPLM | Binding | see [issue 3922](https://github.com/openhab/openhab/issues/3922) |
-| SagerCaster | Binding | Not following the architecture guidelines, see [issue 3754](https://github.com/openhab/openhab/issues/3754) |
-| Logging | Persistence | openHAB 2 does not use logback anymore |
+...
 
 ## Compatible Applications
 

diff --git a/features/bindings.md b/features/bindings.md
@@ -4,43 +4,15 @@ layout: documentation
 
 {% include base.html %}
 
-# List of available Add-ons
-
-All optional add-ons for openHAB 2 are part of the distribution. This includes all new 2.0 bindings as well as all 1.x add-ons that were reported to be compatible. If you are successfully using a 1.x add-on with the 2.0 runtime, which is not yet on this list, please create a PR for adding it.
+# List of available bindings
 
 ## 2.0 Bindings
+{% assign bindings = site.data.bindings | sort: 'label.toLowerCase()' %}
 
 | Binding | Description |
 |-------|----------------------|
-| [Astro Binding](bindings/astro/readme.html) | Astronomical calculations for sun and moon positions |
-| [Autelis Binding](bindings/autelis/readme.html) | Pool controller |
-| [AVM Fritz!Box Binding](bindings/avmfritz/readme.html) | currently only supports FRITZ AHA devices |
-| [DSCAlarm Binding](bindings/dscalarm/readme.html) | DSC PowerSeries alarm systems |
-| [Freebox Binding](bindings/freebox/readme.html) | the french [Freebox Revolution](http://www.free.fr/adsl/freebox-revolution.html) server |
-| [HDanywhere Binding](bindings/hdanywhere/) | HDMI matrix |
-| [IPP Binding](bindings/ipp/readme.html) | Internet Printing Protocol (replaces 1.x CUPS Binding) |
-| [KEBA Binding](bindings/keba/readme.html) | Electric vehicle charging station |
-| [Kostal Inverter Binding](bindings/kostalinverter/readme.html) | Photovoltaic converter |
-| [FS Internet Radio Binding](bindings/fsinternetradio/readme.html) | Internet radios with chip from Frontier Silicon |
-| [LIFX Binding](bindings/lifx/readme.html) | Wifi-enabled LED bulbs |
-| [Lutron Binding](bindings/lutron/readme.html) | Dimmers And Lighting Controls |
-| [MAX! Binding](bindings/max/readme.html) | Heater control solution by eQ-3 |
-| [Network Binding](bindings/network/) | Scans local network (replaces 1.x networkhealth Binding) |
-| [NTP Binding](bindings/ntp/readme.html) | NTP time servers |
-| [OpenSprinkler Binding](bindings/opensprinkler/readme.html) | Open sprinkler system |
-| [PioneerAVR Binding](bindings/pioneeravr/readme.html) | AV receivers by Pioneer |
-| [Philips Hue Binding](bindings/hue/readme.html) | LED lighting system |
-| [Pulseaudio Binding](bindings/pulseaudio/readme.html) | software-based audio distribution |
-| [Rfxcom Binding](bindings/rfxcom/readme.html) | 433MHz radio transceiver and devices |
-| [SamsungTV Binding](bindings/samsungtv/readme.html) | Samsung Smart TVs |
-| [SMAEnergyMeter Binding](bindings/smaenergymeter/readme.html) | SMA Energy Meter for photovoltaic systems |
-| [Sonos Binding](bindings/sonos/readme.html) | Multi-room audio system |
-| [Squeezebox Binding](bindings/squeezebox/readme.html) | Logitech's connected speakers |
-| [Tesla Binding](bindings/tesla/readme.html) | Teslas Model S Electric Vehicle |
-| [Vitotronic Binding](bindings/vitotronic/readme.html) | Heating systems by Viessmann |
-| [WeMo Binding](bindings/wemo/readme.html) | Switchable sockets by Belkin |
-| [YahooWeather Binding](bindings/yahooweather/readme.html) | Weather information from Yahoo |
-| [Z-Wave Binding](bindings/zwave/readme.html) | Z-Wave radio controlled devices |
+{% for binding in bindings %}| [{{ binding.label }}]({{docu}}/features/bindings/{{ binding.id }}/readme.html) | {{ binding.description }} |
+{% endfor %}					
 
 ## Compatible 1.x Add-ons
 

diff --git a/features/bindings/astro/readme.md b/features/bindings/astro/readme.md
@@ -58,11 +58,14 @@ The things requires the geolocation (latitude, longitude) for which the calculat
 ## Full Example
 
 Things:
+
 ```
 astro:sun:home  [ geolocation="xx.xxxxxx,xx.xxxxxx", interval=60]
 astro:moon:home [ geolocation="xx.xxxxxx,xx.xxxxxx", interval=60]
 ```
+
 Items:
+
 ```
 DateTime Sunrise_Time  "Sunrise [%1$tH:%1$tM]"  { channel="astro:sun:home:rise#start" }
 DateTime Sunset_Time   "Sunset [%1$tH:%1$tM]"   { channel="astro:sun:home:set#start" }

diff --git a/features/bindings/avmfritz/readme.md b/features/bindings/avmfritz/readme.md
@@ -68,7 +68,8 @@ If correct credentials are set in the bridge configuration, connected AHA device
 
 ## Full Example
 
-demo.things:
+demo.Things:
+
 ```
 Bridge avm:fritzbox:192.168.178.1 [ ipAddress="192.168.0.64" ] {
 	FRITZ_DECT_200 DECT1 [ ain="xxxxxxxxxxx" ]

diff --git a/features/bindings/freebox/readme.md b/features/bindings/freebox/readme.md
@@ -4,7 +4,7 @@ layout: documentation
 
 {% include base.html %}
 
-# Freebox Binding Configuration
+# Freebox Binding
 
 This binding integrates the [Freebox Revolution](http://www.free.fr/adsl/freebox-revolution.html) to your openHab installation.
 

diff --git a/features/bindings/keba/readme.md b/features/bindings/keba/readme.md
@@ -39,7 +39,8 @@ All devices support the following channels (non exhaustive):
 
 ## Full Example
 
-demo.things:
+demo.Things:
+
 ```
 Thing keba:kecontactp20:1 [ipAddress="192.168.0.64", refreshInterval=30]
 ```

diff --git a/features/bindings/lutron/readme.md b/features/bindings/lutron/readme.md
@@ -73,7 +73,8 @@ Currently there is only one keypad thing type to cover all keypads. Not all chan
 
 ## Full Example
 
-demo.things:
+demo.Things:
+
 ```
 lutron:dimmer:theater (lutron:ipbridge:radiora2) [ integrationId=8, fadeOutTime=2 ]
 lutron:occupancysensor:theater (lutron:ipbridge:radiora2) [ integrationId=9 ]

diff --git a/features/bindings/network/readme.md b/features/bindings/network/readme.md
@@ -41,7 +41,8 @@ All devices support some of the following channels:
 
 ## Full Example
 
-demo.things:
+demo.Things:
+
 ```
 network:device:1 [ hostname="192.168.0.64", port="0", retry="1", timeout="5000", refresh_interval="60000", use_system_ping="false" ]
 ```

diff --git a/features/bindings/opensprinkler/readme.md b/features/bindings/opensprinkler/readme.md
@@ -102,7 +102,8 @@ The following are only support by the OpenSprinkler using the HTTP API interface
 
 ## Full Example
 
-demo.things:
+demo.Things:
+
 ```
 opensprinkler:http:1 [ hostname="192.168.1.23", port=80, password="opendoor", refresh=60 ]
 ```

diff --git a/features/bindings/pioneeravr/readme.md b/features/bindings/pioneeravr/readme.md
@@ -80,7 +80,8 @@ Here after are the ID values of the input sources:
 
 ##Full example
 
-*demo.things:
+*demo.Things:
+
 ```
 pioneeravr:ipAvr:vsx921 [ address="192.168.188.89" ]
 ```

diff --git a/features/bindings/samsungtv/readme.md b/features/bindings/samsungtv/readme.md
@@ -33,7 +33,7 @@ The Samsung TV Thing requires the host name and port address as a configuration
 
 E.g.
 ```
-Thing samsungtv:tv:livingroom [ hostname="192.168.1.10", port=55000, refreshInterval=1000]
+Thing samsungtv:tv:livingroom [ hostName="192.168.1.10", port=55000, refreshInterval=1000]
 ```
 
 ## Channels
-Original file line number
+Diff line change
@@ Expand Up @@
     E.g.
     ```
-    Thing samsungtv:tv:livingroom [ hostname="192.168.1.10", port=55000, refreshInterval=1000]
+    Thing samsungtv:tv:livingroom [ hostName="192.168.1.10", port=55000, refreshInterval=1000]
     ```
     ## Channels
@@ Expand Down @@