kaleidescape Programming Crestron Controllers for a Kaleidescape System May 2015
Contents Who Should Use This Document 8 Getting Started with Crestron 8 Overview of Kaleidescape Modules and Templates 8 Touch Panels and Keypads 9 Touch panels Touch panel variations 9 9 OSD control with a video window 10 OSD control without a video window 10 Standalone touch panel (SATP) control 11 Layout for touch panel user interface 12 Keypads Using Music Presets Music items in the Kaleidescape System 13 13 14 Random and repeat 15 Tags and the Preset ID 15 Zones 16 Saving pres
Controller Zone Name module Importing modules 21 22 Downloading and extracting Kaleidescape modules and templates for Crestron 22 Module contents 22 Automatic import 23 Module version number 24 Updating the modules 25 Scalability 26 System builder 26 Connection methods 26 Programming options 27 Command routing 28 Command routing via TCP/IP 28 Command routing via RS-232 29 Setting the Control Protocol Device ID (CPDID) 29 CPDID addressing example 30 Music zone control 33 Namin
Sample Installation 41 Assigning static IP addresses 42 Configuring TCP/IP clients 43 Configuring touch panels 47 Programming TCP/IP clients 48 Programming touch panels 48 Adding Kaleidescape modules 50 Programming Kaleidescape modules 52 Indicating System Readiness 53 Screen masking and anamorphic lenses 53 CinemaScape mask 54 Lighting and shades 54 Secondary SATP control 55 Volume control 55 Troubleshooting 56 User program commands 56 Nothing is working 58 Music is not ch
Port configuration 65 M500 Player, Music Player, and Cinema One (1st generation) 65 1U, 3U, and 5U Servers 65 RS-232 port pinouts Appendix C: OSD Module v8.4.
Keyboard/Keypad 80 CinemaScape 81 Screen masking 81 Lighting cues 82 Video mode 83 Script control 84 Power 84 System Readiness State 84 Music zone control 84 Child commands Appendix D: SATP Module v8.4.
List window 91 Keyboard 92 System Readiness State 92 Appendix E: Keypad Presets Module v7.1.0 Parameters and I/O Parameters 93 93 Control Protocol Device ID (CPDID) 93 Zone ID 93 Preset ID 93 Hold Time 93 Inputs 93 Outputs 94 Appendix F: Music Collection Module v7.1.0 Parameters and I/O Parameters 96 96 Control Protocol Device ID (CPDID) 96 Zone ID 96 Collection 96 Inputs 96 Outputs 96 Appendix G: Controller Zone Name Module v8.3.
Who Should Use This Document This document explains how to configure a Crestron control system for a Kaleidescape System. Kaleidescape provides modules and templates specifically designed for controlling Kaleidescape Systems using Crestron controllers. The installer must be familiar with the Crestron SIMPL Windows programming environment, Crestron VisionTools Pro-e, and Kaleidescape products. This document revision corresponds to kOS version 6.1, Kaleidescape OSD and SATP modules version 8.4.
o Used with instances of the Kaleidescape App for iPad configured with a controller zone name to receive volume commands and send volume feedback. Kaleidescape modules are designed to provide the flexibility required for many types of installations. System control can be as simple as using a single RS-232 port to control a single movie zone, or as complicated as a large system using multiple TCP/IP clients with complex signal routing to control several movie and music zones.
Touch panel variations are packaged separately and available as downloadable VTP files. Each file is constructed as a single page with sub-pages to manage secondary and tertiary controls within each variation. The corresponding Kaleidescape module must also be downloaded. The touch panel variations in Figures 1 through 3 are screenshots taken from the 1024 × 768 pixel template for the Crestron TPS-15.
This solution has the following requirements: A Kaleidescape movie zone A video display in the same room as the touch panel Figure 2: OSD Control without a video window Standalone touch panel (SATP) control The standalone touch panel (SATP) control provides control for music on touch panels in rooms without video displays, like hallways, dining rooms, and patios, or touch panels with display areas too small to support a large video window.
Layout for touch panel user interface Figure 4 outlines the organization of the Kaleidescape touch panel user interface. This layout complements the Kaleidescape OSD and provides an intuitive method to control the Kaleidescape System. Using a consistent implementation of this grid layout across all panel sizes and control platforms improves overall system usability. Figure 4: Layout for touch panel user interface Selecting the Kaleidescape logo accesses the Kaleidescape menu.
Keypads Keypad commands provide a method for controlling music playback from any zone on any Kaleidescape player without requiring control feedback. Although keypad commands were created for keypads, these commands can use any button-like input, a button on a keypad or touch panel, a motion sensor, or any other input device. Kaleidescape provides two different types of keypad commands.
Music items in the Kaleidescape System The Kaleidescape System treats several different music items as playable. The following table defines these items and the effect of the random and repeat settings on each item.
Random and repeat In the Kaleidescape System, some music items always play in random order and repeat. These music items include any genre, artist, composer, user-defined collection, and all music. When any of these items are saved to a preset and played, the item plays in random order starting with a random track. If the preset is selected again, a new random track plays. This setting removes the requirement to use a next track button to skip a track within the selection.
Zones Presets are shared between all zones on all players in the system. A preset saved on one music zone can be used anywhere in the system. The Keypad Presets module must to be tied to a specific zone. A CPDID and a Zone ID must be assigned in the module to associate the presets with a player and zone in the system. See Programming on page 18 for more information.
Collection browsing A set of buttons can be programmed to browse through the items in a music collection. Any music collection (Albums by Artist, Albums by Title, Artists, Genres, Mix Albums, Classical Composers, Classical Works, New, or any user-defined collection) can be specified. The module provides three controls for browsing: first, next, and previous. These controls step through the collection in the order displayed on the OSD.
Example If the user wants to step through every album in the Kaleidescape System, define a set of buttons to step through the Albums by Artist collection. When the user presses the First Album button, all music plays. This is because the first item on the Albums by Artist collection is All music. If the user subsequently presses the Next button, the first album by the first artist plays, since the collection is sorted alphabetically by artist name.
Device ID Every command and response begins with a device ID which can be a Control Protocol Device ID (CPDID) or the serial number of the component to be controlled. In installations that do not require command routing, the default CPDID None (01 in the ASCII command) is used for all Kaleidescape components. Do not change the default CPDID None unless the installation requires command routing. The CPDID routes commands to the intended zone.
Kaleidescape modules Kaleidescape provides five different types of control modules: OSD module (Onscreen display control) SATP module (Standalone touch panel control) Keypad Presets module Keypad Music Collections module Controller Zone Name module All modules can use either RS-232 or TCP/IP for control. (See Appendix B: RS-232 Port Configuration and Cable Pinout on page 65 for RS-232 pinout.
information on the inputs, outputs and parameters of the SATP module, see Appendix D: SATP Module v8.4.0 Parameters and I/O on page 86. Keypad Presets module The Keypad Presets module provides simple control for music playback from a keypad. The Keypad Presets module associates music items in the system with keypad buttons. Although designed for keypads, any input can be used to trigger a preset and presets can be incorporated into touch panel designs.
Importing modules Downloading and extracting Kaleidescape modules and templates for Crestron Use the following steps to download and extract the Kaleidescape modules and templates for the Crestron system: 1. Download the Kaleidescape modules and templates for Crestron ZIP file (Download all Crestron files) from the Support page on the Kaleidescape website (www.kaleidescape.com/support). 2. Extract the files from the ZIP file to the C:\Crestron\Simpl\PROGRAMS\ folder.
Kaleidescape Presets Processor vX.X.X.ush The Kaleidescape Keypad Music Collections module consists of one file. Kaleidescape Music Collections vX.X.X.umc The Kaleidescape Controller Zone Name module consists of nine files. Kaleidescape Multiple Zone Volume vX.X.X .umc Kaleidescape Initializer for CZN volume control vX.X.X.usp Kaleidescape Zone Volume Pre-Processor vX.X.X.usp Kaleidescape Zone Volume event Processor vX.X.X.usp Kaleidescape Zone Volume feedback Processor vX.X.X.
The user module and SIMPL+ program must be copied to the same directory as shown in the following figure. Figure 6: Module location Module version number The module version number identifies changes both internally and in the interface. The version number of a module is presented in the following format: (major).(minor).(patch) The major version number references major API changes, such as the removal or addition of signals to the module.
Updating the modules Changes in the major or minor revision number are likely to have interface changes that can affect an existing program, and new inputs and outputs might need reconciling. Depending on the subset of the signals used in the installation, these new controls can often be ignored. After updating, open up the program in SIMPL Windows and choose Project and Re-Synch Program to get the new changes.
Scalability The complexity of the Kaleidescape modules is demanding on a Crestron processor. A single, dedicated Crestron CP2E can support the following modules: Up to 15 OSD modules; Up to 15 SATP modules with five users actively browsing; OR Over 90 keypad modules. System builder Imported modules are not currently compatible with System Builder. To be used in System Builder, the modules and templates must be modified.
Programming options In addition to direct physical connections through RS-232 or Ethernet ports, there are other methods of combining Crestron programming with Kaleidescape commands. There are several methods of connecting Kaleidescape module signals to other device modules. The Kaleidescape control protocol also allows for routing commands indirectly, through a single physical connection, to any Kaleidescape player or server (command routing).
All of the methods in Table 3 can be used in the same installation depending on factors such as the cable run length to players, the Crestron processor, and the number of players in the installation. Command routing Command routing allows control of multiple Kaleidescape players with only one connection to the controller. This can be either a TCP/IP or an RS-232 connection to almost any player or server in the system.
multiple servers in the system, the additional servers can be left out of the control programming. Command routing via RS-232 Instead of using a TCP/IP client, all the communications can be routed through a single RS-232 port. As above, connecting through the Kaleidescape server is recommended. However, command routing through the RS-232 control port can cause latency in some cases because of the limited bandwidth of the RS-232 port and is not recommended.
Figure 7: Component Settings button Click on Settings 5. Select the CONTROL tab from the Settings page. 6. Select the Control Protocol Device ID (None, 02 through 99) from the dropdown menu. Select None only if command routing is NOT used for this device as shown in the following figure. Figure 8: Control tab Select None 7. 8. Click OK. The device does not have to be rebooted.
Figure 9: CPDID addressing example Each of the M500 Players is controlled from a Kaleidescape OSD module. The OSD modules must be configured to match the CPDIDs assigned to the players in the browser interface. The field for the CPDID is near the bottom of the module.
Figure 11: Configuring the module CPDID with Zone ID If the controller directs the Music Player to play the selected music in zone 3, the SATP module sends the following text command: 06.03/1/PLAY:\r The 1U Server receives the command and reroutes the command to the Music Player (CPDID 06) via TCP/IP over Ethernet. The Music Player identifies the Zone ID of the command and plays back music in zone 3. The response is directed through the 1U Server back to the SATP module for zone 3.
Music zone control Music zone control provides control for any music zone in a Premiere line system from the OSD for a movie zone. Setting music zone control in the browser interface allows the user to select any zone from the movie zone onscreen display. Now Playing shows what is playing in the currently selected zone. Music zone control is not supported on Cinema One (2nd generation). Naming music zones Music zone names appear in the OSD to identify the controlled music zone.
Controlling music zones Use the following steps to set music zone control. 1. Open the browser interface using: http://my-kaleidescape/ http://my-kaleidescape.local (Windows) (Mac) 2. Select the SETTINGS tab as shown in Figure 13. 3. Select Any music zone in the system can be controlled from the onscreen display radio button. Figure 13: General Setting’s page Select Any music zone in the system can be controlled from the onscreen display 4. Click Save Changes.
When the user selects Control Zone, the Select Music Zone dialog box appears with all the available music zones in the system, labeled with the names assigned in the Kaleidescape browser interface. Figure 15: Select Music Zone dialog box If the OSD is not controlling the local zone when the user selects new music for playback, a reminder that control is for a different music zone will appear. The user then has the option to confirm playback or to select another music zone.
Figure 17: OSD music zone control using a CPDID Serial number control To select which zone to control using the component serial numbers, setup a Serial I/O with the serial numbers and Zone ID of the music zones that the OSD is to control. Figure 18 shows how to use a component serial number to initiate control.
Figure 19: OSD music zone using serial number The Control_1234_zone1_fb signal is high while the OSD is controlling zone 1 of component 1234 and the Control_1234_zone2_fb signal is high while the OSD is controlling zone 2 of component 1234. In an actual program, these functions are usually combined into a single Serial I/O symbol.
Controlling a movie zone with both SATP and OSD control To use both the standalone touch panel (SATP) and the onscreen display (OSD) interface to control a movie zone, like the single zone output of an M500 Player, the user can select music from a touch panel without turning on the video display.
Power control Whether to connect to a component via RS-232 or TCP/IP might be determined by how the power state of the component is managed. Both connection types support power off (ENTER_STANDBY) commands, but not all components can respond to a power on (LEAVE_STANDBY) command over TCP/IP. Power on commands work for all M500, 1080p, Music, and Movie Players receiving the command from an RS-232 connection. Note: Mini players, Alto, and Cinema One (2nd generation) do not have an RS-232 control port.
Power control for the 1080p Player, 1080p Mini Player, Music Player, and Movie Player 2 The Ethernet port for the 1080p Player, 1080p Mini Player, Music Player, and Movie Player 2 is powered while in standby — but in a limited mode. If the ENTER STANDBY command is sent to the component over TCP/IP, initially there is no response. After a moment, the network connection drops, and is then re-established. The component is now in limited mode and responds only to a limited set of commands.
Power control for Alto and Cinema One (2nd generation) The default standby behavior is similar to Cinema One (1st generation): it responds to ENTER_STANDBY and LEAVE_STANDBY commands, and sends DEVICE_POWER_STATE events to indicate a change in power state. Alto and Cinema One (2nd generation) also have a user-selectable option for low power standby mode. If this option is selected, standby mode acts like a full power OFF state and the device will not respond to ENTER_STANDBY or LEAVE_STANDBY commands.
Bedroom and Sunroom The Bedroom and Sunroom each have a TPS-4L to control music zones 2 and 3 of the Music Player. Each music zone will be controlled with a separate SATP module. Master Bedroom The Master Bedroom uses a universal remote to control the local M500 Player. Kitchen The Kitchen has a TPS-12, but a video cable could not be wired to that location, so the OSD No Video template will be used. The M500 Player will be controlled using the OSD module and OSD Video template.
http://my-kaleidescape/ (Windows) http://my-kaleidescape.local/ (Mac) 2. Select the SETTINGS tab. 3. Click on Components in the second row of tabs. 4. Click on the Settings button for the component. 5. Select the NETWORK tab. Information about the current network configuration for the component is displayed. Figure 23: Static IP address assignment under the NETWORK tab Select Use the following IP configuration 6. Select the Use the following IP configuration radio button. 7.
Use the following steps to add TCP/IP clients to the Crestron program. 1. Open SIMPL Windows and click the Configure button to enter the Configure view. Figure 24: Configure button 2. Drag five TCP/IP clients into the program from the Device Library Ethernet Control Modules/Ethernet Intersystem/Device Communications folder. Figure 25: Device Communications folder 3. Double-click the icon for TCP/IP client to configure. The Device Settings: Crestron TCP/IP Client window appears.
Figure 26: Device Settings: Crestron TCP/IP Client window 4. Enter a descriptive name for the music zone or movie zone TCP/IP client in the Device Name text box, for example, KMUSIC Z3. 5. Enter a descriptive name for the location of the zone in the Device Location text box, for example, KMusic-Bedroom and KPlayer-Family Room. 6. Select the IP Net Address tab. 7. Enter the corresponding IP address that was assigned in Assigning static IP addresses on page 42. Figure 27: IP Net Address tab 8.
9. Repeat steps 3 through 8 for each TCP/IP client. Remember that music zones 3 and 4 share the IP address of the Music Player (192.168.1.54). The TCP/IP clients are now labeled with the device names.
Configuring touch panels Touch panels must be added to the program and named. The signal names from the TPS-15 samples in the Kaleidescape OSD Demo and Kaleidescape SATP Demo programs are copied later. Use the following steps to add and name touch panels. 1. While still in the Configure view, open the Device Library Touchpanels/Touchpanels (Cresnet) folder and find the touch panel symbols. Figure 29: Touch panel symbols 2. Select and drag two TPS-4L, one TPS-12, and two TPS-15 symbols into the System view.
Programming TCP/IP clients The communication port must be set and the Connect-F, TX$, and RX$ signals renamed for each TCP/IP client. Use the following steps to enter the port number, and name the TX$, RX$, and Connect-F signals. 1. Click the Program button. Figure 32: Program button 2. Open the Central Control Modules folder in the Program view. 3. Find the TCP/IP client in the Ethernet slot list. 4. Open each TCP/IP client and set Port to 10000. 5. Set the Connect input to 1. 6.
In this example, the TPS-15 signals from the SATP Demo program are used for the TPS-4L touch panels. Use the following steps to copy signal names from TPS-15 in the demo modules. 1. Open a new instance of SIMPL Windows. 2. From the File menu, open the Kaleidescape OSD Demo program. 3. Click the Program button. Figure 34: Program button 4. In the Detail view, scroll to the TPS-15 symbol. Copy the digital input signals. 5.
10. Click Yes. If a prompt appears to name unconnected signals, click No. 11. Return to the Kaleidescape OSD Demo program and repeat steps 4 through 10 for the remaining input and output signals: digital, analog, and serial. 12. Copy all the signals from the Kitchen TPS-12 that was just created. a. Select the touch screen symbol in the Program view. b. Right-click and drag the symbol over the Family Room symbol. A menu appears. Figure 37: Copy/Move menu c. Select Copy All Signals/Parameters. d.
5. From the File menu, open the Kaleidescape OSD Demo program. 6. Select the symbol S-2: Kaleidescape OSD v8.4.0 in the Logic folder and press CtrlC to copy. 7. Return to the program and select the Logic folder. 8. Press Ctrl-V three times to paste three copies of the module in the Logic folder. Figure 39: Copying into the Logic folder 9. For clarity, organize the program by moving everything into subsystems based on zones.
Programming Kaleidescape modules Each module must be made unique by modifying the signal names of the sample modules. Use the following steps to modify signal names. 1. Select the Bedroom subsystem (music zone 3) and press F9. The Search and Replace window appears. Figure 41: Search and Replace window 2. For all the Inputs and Outputs, replace Kaleidescape_ with KMusicZ3_. 3. Click OK. 4.
In this installation example, all Control Protocol Device ID parameters are correctly set to the default CPDID None(01d ) because the example does not use any command routing. Indicating System Readiness A Kaleidescape system will automatically enter idle mode when it is not being used. The digital signals shown in the following figure can be used to track the system readiness state and provide feedback on a touch panel when the Kaleidescape system is not ready or becoming ready.
3. Find the [Mask …] output signals in the Masking_Data roll-up. These outputs go high to indicate the type of picture being shown. Figure 45: Mask output signals 4. Tie these outputs directly to a Serial I/O symbol to use with the masking system. If the projector in this installation used an anamorphic lens, the projector can be controlled using the anamorphic outputs in the Video_Mode roll-up.
IR commands. For more complex lighting systems, tie these signals to the logic or module being used to control the lights. Secondary SATP control In the sample installation, the owner decides to add a second SATP touch panel in the Bedroom, for example, a TPMC-8X. The SATP template for the TPMC-8X uses 16 lines of text for display, instead of the 6 lines on the TPS-4L.
2. Connect the [Volume Up], [Volume Down], [Volume Mute] signals on the output side of the Kaleidescape module to the module of the device controlling volume. 3. Connect the mute feedback and volume level from the module of the device controlling volume to [Mute_On_fb] and [Vol_Level] inputs on the Kaleidescape module. The Kaleidescape App for iPad displays the volume as a percent. The volume level from the device should be scaled to values from 0 to 100.
K DEBUG Enables debugging on all modules at run time. All modules report that debugging is turned on. K DEBUG Enables debugging on only the modules controlling a player with the matching CPDID. This command is helpful in installations using command routing. K STOP DEBUG Stops debugging output on all modules. K ID Makes all modules report the CPDID of the component the modules are controlling. If the component CPDID is set to None, the module reports 01.
Nothing is working 1. If using TCP/IP, open up ViewPort or the Toolbox Console and type est to check the Ethernet status. Verify that the TCP/IP client is connected. If the TCP/IP client is not connected, Verify that TCP/IP client is attempting to connect to the proper IP address. Verify that a 1 has been placed on the Connect input of the TCP/IP client. Verify that port 10000 is being used on the TCP/IP client.
No video on the touch panel with a video window 1. If using S-Video, verify that the Y and C connections are not reversed. (Try reversing the connections, just to be sure.) 2. Verify that the TPS/IMPC (the device where the video cables terminate) is receiving power either through Cresnet or the power connector. Note: A touch panel can be powered by the TPS/IMPC, but a TPS/IMPC cannot be powered by a touch panel. 3. Verify that the video input for the touch panel is set correctly.
Appendix A: Screen Shots for UI Layouts OSD control with a video window — Music Programming Crestron Controllers for a Kaleidescape System Page 60
OSD control with a video window — Movies Music can be playing while selecting a movie to watch. The playback status box in the lower left corner feeds back either movie or music information. This layout shows the keyboard pop-up after selecting the SEARCH… button.
OSD control without a video window — Music Programming Crestron Controllers for a Kaleidescape System Page 62
OSD control without a video window — Movies This layout shows the keyboard pop-up after selecting the SEARCH… button. Music can be playing while selecting a movie. The playback status box in the lower left corner feeds back either movie or music information.
Standalone touch panel Programming Crestron Controllers for a Kaleidescape System Page 64
Appendix B: RS-232 Port Configuration and Cable Pinout Port configuration M500 Player, Music Player, and Cinema One (1st generation) If the RS-232 port is used to communicate with a Kaleidescape player or Cinema One, use the following default communication parameters: Baud rate Data bits Stop bits Parity Flow control 19200 8 1 N N RS-232 communication parameters can be changed on the installer pages of the browser interface.
Appendix C: OSD Module v8.4.0 Parameters and I/O Parameters Control Protocol Device ID (CPDID) This must match the CPDID of the component as set through the Kaleidescape browser interface (http://my-kaleidescape/ ). None is the default. When using None, the Crestron processor must be directly connected to the designated component. Time Update Interval This indicates whether the component should update the time remaining.
[Fast_Forward], [Rewind] Performs the associated transport action. Each press steps through different speeds. [Play] resumes the content at normal speed. [Instant_Replay] Skips backward five seconds on each rising edge. [Skip_Forward], [Skip_Reverse] Moves to the next or previous chapter. On some screens this also acts as [Page_Up] or [Page_Down]. [Intermission_Toggle] Activates the intermission if not currently active. If intermission is already active, deactivates.
Navigation [Up], [Down], [Left], [Right] OSD navigation controls. Can be held down to speed the user through whatever list or menu currently being navigated. [Page_Up], [Page_Down] For OSD screens showing a list, scrolls the list up or down by several lines at a time. Can be held down to speed the user through whatever list or menu currently being navigated. Not required for basic navigation.
OSD menu control [Kaleidescape_Menu_Toggle] Toggles the display of the Kaleidescape menu. The Kaleidescape menu can be used as a guide to take the user to any location in the Kaleidescape OSD. This menu pops up over whatever activity the user is currently engaged in. The [Menu_x] commands below are shortcuts to different selections within the Kaleidescape menu. [Kaleidescape_Menu_On] Like [Kaleidescape_Menu_Toggle], but only causes the Kaleidescape menu to pop up.
[Screen_Saver] Activates the screen saver, if not already active. [Screen_Saver_Stop] Stops the screen saver. Performs no operation if the screen saver is not active. [Child_Safe_Level] Instantly sets the parental control level to the next level below the lowest level with a password. [Default_Parental_Control_Level] Changes the parental control level to the default level set on the browser interface. [Shuffle_Cover_Art] Shuffles the covers shown on the screen.
Movie playback [Disc_Menu] For most DVD or Blu-ray discs, this command calls up the disc menu. The operation of this key can vary from disc to disc. This command can also cue the lighting system, if so configured. [Disc_Top_Menu] For most DVD or Blu-ray discs, returns to the main disc menu. The operation of this key can vary from disc to disc. [DVD_Resume] For most DVDs, dismisses the DVD menu and returns to the previously viewed content. The operation of this key can vary from disc to disc.
[Start_Chapter_Entry] Used to enter a chapter number during content playback. Use the [Select] command as an enter key. [Start_Chapter_Entry_Clock] This activates the [Start_Chapter_Entry] or [Cancel] command in the OSD depending on the state of [Keypad_Active]. This command toggles the chapter entry on and off during playback. [Audio_Next] During movie playback, changes to the next audio stream. At other times this command has no effect.
Volume control [Mute_On_fb], [Vol_Level] The module passes this feedback to the Kaleidescape App for iPad when not configured with a controller zone name so that the user can see the current volume level and mute state. Keyboard/Keypad Keyboard input is used for filtering movie or music lists, jumping to a specific place in the list, for naming favorite scenes and for naming mix albums.
[Mask_Calibrated_Top] and [Mask_Calibrated_Bottom] values. [Calibrate_Masking_Overscan] Causes the OSD to change to the Calibrate Masking Overscan screen. This screen is used to indicate the position of the overscan onto the Kaleidescape movie zone. This overscan data is used in calculating the [Mask_Calibrated_Top] and [Mask_Calibrated_Bottom] values. Script control [Play_Script$] Use a Serial I/O (SIO) symbol to send the name of the script to play to this input.
Music zone control [Zone_to_Control$] Sets the local movie zone to control a (possibly remote) music zone. Input can define the device to control either by serial number or by CPDID. A 01.01 always returns to local control. See Music zone control on page 33 for more information. Outputs {{Tx$}} Used for connection to the TX$ signal of the connected RS-232 or TCP/IP client.
[Menu_Music_Place_fb] Indicates that the OSD is in a music place. This is high when [Menu_Music_List_fb], [Menu_Music_Covers_fb], [Menu_Music_Collections_fb], or [Menu_Music_Now_Playing_fb] are high. [Movie_Capable] Indicates that the Kaleidescape System is capable of movie playback. As of control protocol version 6.2, this capability is always assumed to be true. [Menu_Movie_List_fb] Indicates that the OSD is currently in the Movie List view.
a selected period of inactivity. This setting defaults to five minutes. [Screen_Saver_fb*] The inverse of [Screen_Saver_fb]. [Details_Popup_fb] Indicates that the Details screen is visible on the OSD. [Quick_Search_Keyboard_Active] Feedback for showing the quick search keyboard. If any key is pressed on the keyboard, this feedback signal goes low. [Passcode_Entry_fb] Indicates that the Parental Control Passcode dialog box is being displayed onscreen. Used for parental control.
[Main_Content_fb] Indicates that the main video content is playing. This is low during trailers, special features, and the disc menu. [Ending_Credits_fb] Indicates that the end credits are being shown. [Favorite_Scene_fb] Indicates that the touch panel should display the favorite scene start and end buttons. [Status_and_Settings_fb] Indicates that the movie overlay is active. [Popup_Status_fb] Indicates that the movie overlay is active and displaying the status option.
[Now_Playing_Cover_URL$] A touch panel that supports dynamic graphics can use this signal to display cover art for the content currently playing. The following nine signals [Title_x] and [Chapter_x] can be used to display information about the content currently playing. If the Time Update Interval parameter is set to 1, the signals update once per second, otherwise the signals only update when the chapter or title changes. Note that on a DVD, each title usually contains full content, i.e.
Details page [Details_Visible] Used to drive the details page on the touch panel. This is high when the details can be displayed and low when details have been made obsolete by an onscreen change. Details should not be displayed when this is low. [Details_Text$] A complete description of the item currently highlighted in the OSD, formatted to be similar to the text of the details page of the item on the OSD. [Details_Title$] The title of the content that is currently highlighted in the OSD.
[User_Input_Prompt$] Used for the keyboard and keypad input. Indicates what input is being prompted for on the OSD. [User_Input_Text$] Used for keyboard and keypad input. Indicates what input has already been entered on the OSD. CinemaScape [1.78_(CinemaScape_Off)_fb], [CinemaScape_2.35_Anamorphic_fb], [CinemaScape_2.35_Letterbox_fb], [CinemaScape_Native_2.35_fb] Indicates which CinemaScape Mode the player is currently in.
[Mask_1.33], [Mask_1.66], [Mask_1.78], [Mask_1.85], [Mask_2.35] Indicate the actual aspect ratio of the video content (as opposed to the full-frame content stored on the DVD or Blu-ray disc). These signals can be used to recall presets on a masking system or scaler. [Conservative_1.33], [Conservative_1.66], [Conservative_1.78], [Conservative_1.85], Conservative_2.35] The [Conservative_x] signals are similar to the [Mask_x] signals, but represent a more conservative estimate of the image aspect ratio.
Video mode [Frame_4x3], [Frame_16x9] Indicate the full-frame aspect ratio of the video content output by the movie zone. This allows for adjustments for any external scaling that gets applied to the video frame. If the video output is configured to correct for 16:9, then [Frame_16x9] will remain high and black bars will be put in the image to correct any 4:3 content. Similarly, when correcting for 4:3; black bars will be put in the image to correct any non4:3 content. [16x9_Frame_with_2.
[x_720p50] 720p HD [x_1080i60] 1080i (North America) [x_1080i50] 1080i HD [x_1080p60] 1080i (North America) [x_1080p50] 1080i HD [x_1080p24] 1080i HD [x_4x3] 4:3 output [x_16x9] 16:9 output [x_64x27] 64:27 output Script control [Script_User_Command$] A script can contain a step that sends a string to the control system. That string appears in this output and can be matched with a Serial I/O (SIO) symbol to trigger custom programming.
(plus .01) of the local device. See Music zone control on page 33 for more information. Child commands [Child_Play] If child user interface is already active, performs the associated transport action. If not, activates child user interface if the child user interface is not active. [Child_Stop] [Child_Pause] [Child_Up], [Child_Down], [Child_Left], [Child_Right] If already in child user interface, navigates the covers view. If not, activates the child user interface.
Appendix D: SATP Module v8.4.0 Parameters and I/O Parameters Control Protocol Device ID (CPDID) This must match the CPDID of the component as set through the Kaleidescape browser interface (http://my-kaleidescape). None is the default. When using None, the Crestron processor must be directly connected to the designated component. Zone ID This indicates which zone output to control on the Kaleidescape player. Time Update Interval This indicates whether or not the component updates the time remaining.
Transports [Play], [Stop], [Pause], [Pause_On], [Pause_Off], [Fast_Forward], [Rewind], [Skip_Forward], [Skip_Reverse] Performs the associated transport action. [Play_or_Pause] Performs a play action or pause action depending on the current playback state. If music is playing, this input pauses music playback. If music is stopped or paused, this input resumes playback. Playback control [Random] Toggles random music playback.
[List_Back] Causes the List window to show the previous list. The back information between the Now Playing view and Browse view are independent. [Keyboard_Search] Activates the keyboard pop-up to allow a search string to be entered. [List_Scroll_Bar_Act] An analog input to allow the list to scroll. [List_Up] Moves the List window up one page. [List_Down] Moves the List window down one page. [List_Highlight_Act] An analog input to allow the highlight to scroll through the list.
[Alphapad_x] For a smaller, predictive text (cell phone style) keyboard, each button can represent multiple characters. For example, the 2 button can trigger [2ABC], which would then match any item with either a 2, A, B or C in that position. [Other_Key_Inputs$] If other keyboard characters are required, create a Serial I/O (SIO) symbol and populate the symbol with the required keys. Each key should only send a single character at a time to this input.
on because some music always plays back in random order. See Music items in the Kaleidescape System on page 14 for details. [Repeat_Status] Indicates that music is playing back repeatedly. Note that this will sometimes remain on because some music always repeats. See Music items in the Kaleidescape System on page 14 for details. Playback information [Music_Playback_Active] This signal is active while music playback is occurring. [Song_Length] Length of the song currently playing, expressed in seconds.
[Now_Playing_Selected] Indicates that the Now Playing view is shown in the List window. [List_Back_Available] Indicates that the user can go back to the previous list. This can be used to show the BACK button as enabled or disabled. [Keyboard_Search_Available] Active when the touch panel is displaying a list that can be searched. [Keyboard_Search_Active] Active when the keyboard is required to accept a search string from the user.
[List_Queue_Status1], [List_Queue_Status20] Feedback to show the queue status of each line of the list. These values will either be 1 (playing), 2 (paused) or 3 (in the queue). This should be used to show a small icon adjacent to each line in the List window. Keyboard [Keyboard_Title$] Text describing the current function of the keyboard. For example, while searching for an artist, this will contain Search Artists.
Appendix E: Keypad Presets Module v7.1.0 Parameters and I/O Parameters Control Protocol Device ID (CPDID) This must match the CPDID of the component as set through the Kaleidescape browser interface (http://my-kaleidescape/). None is the default. When using None, the Crestron processor must be directly connected to the designated component. Zone ID This indicates which zone output to control on the Kaleidescape player. Preset ID A text identifier used for the set of presets.
[Random] Toggles random music playback. Note that this does not always function because some music always plays back in random order. See Music items in the Kaleidescape System on page 14 for details. [Repeat] Toggles repeat music playback. Note that this does not always function because some music always repeats. See Music items in the Kaleidescape System on page 14 for details. [Preset_Lock] When this input is high, saving any preset is disabled.
name. If the user is playing an album, it displays the album name. If the user is playing all music by a particular artist, the artist name is displayed. [Now_Playing_Track$] The title and artist for the track currently playing given in the format
- <artist>. [Play_fb], [Stop_fb], [Pause_fb], [Fast_Forward_fb], [Rewind_fb] Transport feedback. Only one of these signals is active at any given time. [Play-Pause_fb] Same feedback as [Play_fb].</p></li><li><h6><a class="text-decoration-none text-link fw-bold" href=/manual/crestron/cp2e/installation-guide-english/page-96.html>PAGE 96</a></h6><p>Appendix F: Music Collection Module v7.1.0 Parameters and I/O Parameters Control Protocol Device ID (CPDID) This must match the CPDID of the component as set through the Kaleidescape browser interface (http://my-kaleidescape/). None is the default. When using None, the Crestron processor must be directly connected to the designated component. Zone ID This indicates which zone output to control on the Kaleidescape player. Collection The music collection that this module will cycle through.</p></li><li><h6><a class="text-decoration-none text-link fw-bold" href=/manual/crestron/cp2e/installation-guide-english/page-97.html>PAGE 97</a></h6><p>[System_Ready] Indicates that the Kaleidescape system is ready. [System_Becoming_Ready] Indicates that the Kaleidescape system is becoming ready from an idle state. [System_Not_Ready] Indicates that Kaleidescape system is idle.</p></li><li><h6><a class="text-decoration-none text-link fw-bold" href=/manual/crestron/cp2e/installation-guide-english/page-98.html>PAGE 98</a></h6><p>Appendix G: Controller Zone Name Module v8.3.0 Parameters and I/O This module provides an interface for volume commands and feedback between your program and instances of the Kaleidescape App for iPad configured with a controller zone name. The controller zone name in the received command is checked against the controller zone name parameter and the corresponding output is pulsed. When an input changes a string is generated with the corresponding controller zone name parameter.</p></li><li><h6><a class="text-decoration-none text-link fw-bold" href=/manual/crestron/cp2e/installation-guide-english/page-99.html>PAGE 99</a></h6><p>Appendix H: Revision History Crestron OSD module Version 8.4.0 Added support for SYSTEM_READINESS_STATE messages Version 8.3.0 Added support for Scale Mode Increased the maximum size of _symbolInstance and made the sizing dynamic to prevent errors when deeply nesting the module. Changed the CPDID text field to a drop down menu. Added “Don’t send volume capabilities” to the volume capabilities drop down menu in case two modules are controlling the same zone.</p></li><li><h6><a class="text-decoration-none text-link fw-bold" href=/manual/crestron/cp2e/installation-guide-english/page-100.html>PAGE 100</a></h6><p> Added [16x9_Frame_with_2.35_Image] and [16x9_Frame_with_2.35_Image] outputs. Added [Mask_Calibrated_Top] and [Mask_Calibrated_Bottom] outputs. Added [Random_Toggle] and [Repeat_Toggle] inputs for music playback. Added power status signals: [Power_on_fb] and [Power_off_fb]. [Now_Playing_Cover_URL] can also return movie cover URLs. Changed join numbers in demo program. Version 6.3.1 This version has been successfully tested using CUZ 4.0 Beta release.</p></li><li><h6><a class="text-decoration-none text-link fw-bold" href=/manual/crestron/cp2e/installation-guide-english/page-101.html>PAGE 101</a></h6><p> Added System Builder Device Support definitions so that the module can more easily be found in the database. Modified signal names to hide unnecessary signals in System Builder. Modified many signal names to clarify their purpose. Crestron SATP module Version 8.4.0 Added support for SYSTEM_READINESS_STATE messages Version 8.3.0 Increased the maximum size of _symbolInstance and made the sizing dynamic to prevent errors when deeply nesting the module.</p></li><li><h6><a class="text-decoration-none text-link fw-bold" href=/manual/crestron/cp2e/installation-guide-english/page-102.html>PAGE 102</a></h6><p>Version 7.0 Module reorganized to use signal roll-ups. Added version number to file names. Added keyboard and keypad inputs. Changed join numbers in demo program. Added [Random_Toggle] and [Repeat_Toggle] inputs for music playback. Added [Zone_Name$] to return the name of the currently controlled zone. Version 6.3.0 Changed Connection_Reset to Connect-F in sample code to clarify its purpose. Corrected system name in sample program.</p></li><li><h6><a class="text-decoration-none text-link fw-bold" href=/manual/crestron/cp2e/installation-guide-english/page-103.html>PAGE 103</a></h6><p> Modified signal names to hide unnecessary signals in System Builder. Modified many signal names to clarify their purpose. Crestron Keypad module Version 7.1.0 Added support for SYSTEM_READINESS_STATE messages Version 7.0.3 Increased the maximum size of _symbolInstance and made the sizing dynamic to prevent errors when deeply nesting the module. Changed the CPDID text field to a drop down menu. Version 7.0.2 Significant speed improvements.</p></li><li><h6><a class="text-decoration-none text-link fw-bold" href=/manual/crestron/cp2e/installation-guide-english/page-104.html>PAGE 104</a></h6><p> Modified many signal and variable names to clarify their purpose. Version 6.1.0 Initial implementation of keypad API. Crestron Controller Zone Name (CZN) module Version 8.3.0 Initial release of the module to parse volume commands coming from the Kaleidescape App for iPad configured with a Controller Zone Name. Crestron touch panel templates Versions Dated 2011-03-01 Added search and jump to collections page. Versions Dated 2010-04-29 Added Blu-ray disc color buttons to templates.</p></li><li><h6><a class="text-decoration-none text-link fw-bold" href=/manual/crestron/cp2e/installation-guide-english/page-105.html>PAGE 105</a></h6><p> Placed a PLAY button over the browse cover on OSD No Video touch panel templates.</p></li><li><h6><a class="text-decoration-none text-link fw-bold" href=/manual/crestron/cp2e/installation-guide-english/page-106.html>PAGE 106</a></h6><p>Notices Document Name: Programming Crestron Controllers for a Kaleidescape System Document Number: 101-0130-00 Permanent Link: www.kaleidescape.com/go/programming-crestron-controllers Publication Date: May 2015 This document revision corresponds to kOS version 6.1, Kaleidescape OSD and SATP modules version 8.4.0, Zone Name module 8.3, and Keypad modules 7.1.0. This document is for informational purposes only.</p></li></ul></nav></div></section></section></main><footer class=page-footer><div class="container flex-column py-3 py-sm-4"><div class="row mb-1 mb-sm-2 mb-md-5"><a href=/ class="brand offset-sm-0 col-sm-4 col-md-3 col-lg-2 offset-2 col-8 text-center text-md-start"><img class=logo-small src=/assets/img/brand-large.png alt=Manualshelf></a></div><div class=row><dl class="text-center text-sm-start col-sm-3"><dt class=fw-bold>Who We Are</dt><dd><a class=text-decoration-none href=/about>About Us</a></dd><dd><a class=text-decoration-none href=/company>Company</a></dd><dd><a class=text-decoration-none href=/careers>Careers</a></dd><dd><a class=text-decoration-none href=/terms>Terms & Privacy</a></dd></dl><dl class="text-center text-sm-start col-sm-3"><dt class=fw-bold>Resources</dt><dd><a class=text-decoration-none href=/brands>List of Manufacturers</a></dd><dd><a href=/ class=text-decoration-none>Support</a></dd><dd><a class=text-decoration-none href=/press>For the Press</a></dd><dd><a class=text-decoration-none href=/press#assets>Media assets</a></dd><dd><a class=text-decoration-none href=/faq>FAQ</a></dd></dl><dl class="text-center text-sm-start col-sm-3"><dt class=fw-bold>Get in touch</dt><dd><a class=text-decoration-none href=#>Blog</a></dd><dd><a class=text-decoration-none href=#>Email</a></dd><dd><a class=text-decoration-none href=/dmca>DMCA</a></dd></dl></div><div class=row><div class="text-center text-sm-start col-sm-4 pe-sm-0"><a href=https://www.facebook.com/pages/ManualShelf/1488826334681423 class="fs-5 text-center d-inline-block social rounded-2 align-middle text-decoration-none me-2"><i class="fab fa-facebook-f"></i></a><a href=https://www.twitter.com/ManualShelf class="fs-5 text-center d-inline-block social rounded-2 align-middle text-decoration-none me-2"><i class="fab fa-twitter"></i></a><a href=https://plus.google.com/+ManualShelf class="fs-5 text-center d-inline-block social rounded-2 align-middle text-decoration-none me-2"><i class="fab fa-google-plus-g"></i></a><a href=http://www.pinterest.com/ManualShelf class="fs-5 text-center d-inline-block social rounded-2 align-middle text-decoration-none"><i class="fab fa-pinterest-p"></i></a></div><div class="col col-sm-8 d-flex flex-column align-items-center flex-sm-row flex-wrap flex-sm-nowrap justify-content-center justify-content-sm-end"><div class="copy w-auto d-flex align-items-center justify-content-center justify-content-sm-end mt-2 mt-sm-0 me-2">ManualShelf © 2013-2025</div><select class="form-select form-select-sm w-auto mt-2 mt-sm-0"><option value=usa>USA</option></select><div></div></div><div id=pixel><script>
googletag.cmd.push(function() { googletag.display('pixel'); });
</script></div></footer><script src=/assets/js/jquery-3.3.1.min.js></script><script src=/assets/js/bootstrap.bundle.min.js></script><script src=/assets/js/jquery.autocomplete.min.js></script><script type=text/javascript>
$.extend({
redirectPost: function(location, args) {
var form = '';
$.each(args, function(key, value) {
form += '<input type="hidden" name="' + key + '" value="' + value + '">';
});
form = '<form id="s1" action="' + location + '" method="POST">' + form + '</form>';
$(document.body).append(form);
$("#s1").submit();
}
});
$(document).ready(function(){
$("#query").autocomplete({
minChars: 3,
groupBy: 'type',
paramName: 'q',
dataType: 'json',
serviceUrl: '/autocomplete',
noCache: true,
showNoSuggestionNotice: true,
noSuggestionNotice: 'Zarro results found',
onSelect: function (suggestion) {
$.redirectPost(suggestion.data.url, {highlight: encodeURIComponent(JSON.stringify(suggestion.data.hls))});
}
});
var toc = $('.toc-selector');
if (toc.length) {
var slideParams = { duration: 800, easing: 'linear' };
toc.click(function() {
$(this).toggleClass('open');
var section = $('.toc-content');
var isCollapsed = section.attr('data-collapsed') === 'true';
if (isCollapsed) {
section.slideDown(slideParams)
section.attr('data-collapsed', 'false')
} else {
section.slideUp(slideParams);
section.attr('data-collapsed', 'true')
}
});
}
});
var lastSmall = $(window).width() < 576;
$(window).resize(function() {
var newSmall = $(window).width() < 576;
if (lastSmall != newSmall) {
lastSmall = newSmall;
window.location.href = window.location.href;
}
});
</script></body></html>
