updated generated content

Signed-off-by: Kai Kreuzer <kai@openhab.org>
pull/186/head
Kai Kreuzer 2017-01-09 18:40:08 +01:00
parent 03b5ac0a23
commit f14516b68d
No known key found for this signature in database
GPG Key ID: 5110767B6248D3C0
7 changed files with 651 additions and 72 deletions

View File

@ -42,7 +42,9 @@ pioneeravr,PioneerAVR Configuration,"The binding can auto-discover the Pioneer A
pulseaudio,Pulseaudio,"This binding integrates pulseaudio devices."
rfxcom,RFXCOM,"This binding integrates large number of sensors and actuators from several different manufactures through [RFXCOM transceivers](http://www.rfxcom.com)."
rme,RME,"This binding integrates the RME RainManager rain water pump and management system"
russound,Russound,"This binding provides integration with any Russound system that support the RIO protocol (all MCA systems, all X systems). This binding provides compatibility with RIO Protocol v1.7 (everything but the Media Managment functionality). The protocol document can be found in the Russound Portal ('RIO Protocol for 3rd Party Integrators.pdf'). Please update to the latest firmware to provide full compatibility with this binding. This binding does provide full feedback from the Russound system if events occur outside of openHAB (such as keypad usage)."
samsungtv,Samsung TV,"This binding integrates the [Samsung TV's](http://www.samsung.com)."
silvercrestwifisocket,Silvercrest Wifi Plug,"This binding integrates the Silvercrest Wifi Socket SWS-A1 sold by Lidl."
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:"
@ -50,6 +52,6 @@ tellstick,Tellstick,"This is an openHAB binding for Tellstick devices produced b
tesla,Tesla,"This binding integrates the [Tesla Electrical Vehicle](http://www.teslamotors.com)."
toon,Toon,"The Toon bindings shows among others current room temperature, setpoint, energy and gas usage information."
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 SOMFYs 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."
vitotronic,Vitotronic,"Viessmann heating systems with Vitotronic has a optolink Interface for maintenance."
yamahareceiver,Yamahareceiver,"This binding connects openHAB with Yamaha Receivers of product line CX-A5000, RX-A30xx, RX-A20xx, RX-A10xx, RX-Vxxx, RX-Z7, DSP-Z7, RX-S600, HTR-xxxx."
zwave,ZWave,"The ZWave binding supports an interface to a wireless Z-Wave home automation network."

