demus/openhab-addons
1
0
Fork 0
mirror of https://github.com/openhab/openhab-addons.git synced 2025-02-04 03:14:07 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve volume event handling (#17387)

Browse Source 
Signed-off-by: Michael Lobstein <michael.lobstein@gmail.com>
Signed-off-by: Ciprian Pascu <contact@ciprianpascu.ro>
This commit is contained in:
mlobstein 2024-09-08 08:00:46 -05:00 committed by Ciprian Pascu
parent de6b120358
commit ecede36feb
7 changed files with 164 additions and 139 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

274
bundles/org.openhab.binding.kaleidescape/README.md
View File

@ -30,16 +30,17 @@ In the Inbox, select Search For Things and then choose the Kaleidescape Binding
The thing has the following configuration parameters: The thing has the following configuration parameters:
| Parameter Label | Parameter ID | Description | Accepted values | | Parameter Label | Parameter ID | Description | Accepted values |
|--------------------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| |-----------------------------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
| Address | host | Host name or IP address of the Kaleidescape component | A host name or IP address | | Address | host | Host name or IP address of the Kaleidescape component | A host name or IP address |
| Port | port | Communication port of the IP connection | 10000 (default - should not need to change) | | Port | port | Communication port of the IP connection | 10000 (default - should not need to change) |
| Serial Port | serialPort | Serial port for connecting directly a component | Serial port name (optional) | | Serial Port | serialPort | Serial port for connecting directly a component | Serial port name (optional) |
| Update Period | updatePeriod | Tells the component how often time status updates should be sent (see notes below) | 0 or 1 are the currently accepted values (default 0) | | Update Period | updatePeriod | Tells the component how often time status updates should be sent (see notes below) | 0 or 1 are the currently accepted values (default 0) |
| Volume Control Enabled | volumeEnabled | Enable the volume and mute controls in the K iPad & phone apps | Boolean (default false) | | Advanced Volume Control Enabled | volumeEnabled | Enable the volume and mute controls in the K iPad & phone apps; when enabled the volume and mute channels described below are active | Boolean (default false) |
| Initial Volume Setting | initialVolume | Initial volume level set when the binding starts up | 0 to 75 (default 25) | | Initial Volume Setting | initialVolume | Initial volume level set when the binding starts up | 0 to 75 (default 25) |
| Load Highlighted Details | loadHighlightedDetails | When enabled the binding will automatically load the the metadata channels when the selected item in the UI (Movie or Album) changes | Boolean (default false) | | Basic Volume Control Enabled | volumeBasicEnabled | Enables stateless volume up/down and mute controls in the K apps; cannot be used when `volumeEnabled` is true (see rules example below) | Boolean (default false) |
| Load Album Details | loadAlbumDetails | When enabled the binding will automatically load the metadata channels for the currently playing Album | Boolean (default false) N/A for Alto and Strato | | Load Highlighted Details | loadHighlightedDetails | When enabled the binding will automatically load the the metadata channels when the selected item in the UI (Movie or Album) changes | Boolean (default false) |
| Load Album Details | loadAlbumDetails | When enabled the binding will automatically load the metadata channels for the currently playing Album | Boolean (default false) N/A for Alto and Strato |
Some notes: Some notes:
@ -58,90 +59,90 @@ Some notes:
The following channels are available: The following channels are available:
| Channel ID | Item Type | Description | | Channel ID | Item Type | Description |
|----------------------------|-------------|------------------------------------------------------------------------------------------------------------------| |----------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------|
| ui#power | Switch | Turn the zone On or Off (system standby) | | ui#power | Switch | Turn the zone On or Off (system standby) |
| ui#volume | Dimmer | A virtual volume that tracks the volume in K control apps, use as a proxy to adjust a real volume item via rules | | ui#volume | Dimmer | A virtual volume that tracks the volume control from the K app, use as a proxy to adjust a real volume item via follow or rules |
| ui#mute | Switch | A virtual mute switch that tracks the mute status in K control apps, use as a proxy to control a real mute item | | ui#mute | Switch | A virtual mute switch that tracks the mute status from the K app, use as a proxy to control a real mute item |
| ui#control | Player | Control Movie Playback e.g. play/pause/next/previous/ffward/rewind | | ui#control | Player | Control Movie Playback e.g. play/pause/next/previous/ffward/rewind |
| ui#title_name | String | The title of the movie currently playing | | ui#title_name | String | The title of the movie currently playing |
| ui#play_mode | String | The current playback mode of the movie | | ui#play_mode | String | The current playback mode of the movie |
| ui#play_speed | String | The speed of playback scanning | | ui#play_speed | String | The speed of playback scanning |
| ui#title_num | Number | The current movie title number that is playing | | ui#title_num | Number | The current movie title number that is playing |
| ui#title_length | Number:Time | The total running time of the currently playing movie (seconds) | | ui#title_length | Number:Time | The total running time of the currently playing movie (seconds) |
| ui#title_loc | Number:Time | The running time elapsed of the currently playing movie (seconds) | | ui#title_loc | Number:Time | The running time elapsed of the currently playing movie (seconds) |
| ui#chapter_num | Number | The current chapter number of the movie that is playing | | ui#chapter_num | Number | The current chapter number of the movie that is playing |
| ui#chapter_length | Number:Time | The total running time of the current chapter (seconds) | | ui#chapter_length | Number:Time | The total running time of the current chapter (seconds) |
| ui#chapter_loc | Number:Time | The running time elapsed of the current chapter | | ui#chapter_loc | Number:Time | The running time elapsed of the current chapter |
| ui#movie_media_type | String | The type of media that is currently playing | | ui#movie_media_type | String | The type of media that is currently playing |
| ui#movie_location | String | Identifies the location in the movie, ie: Main content, Intermission, or End Credits | | ui#movie_location | String | Identifies the location in the movie, ie: Main content, Intermission, or End Credits |
| ui#aspect_ratio | String | Identifies the aspect ratio of the movie | | ui#aspect_ratio | String | Identifies the aspect ratio of the movie |
| ui#video_mode | String | Raw output of video mode data from the component, format: 00:00:00 | | ui#video_mode | String | Raw output of video mode data from the component, format: 00:00:00 |
| ui#video_mode_composite | String | Identifies the video mode currently active on the composite video output | | ui#video_mode_composite | String | Identifies the video mode currently active on the composite video output |
| ui#video_mode_component | String | Identifies the video mode currently active on the component video output | | ui#video_mode_component | String | Identifies the video mode currently active on the component video output |
| ui#video_mode_hdmi | String | Identifies the video mode currently active on the HDMI video output | | ui#video_mode_hdmi | String | Identifies the video mode currently active on the HDMI video output |
| ui#video_color | String | Provides color information about the current video output (Strato Only) | | ui#video_color | String | Provides color information about the current video output (Strato Only) |
| ui#video_color_eotf | String | Identifies the Electro-Optical Transfer Function standard of the current video output (Strato Only) | | ui#video_color_eotf | String | Identifies the Electro-Optical Transfer Function standard of the current video output (Strato Only) |
| ui#content_color | String | Provides color information about the currently playing content (Strato Only) | | ui#content_color | String | Provides color information about the currently playing content (Strato Only) |
| ui#content_color_eotf | String | Identifies the Electro-Optical Transfer Function standard of the currently playing content (Strato Only) | | ui#content_color_eotf | String | Identifies the Electro-Optical Transfer Function standard of the currently playing content (Strato Only) |
| ui#scale_mode | String | Identifies whether the image from the player requires scaling | | ui#scale_mode | String | Identifies whether the image from the player requires scaling |
| ui#screen_mask | String | Provides aspect ratio and masking information for the current video image | | ui#screen_mask | String | Provides aspect ratio and masking information for the current video image |
| ui#screen_mask2 | String | Provides masking information based on aspect ratio and overscan area | | ui#screen_mask2 | String | Provides masking information based on aspect ratio and overscan area |
| ui#cinemascape_mask | String | When in CinemaScape mode, provides information about the frame aspect ratio | | ui#cinemascape_mask | String | When in CinemaScape mode, provides information about the frame aspect ratio |
| ui#cinemascape_mode | String | Identifies the CinemaScape mode currently active | | ui#cinemascape_mode | String | Identifies the CinemaScape mode currently active |
| ui#ui_state | String | Provides information about which screen is visible in the Kaleidescape user interface | | ui#ui_state | String | Provides information about which screen is visible in the Kaleidescape user interface |
| ui#child_mode_state | String | Indicates if the onscreen display is displaying the child user interface | | ui#child_mode_state | String | Indicates if the onscreen display is displaying the child user interface |
| ui#readiness_state | String | Indicates the system's current idle mode (Not available on Premiere system players) | | ui#readiness_state | String | Indicates the system's current idle mode (Not available on Premiere system players) |
| ui#highlighted_selection | String | Specifies the handle of the movie or album currently selected on the user interface | | ui#highlighted_selection | String | Specifies the handle of the movie or album currently selected on the user interface |
| ui#user_defined_event | String | Will contain custom event messages generated by scripts, sent from another component, or system events | | ui#user_defined_event | String | Will contain custom event messages generated by scripts, sent from another component, or system events |
| ui#user_input | String | Indicates if the user is being prompted for input, what type of input, and any currently entered characters | | ui#user_input | String | Indicates if the user is being prompted for input, what type of input, and any currently entered characters |
| ui#user_input_prompt | String | Indicates user input prompt info and properties currently shown on screen | | ui#user_input_prompt | String | Indicates user input prompt info and properties currently shown on screen |
| ui#sendcmd | String | Sends a raw command to the Kaleidescape player (WriteOnly) | | ui#sendcmd | String | Sends a raw command to the Kaleidescape player (WriteOnly) |
| -- music channels (not available on Alto and Strato) -- | | -- music channels (not available on Alto and Strato) -- |
| music#control | Player | Control Music Playback e.g. play/pause/next/previous/ffward/rewind | | music#control | Player | Control Music Playback e.g. play/pause/next/previous/ffward/rewind |
| music#repeat | Switch | Controls repeat playback for music | | music#repeat | Switch | Controls repeat playback for music |
| music#random | Switch | Controls random playback for music | | music#random | Switch | Controls random playback for music |
| music#track | String | The name of the currently playing track | | music#track | String | The name of the currently playing track |
| music#artist | String | The name of the currently playing artist | | music#artist | String | The name of the currently playing artist |
| music#album | String | The name of the currently playing album | | music#album | String | The name of the currently playing album |
| music#play_mode | String | The current playback mode of the music | | music#play_mode | String | The current playback mode of the music |
| music#play_speed | String | The speed of playback scanning | | music#play_speed | String | The speed of playback scanning |
| music#track_length | Number:Time | The total running time of the current playing track (seconds) | | music#track_length | Number:Time | The total running time of the current playing track (seconds) |
| music#track_position | Number:Time | The running time elapsed of the current playing track (seconds) | | music#track_position | Number:Time | The running time elapsed of the current playing track (seconds) |
| music#track_progress | Number | The percentage complete of the current playing track | | music#track_progress | Number | The percentage complete of the current playing track |
| music#track_handle | String | The handle of the currently playing track | | music#track_handle | String | The handle of the currently playing track |
| music#album_handle | String | The handle of the currently playing album | | music#album_handle | String | The handle of the currently playing album |
| music#nowplay_handle | String | The handle of the current now playing list | | music#nowplay_handle | String | The handle of the current now playing list |
| -- metadata display channels (music related channels not available on Alto and Strato) -- | | -- metadata display channels (music related channels not available on Alto and Strato) -- |
| detail#type | String | Indicates if the currently selected item is a Movie or Album | | detail#type | String | Indicates if the currently selected item is a Movie or Album |
| detail#title | String | The title of the selected movie | | detail#title | String | The title of the selected movie |
| detail#album_title | String | The title of the selected album | | detail#album_title | String | The title of the selected album |
| detail#cover_art | Image | Cover art image of the currently selected item | | detail#cover_art | Image | Cover art image of the currently selected item |
| detail#cover_url | String | The url of the cover art | | detail#cover_url | String | The url of the cover art |
| detail#hires_cover_url | String | The url of the high resolution cover art | | detail#hires_cover_url | String | The url of the high resolution cover art |
| detail#rating | String | The MPAA rating of the selected movie | | detail#rating | String | The MPAA rating of the selected movie |
| detail#year | String | The release year of the selected item | | detail#year | String | The release year of the selected item |
| detail#running_time | Number:Time | The total running time of the selected item (seconds) | | detail#running_time | Number:Time | The total running time of the selected item (seconds) |
| detail#actors | String | A list of actors appearing in the selected movie | | detail#actors | String | A list of actors appearing in the selected movie |
| detail#artist | String | The artist of the selected album | | detail#artist | String | The artist of the selected album |
| detail#directors | String | A list of directors of the selected movie | | detail#directors | String | A list of directors of the selected movie |
| detail#genres | String | A list of genres of the selected item | | detail#genres | String | A list of genres of the selected item |
| detail#rating_reason | String | An explaination of why the selected movie received its rating | | detail#rating_reason | String | An explaination of why the selected movie received its rating |
| detail#synopsis | String | A synopsis of the selected movie | | detail#synopsis | String | A synopsis of the selected movie |
| detail#review | String | A review of the selected album | | detail#review | String | A review of the selected album |
| detail#color_description | String | Indicates if the selected movie is in Color, Black and White, etc. | | detail#color_description | String | Indicates if the selected movie is in Color, Black and White, etc. |
| detail#country | String | The country that the selected movie originates from | | detail#country | String | The country that the selected movie originates from |
| detail#aspect_ratio | String | The aspect ratio of the selected movie | | detail#aspect_ratio | String | The aspect ratio of the selected movie |
| detail#disc_location | String | Indicates where the disc for the selected item is currently residing in the system (ie Vault, Tray, etc.) | | detail#disc_location | String | Indicates where the disc for the selected item is currently residing in the system (ie Vault, Tray, etc.) |
## Full Example ## Full Example
kaleidescape.things: kaleidescape.things:
```java ```java
kaleidescape:player:myzone1 "M500 Living Rm" [ host="192.168.1.10", updatePeriod=0, loadHighlightedDetails=true, loadAlbumDetails=true ] kaleidescape:strato:myzone1 "Strato Theater Rm" [ host="192.168.1.10", updatePeriod=0, loadHighlightedDetails=true ]
kaleidescape:cinemaone:myzone2 "My Cinema One" [ host="192.168.1.11", updatePeriod=0, loadHighlightedDetails=true, loadAlbumDetails=true ] kaleidescape:player:myzone2 "M500 Living Rm" [ host="192.168.1.11", updatePeriod=0, loadHighlightedDetails=true, loadAlbumDetails=true ]
kaleidescape:strato:myzone3 "Strato Theater Rm" [ host="192.168.1.12", updatePeriod=0, loadHighlightedDetails=true ] kaleidescape:cinemaone:myzone3 "My Cinema One" [ host="192.168.1.12", updatePeriod=0, loadHighlightedDetails=true, loadAlbumDetails=true ]
``` ```
kaleidescape.items: kaleidescape.items:
@ -346,18 +347,13 @@ kaleidescape.rules:
```java ```java
var int lightPercent var int lightPercent
val kactions = getActions("kaleidescape","kaleidescape:player:myzone1")
// send command to go to movie covers when button pressed // send command to go to movie covers when button pressed
rule "Go to Movie Covers" rule "Go to Movie Covers"
when when
Item z1_GoMovieCovers received command Item z1_GoMovieCovers received command
then then
if (null === kactions) { z1_Ui_Sendcmd.sendCommand("GO_MOVIE_COVERS")
logInfo("kactions", "Actions not found, check thing ID")
return
}
kactions.sendKCommand("GO_MOVIE_COVERS")
end end
// send command to play a script // send command to play a script
@ -365,14 +361,36 @@ rule "Play Script - Great Vistas"
when when
Item z1_PlayScript received command Item z1_PlayScript received command
then then
if (null === kactions) { z1_Ui_Sendcmd.sendCommand("PLAY_SCRIPT:Great Vistas")
logInfo("kactions", "Actions not found, check thing ID")
return
}
kactions.sendKCommand("PLAY_SCRIPT:Great Vistas")
end end
// handle a control system command sent from a script // handle volume events from K apps or IR remote
// the events can be used to send a command to another item that controls volume
rule "Handle volume events"
when
Item z1_Ui_UserDefinedEvent received update
then
var volEvt = newState.toString()
// When `volumeBasicEnabled` is true for the thing, VOLUME_UP, VOLUME_DOWN and TOGGLE_MUTE are received from the iPad and phone apps
// VOLUME_UP_PRESS/RELEASE, VOLUME_DOWN_PRESS/RELEASE, TOGGLE_MUTE events will always be received from the IR remote
// *RELEASE events are not used in this example
if (volEvt == "VOLUME_UP" || volEvt == "VOLUME_UP_PRESS") {
logInfo("k rules", "Volumne Up received")
}
if (volEvt == "VOLUME_DOWN" || volEvt == "VOLUME_DOWN_PRESS") {
logInfo("k rules", "Volumne Down received")
}
if (volEvt == "TOGGLE_MUTE") {
logInfo("k rules", "Mute Toggle received")
}
end
// handle a control system command sent from a kaleidescape script
// the command string is specified in a "Send command to control system" script step
rule "Handle script commands" rule "Handle script commands"
when when
Item z1_Ui_UserDefinedEvent received update Item z1_Ui_UserDefinedEvent received update
@ -412,6 +430,28 @@ then
logInfo("k rules", "intermission over") logInfo("k rules", "intermission over")
end end
rule "Movie Search"
when
Item z1_MovieSearch received update
then
if (newState != NULL && newState.toString.length > 0) {
z1_Ui_Sendcmd.sendCommand("GO_MOVIE_LIST")
Thread::sleep(1000)
z1_Ui_Sendcmd.sendCommand("FILTER_LIST")
Thread::sleep(300)
var i = 0
var srch = newState.toString.toUpperCase
logInfo("k rules","Searching for: " + srch)
while (i < (srch.length)) {
z1_Ui_Sendcmd.sendCommand("KEYBOARD_CHARACTER:" + srch.charAt(i).toString)
Thread::sleep(100)
i++
}
}
end
// The following are no longer required since the thing configuration will enable automatic loading of metatdata. // The following are no longer required since the thing configuration will enable automatic loading of metatdata.
// However the examples are still valid for advanced use cases where retrieving metadata from an arbitrary content handle is desired. // However the examples are still valid for advanced use cases where retrieving metadata from an arbitrary content handle is desired.
@ -419,43 +459,13 @@ rule "Load selected item Metadata"
when when
Item z1_Ui_HighlightedSelection changed Item z1_Ui_HighlightedSelection changed
then then
if (null === kactions) { z1_Ui_Sendcmd.sendCommand("GET_CONTENT_DETAILS:" + z1_Ui_HighlightedSelection.state.toString + ":")
logInfo("kactions", "Actions not found, check thing ID")
return
}
kactions.sendKCommand("GET_CONTENT_DETAILS:" + z1_Ui_HighlightedSelection.state.toString + ":")
end end
rule "Load Metadata for currently playing album" rule "Load Metadata for currently playing album"
when when
Item z1_Music_AlbumHandle changed Item z1_Music_AlbumHandle changed
then then
if (null === kactions) { z1_Ui_Sendcmd.sendCommand("GET_CONTENT_DETAILS:" + z1_Music_AlbumHandle.state.toString + ":")
logInfo("kactions", "Actions not found, check thing ID")
return
}
kactions.sendKCommand("GET_CONTENT_DETAILS:" + z1_Music_AlbumHandle.state.toString + ":")
end
rule "Movie Search"
when
Item z1_MovieSearch received update
then
if (newState != NULL && newState.toString.length > 0) {
kactions.sendKCommand("GO_MOVIE_LIST")
Thread::sleep(1000)
kactions.sendKCommand("FILTER_LIST")
Thread::sleep(300)
var i = 0
var srch = newState.toString.toUpperCase
logInfo("kaleidescape.search","Searching for: " + srch)
while (i < (srch.length)) {
kactions.sendKCommand("KEYBOARD_CHARACTER:" + srch.charAt(i).toString)
Thread::sleep(100)
i++
}
}
end end
``` ```

1
bundles/org.openhab.binding.kaleidescape/src/main/java/org/openhab/binding/kaleidescape/internal/KaleidescapeBindingConstants.java
View File

@ -188,6 +188,7 @@ public class KaleidescapeBindingConstants {
public static final String MUSIC_RANDOM_OFF = "MUSIC_RANDOM_OFF"; public static final String MUSIC_RANDOM_OFF = "MUSIC_RANDOM_OFF";
public static final String SEND_TO_SYSLOG = "SEND_TO_SYSLOG:INFORMATION:"; public static final String SEND_TO_SYSLOG = "SEND_TO_SYSLOG:INFORMATION:";
public static final String SEND_EVENT_VOLUME_CAPABILITIES_3 = "SEND_EVENT:VOLUME_CAPABILITIES=3";
public static final String SEND_EVENT_VOLUME_CAPABILITIES_15 = "SEND_EVENT:VOLUME_CAPABILITIES=15"; public static final String SEND_EVENT_VOLUME_CAPABILITIES_15 = "SEND_EVENT:VOLUME_CAPABILITIES=15";
public static final String SEND_EVENT_VOLUME_LEVEL_EQ = "SEND_EVENT:VOLUME_LEVEL="; public static final String SEND_EVENT_VOLUME_LEVEL_EQ = "SEND_EVENT:VOLUME_LEVEL=";
public static final String SEND_EVENT_MUTE = "SEND_EVENT:MUTE_"; public static final String SEND_EVENT_MUTE = "SEND_EVENT:MUTE_";

1
bundles/org.openhab.binding.kaleidescape/src/main/java/org/openhab/binding/kaleidescape/internal/configuration/KaleidescapeThingConfiguration.java
View File

@ -28,6 +28,7 @@ public class KaleidescapeThingConfiguration {
public @Nullable Integer updatePeriod; public @Nullable Integer updatePeriod;
public boolean volumeEnabled; public boolean volumeEnabled;
public Integer initialVolume = 0; public Integer initialVolume = 0;
public boolean volumeBasicEnabled;
public boolean loadHighlightedDetails; public boolean loadHighlightedDetails;
public boolean loadAlbumDetails; public boolean loadAlbumDetails;
} }

