updated generated content

Signed-off-by: Kai Kreuzer <[email protected]>

addons/bindings/astro/readme.md

@@ -22,7 +22,8 @@ No binding configuration required.
 
 ## Thing Configuration
 
-The things requires the geolocation (latitude, longitude) for which the calculation is done. Optionally, a refresh interval (in seconds) can be defined to also calculate positional data like azimuth and elevation.
+A thing requires the geolocation (latitude, longitude) for which the calculation is done.
+Optionally, a refresh interval (in seconds) can be defined to also calculate positional data like azimuth and elevation.
 
 ## Channels
 
@@ -55,23 +56,59 @@ The things requires the geolocation (latitude, longitude) for which the calculat
     * **group** `position`
         * **channel** `azimuth, elevation` (Number)
 
+### Trigger Channels
+* **thing** `sun`
+    * **group** `rise, set, noon, night, morningNight, astroDawn, nauticDawn, civilDawn, astroDusk, nauticDusk, civilDusk, eveningNight, daylight`
+        * **event** `START, END`
+    * **group** `eclipse`
+        * **event**: `TOTAL, PARTIAL, RING`
+* **thing** `moon`
+    * **group** `rise`
+        * **event** `START`
+    * **group** `set`
+        * **event** `END`
+    * **group** `phase`
+        * **event**: `FIRST_QUARTER, THIRD_QUARTER, FULL, NEW`
+    * **group** `eclipse`
+        * **event**: `TOTAL, PARTIAL`
+    * **group** `perigee`
+        * **event**: `PERIGEE`
+    * **group** `apogee`
+        * **event**: `APOGEE`
+
+**Offsets:** For each event group you can optionally configure an offset in minutes.
+The offset must be configured in the channel properties for the corresponding thing.
+The minimum allowed offset is -1440 and the maximum allowed offset is 1440.
+
 ## Full Example
 
 Things:
 
 ```
-astro:sun:home  [ geolocation="xx.xxxxxx,xx.xxxxxx", interval=60]
-astro:moon:home [ geolocation="xx.xxxxxx,xx.xxxxxx", interval=60]
+astro:sun:home  [ geolocation="xx.xxxxxx,xx.xxxxxx", interval=60 ]
+astro:moon:home [ geolocation="xx.xxxxxx,xx.xxxxxx", interval=60 ]
+```
+
+or optionally with an offset
+
+```
+astro:sun:home [ geolocation="xx.xxxxxx,xx.xxxxxx", interval=60 ] {
+    Channels:
+        Type rangeEvent : rise#event [
+            offset=-30
+        ]
+}
+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" }
-Number   Azimuth       "Azimuth"                { channel="astro:sun:home:position#azimuth" }
-Number   Elevation     "Elevation"              { channel="astro:sun:home:position#elevation" }
-String   MoonPhase     "MoonPhase"              { channel="astro:moon:home:phase#name" }
+Number   Azimuth       "Azimuth [%.1f °]"       { channel="astro:sun:home:position#azimuth" }
+Number   Elevation     "Elevation [%.1f °]"     { channel="astro:sun:home:position#elevation" }
+String   MoonPhase     "Moon Phase [%s]"        { channel="astro:moon:home:phase#name" }
 ```
 
 Events:
