The Kaleidescape integration allows for the automation of Kaleidescape movie players.
Ideas for automation include:
- Playing and pausing a movie sets lighting scenes.
- The start of movie credits turns up the lights.
- A change in aspect ratio controls a projection masking system.
- A change in video resolution controls a lens system or video scaler.
This integration is intended for the automation of Kaleidescape players with a movie zone. This includes all Strato and Premier players. Strato players support auto-discovery in Home Assistant. Premier players must be added manually by adding an instance of this integration and specifying the IP address of the player.
Adding Kaleidescape to your Home Assistant instance can be done via the user interface, by using this My button:
Kaleidescape can be auto-discovered by Home Assistant. If an instance was found, it will be shown as “Discovered”, which you can select to set it up right away.
If there wasn’t any discovered automatically, don’t worry! You can set up a manual integration entry:
The Kaleidescape media player platform will create a Media Player entity for the device. This entity will display the currently playing media and playback controls.
A typical service call might look like the example below, which sends a command to the device to select the currently highlighted item.
service: remote.send_command target: entity_id: remote.kaleidescape_theater data: command: - select
The Kaleidescape sensor platform will create multiple Sensor entities for the device. The follow sensors are provided:
The location in the current movie.
The play status of the current movie.
The playback speed of the current movie. An integer between 1 (normal) and 3 (fast).
The video mode of the current movie.
The Electro-Optical Transfer Function standard of the current movie.
The color space standard of the current movie.
The color depth standard of the current movie.
The chroma color sampling standard of the current movie.
The actual aspect ratio of the current movie.
The top trim value, relative to the current Screen Mask Ratio. A percentage between -100% and +100%.
The bottom trim value, relative to the current Screen Mask Ratio. A percentage between -100% and +100%.
Has the same possible values as the Screen Mask Ratio, but represents a more conservative estimate of the image aspect ratio.
The position for the top mask in absolute terms, measured from the top of the screen. A percentage between -100% and +100%.
The position for the bottom mask in absolute terms, measured from the bottom of the screen. A percentage between -100% and +100%.
The Cinemascape frame aspect ratio of the current movie.
The Cinemascape mode of the current movie.
Additional details about the values provided by the sensors can be found in Kaleidescape’s Control Protocol Reference Manual.
A typical automation might look like the example below, which turns up the lights when the media_location sensor leaves the content state.
- alias: kaleidescape_theater_lights_up trigger: - platform: state entity_id: sensor.kaleidescape_theater_media_location from: content action: - service: scene.turn_on target: entity_id: scene.theater_lights