1 id label description
42 pulseaudio Pulseaudio This binding integrates pulseaudio devices.
43 rfxcom RFXCOM This binding integrates large number of sensors and actuators from several different manufactures through [RFXCOM transceivers](http://www.rfxcom.com).
44 rme RME This binding integrates the RME RainManager rain water pump and management system
45 russound Russound This binding provides integration with any Russound system that support the RIO protocol (all MCA systems, all X systems). This binding provides compatibility with RIO Protocol v1.7 (everything but the Media Managment functionality). The protocol document can be found in the Russound Portal ('RIO Protocol for 3rd Party Integrators.pdf'). Please update to the latest firmware to provide full compatibility with this binding. This binding does provide full feedback from the Russound system if events occur outside of openHAB (such as keypad usage).
46 samsungtv Samsung TV This binding integrates the [Samsung TV's](http://www.samsung.com).
47 silvercrestwifisocket Silvercrest Wifi Plug This binding integrates the Silvercrest Wifi Socket SWS-A1 sold by Lidl.
48 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.
49 squeezebox Logitech Squeezebox This binding integrates the [Logitech Media Server](http://www.mysqueezebox.com) and compatible Squeeze players.
50 systeminfo Systeminfo System information Binding provides operating system and hardware information including:
52 tesla Tesla This binding integrates the [Tesla Electrical Vehicle](http://www.teslamotors.com).
53 toon Toon The Toon bindings shows among others current room temperature, setpoint, energy and gas usage information.
54 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.
55 vitotronic vitotronic Vitotronic Viessmann heating systems with vitotronic has a optolink Interface for maintenance. Viessmann heating systems with Vitotronic has a optolink Interface for maintenance.
56 yamahareceiver Yamahareceiver This binding connects openHAB with Yamaha Receivers of product line CX-A5000, RX-A30xx, RX-A20xx, RX-A10xx, RX-Vxxx, RX-Z7, DSP-Z7, RX-S600, HTR-xxxx.
57 zwave ZWave The ZWave binding supports an interface to a wireless Z-Wave home automation network.

View File

@ -0,0 +1,463 @@
---
layout: documentation
---
{% include base.html %}
# Russound Binding
This binding provides integration with any Russound system that support the RIO protocol (all MCA systems, all X systems). This binding provides compatibility with RIO Protocol v1.7 (everything but the Media Managment functionality). The protocol document can be found in the Russound Portal ("RIO Protocol for 3rd Party Integrators.pdf"). Please update to the latest firmware to provide full compatibility with this binding. This binding does provide full feedback from the Russound system if events occur outside of openHAB (such as keypad usage).
## Supported Bridges/Things
* Bridge: Russound System (usually the main controller)
* Bridge: Russound Controller (1-6 controllers supported)
* Bridge: Russound Source (1-12 sources supported)
* Bridge: Russound Bank (1-6 banks supported for any tuner source)
* Thing: Russound Bank Preset (1-6 presets supported for each bank)
* Thing: Russound System Favorite (1-32 favorites supported)
* Bridge: Russound Zone (1-6 zones supported for each controller)
* Thing: Russound Zone Favorite (1-2 zone favorites for each zone)
* Thing: Russound Zone Presets (1-36 presets for each zone [corresponds to banks 1-6, presets 1-6 for each bank])
## Thing Configuration
The following configurations occur for each of the bridges/things:
### Russound System
| Name | Type | Description |
|--------------|---------------|--------------------------------------------------------------------------|
| ipAddress | string | IP Address or host name of the russound system (usually main controller) |
| ping | int | Interval, in seconds, to ping the system to keep connection alive |
| retryPolling | int | Interval, in seconds, to retry a failed connection attempt |
### Russound System Favorite
| Name | Type | Description |
|--------------|---------------|--------------------------------------------------------------------------|
| favorite | int | The favorite # (1-32) |
### Russound Source
| Name | Type | Description |
|--------------|---------------|--------------------------------------------------------------------------|
| source | int | The source # (1-12) |
### Russound Bank
| Name | Type | Description |
|--------------|---------------|--------------------------------------------------------------------------|
| bank | int | The bank # (1-6) |
### Russound Bank Preset
| Name | Type | Description |
|--------------|---------------|--------------------------------------------------------------------------|
| preset | int | The preset # (1-6) |
### Russound Controller
| Name | Type | Description |
|--------------|---------------|--------------------------------------------------------------------------|
| controller | int | The controller address # (1-6) |
### Russound Zone
| Name | Type | Description |
|--------------|---------------|--------------------------------------------------------------------------|
| zone | int | The zone # (1-6) |
### Russound Zone Favorite
| Name | Type | Description |
|--------------|---------------|--------------------------------------------------------------------------|
| favorite | int | The zone favorite # (1-2) |
### Russound Zone Preset Commands
| Name | Type | Description |
|--------------|---------------|--------------------------------------------------------------------------|
| preset | int | The zone preset # (1-36 - corresponds to bank 1-6, preset 1-6) |
## Channels
The following channels are supported for each bridge/thing
### Russound System
| Channel Type ID | Read/Write | Item Type | Description |
|--------------------|------------|--------------|--------------------------------------------------------------------- |
| version | R | String | The firmware version of the system |
| status | R | Switch | Whether any controller/zone is on (or if all are off) |
| language | RW | String | System language (english, chinese and russian are supported) |
### Russound System Favorite
| Channel Type ID | Read/Write | Item Type | Description |
|--------------------|------------|--------------|--------------------------------------------------------------------- |
| name | R | String | The name of the system favorite (changed by zone favorites) |
| valid | R | Switch | If system favorite is valid or not (changed by zone favorites) |
### Russound Source (please see source cross-reference below for what is supported by which sources)
| Channel Type ID | Read/Write | Item Type | Description |
|--------------------|------------|--------------|--------------------------------------------------------------------- |
| name | R | String | The name of the source |
| type | R | String | The type of source |
| ipaddress | R | String | The IP Address of the source |
| composername | R | String | The currently playing composer name |
| channel | R | String | The currently playing channel (usually tuner frequency) |
| channelname | R | String | The currently playing channel name |
| genre | R | String | The currently playing genre |
| artistname | R | String | The currently playing artist name |
| albumname | R | String | The currently playing album name |
| coverarturl | R | String | The currently playing URL to the cover art |
| coverart | R | Image | The currently playing cover art image |
| playlistname | R | String | The currently playing play list name |
| songname | R | String | The currently playing song name |
| mode | R | String | The provider mode or streaming service |
| shufflemode | R | String | The current shuffle mode |
| repeatmode | R | String | The current repeat mode |
| rating | R | String | The rating for the currently played song (can be changed via zone) |
| programservicename | R | String | The program service name (PSN) |
| radiotext | R | String | The radio text |
| radiotext2 | R | String | The radio text (line 2) |
| radiotext3 | R | String | The radio text (line 3) |
| radiotext4 | R | String | The radio text (line 4) |
| volume | R | String | The source's volume level (undocumented) |
### Russound Bank
| Channel Type ID | Read/Write | Item Type | Description |
|--------------------|------------|--------------|--------------------------------------------------------------------- |
| name | R | String | The name of the bank (changed by SCS-C5 software) |
### Russound Preset
| Channel Type ID | Read/Write | Item Type | Description |
|--------------------|------------|--------------|--------------------------------------------------------------------- |
| name | R | String | The name of the Preset (changed by zone preset commands) |
| valid | R | Switch | If preset is valid or not (changed by zone preset commands) |
### Russound Controller
| Channel Type ID | Read/Write | Item Type | Description |
|--------------------|------------|--------------|--------------------------------------------------------------------- |
| type | R | String | The model type of the controller (i.e. "MCA-C5") |
| ipaddress | R | String | The IPAddress of the controller (only if it's the main controller) |
| macaddress | R | String | The MAC Address of the controller (only if it's the main controller) |
### Russound Zone
| Channel Type ID | Read/Write | Item Type | Description |
|--------------------|------------|--------------|--------------------------------------------------------------------- |
| status | RW | Switch | Whether the zone is on or off |
| name | R | String | The name of the zone (changed by SCS-C5 software) |
| source | RW | Number | The (physical) number for the current source |
| volume | RW | Number | The current volume of the zone (0 to 50) |
| mute | RW | Switch | Whether the zone is muted or not |
| bass | RW | Number | The bass setting (-10 to 10) |
| treble | RW | Number | The treble setting (-10 to 10) |
| balance | RW | Number | The balance setting (-10 [full left] to 10 [full right]) |
| loudness | RW | Switch | Set's the loudness on/off |
| turnonvolume | RW | Number | The initial volume when turned on (0 to 50) |
| donotdisturb | RW | String | The do not disturb setting (on/off/slave) |
| partymode | RW | String | The party mode (on/off/master) |
| page | R | Switch | Whether the zone is in paging mode or not |
| sharedsource | R | Switch | Whether the zone's source is being shared or not |
| sleeptimeremaining | RW | Number | Sleep time, in minutes, remaining (0 to 60 in 5 step increments) |
| lasterror | R | String | The last error that occurred in the zone |
| enabled | R | Switch | Whether the zone is enabled or not |
| repeat | W | Switch | Toggle the repeat mode for the current source |
| shuffle | W | Switch | Toggle the shuffle mode for the current source |
| rating | W | Switch | Signal a like (ON) or dislike (OFF) to the current source |
| keypress | W | String | (Advanced) Send a keypress from the zone |
| keyrelease | W | String | (Advanced) Send a keyrelease from the zone |
| keyhold | W | String | (Advanced) Send a keyhold from the zone |
| keycode | W | String | (Advanced) Send a keycode from the zone |
| event | W | String | (Advanced) Send an event from the zone |
* As of the time of this document, rating ON (like) produced an error in the firmware from the related command. This has been reported to Russound.
* keypress/keyrelease/keyhold/keycode/event are advanced commands that will pass the related event string to Russound (i.e. "EVENT C[x].Z[y]!KeyPress [stringtype]"). Please see the "RIO Protocol for 3rd Party Integrators.pdf" (found at the Russound Portal) for proper string forms.
* If you send a OnOffType to the volume will have the same affect as turning the zone on/off (ie sending OnOffType to "status")
* The volume PercentType will be scaled to Russound's volume of 0-50 (ie 50% = volume of 25, 100% = volume of 50)
### Russound Zone Favorite
| Channel Type ID | Read/Write | Item Type | Description |
|--------------------|------------|--------------|----------------------------------------------------------------------------- |
| name | RW | String | The name of the zone favorite (only saved when the 'savexxx' cmd is issued) |
| valid | R | Switch | If favorite is valid or not ('on' when favorite is saved, 'off' when deleted |
| cmd | W | String | The favorite command (see note below) |
The favorite command channel ("cmd") supports the following
| Command Text | Description |
|--------------|-----------------------------------------------------|
| savesys | Save the associated zone as the a system favorite |
| restoresys | Restores the system favorite to the associated zone |
| deletesys | Deletes the system favorite |
| savezone | Save the associated zone as the a zone favorite |
| restorezone | Restores the zone favorite to the associated zone |
| deletezone | Deletes the zone favorite |
### Russound Zone Preset Commands
| Channel Type ID | Read/Write | Item Type | Description |
|--------------------|------------|--------------|-----------------------------------------------------------------------------------------|
| name | RW | String | The name of the preset (only saved when the 'save' preset cmd is issued) |
| valid | R | Switch | If favorite is valid or not ('on' when a preset is saved, 'off' when preset is deleted) |
| cmd | W | String | The preset command (see note below) |
The preset command channel ("cmd") supports the following
| Command Text | Description |
|--------------|--------------------------------------------|
| save | Save the associated zone as the preset |
| restore | Restores the preset to the associated zone |
| delete | Deletes the preset |
### Source channel support cross reference
| Channel Type ID | Sirius | XM | SMS3 | DMS 3.1 Media | DMS 3.1 AM/FM | iBridge | Internal AM/FM | Arcam T32 | Others |
|--------------------|--------|----|------|---------------|---------------|---------|----------------|-----------|--------|
| name | X | X | X | X | X | X | X | X | X |
| type | X | X | X | X | X | X | X | X | X |
| ipaddress | | | X | X | X | | | | |
| composername | X | | | | | | | | |
| channel | | | | | X | | X | | |
| channelname | X | X | | X | | | | X | |
| genre | X | X | | | | | | X | |
| artistname | X | X | X | X | | X | | | |
| albumname | | | X | X | | X | | | |
| coverarturl | 1 | | | X | | | | | |
| playlistname | | | X | X | | X | | | |
| songname | X | X | X | X | | X | | | |
| mode | | | | X | | | | | |
| shufflemode | | | | X | | X | | | |
| repeatmode | | | | X | | | | | |
| rating | | | | X | | | | | |
| programservicename | | | | | X | | X | | |
| radiotext | | | | | X | | X | X | |
| radiotext2 | | | | | | | | X | |
| radiotext3 | | | | | | | | X | |
| radiotext4 | | | | | | | | X | |
1. Sirius Internal Radio Only
## Full Example
The following is an example of
1. Main controller (#1) at ipaddress 192.168.1.24
2. Two Sources connected to it (#1 is the internal AM/FM and #2 is a DMS 3.1)
3. Two System favorites (#1 FM 102.9, #2 Pandora on DMS)
4. One bank (called "FM-1")
5. Two presets within the bank (#1 FM 100.7, #2 FM 105.1)
6. Four zones on the controller (1-4 in various rooms)
7. Zone 1 has two favorites (#1 Spotify on DMS, #2 Airplay on DMS)
8. Zone 2 has two presets (#1 corresponds to bank 1/preset 1 [102.9], #2 corresponds to bank1/preset 2 [Pandora])
.things
```
russound:rio:home [ ipAddress="192.168.1.24", ping=30, retryPolling=10 ]
russound:sysfavorite:1 (russound:rio:home) [ favorite=1 ]
russound:sysfavorite:2 (russound:rio:home) [ favorite=2 ]
russound:controller:1 (russound:rio:home) [ controller=1 ]
russound:source:1 (russound:rio:home) [ source=1 ]
russound:source:2 (russound:rio:home) [ source=2 ]
russound:bank:1 (russound:source:1) [ bank=1 ]
russound:bankpreset:1 (russound:bank:1) [ preset=1 ]
russound:bankpreset:2 (russound:bank:1) [ preset=2 ]
russound:zone:1 (russound:controller:1) [ zone=1 ]
russound:zone:2 (russound:controller:1) [ zone=2 ]
russound:zone:3 (russound:controller:1) [ zone=3 ]
russound:zone:4 (russound:controller:1) [ zone=4 ]
russound:zonefavorite:1 (russound:zone:1) [ favorite=1 ]
russound:zonefavorite:2 (russound:zone:1) [ favorite=2 ]
russound:zonepreset:1 (russound:zone:2) [ preset=1 ]
russound:zonepreset:2 (russound:zone:2) [ preset=2 ]
```
This is an example of all the items that can be included (regardless of the above setup)
.items
```
String Rio_Version "Version [%s]" { channel="russound:rio:home:version" }
String Rio_Lang "Language [%s]" { channel="russound:rio:home:lang" }
Switch Rio_Status "Status [%s]" { channel="russound:rio:home:status" }
Switch Rio_AllOn "All Zones" { channel="russound:rio:home:allon" }
String Rio_Ctl_Type "Model [%s]" { channel="russound:controller:1:type" }
String Rio_Ctl_IPAddress "IP Address [%s]" { channel="russound:controller:1:ipaddress" }
String Rio_Ctl_MacAddress "MAC [%s]" { channel="russound:controller:1:macaddress" }
String Rio_Zone_Name "Name [%s]" { channel="russound:zone:1:name" }
Switch Rio_Zone_Status "Status" { channel="russound:zone:1:status" }
Number Rio_Zone_Source "Source [%s]" { channel="russound:zone:1:source" }
Number Rio_Zone_Bass "Bass [%s]" { channel="russound:zone:1:bass" }
Number Rio_Zone_Treble "Treble [%s]" { channel="russound:zone:1:treble" }
Number Rio_Zone_Balance "Balance [%s]" { channel="russound:zone:1:balance" }
Switch Rio_Zone_Loudness "Loudness [%s]" { channel="russound:zone:1:loudness" }
Number Rio_Zone_TurnOnVolume "Turn on Volume [%s]" { channel="russound:zone:1:turnonvolume" }
String Rio_Zone_DoNotDisturb "Do not Disturb [%s]" { channel="russound:zone:1:donotdisturb" }
String Rio_Zone_PartyMode "Party Mode [%s]" { channel="russound:zone:1:partymode" }
Dimmer Rio_Zone_Volume "Volume [%s %%]" { channel="russound:zone:1:volume" }
Switch Rio_Zone_Mute "Mute [%s]" { channel="russound:zone:1:mute" }
Switch Rio_Zone_Page "Page [%s]" { channel="russound:zone:1:page" }
Switch Rio_Zone_SharedSource "Shared Source [%s]" { channel="russound:zone:1:sharedsource" }
Number Rio_Zone_SleepTime "Sleep Time Remaining [%s]" { channel="russound:zone:1:sleeptimeremaining" }
String Rio_Zone_LastError "Last Error [%s]" { channel="russound:zone:1:lasterror" }
Switch Rio_Zone_Enabled "Enabled [%s]" { channel="russound:zone:1:enabled" }
Switch Rio_Zone_Repeat "Toggle Repeat" { channel="russound:zone:1:repeat", autoupdate="false" }
Switch Rio_Zone_Shuffle "Toggle Shuffle" { channel="russound:zone:1:shuffle", autoupdate="false" }
Switch Rio_Zone_Rating "Rating" { channel="russound:zone:1:rating", autoupdate="false" }
String Rio_Src_Name "Name [%s]" { channel="russound:source:1:name" }
String Rio_Src_Type "Type [%s]" { channel="russound:source:1:type" }
String Rio_Src_IP "IPAddress [%s]" { channel="russound:source:1:ipaddress" }
String Rio_Src_Composer "Composer [%s]" { channel="russound:source:1:composername" }
String Rio_Src_Channel "Channel [%s]" { channel="russound:source:1:channel" }
String Rio_Src_ChannelName "Channel Name [%s]" { channel="russound:source:1:channelname" }
String Rio_Src_Genre "Genre [%s]" { channel="russound:source:1:genre" }
String Rio_Src_ArtistName "Artist [%s]" { channel="russound:source:1:artistname" }
String Rio_Src_AlbumName "Album [%s]" { channel="russound:source:1:albumname" }
String Rio_Src_Cover "Cover Art [%s]" { channel="russound:source:1:coverarturl" }
String Rio_Src_PlaylistName "PlayList [%s]" { channel="russound:source:1:playlistname" }
String Rio_Src_SongName "Song [%s]" { channel="russound:source:1:songname" }
String Rio_Src_Mode "Mode [%s]" { channel="russound:source:1:mode" }
String Rio_Src_Shuffle "Shuffle [%s]" { channel="russound:source:1:shufflemode" }
String Rio_Src_Repeat "Repeat [%s]" { channel="russound:source:1:repeatmode" }
String Rio_Src_Rating "Rating [%s]" { channel="russound:source:1:rating" }
String Rio_Src_ProgramServiceName "PSN [%s]" { channel="russound:source:1:programservicename" }
String Rio_Src_RadioText "Radio Text [%s]" { channel="russound:source:1:radiotext" }
String Rio_Src_RadioText2 "Radio Text #2 [%s]" { channel="russound:source:1:radiotext2" }
String Rio_Src_RadioText3 "Radio Text #3 [%s]" { channel="russound:source:1:radiotext3" }
String Rio_Src_RadioText4 "Radio Text #4 [%s]" { channel="russound:source:1:radiotext4" }
String Rio_Sys_Favorite_Name "Name1 [%s]" { channel="russound:sysfavorite:1:name" }
Switch Rio_Sys_Favorite_Valid "Valid1 [%s]" { channel="russound:sysfavorite:1:valid" }
String Rio_Sys_Favorite_Name2 "Name2 [%s]" { channel="russound:sysfavorite:2:name" }
Switch Rio_Sys_Favorite_Valid2 "Valid2 [%s]" { channel="russound:sysfavorite:2:valid" }
String Rio_Zone_Favorite_Name "Name [%s]" { channel="russound:zonefavorite:1:name" }
Switch Rio_Zone_Favorite_Valid "Valid [%s]" { channel="russound:zonefavorite:1:valid", autoupdate="false" }
String Rio_Zone_Favorite_Cmd "Command" { channel="russound:zonefavorite:1:cmd" }
String Rio_Zone_Favorite_Name2 "Name2 [%s]" { channel="russound:zonefavorite:2:name" }
Switch Rio_Zone_Favorite_Valid2 "Valid2 [%s]" { channel="russound:zonefavorite:2:valid", autoupdate="false" }
String Rio_Zone_Favorite_Cmd2 "Command2" { channel="russound:zonefavorite:2:cmd" }
String Rio_Src_Bank_Name "Name [%s]" { channel="russound:bank:1:name" }
String Rio_Bank_Preset_Name "Name [%s]" { channel="russound:bankpreset:1:name" }
Switch Rio_Bank_Preset_Valid "Valid [%s]" { channel="russound:bankpreset:1:valid" }
String Rio_Bank_Preset_Name2 "Name2 [%s]" { channel="russound:bankpreset:2:name" }
Switch Rio_Bank_Preset_Valid2 "Valid2 [%s]" { channel="russound:bankpreset:2:valid" }
String Rio_Zone_Preset_Cmd "Command" { channel="russound:zonepreset:1:cmd" }
String Rio_Zone_Preset_Cmd2 "Command2" { channel="russound:zonepreset:2:cmd" }
```
.sitemap
```
Frame label="Russound" {
Text label="System" {
Text item=Rio_Version
Text item=Rio_Status
Selection item=Rio_Lang mappings=[ENGLISH="English", RUSSIAN="Russian", CHINESE="Chinese"]
Switch item=Rio_AllOn
Text label="Favorites" {
Text item=Rio_Sys_Favorite_Name
Text item=Rio_Sys_Favorite_Valid
Text item=Rio_Sys_Favorite_Name2
Text item=Rio_Sys_Favorite_Valid2
}
}
Text label="Source 1" {
Text label="Bank 1" {
Text item=Rio_Src_Bank_Name
Text label="Presets" {
Text item=Rio_Bank_Preset_Name
Text item=Rio_Bank_Preset_Valid
Text item=Rio_Bank_Preset_Name2
Text item=Rio_Bank_Preset_Valid2
}
}
}
Text label="Controller 1" {
Text item=Rio_Ctl_Type
Text item=Rio_Ctl_IPAddress
Text item=Rio_Ctl_MacAddress
Text label="Zone 1" {
Text item=Rio_Zone_Name
Switch item=Rio_Zone_Status
Selection item=Rio_Zone_Source mappings=[1="Room1", 2="Room2", 3="Room3", 4="Room4"]
Setpoint item=Rio_Zone_Bass
Setpoint item=Rio_Zone_Treble
Setpoint item=Rio_Zone_Balance
Switch item=Rio_Zone_Loudness
Setpoint item=Rio_Zone_TurnOnVolume
Selection item=Rio_Zone_DoNotDisturb mappings=[ON="On", OFF="Off", SLAVE="Slave"]
Selection item=Rio_Zone_PartyMode mappings=[ON="On", OFF="Off", MASTER="Master"]
Slider item=Rio_Zone_Volume
Switch item=Rio_Zone_Mute
Text item=Rio_Zone_Page
Text item=Rio_Zone_SharedSource
Setpoint item=Rio_Zone_SleepTime minValue="0" maxValue="60" step="5"
Text item=Rio_Zone_LastError
Text item=Rio_Zone_Enabled
Switch item=Rio_Zone_Shuffle mappings=[ON="Toggle"]
Switch item=Rio_Zone_Repeat mappings=[ON="Toggle"]
Switch item=Rio_Zone_Rating mappings=[ON="Like"]
Switch item=Rio_Zone_Rating mappings=[OFF="Dislike"]
Text label="Source" {
Text item= Rio_Src_Type
Text item= Rio_Src_IP
Text item= Rio_Src_Composer
Text item= Rio_Src_Channel
Text item= Rio_Src_ChannelName
Text item= Rio_Src_Genre
Text item= Rio_Src_ArtistName
Text item= Rio_Src_AlbumName
Text item= Rio_Src_Cover
Image item= Rio_Src_Cover
Text item= Rio_Src_PlaylistName
Text item= Rio_Src_SongName
Text item= Rio_Src_Mode
Text item= Rio_Src_Shuffle
Text item= Rio_Src_Repeat
Text item= Rio_Src_Rating
Text item= Rio_Src_ProgramServiceName
Text item= Rio_Src_RadioText
Text item= Rio_Src_RadioText2
Text item= Rio_Src_RadioText3
Text item= Rio_Src_RadioText4
}
Text label="Favorite" {
Text item=Rio_Zone_Favorite_Name
Text item=Rio_Zone_Favorite_Valid
Selection item=Rio_Zone_Favorite_Cmd mappings=[savezone="Save Zone", restorezone="Restore Zone", deletezone="Delete Zone", savesys="Save System", restoresys="Restore System", deletesys="Delete System"]
Text item=Rio_Zone_Favorite_Name2
Text item=Rio_Zone_Favorite_Valid2
Selection item=Rio_Zone_Favorite_Cmd2 mappings=[savezone="Save Zone", restorezone="Restore Zone", deletezone="Delete Zone", savesys="Save System", restoresys="Restore System", deletesys="Delete System"]
}
Text label="Preset" {
Selection item=Rio_Zone_Preset_Cmd mappings=[save="Save", restore="Restore", delete="Delete"]
Selection item=Rio_Zone_Preset_Cmd2 mappings=[save="Save", restore="Restore", delete="Delete"]
}
}
}
}
```

View File

@ -0,0 +1,49 @@
---
layout: documentation
---
{% include base.html %}
# Silvercrest Wifi Plug Binding
This binding integrates the Silvercrest Wifi Socket SWS-A1 sold by Lidl.
## Supported Things
- Silvercrest Wifi Socket SWS-A1 - [(Owner Manual)](http://www.lidl-service.com/static/118127777/103043_FI.pdf) -- Tested with firmware version: 1.41, 1.60, 1.70
## Discovery
The Discovery of Wifi Sockets is always running in the background. If a command is sent to wifi socket using the android/ios app or if the physical button in the device is pressed, the device will be recognized and will be placed in the Inbox.
## Binding Configuration
The binding does not require any special configuration. The Wifi Socket should be connected to the same wifi network.
## Thing Configuration
To configure a Wifi Socket manually only the mac address is required. You can check the Wifi Socket mac address in your router or using some mobile app.
Wifi Socket thing parameters:
| Parameter ID | Parameter Type | Mandatory | Description | Default |
|--------------|----------------|------|------------------|-----|
| macAddress | text | true | The socket MAC address | |
| hostAddress | text | false | The socket Host address. The binding is capable to discover the host address. | |
| updateInterval | integer | false | Update time interval in seconds to request the status of the socket. | 60 |
E.g.
```
Thing silvercrestwifisocket:wifiSocket:lamp [ macAddress="ACCF23343C50" ]
```
## Channels
The Silvercrest Wifi Socket support the following channel:
| Channel Type ID | Item Type | Description |
|-----------------|------------------------|--------------|
| switch | Switch | Wifi Socket Switch. |

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

View File

@ -4,107 +4,174 @@ layout: documentation
{% include base.html %}
#Tellstick Binding
# Tellstick Binding
This is an openHAB binding for Tellstick devices produced by Telldus, a Swedish company based in Lund.
The original Tellstick focused on controlling 433 MHz devices like switches, dimmers and reading sensors from different brands. <br>
Many of the supported devices are cheaper and "low-end" and support have been made by reverse engineer the transmission protocols. <br>
All of these 433 MHz devices is one-way, so some versions of the Tellstick monitoring the air to keep the state of all devices.
The latest versions have also implemented Z-Wave as transmission protocol which open up for more robust transmission due two-ways communication.
All of these 433 MHz devices is one-way, so some versions of the Tellstick monitoring the air to keep the state of all devices.
The latest versions have also implemented Z-Wave as transmission protocol which open up for more robust transmission due two-ways communication.
<p align="center">
<img src="doc/tellstick_duo.jpg" alt="Tellstick Duo with device" width="300px"/>
</p>
## Supported Things
This binding implements two different API:
**1)** *Telldus Core* which is a local only interface supported by USB based device. <br>
**2)** *Telldus Live* which is a REST based cloud service maintained by Telldus. <br>
3) (According to [Telldus](http://developer.telldus.com/blog/2016/01/21/local-api-for-tellstick-znet-lite-beta) are they working with a local REST based API for the new Z-Wave devices. This is currently **NOT** supported by this binding.)
Depending on your Tellstick model different API methods is available:
<table>
<tr><td><b>Model</b></td> <td><b>Telldus Core</b></td> <td><b>Telldus Live</b></td> <td><b>Verified working with openHAB</b></td></tr>
<tr><td>Tellstick Basic</td><td>X</td><td>X</td></tr>
<tr><td>Tellstick Duo</td><td>X</td><td>X</td><td>X</td></tr>
<tr><td>Tellstick Net</td><td></td><td>X</td></tr>
<tr><td>Tellstick ZNet Lite</td><td></td><td>X</td></tr>
<tr><td>Tellstick ZNet Pro</td><td></td><td>X</td><td>X</td></tr>
</table>
This binding supports the following thing types:
* Telldus Core Bridge
* Telldus Live Bridge
* Dimmable Device
* Switchable Device
* Sensors
* *Dimmable Device* - Usually for controlling lamps. `dimmer`
* *Switchable Device* - On/Off only could be lamps or other electronic equipment. `switch`
* *Sensors* - Often temperature-, barometic- and humidity-sensors. `sensor`
## Binding Configuration
Additionally the binding have two types of bridge things which correspond to available API types:
* *Telldus Core Bridge* - Oldest API, used by USB devices. `telldus-core`
* *Telldus Live Bridge* - Telldus Cloud service, all devices with online access. `telldus-live`
---
#####For Telldus Core only#####
*First of all you need to make sure that your JVM is matching your installed Telldus Center. This normally means openHab must run on a 32bit JVM for windows and a 64bit JVM for linux. For windows the binding is hardcoded to look for Telldus Center in Programs Files ("C:/Program Files/Telldus/;C:/Program Files (x86)/Telldus/"). If you have trouble getting the telldus core library to work you can modify the library path using*
***Switchbased sensors workaround*** <br>
*Some 433MHz magnetic & PIR sensors for example magnetic door sensors are detected as a regular `switch` things instead of a separate type. There is technically no way of distinguish them apart from regulur `switch` things. For using them as sensors only (not paired to a lamp) please consult the workaround in the channel section.*
## Discovery
Both Telldus Core and Live devices will be discovered once the bridges are configured.
Devices which is added to *Telldus Core* and *Telldus Live* can be discovered by openHAB.
When you add this binding it will try to discover the *Telldus Core Bridge*. If it's installed correct its devices will show up.
If you want to use the *Telldus Live* its bridge, *Telldus Live bridge* need to be added manually.
## Binding Configuration
***For USB connected tellsticks only, eg. Basic and DUO*** <br>
*First of all you need to make sure that your JVM is matching your installed Telldus Center. This normally means openHab must run on a 32bit JVM for windows and a 64bit JVM for linux. For windows the binding is hardcoded to look for Telldus Center in Programs Files ("C:/Program Files/Telldus/;C:/Program Files (x86)/Telldus/"). If you have trouble getting the telldus core library to work you can modify the library path using*
## Thing Configuration
```xtend
Bridge tellstick:telldus-core:1 "Tellstick Duo" []
Only the bridges require manual configuration. The devices and sensors should not be added by hand, let the discovery/inbox initially configure these.
Bridge tellstick:telldus-live:2 "Tellstick ZWave" [publicKey="XXX", privateKey="YYYY", token= "ZZZZ", tokenSecret="UUUU"]
### Dimmers & switches
There is an option to override the resend count of the commands. Use the option `repeat` for that. Default resend count is 2.
### Bridges
Depending on your tellstick device type there is different ways of using this binding. The binding implements two different API:
**1)** *Telldus Core* which is a local only interface supported by USB based device. <br>
**2)** *Telldus Live* which is a REST based cloud service maintained by Telldus. <br>
> Not implemented yet but supported by some new devices: <br>
> **3)** *Local Rest API* is a local API which would work similar to Telldus Live but local.
Depending on your Tellstick model different API methods is available:
<table>
<tr><td><b>Model</b></td> <td><b>Telldus Core</b></td> <td><b>Telldus Live</b></td> <td>Local REST API</td> <td><b>Verified working with openHAB</b></td></tr>
<tr><td>Tellstick Basic</td><td>X</td><td>X</td><td></td><td></td></tr>
<tr><td>Tellstick Duo</td><td>X</td><td>X</td><td></td><td>X</td></tr>
<tr><td>Tellstick Net v.1</td><td></td><td>X</td><td></td><td></td></tr>
<tr><td>Tellstick Net v.2</td><td></td><td>X</td><td>X</td><td></td></tr>
<tr><td>Tellstick ZNet Lite v.1</td><td></td><td>X</td><td>X</td><td>X</td></tr>
<tr><td>Tellstick ZNet Lite v.2</td><td></td><td>X</td><td>X</td><td></td></tr>
<tr><td><i>Tellstick ZNet Pro (Not released)</i></td><td></td><td>X</td><td>X</td><td></td></tr>
</table>
#### Telldus Core Bridge
```
Bridge tellstick:telldus-core:1 "Tellstick Duo" [resendInterval="200"]
```
## Channels
Optional:
There are two levels of discovery. When you add this binding it will try to discover the Telldus Core Bridge (this only works if you have Telldus installed and right 32/64 bit version of java).
If you want to use the Telldus Live bridge, then you manually need to add this thing.
When you add either of those all devices and sensors will be discovered and reported in the inbox.
## Thing Configuration
#####Telldus Core Bridge#####
- **libraryPath:** The path to tellduscore.dll/so,
- **libraryPath:** The path to tellduscore.dll/so,
- **resendInterval:** The interval between each transmission of command, default 100ms.
#####Telldus Live Bridge#####
#### Telldus Live Bridge
To configure Telldus Live you have request OAuth tokens from Telldus. Goto this page
http://api.telldus.com/keys/index and request your keys and update the config.
```
Bridge tellstick:telldus-live:2 "Tellstick ZWave" [publicKey="XXX", privateKey="YYYY", token= "ZZZZ", tokenSecret="UUUU"]
```
Required:
- **privateKey:** Private key
- **publicKey:** Public key
- **token:** Token
- **tokenSecret:** Token secret
- **refreshInterval:** How often we should contact Telldus.Live to check for updates
The devices and sensors should not be configured by hand, let the discovery/inbox configure these.
Optional:
- **refreshInterval:** How often we should contact *Telldus Live* to check for updates
## Channels
Actuators (dimmer/switch) support the following channels:
| Channel Type ID | Item Type | Description |
|-----------------|--------------|----------------------------------------------- |
| dimmer | Number | This channel indicates the current dim level |
| state | Switch | This channel indicates whether a device is turned on or off. |
| timestamp | DateTime | This channel reports the last time this device state changed. |
<table>
<tr><td colspan="3">Actuators ([dimmer]/[switch]) support the following channels:</td></tr>
<tr><td><b>Channel Type ID</b></td> <td><b>Item Type</b></td> <td><b>Description</b></td> </tr>
<tr><td>dimmer</td><td>Number</td><td>This channel indicates the current dim level</td></tr>
<tr><td>state</td><td>Switch</td><td>This channel indicates whether a device is turned on or off.</td></tr>
<tr><td>timestamp</td><td>DateTime</td><td>This channel reports the last time this device state changed.</td></tr>
</table>
Sensors support the following channels:
| Channel Type ID | Item Type | Description |
|-----------------|--------------|----------------------------------------------- |
| humidity | Number | This channel reports the current humidity in percentage |
| temperature | Number | This channel reports the current temperature in celsius |
| timestamp | DateTime | This channel reports the last time this sensor was updates. |
<table>
<tr><td colspan="3">Sensors ([sensor]) support the following channels:</td></tr>
<tr><td><b>Channel Type ID</b></td> <td><b>Item Type</b></td> <td><b>Description</b></td> </tr>
<tr><td>humidity</td><td>Number</td><td>This channel reports the current humidity in percentage.</td></tr>
<tr><td>temperature</td><td>Number</td><td>This channel reports the current temperature in celsius.</td></tr>
<tr><td>timestamp</td><td>DateTime</td><td> This channel reports the last time this sensor was updates.</td></tr>
</table>
### Switchbased sensor workaround
All switchbased sensors are binary and the goal is to represent them as a `contact` item in openhab. Eg. a door is open or closed and can't be altered by sending a radio signal. To achive that we will create a proxy item which is updated by a rule.
First create another proxy item for every sensor:
```
Switch front_door_sensor "Front door" <door> {channel="tellstick:switch:1:7:state"}
Contact front_door_proxy "Front door" <door>
```
Then create a rule which updates the proxy item:
```
rule "proxy_front_door_on"
when
Item front_door_sensor changed to ON
then
postUpdate(front_door_proxy, OPEN);
end
rule "proxy_front_door_off"
when
Item front_door_sensor changed to OFF
then
postUpdate(front_door_proxy, CLOSED);
end
```
## Full Example
```xtend
Bridge tellstick:telldus-core:1 "Tellstick Duo" []
### tellstick.things
```
Bridge tellstick:telldus-core:1 "Tellstick Duo" [resendInterval="200"]
Bridge tellstick:telldus-live:2 "Tellstick ZWave" [refresh="10000", publicKey="XXXXXXXX", privateKey="YYYYYY", token= "ZZZZZZZZ", tokenSecret="UUUUUUUUUU"]
```
Devices are preferable discovered automatically.
Add them either with karaf: `inbox approve <thingId>` or in paperUI. The bridges can also be added with PaperUI.
### tellstick.items
List available devices in karaf with `things` or get the channels in paperUI.
```
Slider living_room_ceiling "Living room ceiling" <light> {channel="tellstick:dimmer:1:3:state"}
Switch living_room_table "Living room table" <light> {channel="tellstick:switch:1:3:state"}
Number inside_temperature "Inside temperature [%.1f °C]" <temperature> {channel="tellstick:sensor:1:47_temperaturehumidity_fineoffset:temperature"}
Number inside_humidity "Inside humidity [%.1f RH]" <humidity> {channel="tellstick:sensor:1:47_temperaturehumidity_fineoffset:humidity"}
```

View File

@ -4,17 +4,17 @@ layout: documentation
{% include base.html %}
# vitotronic Binding
# Vitotronic Binding
Viessmann heating systems with vitotronic has a optolink Interface for maintenance.
Viessmann heating systems with Vitotronic has a optolink Interface for maintenance.
This interface can use for get/set data in the heating system. [see on openv](http://openv.wikispaces.com)
The vitotronic binding is a solution to bind this interface into openHAB2.
The Vitotronic binding is a solution to bind this interface into openHAB2.
It supports the separation of the heating adaption from the integration in [openHAB2](http://www.openhab.org/).
![Architectur](doc/architecture_vitotronic.jpg)
The adapter transform the address oriented raw interface of the vitotronic to a abstract format.
The adapter transform the address oriented raw interface of the Vitotronic to a abstract format.
The adapter itself is not a part of the openhab2 binding.
[A alpha version is available here](https://github.com/steand/optolink)
[More Information about the adapter](https://github.com/steand/optolink/wiki)

View File

@ -12,9 +12,7 @@ Features:
* Responsive layout suitable for various screen sizes
* AJAX navigation
* Live update<sup>1</sup>
<sup>1</sup>: as for now, only control states and icons are updated. Visibility changes require a page reload.
* Live update
Configuration: