From c0efe6050bc628a19991e13b12ebf5ecdcf70802 Mon Sep 17 00:00:00 2001 From: Kai Kreuzer Date: Fri, 17 Mar 2017 19:56:07 +0100 Subject: [PATCH] updated generated content Signed-off-by: Kai Kreuzer --- _bindings/astro/readme.md | 12 +++ _bindings/avmfritz/readme.md | 10 +- _bindings/digitalstrom/readme.md | 6 -- _bindings/fsinternetradio/readme.md | 12 +-- _bindings/gardena/readme.md | 24 +++++ _bindings/hue/readme.md | 6 -- _bindings/kodi/readme.md | 29 +++--- _bindings/lifx/readme.md | 44 +++++--- _bindings/netatmo/readme.md | 5 +- _bindings/ntp/readme.md | 6 -- _bindings/onkyo/readme.md | 90 +++++++++++++++++ _bindings/sonos/readme.md | 6 -- _bindings/wemo/readme.md | 6 -- _bindings/wr32231/readme.md | 149 ++++++++++++++++++++++++++++ _bindings/yahooweather/readme.md | 6 -- _iconsets/classic/readme.md | 6 -- _io/homekit/readme.md | 2 +- _transformations/jsonpath/readme.md | 9 +- _transformations/map/readme.md | 2 +- _transformations/regex/readme.md | 4 +- _transformations/xslt/readme.md | 4 +- _uis/basic/readme.md | 6 -- _uis/classic/readme.md | 6 -- _uis/paper/readme.md | 4 - _voice/mactts/readme.md | 6 -- 25 files changed, 337 insertions(+), 123 deletions(-) create mode 100644 _bindings/wr32231/readme.md diff --git a/_bindings/astro/readme.md b/_bindings/astro/readme.md index b15ba17f5..52eabf0f8 100644 --- a/_bindings/astro/readme.md +++ b/_bindings/astro/readme.md @@ -167,6 +167,18 @@ astro:sun:home [ geolocation="xx.xxxxxx,xx.xxxxxx", altitude=100, interval=60 ] } ``` +or a offset and latest + +``` +astro:sun:home [ geolocation="xx.xxxxxx,xx.xxxxxx", altitude=100, interval=60 ] { + Channels: + Type rangeEvent : rise#event [ + offset=-10, + latest="08:00" + ] +} +``` + Items: ``` diff --git a/_bindings/avmfritz/readme.md b/_bindings/avmfritz/readme.md index 08dac33fb..5b632abcb 100644 --- a/_bindings/avmfritz/readme.md +++ b/_bindings/avmfritz/readme.md @@ -95,8 +95,8 @@ demo.items: ``` 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" } +Number Energy1 "Accumulated energy consumption [%.3f Wh]" { channel="avmfritz:FRITZ_DECT_200:1:DECT1:energy" } +Number Power1 "Current power consumption [%.2f W]" { channel="avmfritz:FRITZ_DECT_200:1:DECT1:power" } Switch Outlet2 { channel="avmfritz:FRITZ_Powerline_546E:1:PL1:outlet" } ``` @@ -106,13 +106,13 @@ demo.sitemap: ``` sitemap demo label="Main Menu" { - Frame "FRITZ!DECT 200 switchable outlet" { - Switch item=Outlet1 icon="PowerOutlet" + Frame label="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" { + Frame label="FRITZ!Powerline 546E switchable outlet" { Switch item=Outlet2 } } diff --git a/_bindings/digitalstrom/readme.md b/_bindings/digitalstrom/readme.md index e65ea1c4d..360ad434b 100644 --- a/_bindings/digitalstrom/readme.md +++ b/_bindings/digitalstrom/readme.md @@ -13,12 +13,6 @@ install: auto {% include base.html %} ---- -layout: documentation ---- - -{% include base.html %} - # digitalSTROM Binding This binding integrates the [digitalSTROM-System](http://www.digitalstrom.de/). diff --git a/_bindings/fsinternetradio/readme.md b/_bindings/fsinternetradio/readme.md index 2abf586df..0fd8e9c46 100644 --- a/_bindings/fsinternetradio/readme.md +++ b/_bindings/fsinternetradio/readme.md @@ -13,12 +13,6 @@ install: auto {% include base.html %} ---- -layout: documentation ---- - -{% include base.html %} - # FS Internet Radio Binding This binding integrates internet radios based on the [Frontier Silicon chipset](http://www.frontier-silicon.com/). @@ -77,13 +71,13 @@ The radio mode depends on the internet radio model (and probably its firmware ve ## Full Example -demo.things: +demo.things: ``` fsinternetradio:radio:radioInKitchen [ ip="192.168.0.42" ] ``` -demo.items: +demo.items: ``` Switch RadioPower "Radio Power" { channel="fsinternetradio:radio:radioInKitchen:power" } @@ -95,7 +89,7 @@ String RadioInfo1 "Radio Info1" { channel="fsinternetradio:radio:radioInKitchen: String RadioInfo2 "Radio Info2" { channel="fsinternetradio:radio:radioInKitchen:play-info-text" } ``` -demo.sitemap: +demo.sitemap: ``` sitemap demo label="Main Menu" diff --git a/_bindings/gardena/readme.md b/_bindings/gardena/readme.md index 1f7e331da..3d772b149 100644 --- a/_bindings/gardena/readme.md +++ b/_bindings/gardena/readme.md @@ -88,6 +88,30 @@ In the items file, you can link items to channels of your Things: Number Battery_Level "Battery [%d %%]" {channel="gardena:mower:home:myMower:battery#level"} ``` +## Sensor refresh + +You can send a REFRESH command to items linked to these Sensor channels: + +* ambient_temperature#temperature +* soil_temperature#temperature +* humidity#humidity +* light#light + +In the console: + +``` +smarthome:send ITEM_NAME REFRESH +``` + +In scripts: + +``` +import org.eclipse.smarthome.core.types.RefreshType +... +sendCommand(ITEM_NAME, RefreshType.REFRESH) +``` + + ### Debugging and Tracing If you want to see what's going on in the binding, switch the loglevel to TRACE in the Karaf console diff --git a/_bindings/hue/readme.md b/_bindings/hue/readme.md index b1e72feb1..e58682b34 100644 --- a/_bindings/hue/readme.md +++ b/_bindings/hue/readme.md @@ -13,12 +13,6 @@ install: auto {% include base.html %} ---- -layout: documentation ---- - -{% include base.html %} - # Philips Hue Binding This binding integrates the [Philips Hue Lighting system](http://www.meethue.com). diff --git a/_bindings/kodi/readme.md b/_bindings/kodi/readme.md index 2e424dcf3..41544ce72 100644 --- a/_bindings/kodi/readme.md +++ b/_bindings/kodi/readme.md @@ -16,7 +16,7 @@ install: auto # Kodi Binding [Kodi](https://kodi.tv) (formerly known as XBMC) is an free and open source (GPL) software media center for playing videos, music, pictures, games, and more. -Kodi runs on Linux, OS X, Windows, iOS, and Android. +Kodi runs on Linux, OS X, BSD, Windows, iOS, and Android. It allows users to play and view most videos, music, podcasts, and other digital media files from local and network storage media and the internet. The Kodi Binding integrated Kodi media center support with openHAB, allowing both controlling the player as well as retrieving player status data like the currently played movie title. @@ -94,20 +94,20 @@ The Kodi thing supports the following channels: demo.items ``` -Switch myKodi_mute "Stumm" { channel="kodi:kodi:myKodi:mute" } -Dimmer myKodi_volume "Lautstärke [%d]" { channel="kodi:kodi:myKodi:volume" } -Player myKodi_control "Kontrolle [%s]" { channel="kodi:kodi:myKodi:control" } +Switch myKodi_mute "Mute" { channel="kodi:kodi:myKodi:mute" } +Dimmer myKodi_volume "Volume [%d]" { channel="kodi:kodi:myKodi:volume" } +Player myKodi_control "Control" { channel="kodi:kodi:myKodi:control" } Switch myKodi_stop "Stop" { channel="kodi:kodi:myKodi:stop" } -String myKodi_title "Titel [%s]" { channel="kodi:kodi:myKodi:title" } -String myKodi_showtitle "Showtitel [%s]" { channel="kodi:kodi:myKodi:showtitle" } +String myKodi_title "Title [%s]" { channel="kodi:kodi:myKodi:title" } +String myKodi_showtitle "Show title [%s]" { channel="kodi:kodi:myKodi:showtitle" } String myKodi_album "Album [%s]" { channel="kodi:kodi:myKodi:album" } String myKodi_artist "Artist [%s]" { channel="kodi:kodi:myKodi:artist" } String myKodi_playuri "PlayerURI [%s]" { channel="kodi:kodi:myKodi:playuri" } -String myKodi_notification "Benachrichtigung [%s]" { channel="kodi:kodi:myKodi:shownotification" } -String myKodi_input "Input [%s]" { channel="kodi:kodi:myKodi:input" } -String myKodi_inputtext "Inputtext [%s]" { channel="kodi:kodi:myKodi:inputtext" } -String myKodi_systemcommand "Systemcommand [%s]" { channel="kodi:kodi:myKodi:systemcommand" } -String myKodi_mediatype "Mediatyp [%s]" { channel="kodi:kodi:myKodi:mediatype" } +String myKodi_notification "Notification [%s]" { channel="kodi:kodi:myKodi:shownotification" } +String myKodi_input "Input" { channel="kodi:kodi:myKodi:input" } +String myKodi_inputtext "Inputtext" { channel="kodi:kodi:myKodi:inputtext" } +String myKodi_systemcommand "Systemcommand" { channel="kodi:kodi:myKodi:systemcommand" } +String myKodi_mediatype "Mediatype [%s]" { channel="kodi:kodi:myKodi:mediatype" } ``` ## Sitemap Configuration @@ -120,16 +120,15 @@ sitemap demo label="myKodi" Frame label="myKodi" { Switch item=myKodi_mute Slider item=myKodi_volume - Selection item=myKodi_control mappings=[PLAY='Play', PAUSE='Pause', NEXT='Next', PREVIOUSE'Previous', FFWARD='Fastforward', REWIND='Rewind'] + Selection item=myKodi_control mappings=[PLAY='Play', PAUSE='Pause', NEXT='Next', PREVIOUS='Previous', FASTFORWARD='Fastforward', REWIND='Rewind'] + Default item=myKodi_control Switch item=myKodi_stop Text item=myKodi_title Text item=myKodi_showtitle Text item=myKodi_album Text item=myKodi_artist Text item=myKodi_playuri - Text item=myKodi_notification - Text item=myKodi_input - Text item=myKodi_inputtext + Selection item=myKodi_input mappings=[Up='Up', Down='Down', Left='Left', Right='Right', Select='Select', Back='Back', Home='Home', ContextMenu='ContextMenu', Info='Info', ShowCodec='ShowCodec', ShowOSD='ShowOSD'] Selection item=myKodi_systemcommand mappings=[Shutdown='Herunterfahren', Suspend='Bereitschaft', Reboot='Neustart'] Text item=myKodi_mediatype } diff --git a/_bindings/lifx/readme.md b/_bindings/lifx/readme.md index 116905705..de034bd23 100644 --- a/_bindings/lifx/readme.md +++ b/_bindings/lifx/readme.md @@ -13,12 +13,6 @@ install: auto {% include base.html %} ---- -layout: documentation ---- - -{% include base.html %} - # LIFX Binding This binding integrates the [LIFX LED Lights](http://www.lifx.com/). All LIFX lights are directly connected to the WLAN and the binding communicates with them over a UDP protocol. @@ -38,7 +32,7 @@ The following table lists the thing types of the supported LIFX devices: | LIFX A19 | colorlight | | LIFX BR30 | colorlight | | LIFX Z | colorlight | -| | +| | | | LIFX+ A19 | colorirlight | | LIFX+ BR30 | colorirlight | | | | @@ -94,6 +88,10 @@ The **porch** light is a LIFX+ BR30 that has a *colorirlight* thing type which s Finally, **kitchen** is a White 800 (Low Voltage) light that has a *whitelight* thing type which supports *brightness* and *temperature* channels. +Either create a single *Color* item linked to the *color* channel and define *Switch*, *Slider* and *Colorpicker* entries with this item in the sitemap. +Or create items for each type (*Color*, *Switch*, *Dimmer*) and define the correspondent entries in the sitemap. + + ### demo.things: ``` @@ -102,6 +100,11 @@ Thing lifx:colorlight:living [ deviceId="D073D5A1A1A1" ] { Type color : color [ powerOnBrightness= ] } +Thing lifx:colorlight:living2 [ deviceId="D073D5A2A2A2" ] { + Channels: + Type color : color [ powerOnBrightness= ] +} + Thing lifx:colorirlight:porch [ deviceId="D073D5B2B2B2", fadetime=0 ] { Channels: Type color : color [ powerOnBrightness=75 ] @@ -115,17 +118,19 @@ Thing lifx:whitelight:kitchen [ deviceId="D073D5C3C3C3", fadetime=150 ] ``` // Living -Switch Living_Toggle { channel="lifx:colorlight:living:color" } -Dimmer Living_Dimmer { channel="lifx:colorlight:living:color" } Color Living_Color { channel="lifx:colorlight:living:color" } Dimmer Living_Temperature { channel="lifx:colorlight:living:temperature" } +// Living2 (alternative approach) +Color Living2_Color { channel="lifx:colorlight:living2:color" } +Switch Living2_Switch { channel="lifx:colorlight:living2:color" } +Dimmer Living2_Dimmer { channel="lifx:colorlight:living2:color" } +Dimmer Living2_Temperature { channel="lifx:colorlight:living2:temperature" } + // Porch -Switch Porch_Toggle { channel="lifx:colorirlight:porch:color" } -Dimmer Porch_Dimmer { channel="lifx:colorirlight:porch:color" } Color Porch_Color { channel="lifx:colorirlight:porch:color" } -Dimmer Porch_Temperature { channel="lifx:colorirlight:porch:temperature" } Dimmer Porch_Infrared { channel="lifx:colorirlight:porch:infrared" } +Dimmer Porch_Temperature { channel="lifx:colorirlight:porch:temperature" } // Kitchen Switch Kitchen_Toggle { channel="lifx:whitelight:kichen:brightness" } @@ -140,15 +145,22 @@ Dimmer Kitchen_Temperature { channel="lifx:whitelight:kitchen:temperature" } sitemap demo label="Main Menu" { Frame label="Living" { - Switch item=Living_Toggle - Slider item=Living_Dimmer + Switch item=Living_Color + Slider item=Living_Color Colorpicker item=Living_Color Slider item=Living_Temperature } + Frame label="Living2" { + Switch item=Living2_Toggle + Slider item=Living2_Dimmer + Colorpicker item=Living2_Color + Slider item=Living2_Temperature + } + Frame label="Porch" { - Switch item=Porch_Toggle - Slider item=Porch_Dimmer + Switch item=Porch_Color + Slider item=Porch_Color Colorpicker item=Porch_Color Slider item=Porch_Temperature Slider item=Porch_Infrared diff --git a/_bindings/netatmo/readme.md b/_bindings/netatmo/readme.md index e0360f40c..ce53c3b5b 100644 --- a/_bindings/netatmo/readme.md +++ b/_bindings/netatmo/readme.md @@ -99,14 +99,13 @@ Number Netatmo_Indoor_CO2 "CO2" { channel = "netatmo:NAMain:home * PressureTrend * AbsolutePressure * Noise -* WifiStatus -* Location -* TimeStamp * HeatIndex * Humidex * Dewpoint * DewpointDepression * WifiStatus +* Location +* TimeStamp * LastStatusStore ### Weather Station Outdoor module diff --git a/_bindings/ntp/readme.md b/_bindings/ntp/readme.md index 6b27dad07..bf5e4d1f2 100644 --- a/_bindings/ntp/readme.md +++ b/_bindings/ntp/readme.md @@ -12,12 +12,6 @@ install: auto {% include base.html %} ---- -layout: documentation ---- - -{% include base.html %} - # NTP Binding The NTP binding is used for displaying the local date and time based update from an NTP server. diff --git a/_bindings/onkyo/readme.md b/_bindings/onkyo/readme.md index 16f7039e4..aa7de548b 100644 --- a/_bindings/onkyo/readme.md +++ b/_bindings/onkyo/readme.md @@ -168,6 +168,96 @@ Here after are the ID values of the input sources: * 48: MULTICH * 50: SIRIUS +## Item Configuration + +demo.items + +``` +Switch avr1Z1_Power "Power" { channel="onkyo:onkyoAVR:avr1:zone1#power" } +Switch avr1Z1_Mute "Mute" { channel="onkyo:onkyoAVR:avr1:zone1#mute" } +Number avr1Z1_Input "Input [%s]" { channel="onkyo:onkyoAVR:avr1:zone1#input" } +Dimmer avr1Z1_Volume "Volume [%d]" { channel="onkyo:onkyoAVR:avr1:zone1#volume" } + +Switch avr1Z2_Power "Power [%s]" { channel="onkyo:onkyoAVR:avr1:zone2#power" } +Switch avr1Z2_Mute "Mute [%s]" { channel="onkyo:onkyoAVR:avr1:zone2#mute" } +Number avr1Z2_Input "Input [%s]" { channel="onkyo:onkyoAVR:avr1:zone2#input" } +Dimmer avr1Z2_Volume "Volume [%s]" { channel="onkyo:onkyoAVR:avr1:zone2#volume" } + +Player avr1Player_Control "Control" { channel="onkyo:onkyoAVR:avr1:player#control" } +String avr1Player_Title "Title [%s]" { channel="onkyo:onkyoAVR:avr1:player#title" } +String avr1Player_Album "Album [%s]" { channel="onkyo:onkyoAVR:avr1:player#album" } +String avr1Player_Artist "Artist [%s]" { channel="onkyo:onkyoAVR:avr1:player#artist" } +String avr1Player_CurrentPlayingTime "CurrentPlayingTime [%s]" { channel="onkyo:onkyoAVR:avr1:player#currentPlayingTime" } +Number avr1Player_Listenmode "Listenmode [%d]" { channel="onkyo:onkyoAVR:avr1:player#listenmode" } +String avr1Player_PlayURI "PlayURI [%s]" { channel="onkyo:onkyoAVR:avr1:player#playuri" } +Image avr1Player_AlbumArt "AlbumArt [%s]" { channel="onkyo:onkyoAVR:avr1:player#albumArt" } +String avr1Player_AlbumArtUrl "AlbumArtUrl [%s]" { channel="onkyo:onkyoAVR:avr1:player#albumArtUrl" } + +String avr1Net_Title "Title [%s]" { channel="onkyo:onkyoAVR:avr1:netmenu#title" } +String avr1Net_Control "Control" { channel="onkyo:onkyoAVR:avr1:netmenu#control" } +Number avr1Net_Selection "Selection [%d]" { channel="onkyo:onkyoAVR:avr1:netmenu#selection" } +String avr1Net_Item0 "Item0 [%s]" { channel="onkyo:onkyoAVR:avr1:netmenu#item0" } +String avr1Net_Item1 "Item1 [%s]" { channel="onkyo:onkyoAVR:avr1:netmenu#item1" } +String avr1Net_Item2 "Item2 [%s]" { channel="onkyo:onkyoAVR:avr1:netmenu#item2" } +String avr1Net_Item3 "Item3 [%s]" { channel="onkyo:onkyoAVR:avr1:netmenu#item3" } +String avr1Net_Item4 "Item4 [%s]" { channel="onkyo:onkyoAVR:avr1:netmenu#item4" } +String avr1Net_Item5 "Item5 [%s]" { channel="onkyo:onkyoAVR:avr1:netmenu#item5" } +String avr1Net_Item6 "Item6 [%s]" { channel="onkyo:onkyoAVR:avr1:netmenu#item6" } +String avr1Net_Item7 "Item7 [%s]" { channel="onkyo:onkyoAVR:avr1:netmenu#item7" } +String avr1Net_Item8 "Item8 [%s]" { channel="onkyo:onkyoAVR:avr1:netmenu#item8" } +String avr1Net_Item9 "Item9 [%s]" { channel="onkyo:onkyoAVR:avr1:netmenu#item9" } +``` + +## Sitemap Configuration + +demo.sitemap + +``` +sitemap demo label="Onkyo AVR" +{ + Frame label="Zone1" { + Switch item=avr1Z1_Power + Switch item=avr1Z1_Mute + Selection item=avr1Z1_Input mappings=[ 0='DVR/VCR', 1='SATELLITE/CABLE', 2='GAME', 3='AUX', 4='GAME', 5='PC', 16='BLURAY/DVD', 32='TAPE1', 33='TAPE2', 34='PHONO', 35='CD', 36='FM', 37='AM', 38='TUNER', 39='MUSICSERVER', 40='INTE +RNETRADIO', 41='USB', 42='USB_BACK', 43='NETWORK', 45='AIRPLAY', 48='MULTICH', 50='SIRIUS' ] + Slider item=avr1Z1_Volume + } + + Frame label="Zone 2" { + Switch item=avr1Z2_Power + Switch item=avr1Z2_Mute + Selection item=avr1Z2_Input mappings=[ 0='DVR/VCR', 1='SATELLITE/CABLE', 2='GAME', 3='AUX', 4='GAME', 5='PC', 16='BLURAY/DVD', 32='TAPE1', 33='TAPE2', 34='PHONO', 35='CD', 36='FM', 37='AM', 38='TUNER', 39='MUSICSERVER', 40='INTE +RNETRADIO', 41='USB', 42='USB_BACK', 43='NETWORK', 45='AIRPLAY', 48='MULTICH', 50='SIRIUS' ] + Slider item=avr1Z2_Volume + } + + Frame label="Player" { + Default item=avr1Player_Control + Text item=avr1Player_Title + Text item=avr1Player_Album + Text item=avr1Player_Artist + Text item=avr1Player_CurrentPlayingTime + Selection item=avr1Player_Listenmode mappings=[0=Stereo, 1=Direct, 2=Surround, 15=Mono, 31="Whole House", 66="THX Cinema"] + } + Frame label="NetMenu" { + Text item=avr1Net_Title + Selection item=avr1Net_Control mappings=[ Up='Up', Down='Down', Select='Select', Back='Back', PageUp='PageUp', PageDown='PageDow', Select0='Select0', Select1='Select1', Select2='Select2', Select3='Select3', Select4='Select4', S +elect5='Select5', Select6='Select6', Select7='Select7', Select8='Select8', Select9='Select9' ] + Selection item=avr1Net_Selection mappings=[ 0='Item0', 1='Item1', 2='Item2', 3='Item3', 4='Item4', 5='Item5', 6='Item6', 7='Item7', 8='Item8', 9='Item9' ] + Text item=avr1Net_Item0 + Text item=avr1Net_Item1 + Text item=avr1Net_Item2 + Text item=avr1Net_Item3 + Text item=avr1Net_Item4 + Text item=avr1Net_Item5 + Text item=avr1Net_Item6 + Text item=avr1Net_Item7 + Text item=avr1Net_Item8 + Text item=avr1Net_Item9 + } +} +``` + ## Audio Support + All supported Onkyo AVRs are registered as an audio sink in the framework. diff --git a/_bindings/sonos/readme.md b/_bindings/sonos/readme.md index fdf82eb7a..6e0c003e7 100644 --- a/_bindings/sonos/readme.md +++ b/_bindings/sonos/readme.md @@ -13,12 +13,6 @@ install: auto {% include base.html %} ---- -layout: documentation ---- - -{% include base.html %} - # Sonos Binding This binding integrates the [Sonos Multi-Room Audio system](http://www.sonos.com). diff --git a/_bindings/wemo/readme.md b/_bindings/wemo/readme.md index 4a4691141..e37cad4d1 100644 --- a/_bindings/wemo/readme.md +++ b/_bindings/wemo/readme.md @@ -13,12 +13,6 @@ install: auto {% include base.html %} ---- -layout: documentation ---- - -{% include base.html %} - # Belkin Wemo Binding This binding integrates the [Belkin WeMo Family](http://www.belkin.com/us/Products/c/home-automation/). diff --git a/_bindings/wr32231/readme.md b/_bindings/wr32231/readme.md new file mode 100644 index 000000000..48ca5aaba --- /dev/null +++ b/_bindings/wr32231/readme.md @@ -0,0 +1,149 @@ +--- +id: wr3223 +label: WR3223 ventilation controller +title: WR3223 ventilation controller - Bindings +type: binding +description: "The WR3223 ventilation controller is used for room ventilation systems, for example in houses produced by company “Schwörer Haus”. The manufacturer of the controller is [Hermes Electronic](http://www.hermes-electronic.de/)." +source: https://github.com/openhab/openhab1-addons/blob/master/bundles/binding/org.openhab.binding.wr3223/README.md +since: 1x +install: manual +--- + + + +{% include base.html %} + +# WR3223 ventilation controller Binding + +The WR3223 ventilation controller is used for room ventilation systems, for example in houses produced by company “Schwörer Haus”. The manufacturer of the controller is [Hermes Electronic](http://www.hermes-electronic.de/). + +The WR3223 binding can read several measurements and the current state of the ventilation system. It can also adjust the fan speed, operation mode and the target temperature. + +## Prerequisites + +The WR3223 can be connected by an RS232 or USB adapter. The adapter can be orderd from Hermes Electronic. If you want to connect the WR3223 by yourself, have a look at: [https://community.openhab.org/t/wr3223-ventilation-controller-schworer-haus/](https://community.openhab.org/t/wr3223-ventilation-controller-schworer-haus/) + +To control the WR3223, you have to disconnect the control panel, otherwise the WR3223 will ignore the command from the serial port. + +## Binding Configuration + +This binding can be configured in the file `services/wr3223.cfg`. + +The connection must be configured via either the serialPort setting or via the host and port settings. + +| Property | Default | Required | Description | +|----------------|---------|:--------:|-------------| +| serialPort | | Yes (if serial port is used) | Serial port where the WR3223 is connected. E.g. /dev/ttyUSB0 | +| host | | Yes (if TCP is used) | IP address of the TCP to serial gateway | +| port | | Yes (if TCP is used) | port number of the TCP to serial gateway | +| refresh | 15000 | No | Refresh interval in milliseconds. The WR3223 needs a refresh at least every 20 seconds! | +| controllerAddr | 1 | No | The controller address is normally 1. + +## Item Configuration + +The syntax of the binding configuration strings accepted is the following: + +``` +wr3223="" +``` + +where `` is replaced with the WR3223 command from the list below: + +| `` | Item Type | Read / Write | Notes | +|---------------------------------------------|-----------|--------------|----------------------------------------------------------| +| temperature_evaporator | Number | Read | de: Verdampfertemperatur (T1) | +| temperature_condenser | Number | Read | de: Kondensatortemperatur (T2) | +| temperature_outside | Number | Read | de: Aussentemperatur (T3) | +| temperature_outgoing_air | Number | Read | de: Ablufttemperatur (Raumtemperatur) (T4) | +| temperature_after_heat_exchanger | Number | Read | de: Temperatur nach Wärmetauscher (Fortluft) (T5) | +| temperature_supply_air | Number | Read | de: Zulufttemperatur (T6) | +| temperature_after_brine_preheating | Number | Read | de: Temperatur nach Solevorerwärmung (T7) | +| temperature_after_preheating | Number | Read | de: Temperatur nach Wärmetauscher (T8) | +| rotation_speed_supply_air_motor | Number | Read | de: Drehzahl Zuluftmotor | +| rotation_speed_exhaust_air_motor | Number | Read | de: Drehzahl Abluftmotor | +| bypass | Contact | Read | de: Zustand Bypass | +| compressor | Contact | Read | de: Zustand Kompressor Relais | +| additional_heater_relais | Contact | Read | de: Zustand Zusatzheizung Relais | +| additional_heater_status | Contact | Read | de: Zusatzheizung An/Aus | +| additional_heater_open | Switch | Read / Write | de: Zusatzheizung ausgeschaltet (0) oder freigegeben (1) | +| additional_heater_activate | Switch | Read / Write | de: Zusatzheizung ein/ausschalten | +| bypass_relay | Contact | Read | de: Zustand Netzrelais Bypass | +| preheating_radiator_active | Contact | Read | de: Vorheizen aktiv | +| control_device_active | Contact | Read | de: Bedienteil aktiv | +| earth_heat_exchanger | Contact | Read | de: Erdwärmetauscher | +| magnet_valve | Contact | Read | de: Magnetventil | +| openhab_interface_active | Contact | Read | de: Bedienung über RS Schnittstelle (WR3223 Binding) | +| preheating_radiator | Contact | Read | de: Vorheizregister | +| warm_water_post_heater | Contact | Read | de: WW Nachheizregister | +| ventilation_level_available | Contact | Read | de: Luftstufe vorhanden | +| ventilation_level | Number | Read / Write | de: Aktuelle Luftstufe | +| operation_mode | Number | Read / Write | de: Betriebsart | +| cooling_mode | Switch | Read / Write | de: Kühlen | +| temperature_supply_air_target | Number | Read / Write | de: Zuluftsoll Temperatur | +| heat_feedback_rate | Number | Read | de: Aktuelle Rückwärmzahl in % | +| speed_deviation_max_level_1 | Number | Read / Write | de: Max. Drehzahlabweichung Zu-/Abluft in Stufe 1 | +| speed_deviation_max_level_2 | Number | Read / Write | de: Max. Drehzahlabweichung Zu-/Abluft in Stufe 2 | +| speed_deviation_max_level_3 | Number | Read / Write | de: Max. Drehzahlabweichung Zu-/Abluft in Stufe 3 | +| speed_increase_earth_heat_exchanger_level_1 | Number | Read / Write | de: Drehzahlerhöhung Zuluftventilator Stufe 1, wenn Erdwärmetauscher ein (0% bis 40%) | +| speed_increase_earth_heat_exchanger_level_2 | Number | Read / Write | de: Drehzahlerhöhung Zuluftventilator Stufe 2, wenn Erdwärmetauscher ein (0% bis 40%) | +| speed_increase_earth_heat_exchanger_level_3 | Number | Read / Write | de: Drehzahlerhöhung Zuluftventilator Stufe 3, wenn Erdwärmetauscher ein (0% bis 40%) | +| air_exchange_decrease_outside_temperature | Number | Read / Write | de: Luftwechsel um 3% reduziert ab Außentemp. ...°C (-20°C bis +10°C) | +| ventilation_speed_level_1 | Number | Read / Write | de: Luftstufe 1, % des max. Ventilatorstellwerts (40 bis 100%) | +| ventilation_speed_level_2 | Number | Read / Write | de: Luftstufe 2, % des max. Ventilatorstellwerts (40 bis 100%) | +| ventilation_speed_level_3 | Number | Read / Write | de: Luftstufe 3, % des max. Ventilatorstellwerts (40 bis 100%) | +| summer_earth_heat_exchanger_activation_temperature | Number | Read / Write | de: Einschalt-Außentemperatur Erdwämietauscher im Sommer (20°C bis 40°C) | +| winter_earth_heat_exchanger_activation_temperature | Number | Read / Write | de: Einschalt-Außentemperatur Erdwärmetauscher im Winter (-20°C bis 10°C) | +| defrosting_start_temperature | Number | Read / Write | de: Beginn Abtauung ab Verdampfertemperatur ...°C | +| defrosting_end_temperature | Number | Read / Write | de: Ende Abtauung ab Verdampfertemperatur ...°C | +| defrosting_ventilation_level | Number | Read / Write | de: Lüfterstufe im Abtaubetrieb | +| defrosting_hold_off_time | Number | Read / Write | de: Sperrzeit für den nächsten Abtauvorgang | +| defrosting_overtravel_time | Number | Read / Write | de: Abtaunachlauzeit | +| defrosting_heat_feedback_rate | Number | Read / Write | de: Abtaurückwärmezahl Schaltpunkt (20% bis 80 %) | +| solar_max | Number | Read / Write | de: Solar max | +| solar_usage | Number | Read | de: Solar Nutzen (Stunden) | +| delta_t_off | Number | Read / Write | de: Delta T Aus Temperaturdifferenz zwischen Speicher u. Kollektor | +| delta_t_on | Number | Read / Write | de: Delta T Ein Temperaturdifferenz zwischen Speicher u. Kollektor | +| temperature_condenser_max | Number | Read / Write | de: Maximale Kondensatortemperatur | +| idle_time_pressure_reduction | Number | Read / Write | de: Pausezeit für Druckabbau bei automatischer Umschaltung | +| support_fan_level_1_earth_heat_exchanger | Number | Read / Write | de: Unterstuetzungsgeblaese bei Luftstufe 1 bei EWT | +| support_fan_level_2_earth_heat_exchanger | Number | Read / Write | de: Unterstuetzungsgeblaese bei Luftstufe 2 bei EWT | +| support_fan_level_3_earth_heat_exchanger | Number | Read / Write | de: Unterstuetzungsgeblaese bei Luftstufe 3 bei EWT | +| control_voltage_outgoing_air | Number | Read | de: Steuerspannung Abluft | +| control_voltage_supply_air | Number | Read | de: Steuerspannung Zuluft | +| warm_water_target_temperature | Number | Read / Write | de: Warmwasser Sollwert | +| heat_pump_status | Contact | Read | de: Wärmepumpe An/Aus | +| heat_pump_open | Switch | Read / Write | de: Wärmepumpe freigegeben (1) oder aus (0) | +| heat_pump_activate | Switch | Read / Write | de: Wärmepumpe Ein/-Ausschalten | +| evu_blockade | Contact | Read | de: EVU Abschaltung | +| malfunction | Contact | Read | de: Störung vorhanden | +| error_temp_sensor_short | Contact | Read | de: Kurzsch. TS | +| error_offset | Contact | Read | de: Offset error | +| error_temp_sensor_interupt | Contact | Read | de: Unterbr. TS | +| error_high_pressure | Contact | Read | de: Hochdruckfehler | +| error_sys_ram | Contact | Read | de: Error sys ram | +| error_sys_rom | Contact | Read | de: Error sys rom | +| error_sys_ee | Contact | Read | de: Error sys ee | +| error_sys_io | Contact | Read | de: Error sys io | +| error_sys_67_ad | Contact | Read | de: Error sys 67 ad | +| error_supply_air | Contact | Read | de: Zuluft fehlt | +| error_outgoing_air | Contact | Read | de: Abluft fehlt | +| error_condenser | Contact | Read | de: Kondensationsfehler | +| error_preheating | Contact | Read | de: Vorheizfehler | + +## Examples + +### Items + +``` +Number wr3223_operation_mode "Betriebsart [%.0f]" { wr3223="operation_mode" } +Number wr3223_ventilation_level "Aktuelle Luftstufe [%.0f]" { wr3223="ventilation_level" } +Number wr3223_temperature_supply_air_target "Soll Temperatur [%.1f]" { wr3223="temperature_supply_air_target" } +``` + +### Sitemap (fragment) + +``` +Switch item=wr3223_ventilation_level label="Stufe" mappings=[0="Aus", 1="1", 2="2", 3="3"] +Switch item=wr3223_operation_mode label="Betriebsart" mappings=[1="Sommer", 2="Abluft", 3="Winter"] +Setpoint item=wr3223_temperature_supply_air_target minValue=16 maxValue=28 step=1 +``` diff --git a/_bindings/yahooweather/readme.md b/_bindings/yahooweather/readme.md index 174f3fe76..674dd1064 100644 --- a/_bindings/yahooweather/readme.md +++ b/_bindings/yahooweather/readme.md @@ -13,12 +13,6 @@ install: auto {% include base.html %} ---- -layout: documentation ---- - -{% include base.html %} - # YahooWeather Binding This binding uses the [Yahoo Weather service](https://developer.yahoo.com/weather/) for providing current weather information. diff --git a/_iconsets/classic/readme.md b/_iconsets/classic/readme.md index b716767c0..ea692e997 100644 --- a/_iconsets/classic/readme.md +++ b/_iconsets/classic/readme.md @@ -12,12 +12,6 @@ install: manual {% include base.html %} ---- -layout: documentation ---- - -{% include base.html %} - # Classic Icon Set This is a modernized version of the original icon set of openHAB 1.

diff --git a/_io/homekit/readme.md b/_io/homekit/readme.md index d6d590043..f6b699163 100644 --- a/_io/homekit/readme.md +++ b/_io/homekit/readme.md @@ -112,7 +112,7 @@ String DownstairsThermostatHeatingCoolingMode "Downstairs Thermostat Heating/Coo ``` ## Additional Notes -HomeKit allows only a single pairing to be established with the bridge. This pairing is normally shared across devices via iCloud. If you need to establish a new pairing, you'll need to clear the existing pairings. To do this, you can issue the command ```smarthome homekit clearPairings``` from the OSGi console. +HomeKit allows only a single pairing to be established with the bridge. This pairing is normally shared across devices via iCloud. If you need to establish a new pairing, you'll need to clear the existing pairings. To do this, you can issue the command ```smarthome:homekit clearPairings``` from the OSGi console. HomeKit requires a unique identifier for each accessory advertised by the bridge. This unique identifier is hashed from the Item's name. For that reason, it is important that the name of your Items exposed to HomeKit remain consistent. diff --git a/_transformations/jsonpath/readme.md b/_transformations/jsonpath/readme.md index 8ddcf3d88..8e9c141ed 100644 --- a/_transformations/jsonpath/readme.md +++ b/_transformations/jsonpath/readme.md @@ -18,11 +18,6 @@ Extract an element of a JSON string using a [JsonPath expression](https://github Return `null` if the JsonPath expression could not be found. -## Testing Tools - -* [http://jsonpath.com/](http://jsonpath.com/) -* [http://www.jsonquerytool.com/](http://www.jsonquerytool.com/) - ## Example Given the JsonPath expression `$.device.status.temperature`: @@ -31,3 +26,7 @@ Given the JsonPath expression `$.device.status.temperature`: |-------|--------| | `{ "device": { "status": { "temperature": 23.2 }}}` | `23.2` | +## Testing Tools + +* [http://jsonpath.com/](http://jsonpath.com/) +* [http://www.jsonquerytool.com/](http://www.jsonquerytool.com/) diff --git a/_transformations/map/readme.md b/_transformations/map/readme.md index dfa07ed5c..a58429844 100644 --- a/_transformations/map/readme.md +++ b/_transformations/map/readme.md @@ -22,7 +22,7 @@ To organize the various transformations one might use subfolders. ## Example -binary.map: +transform/binary.map: ```properties key=value diff --git a/_transformations/regex/readme.md b/_transformations/regex/readme.md index 18dfb4ea3..7493f6f31 100644 --- a/_transformations/regex/readme.md +++ b/_transformations/regex/readme.md @@ -28,5 +28,5 @@ With the input string `My network does not work.`: | regular expression | output | |--------------------|--------| -| `s/work/cast/g` | `My netcast does not cast.` | -| `.*(\snot).*` | ` not` | +| `s/work/cast/g` | `"My netcast does not cast."` | +| `.*(\snot).*` | `" not"` | diff --git a/_transformations/xslt/readme.md b/_transformations/xslt/readme.md index c97dcc5f8..a61c277c0 100644 --- a/_transformations/xslt/readme.md +++ b/_transformations/xslt/readme.md @@ -44,8 +44,8 @@ transform/helloworld.xsl: output: -``` -hello +```xml +hello world ``` Other examples may be found [here](https://en.wikipedia.org/wiki/XSLT#XSLT_examples). \ No newline at end of file diff --git a/_uis/basic/readme.md b/_uis/basic/readme.md index d4f4b2ffb..e1de3f244 100644 --- a/_uis/basic/readme.md +++ b/_uis/basic/readme.md @@ -12,12 +12,6 @@ install: auto {% include base.html %} ---- -layout: documentation ---- - -{% include base.html %} - ## Basic UI The Basic UI is a web interface based on Material Design Lite from Google. diff --git a/_uis/classic/readme.md b/_uis/classic/readme.md index d4f1cbbc1..ce22e1f1b 100644 --- a/_uis/classic/readme.md +++ b/_uis/classic/readme.md @@ -12,12 +12,6 @@ install: auto {% include base.html %} ---- -layout: documentation ---- - -{% include base.html %} - ## Classic UI The Classic UI is the original web user interface of openHAB 1 and thus is the most stable and widely used UI as of today. diff --git a/_uis/paper/readme.md b/_uis/paper/readme.md index 88fef385a..a2c5c1d94 100644 --- a/_uis/paper/readme.md +++ b/_uis/paper/readme.md @@ -12,10 +12,6 @@ install: auto {% include base.html %} ---- -layout: documentation ---- - # Paper UI The Paper UI is an HTML5 web application. The Paper UI implements Google's Material Design and is responsive, so that it smoothly renders on different screen sizes. All modern browsers (Safari, Chrome, Firefox) besides the Internet Explorer are supported in their newest version. The Internet Explorer is mainly lacking support for SSE. diff --git a/_voice/mactts/readme.md b/_voice/mactts/readme.md index 3bbb45629..7a101cc89 100644 --- a/_voice/mactts/readme.md +++ b/_voice/mactts/readme.md @@ -12,12 +12,6 @@ install: auto {% include base.html %} ---- -layout: documentation ---- - -{% include base.html %} - # MacOS Text-to-Speech ## Overview