Skip to content

Add Russound Binding #1250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kaikreuzer merged 13 commits into from
Jan 5, 2017
Merged

Add Russound Binding #1250

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
56e0f8f
Initial Russound Implementation (#1225)
tmrobert8 Sep 21, 2016
3880d7a
Initial Russound Implementation (#1225)
tmrobert8 Sep 21, 2016
ccfb802
Merge branch '1225-Russound' of https://github.com/tmrobert8/openhab2…
tmrobert8 Dec 28, 2016
592cb16
Fixed small (potential) issue setting online status
tmrobert8 Dec 29, 2016
1c8cd62
Arg - update pom.xml to include russound
tmrobert8 Dec 29, 2016
32df124
Merge branch 'master' of https://github.com/openhab/openhab2-addons i…
tmrobert8 Dec 29, 2016
8c2f2a9
Various fixes
tmrobert8 Dec 30, 2016
1af8e3d
Added to feature.xml
tmrobert8 Dec 30, 2016
b60dab5
Fixed feature (copied too much)
tmrobert8 Dec 30, 2016
8ab4592
Fixed Warning message in disconnect, fixed issue with config reload
tmrobert8 Jan 3, 2017
77e8358
Kai Changes!
tmrobert8 Jan 4, 2017
f1810ee
Fixed import on manifest.mf
tmrobert8 Jan 4, 2017
9d93f5c
Fixed issue with dispatcher waiting on close
tmrobert8 Jan 5, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions addons/binding/org.openhab.binding.russound/.classpath
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<classpath>
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.7"/>
<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
<classpathentry kind="src" path="src/main/java"/>
<classpathentry kind="output" path="target/classes"/>
</classpath>
<?xml version="1.0" encoding="UTF-8"?>
<classpath>
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.7"/>
<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
<classpathentry kind="src" path="src/main/java"/>
<classpathentry kind="output" path="target/classes"/>
</classpath>
70 changes: 38 additions & 32 deletions addons/binding/org.openhab.binding.russound/ESH-INF/thing/thing-types.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,9 +188,7 @@
<channels>
<channel id="name" typeId="zfavName"/>
<channel id="valid" typeId="zfavValid"/>
<channel id="save" typeId="zfavSave"/>
<channel id="restore" typeId="zfavRestore"/>
<channel id="delete" typeId="zfavDelete"/>
<channel id="cmd" typeId="zfavCmd"/>
</channels>

<config-description>
Expand Down Expand Up @@ -232,9 +230,9 @@
<description>Zone Preset Commands to save/restore/delete presets for the zone</description>

<channels>
<channel id="save" typeId="zpreSave"/>
<channel id="restore" typeId="zpreRestore"/>
<channel id="delete" typeId="zpreDelete"/>
<channel id="name" typeId="zpreName"/>
<channel id="valid" typeId="zpreValid"/>
<channel id="cmd" typeId="zpreCmd"/>
</channels>

<config-description>
Expand Down Expand Up @@ -553,20 +551,20 @@
<label>Valid</label>
<description>If the zone favorite is valid or not</description>
</channel-type>
<channel-type id="zfavSave" advanced="true">
<item-type>Switch</item-type>
<label>Save the favorite</label>
<description>Saves the favorite (ON=as system favorite, OFF=as zone favorite)</description>
</channel-type>
<channel-type id="zfavRestore" advanced="true">
<item-type>Switch</item-type>
<label>Restore a favorite</label>
<description>Restores the favorite (ON=system favorite, OFF=zone favorite)</description>
</channel-type>
<channel-type id="zfavDelete" advanced="true">
<item-type>Switch</item-type>
<label>Delete a favorite</label>
<description>Deletes the favorite (ON=system favorite, OFF=zone favorite)</description>
<channel-type id="zfavCmd" advanced="true">
<item-type>String</item-type>
<label>Favorite Command</label>
<description>Preset Command ("savesys", "restoresys", "deletesys", "savezone", "restorezone", "deletezone")</description>
<state>
<options>
<option value="savesys">Save as system favorite</option>
<option value="restoresys">Restore system favorite</option>
<option value="deletesys">Delete system favorite</option>
<option value="savezone">Save as zone favorite</option>
<option value="restorezone">Restore zone favorite</option>
<option value="deletezone">Delete zone favorite</option>
</options>
</state>
</channel-type>

<channel-type id="bkpreName">
Expand All @@ -581,20 +579,28 @@
<description>If the bank preset is valid or not</description>
</channel-type>

<channel-type id="zpreSave" advanced="true">
<item-type>Switch</item-type>
<label>Save the favorite</label>
<description>Saves the zone as a preset</description>
<channel-type id="zpreName">
<item-type>String</item-type>
<label>Name</label>
<description>The name of the zone preset</description>
<state readOnly="true"/>
</channel-type>
<channel-type id="zpreRestore" advanced="true">
<channel-type id="zpreValid" advanced="true">
<item-type>Switch</item-type>
<label>Restore a favorite</label>
<description>Restores the preset to the zone</description>
<label>Valid</label>
<description>If the zone preset is valid or not</description>
</channel-type>
<channel-type id="zpreDelete" advanced="true">
<item-type>Switch</item-type>
<label>Delete a favorite</label>
<description>Deletes preset for the zone</description>
<channel-type id="zpreCmd" advanced="true">
<item-type>String</item-type>
<label>Preset Command</label>
<description>Preset Command ("save", "restore", "delete")</description>
<state>
<options>
<option value="save">Save as preset</option>
<option value="restore">Restore preset</option>
<option value="delete">Delete preset</option>
</options>
</state>
</channel-type>

</thing:thing-descriptions>
4 changes: 2 additions & 2 deletions addons/binding/org.openhab.binding.russound/META-INF/MANIFEST.MF
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ Import-Package:
org.eclipse.smarthome.core.thing.type,
org.eclipse.smarthome.core.types,
org.openhab.binding.russound,
org.openhab.binding.russound.rio,
org.openhab.binding.russound.internal.rio,
org.slf4j
Service-Component: OSGI-INF/*.xml
Export-Package: org.openhab.binding.russound,
org.openhab.binding.russound.rio
org.openhab.binding.russound.internal.rio
Copy link
Member

@kaikreuzer kaikreuzer Jan 4, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, you should not export it anymore now :-)

40 changes: 20 additions & 20 deletions addons/binding/org.openhab.binding.russound/OSGI-INF/RussoundHandlerFactory.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2016 by the respective copyright holders.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html
-->
<scr:component xmlns:scr="http://www.osgi.org/xmlns/scr/v1.1.0" immediate="true" name="binding.russound">
<implementation class="org.openhab.binding.russound.internal.RussoundHandlerFactory"/>
<service>
<provide interface="org.eclipse.smarthome.core.thing.binding.ThingHandlerFactory"/>
</service>
</scr:component>
<?xml version="1.0" encoding="UTF-8"?>
<!--

Copyright (c) 2014-2016 by the respective copyright holders.

All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html

-->
<scr:component xmlns:scr="http://www.osgi.org/xmlns/scr/v1.1.0" immediate="true" name="binding.russound">

<implementation class="org.openhab.binding.russound.internal.RussoundHandlerFactory"/>

<service>
<provide interface="org.eclipse.smarthome.core.thing.binding.ThingHandlerFactory"/>
</service>

</scr:component>
88 changes: 42 additions & 46 deletions addons/binding/org.openhab.binding.russound/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# 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).
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 Preset (1-6 presets supported for each bank)
* 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 Preset Commands (1-36 presets commands for each zone [corresponds to banks 1-6, presets 1-6 for each bank])
* Thing: Russound Zone Presets (1-36 presets for each zone [corresponds to banks 1-6, presets 1-6 for each bank])

## Thing Configuration

Expand Down Expand Up @@ -44,7 +44,7 @@ The following configurations occur for each of the bridges/things:
|--------------|---------------|--------------------------------------------------------------------------|
| bank | int | The bank # (1-6) |

### Russound Preset
### Russound Bank Preset

| Name | Type | Description |
|--------------|---------------|--------------------------------------------------------------------------|
Expand Down Expand Up @@ -181,22 +181,38 @@ The following channels are supported for each bridge/thing

### Russound Zone Favorite

| Channel Type ID | Read/Write | Item Type | Description |
|--------------------|------------|--------------|--------------------------------------------------------------------- |
| name | RW | String | The name of the zone favorite (only saved via 'save' channel) |
| valid | R | Switch | If favorite is valid or not (changed by save [on], delete [off]) |
| save | W | Switch | Save the favorite (ON=as system favorite, OFF=as zone favorite) |
| restore | W | Switch | Restores the favorite (ON=System favorite, OFF=zone favorite) |
| delete | W | Switch | Deletes the favorite (ON=System favorite, OFF=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 |
|--------------------|------------|--------------|--------------------------------------------------------------------- |
| save | W | Switch | Save the zone as a preset |
| restore | W | Switch | Restores the preset to the zone |
| delete | W | Switch | Deletes the preset |
| 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

Expand Down Expand Up @@ -229,6 +245,7 @@ The following channels are supported for each bridge/thing
## Full Example

The following is an example of

1. Main controller (#1) at ipaddress 192.168.1.24
Copy link
Member

@kaikreuzer kaikreuzer Jan 2, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add empty line above

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)
Expand Down Expand Up @@ -323,14 +340,10 @@ Switch Rio_Sys_Favorite_Valid2 "Valid2 [%s]" { channel="russound:sysfavorite:2:v

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" }
Switch Rio_Zone_Favorite_Save "Save" { channel="russound:zonefavorite:1:save", autoupdate="false" }
Switch Rio_Zone_Favorite_Restore "Restore" { channel="russound:zonefavorite:1:restore", autoupdate="false" }
Switch Rio_Zone_Favorite_Delete "Delete" { channel="russound:zonefavorite:1:delete", 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" }
Switch Rio_Zone_Favorite_Save2 "Save2" { channel="russound:zonefavorite:2:save", autoupdate="false" }
Switch Rio_Zone_Favorite_Restore2 "Restore2" { channel="russound:zonefavorite:2:restore", autoupdate="false" }
Switch Rio_Zone_Favorite_Delete2 "Delete2" { channel="russound:zonefavorite:2:delete", 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" }

Expand All @@ -339,15 +352,12 @@ 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" }

Switch Rio_Zone_Preset_Save "Save" { channel="russound:zonepreset:1:save", autoupdate="false" }
Switch Rio_Zone_Preset_Restore "Restore" { channel="russound:zonepreset:1:restore", autoupdate="false" }
Switch Rio_Zone_Preset_Delete "Delete" { channel="russound:zonepreset:1:delete", autoupdate="false" }
Switch Rio_Zone_Preset_Save2 "Save2" { channel="russound:zonepreset:2:save", autoupdate="false" }
Switch Rio_Zone_Preset_Restore2 "Restore2" { channel="russound:zonepreset:2:restore", autoupdate="false" }
Switch Rio_Zone_Preset_Delete2 "Delete2" { channel="russound:zonepreset:2:delete", autoupdate="false" }
String Rio_Zone_Preset_Cmd "Command" { channel="russound:zonepreset:1:cmd" }
String Rio_Zone_Preset_Cmd2 "Command2" { channel="russound:zonepreset:2:cmd" }
```

.sitemap

```
Copy link
Member

@kaikreuzer kaikreuzer Jan 2, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add empty line above

Frame label="Russound" {
Text label="System" {
Expand Down Expand Up @@ -429,29 +439,15 @@ Frame label="Russound" {
Text label="Favorite" {
Text item=Rio_Zone_Favorite_Name
Text item=Rio_Zone_Favorite_Valid
Switch item=Rio_Zone_Favorite_Save mappings=[ON="System"]
Switch item=Rio_Zone_Favorite_Save mappings=[OFF="Zone"]
Switch item=Rio_Zone_Favorite_Restore mappings=[ON="System"]
Switch item=Rio_Zone_Favorite_Restore mappings=[OFF="Zone"]
Switch item=Rio_Zone_Favorite_Delete mappings=[ON="System"]
Switch item=Rio_Zone_Favorite_Delete mappings=[OFF="Zone"]
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
Switch item=Rio_Zone_Favorite_Save2 mappings=[ON="System"]
Switch item=Rio_Zone_Favorite_Save2 mappings=[OFF="Zone"]
Switch item=Rio_Zone_Favorite_Restore2 mappings=[ON="System"]
Switch item=Rio_Zone_Favorite_Restore2 mappings=[OFF="Zone"]
Switch item=Rio_Zone_Favorite_Delete2 mappings=[ON="System"]
Switch item=Rio_Zone_Favorite_Delete2 mappings=[OFF="Zone"]
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" {
Switch item=Rio_Zone_Preset_Save mappings=[ON="Save"]
Switch item=Rio_Zone_Preset_Restore mappings=[ON="Restore"]
Switch item=Rio_Zone_Preset_Delete mappings=[ON="Delete"]
Switch item=Rio_Zone_Preset_Save2 mappings=[ON="Save"]
Switch item=Rio_Zone_Preset_Restore2 mappings=[ON="Restore"]
Switch item=Rio_Zone_Preset_Delete2 mappings=[ON="Delete"]
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"]
}
}
}
Expand Down
10 changes: 5 additions & 5 deletions addons/binding/org.openhab.binding.russound/build.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
source.. = src/main/java/
output.. = target/classes
bin.includes = META-INF/,\
.,\
OSGI-INF/,\
source.. = src/main/java/
output.. = target/classes
bin.includes = META-INF/,\
.,\
OSGI-INF/,\
ESH-INF/
38 changes: 19 additions & 19 deletions addons/binding/org.openhab.binding.russound/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.openhab.binding</groupId>
<artifactId>pom</artifactId>
<version>2.0.0-SNAPSHOT</version>
</parent>
<groupId>org.openhab.binding</groupId>
<artifactId>org.openhab.binding.russound</artifactId>
<version>2.0.0-SNAPSHOT</version>
<name>Russound Binding</name>
<packaging>eclipse-plugin</packaging>
</project>
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.openhab.binding</groupId>
<artifactId>pom</artifactId>
<version>2.0.0-SNAPSHOT</version>
</parent>

<groupId>org.openhab.binding</groupId>
<artifactId>org.openhab.binding.russound</artifactId>
<version>2.0.0-SNAPSHOT</version>

<name>Russound Binding</name>
<packaging>eclipse-plugin</packaging>

</project>
Loading