3
bundles/org.openhab.binding.kaleidescape/src/main/java/org/openhab/binding/kaleidescape/internal/handler/KaleidescapeHandler.java
View File

@ -89,6 +89,7 @@ public class KaleidescapeHandler extends BaseThingHandler implements Kaleidescap
protected int metaRuntimeMultiple = 1; protected int metaRuntimeMultiple = 1;
protected int volume = 0; protected int volume = 0;
protected boolean volumeEnabled = false; protected boolean volumeEnabled = false;
protected boolean volumeBasicEnabled = false;
protected boolean isMuted = false; protected boolean isMuted = false;
protected boolean isLoadHighlightedDetails = false; protected boolean isLoadHighlightedDetails = false;
protected boolean isLoadAlbumDetails = false; protected boolean isLoadAlbumDetails = false;
@ -162,6 +163,8 @@ public class KaleidescapeHandler extends BaseThingHandler implements Kaleidescap
this.volume = config.initialVolume; this.volume = config.initialVolume;
this.updateState(VOLUME, new PercentType(this.volume)); this.updateState(VOLUME, new PercentType(this.volume));
this.updateState(MUTE, OnOffType.OFF); this.updateState(MUTE, OnOffType.OFF);
} else if (config.volumeBasicEnabled) {
this.volumeBasicEnabled = true;
} }
if (serialPort != null) { if (serialPort != null) {

8
bundles/org.openhab.binding.kaleidescape/src/main/java/org/openhab/binding/kaleidescape/internal/handler/KaleidescapeMessageHandler.java
View File

@ -478,6 +478,10 @@ public enum KaleidescapeMessageHandler {
handler.connector.sendCommand(SEND_EVENT_VOLUME_LEVEL_EQ + handler.volume); handler.connector.sendCommand(SEND_EVENT_VOLUME_LEVEL_EQ + handler.volume);
handler.connector.sendCommand(SEND_EVENT_MUTE + (handler.isMuted ? MUTE_ON : MUTE_OFF)); handler.connector.sendCommand(SEND_EVENT_MUTE + (handler.isMuted ? MUTE_ON : MUTE_OFF));
} }
} else if (handler.volumeBasicEnabled) {
synchronized (handler.sequenceLock) {
handler.connector.sendCommand(SEND_EVENT_VOLUME_CAPABILITIES_3);
}
} }
break; break;
case "VOLUME_UP": case "VOLUME_UP":
@ -514,10 +518,8 @@ public enum KaleidescapeMessageHandler {
} }
} }
break; break;
// the default is to just publish all other USER_DEFINED_EVENTs
default:
handler.updateChannel(KaleidescapeBindingConstants.USER_DEFINED_EVENT, new StringType(message));
} }
handler.updateChannel(KaleidescapeBindingConstants.USER_DEFINED_EVENT, new StringType(message));
} catch (KaleidescapeException e) { } catch (KaleidescapeException e) {
logger.debug("USER_DEFINED_EVENT - exception on message: {}", message); logger.debug("USER_DEFINED_EVENT - exception on message: {}", message);
} }