@@ -84,26 +121,3 @@ then
     ...
 end
 ```
-
-Available events:
-* **thing** `sun`
-    * **group** `rise, set, noon, night, morningNight, astroDawn, nauticDawn, civilDawn, astroDusk, nauticDusk, civilDusk, eveningNight, daylight`
-        * **event** `START, END`
-    * **group** `eclipse`
-        * **event**: `TOTAL, PARTIAL, RING`
-* **thing** `moon`
-    * **group** `rise`
-        * **event** `START`
-    * **group** `set`
-        * **event** `END`
-    * **group** `phase`
-        * **event**: `FIRST_QUARTER, THIRD_QUARTER, FULL, NEW`
-    * **group** `eclipse`
-        * **event**: `TOTAL, PARTIAL`
-    * **group** `perigee`
-        * **event**: `PERIGEE`
-    * **group** `apogee`
-        * **event**: `APOGEE`
-
-**Note**: Offsets for each event group can be configured in the channel properties
-

addons/bindings/avmfritz/readme.md

@@ -15,9 +15,9 @@ The binding integrates the AHA ( [AVM Home Automation](http://avm.de/ratgeber/sm
 
 The well known FRITZ!Boxes are supported as bridge for accessing other AHA devices. It is planned to support some channels directly at the bridge like call monitoring and others - but these things are under current development by now. The Box has to run at least on firmware FRITZ!OS 6.00 and hast to support the "Smart Home" service.
 
-### FRITZ!DECT 200
+### FRITZ!DECT 200 / FRITZ!DECT 210
 
-This [switchable outlet](http://avm.de/produkte/fritzdect/fritzdect-200/) has to be connected to a FRITZ!Box by DECT protocol. It supports switching the outlet, current power and accumulated energy consumption and temperature readings.
+This switchable outlets [FRITZ!DECT 210](https://avm.de/produkte/fritzdect/fritzdect-210/) and [FRITZ!DECT 200](https://avm.de/produkte/fritzdect/fritzdect-200/) have to be connected to a FRITZ!Box by DECT protocol. They support switching the outlet, current power and accumulated energy consumption and temperature readings.
 
 ### FRITZ!DECT Repeater 100
 
@@ -65,10 +65,10 @@ If correct credentials are set in the bridge configuration, connected AHA device
 
 | Channel Type ID | Item Type    | Description  | Available on thing |
 |-------------|--------|-----------------------------|------------------------------------|
-| temperature | Number | Actual measured temperature | FRITZ!DECT 200, FRITZ!DECT Repeater 100 |
-| energy | Number | Accumulated energy consumption | FRITZ!DECT 200, FRITZ!Powerline 546E |
-| power | Number | Current power consumption | FRITZ!DECT 200, FRITZ!Powerline 546E |
-| outlet | Switch | Switchable outlet | FRITZ!DECT 200, FRITZ!Powerline 546E |
+| temperature | Number | Actual measured temperature (in °C) | FRITZ!DECT 210, FRITZ!DECT 200, FRITZ!DECT Repeater 100 |
+| energy | Number | Accumulated energy consumption (in Wh) | FRITZ!DECT 210, FRITZ!DECT 200, FRITZ!Powerline 546E |
+| power | Number | Current power consumption (in W) | FRITZ!DECT 210, FRITZ!DECT 200, FRITZ!Powerline 546E |
+| outlet | Switch | Switchable outlet (ON/OFF) | FRITZ!DECT 210, FRITZ!DECT 200, FRITZ!Powerline 546E |
 
 ## Full Example
 
@@ -84,7 +84,11 @@ Bridge avmfritz:fritzbox:1 [ ipAddress="192.168.xxx.xxx", password ="xxx", user=
 demo.items:
 
 ```
