public
/
openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[kaleidescape] update README (#13593) 

* update README

Signed-off-by: Michael Lobstein <michael.lobstein@gmail.com>
This commit is contained in:
mlobstein 2022-10-29 03:43:32 -05:00 committed by GitHub
parent af4657f3db
commit 99e309e991
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,25 +1,14 @@
# 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:
@ -28,10 +17,12 @@ The supported thing types are:
`alto`
`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
@ -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:

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

@ -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">
<name>Kaleidescape System Binding</name>
<description>Controls a Kaleidescape System Movie Player</description>
<name>Kaleidescape Binding</name>
<description>Controls a Kaleidescape Movie Player</description>
</binding:binding>

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

@ -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