10
bundles/org.openhab.binding.kaleidescape/src/main/resources/OH-INF/config/config.xml
View File

@ -32,8 +32,8 @@
<default>0</default> <default>0</default>
</parameter> </parameter>
<parameter name="volumeEnabled" type="boolean" required="false"> <parameter name="volumeEnabled" type="boolean" required="false">
<label>Volume Control Enabled</label> <label>Advanced Volume Control Enabled</label>
<description>Enable the Volume and Mute controls in the Kaleidescape iPad &amp; Phone apps and track their status in <description>Enable the Volume and Mute controls in the Kaleidescape iPad &amp; phone apps and track their status in
the binding. Disabled by default to prevent conflicts with other control systems that may already be controlling the binding. Disabled by default to prevent conflicts with other control systems that may already be controlling
volume on this zone.</description> volume on this zone.</description>
<default>false</default> <default>false</default>
@ -43,6 +43,12 @@
<description>When the binding starts up, set the Inital Volume level to this value (Default 25).</description> <description>When the binding starts up, set the Inital Volume level to this value (Default 25).</description>
<default>25</default> <default>25</default>
</parameter> </parameter>
<parameter name="volumeBasicEnabled" type="boolean" required="false">
<label>Basic Volume Control Enabled</label>
<description>Enable Basic Volume up-down and Mute toggle controls in the Kaleidescape iPad &amp; phone apps. Cannot
be used at the same time as volumeEnabled set to true.</description>
<default>false</default>
</parameter>
<parameter name="loadHighlightedDetails" type="boolean" required="false"> <parameter name="loadHighlightedDetails" type="boolean" required="false">
<label>Load Highlighted Details</label> <label>Load Highlighted Details</label>
<description>When enabled the binding will automatically load the metadata channels when the selected item in the UI <description>When enabled the binding will automatically load the metadata channels when the selected item in the UI

6
bundles/org.openhab.binding.kaleidescape/src/main/resources/OH-INF/i18n/kaleidescape.properties
View File

@ -50,8 +50,10 @@ thing-type.config.kaleidescape.kaleidescapedevice.serialPort.label = Serial Port
thing-type.config.kaleidescape.kaleidescapedevice.serialPort.description = (Optional) Serial Port to use for connecting directly to an individual Kaleidescape component. thing-type.config.kaleidescape.kaleidescapedevice.serialPort.description = (Optional) Serial Port to use for connecting directly to an individual Kaleidescape component.
thing-type.config.kaleidescape.kaleidescapedevice.updatePeriod.label = Update Period thing-type.config.kaleidescape.kaleidescapedevice.updatePeriod.label = Update Period
thing-type.config.kaleidescape.kaleidescapedevice.updatePeriod.description = Tells the component how often time status updates should be sent; Values greater than 1 are not yet implmented by the protocol. Setting to 1 may impact openHAB system performance due to constant updates while content playing. thing-type.config.kaleidescape.kaleidescapedevice.updatePeriod.description = Tells the component how often time status updates should be sent; Values greater than 1 are not yet implmented by the protocol. Setting to 1 may impact openHAB system performance due to constant updates while content playing.
thing-type.config.kaleidescape.kaleidescapedevice.volumeEnabled.label = Volume Control Enabled thing-type.config.kaleidescape.kaleidescapedevice.volumeBasicEnabled.label = Basic Volume Control Enabled
thing-type.config.kaleidescape.kaleidescapedevice.volumeEnabled.description = Enable the Volume and Mute controls in the Kaleidescape iPad & Phone apps and track their status in the binding. Disabled by default to prevent conflicts with other control systems that may already be controlling volume on this zone. thing-type.config.kaleidescape.kaleidescapedevice.volumeBasicEnabled.description = Enable Basic Volume up-down and Mute toggle controls in the Kaleidescape iPad & phone apps. Cannot be used at the same time as volumeEnabled set to true.
thing-type.config.kaleidescape.kaleidescapedevice.volumeEnabled.label = Advanced Volume Control Enabled
thing-type.config.kaleidescape.kaleidescapedevice.volumeEnabled.description = Enable the Volume and Mute controls in the Kaleidescape iPad & phone apps and track their status in the binding. Disabled by default to prevent conflicts with other control systems that may already be controlling volume on this zone.
# channel group types # channel group types