-Number Temp { channel="avmfritz:FRITZ_DECT_200:1:DECT1:temperature" }
+Switch Outlet1 "Switchable outlet" { channel="avmfritz:FRITZ_DECT_200:1:DECT1:outlet" }
+Number Temperature1 "Actual measured temperature [%.1f °C]" { channel="avmfritz:FRITZ_DECT_200:1:DECT1:temperature" }
+Number Energy1 "Accumulated energy consumption [%.3 Wh]" { channel="avmfritz:FRITZ_DECT_200:1:DECT1:energy" }
+Number Power1 "Current power consumption [%.2 W]" { channel="avmfritz:FRITZ_DECT_200:1:DECT1:power" }
+
 Switch Outlet2 { channel="avmfritz:FRITZ_Powerline_546E:1:PL1:outlet" }
 ```
 
@@ -93,8 +97,13 @@ demo.sitemap:
 ```
 sitemap demo label="Main Menu"
 {
-	Frame {
-		Text item=Temp
+	Frame "FRITZ!DECT 200 switchable outlet" {
+		Switch item=Outlet1 icon="PowerOutlet"
+		Text item=Temperature1 icon="temperature"
+		Text item=Energy1 icon="energy"
+		Text item=Power1 icon="energy"
+	}
+	Frame "FRITZ!Powerline 546E switchable outlet" {
 		Switch item=Outlet2
 	}
 }

addons/bindings/harmonyhub/readme.md

@@ -84,4 +84,4 @@ sitemap demo label="Main Menu" {
         }
 }
 ```
-Possible values for the "buttonPress" channel can be determined via the REST API for channel-types, http://YourServer/rest/channel-types. Search the JSON for "harmonyhub:device".
+Possible values for the "buttonPress" channel can be determined via the REST API for channel-types, http://YourServer:8080/rest/channel-types. Search the JSON for "harmonyhub:device".

addons/bindings/ipp/readme.md

@@ -34,4 +34,5 @@ All devices support some of the following channels:
 | jobs | Number       | Total number of print jobs on the printer |
 | waitingJobs | Number       | Number of waiting print jobs on the printer |
 | doneJobs | Number       | Number of completed print jobs on the printer |
+
 ## Full Example

addons/bindings/kodi/readme.md

@@ -53,10 +53,10 @@ The following configuration options are available for the Kodi binding:
 The Kodi thing requires the IP address of the device hosting your Kodi media center instance and the TCP port to access it on (default: `9090`).
 These parameters will be found by the auto-discovery feature.
 
-A manual setup through a `things` file could look like this:
+A manual setup through a `things/kodi.things` file could look like this:
 
 ```
-Kodi:Kodi:myKodi [ipAddress="192.168.1.100", port="9090"]
+kodi:kodi:myKodi [ipAddress="192.168.1.100", port="9090"]
 ```
 
 ## Channels
@@ -68,6 +68,7 @@ The Kodi thing supports the following channels:
 | mute                    | Switch       | Mute/unmute your playback |
 | volume                  | Dimmer       | Read or control the volume of your playback |
 | control                 | Player       | Control the Kodi player, e.g.  play/pause/next/previous/ffward/rewind |
+| stop                    | Switch       | Stops the Kodi player |
 | title                   | String       | Title of the currently played song/movie/tv episode |
 | showtitle               | String       | Title of the currently played tv-show; empty for other types |
 | album                   | String       | Album name of the currently played song |

addons/bindings/rfxcom/readme.md

@@ -97,26 +97,26 @@ This binding currently supports following channels:
 
 | Channel Type ID | Item Type    | Description  |
 |-----------------|------------------------|--------------|
-| batterylevel | Number | Battery level. |
+| batteryLevel | Number | Battery level. |
 | command | Switch | Command channel. |
 | contact | Contact | Contact channel. |
-| dimminglevel | Dimmer | Dimming level channel. |
+| dimmingLevel | Dimmer | Dimming level channel. |
 | humidity | Number | Relative humidity level in percentages. |
-| humiditystatus | String | Current humidity status. |
+| humidityStatus | String | Current humidity status. |
 | instantamp | Number | Instant current in Amperes. |
 | instantpower | Number | Instant power consumption in Watts. |
 | status | String | Status channel. |
 | setpoint | Number | Requested temperature. |
 | mood | Number | Mood channel. |
 | motion | Switch | Motion detection sensor state. |
-| rainrate | Number | Rain fall rate in millimeters per hour. |
-| raintotal | Number | Total rain in millimeters. |
-| rawmessage | String | Hexadecimal string of the raw RF message. |
-| rawpayload | String | Hexadecimal string of the message payload, without header. |
+| rainRate | Number | Rain fall rate in millimeters per hour. |
+| rainTotal | Number | Total rain in millimeters. |
+| rawMessage | String | Hexadecimal string of the raw RF message. |
+| rawPayload | String | Hexadecimal string of the message payload, without header. |
 | shutter | Rollershutter | Shutter channel. |
-| signallevel | Number | Received signal strength level. |
+| signalLevel | Number | Received signal strength level. |
 | temperature | Number | Current temperature in degree Celsius. |
-| totalusage | Number | Used energy in Watt hours. |
-| totalamphour | Number | Used "energy" in ampere-hours. |
-| winddirection | Number | Wind direction in degrees. |
-| windspeed | Number | Average wind speed in meters per second. |
+| totalUsage | Number | Used energy in Watt hours. |
+| totalAmpHour | Number | Used "energy" in ampere-hours. |
+| windDirection | Number | Wind direction in degrees. |
+| windSpeed | Number | Average wind speed in meters per second. |

addons/uis/basic/readme.md

@@ -8,13 +8,13 @@ layout: documentation
 
 The Basic UI is a web interface based on Material Design Lite from Google.
 
-Features:
+### Features
 
 * Responsive layout suitable for various screen sizes
 * AJAX navigation
 * Live update
 
-Configuration:
+### Configuration
 
 ```
 org.eclipse.smarthome.basicui:defaultSitemap=demo
