From 99e309e991beadaae37cee09b03c711f88c7f562 Mon Sep 17 00:00:00 2001 From: mlobstein Date: Sat, 29 Oct 2022 03:43:32 -0500 Subject: [PATCH] [kaleidescape] update README (#13593) * update README Signed-off-by: Michael Lobstein --- .../README.md | 34 +++++++------------ .../main/resources/OH-INF/binding/binding.xml | 4 +-- .../OH-INF/i18n/kaleidescape.properties | 4 +-- 3 files changed, 16 insertions(+), 26 deletions(-) diff --git a/bundles/org.openhab.binding.kaleidescape/README.md b/bundles/org.openhab.binding.kaleidescape/README.md index 5cf6d50ea..8d6f72651 100644 --- a/bundles/org.openhab.binding.kaleidescape/README.md +++ b/bundles/org.openhab.binding.kaleidescape/README.md @@ -1,37 +1,28 @@ # Kaleidescape Binding -This binding is used to control and retrieve information from a Kaleidescape movie player. -All movie player components including the original K-Player series, M Class Players, Cinema One, Alto, and Strato are supported. -The 4 zone audio only KMUSIC-4000 is not supported at this time. -As there are many good control options already available for these components, this binding focuses primarily on retrieving information - for display purposes and to use in rules for controlling other Things such lighting, projector lens control, masking, etc. -Basic playback transport controls are provided and any other command that is supported by the control protocol can be sent to the component through rules based commands. +This binding now makes it possible to easily integrate almost all of the capabilities of the Kaleidescape control protocol into openHAB. +Beyond just integrating playback transport controls, all meta-data provided via the control protocol are made available for display purposes and to use in rules. +By using rules, it is possible to control other Things such lighting, projector lens shift, screen masking, etc. based on events that occur during movie playback. +Finally, any other command that is supported by the control protocol can be sent to the component through rules. See [Kaleidescape-System-Control-Protocol-Reference-Manual.pdf](https://support.kaleidescape.com/article/Control-Protocol-Reference-Manual) for a reference of available commands. -To simplify the design of the binding code, a different Thing instance is created for each component - in a multi-zone system and each Thing maintains its own socket connection to the target component. -Overall this binding supports the majority of information and commands available in the Kaleidescape control protocol but is by no means exhaustive. -Any feedback or suggestions for improvement are welcome. - -The binding supports two different kinds of connections: - -* direct IP connection (preferred), -* serial connection (19200-8-N-1) ## Supported Things -There are four supported thing types, which represent the different models of Kaleidescape components. +All movie player components including the original K-Player series, M Class Players, Cinema One, Alto, and Strato are supported. It is important to choose the correct thing type to ensure the available channels are correct for the component being used. The supported thing types are: `player` Any KPlayer, M Class [M300, M500, M700] or Cinema One 1st Gen player `cinemaone` Cinema One (2nd Gen) `alto` -`strato` Includes Strato, Strato S, or Strato C +`strato` Includes Strato, Strato S, or Strato C + +The binding supports either a TCP/IP connection or direct serial port connection (19200-8-N-1) to the Kaleidescape component. ## Discovery -Manually initiated Auto-discovery will locate all suported Kaleidescape components if they are on the same IP subnet of the openHAB server. -In the Inbox, select Search For Things and then choose the Kaleidescape System Binding to initiate a discovery scan. +Manually initiated Auto-discovery will locate all supported Kaleidescape components if they are on the same IP subnet of the openHAB server. +In the Inbox, select Search For Things and then choose the Kaleidescape Binding to initiate a discovery scan. ## Binding Configuration @@ -76,7 +67,7 @@ The following channels are available: | 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#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#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#play_mode | String | The current playback mode of the movie | | ui#play_speed | String | The speed of playback scanning | @@ -110,7 +101,7 @@ The following channels are available: | 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 | | -- 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#random | Switch | Controls random playback for music | | music#track | String | The name of the currently playing track | @@ -146,7 +137,6 @@ The following channels are available: | 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.) | - ## Full Example kaleidescape.things: diff --git a/bundles/org.openhab.binding.kaleidescape/src/main/resources/OH-INF/binding/binding.xml b/bundles/org.openhab.binding.kaleidescape/src/main/resources/OH-INF/binding/binding.xml index b9be10ebc..58da0d572 100644 --- a/bundles/org.openhab.binding.kaleidescape/src/main/resources/OH-INF/binding/binding.xml +++ b/bundles/org.openhab.binding.kaleidescape/src/main/resources/OH-INF/binding/binding.xml @@ -3,7 +3,7 @@ xmlns:binding="https://openhab.org/schemas/binding/v1.0.0" xsi:schemaLocation="https://openhab.org/schemas/binding/v1.0.0 https://openhab.org/schemas/binding-1.0.0.xsd"> - Kaleidescape System Binding - Controls a Kaleidescape System Movie Player + Kaleidescape Binding + Controls a Kaleidescape Movie Player diff --git a/bundles/org.openhab.binding.kaleidescape/src/main/resources/OH-INF/i18n/kaleidescape.properties b/bundles/org.openhab.binding.kaleidescape/src/main/resources/OH-INF/i18n/kaleidescape.properties index 77bcbbcac..6e993f08f 100644 --- a/bundles/org.openhab.binding.kaleidescape/src/main/resources/OH-INF/i18n/kaleidescape.properties +++ b/bundles/org.openhab.binding.kaleidescape/src/main/resources/OH-INF/i18n/kaleidescape.properties @@ -1,7 +1,7 @@ # binding -binding.kaleidescape.name = Kaleidescape System Binding -binding.kaleidescape.description = Controls a Kaleidescape System Movie Player +binding.kaleidescape.name = Kaleidescape Binding +binding.kaleidescape.description = Controls a Kaleidescape Movie Player # thing types