@@ -25,7 +25,18 @@ org.eclipse.smarthome.basicui:enableIcons=true
 org.eclipse.smarthome.basicui:iconType=svg
 ```
 
-Screenshots:
+### Accessing Sitemaps
+
+The Basic UI has a default layout showing all things and their corresponding items. You may create your own sitemaps and access them through the basic UI in 2 ways.
+
+1. Set the default sitemap via the Paper UI via Configuration -> Services -> Basic UI -> Configure, and set the Default Sitemap name.
+
+2. Passing the "sitemap" parameter to the URL used to access the server.
+
+Example: http://hostname:8080/basicui/app?sitemap=sitemapname
+
+
+### Screenshots:
 
 [![Screenshot 1](doc/screenshot-1.png)](doc/screenshot-1-full.png)
 [![Screenshot 2](doc/screenshot-2.png)](doc/screenshot-2-full.png)

addons/uis/classic/readme.md

@@ -29,5 +29,17 @@ org.eclipse.smarthome.classicui:iconType=png
 org.eclipse.smarthome.classicui:disableHtmlCache=false
 ```
 
+### Accessing Sitemaps
+
+The Classic UI has a default layout showing all things and their corresponding items. You may create your own sitemaps and access them through the basic UI in 2 ways.
+
+1. Set the default sitemap via the Paper UI via Configuration -> Services -> Classic UI -> Configure, and set the Default Sitemap name.
+
+2. Passing the "sitemap" parameter to the URL used to access the server.
+
+      Example: http://hostname:8080/classicui/app?sitemap=sitemapname
+
+### Screenshots:
+
 ![Screenshot](doc/screenshot.png)
 

addons/uis/habpanel/readme.md

@@ -9,35 +9,46 @@ HABPanel
 
 HABPanel is a lightweight dashboard interface for openHAB.
 
-It notably features a quasi-WYSIWYG in-app editor allowing the user to design the dashboard directly on the target device.
+It notably features an embedded dashboard designer allowing to build interfaces easily right on the target device.
 
 ## Configuration
 
-HABPanel stores its configuration (including sets of dashboards, called panel configurations) as openHAB 2 service configuration variables.
-This allows sharing of panel configurations between devices. You can also lock down editing globally to prevent accidental changes.
+Unlike Basic UI and other interfaces, HABPanel doesn't use pre-configured sitemaps.
 
-You can access the configuration in Paper UI, _Configuration > Services > HABPanel_.
+It can however store all its configuration (called panel configurations, including sets of dashboards, custom widgets definitions, and other settings)
+on the server as openHAB 2 service configuration variables.
 
-Note: by default, HABPanel uses the local browser's storage until you save it in a new panel configuration as detailed below. 
+You can access this server-side configuration in Paper UI, _Configuration > Services > UI > HABPanel_.
+From there, you can also lock down the embedded editing features globally to prevent accidental changes by end users.
+You can also specify the name of a known panel configuration to load immediately when starting to configure a brand new HABPanel instance;
+otherwise, the local browser's storage will be used only until you save a new panel configuration as detailed below.
 
 ## Getting started
 
-- When accessing HABPanel for the first time on a new browser or device, you should be presented with a rather empty screen with a clock, a settings icon (gears) to the left. Click on the icon.
-- You're now in edit mode, a link (**"Add new dashboard"**) appeared, as well as an "Advanced settings" link.
-- If you previously used HABPanel, are using openHAB 2 and stored some panel configurations on the server, go to "Advanced settings" and click on your previous configuration. Otherwise, create your first dashboard: click on the "Add new dashboard" link and give it a name.
-- Click on the dashboard tile to enter the dashboard editor
-- Add your first widget: click on "Add Widget" and select the type in the menu (let's say Dummy)
+- When accessing HABPanel for the first time on a new browser or device, you should be presented with a rather empty screen - follow the tutorial and begin by clicking (or tapping) on the top-right corner icon.
+- You're now in edit mode, a link (_"Add new dashboard"_) appeared, as well as an _"Advanced settings"_ link.
+- If you previously used HABPanel and stored some panel configurations on the server, go to _"Advanced settings"_ and click on your previous configuration - it will be instantly brought back. Or, create your first dashboard: click/tap on the _"Add new dashboard"_ link and give it a name.
+- Click/tap on the dashboard tile to enter the dashboard editor
+- Add your first widget: select the _"Add Widget"_ menu and choose a widget type (let's say Dummy - a simple widget displaying an item's state)
 - Move the widget by drag-and-drop and resize it with the white chevron - it appears when you click on the widget
-- Click on the gears icon to bring up the widget's settings
-- Rename the widget, bind it to a supported openHAB item, adjust some settings and click OK
-- Save your configuration by clicking the Save button
-- Click Run to see your dashboard in action - use your browser's back button or the arrow to go back to the drawing board
-- When you're happy with your set of dashboards, go back to "Advanced settings" and either "Show the local configuration object" (the only available if using openHAB 1) and copy the JSON object somewhere to back it up, or click on "Save the current configuration to a new panel configuration"; this will store it on the openHAB 2 server and make it available for reuse.
+- Hit on the three dots in the widget top-right corner to bring up its context menu and choose _"Edit..."_
+- Adjust some settings (name, openHAB item etc.) and confirm your changes
+- Save your configuration by clicking/tapping the _Save_ button
+- Click/tap _Run_ to see your dashboard in action - use your browser's back button or the arrow to go back to the drawing board
+- Once you're happy with your set of dashboards, go back to _"Advanced settings"_ then click/tap on _"Save the current configuration to a new panel configuration"_; this will store it on the openHAB 2 server as described above, and make it available for reuse.
 
 ## Screenshots
 
-_(excuse the French, will make new ones in English later)_
+![](doc/screenshot0.png)
 
-![](doc/Screenshot_2016-08-22-23-36-25.png) ![](doc/Screenshot_2016-08-22-23-50-24.png)
-![](doc/Screenshot_2016-08-22-23-37-07.png) ![](doc/Screenshot_2016-08-22-23-38-05.png)
-![](doc/Screenshot_2016-08-22-23-41-34.png) ![](doc/Screenshot_2016-08-22-23-41-48.png)
+![](doc/screenshot1.png)
+
+![](doc/screenshot2.png)
+
+![](doc/screenshot3.png)
+
+![](doc/screenshot4.png)
+
+![](doc/screenshot5.png)
+
+![](doc/screenshot6.png)