Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mvdwetering/huesyncbox

Custom integration for Home Assistant to control the Philips Hue Play HDMI Sync Box
https://github.com/mvdwetering/huesyncbox

hacs homeassistant-integration hue-entertainment huesync philips-hue

Last synced: about 13 hours ago
JSON representation

Custom integration for Home Assistant to control the Philips Hue Play HDMI Sync Box

Awesome Lists containing this project

README 

        
# Philips Hue Play HDMI Sync Box



[![Contributors](https://img.shields.io/github/contributors/mvdwetering/huesyncbox.svg)](https://github.com/mvdwetering/huesyncbox/graphs/contributors)



Custom integration for the Philips Hue Play HDMI Sync Box. 

Both 4K and 8K are supported.



- [About](#about)

  - [Behavior](#behavior)

  - [Actions](#actions)

- [Updating from before version 2](#updating-from-before-version-20)

- [Installation](#installation)

  - [Home Assistant Community Store (recommended)](#home-assistant-community-store-hacs)

  - [Manually](#manually)



## About



> Please set up the Philips Hue Play HDMI Syncbox with the Hue App first and make sure it works before setting up this integration.



This integration exposes the Philips Hue Play HDMI Sync Box in Home Assistant so it can be used in automations or dashboards.



The Philips Hue Play HDMI Sync Box will be discovered automatically in most cases and otherwise can be added manually through the `Settings > Devices and Services` menu in Home Assistant.



The following features are available:



* Power on/off

* Light sync on/off

* Intensity (subtle/moderate/high/intense)

* Sync mode (video/music/game)

* HDMI Input selection

* Brightness control

* Entertainment area selection

* HDMI input connection status

* Dolby Vision compatibility on/off (only on 4K)

* LED indicator mode

* Bridge connection status ⁺

* Bridge ID ⁺

* IP address ⁺

* Wifi quality ⁺

* Content info ⁺



Entities marked with ⁺ are disabled by default.



### Behavior



A few notes on behavior when changing entities. Note that this behavior is just how the box reacts when sending these commands, not something coded in this integration.



* Enabling light sync will also power on the box

* Setting sync mode will also power on the box and start light sync on the selected mode

* When you want to change multiple entities the order is important. For example, Intensity applies to the current selected mode. So if you want to change both the `intensity` and `mode` you _first_ have to change the mode and then set the intensity. Otherwise, the intensity is applied to the "old" mode. If you want to avoid ordering issues you can use the `set_sync_state` action which will take care of the ordering and is more efficient than sending everything separately.



### Actions



The integration exposes some additional actions.



For the parameter descriptions use the Actions tab in the Home Assistant Developer tools and search for `huesyncbox` in the actions list.



| Action name | Description |

|---|---|

| set_bridge | Set the bridge to be used by the Philips Hue Play HDMI Syncbox. |

| set_sync_state | Set the state of multiple features of the Philips Hue Play HDMI Syncbox at once. Makes sure everything is set in the correct order and is more efficient than using separate commands. |



## Updating from before version 2.0



The 2.0 version is a complete rewrite to allow for multiple entities and modernize the integration in general, however it is a big breaking change.



See the [release notes for 2.0.0](https://github.com/mvdwetering/huesyncbox/releases/tag/v2.0.0) for more details on the changes and migration.



No functionality is lost it just moved to a different place.



## Installation



> **Note**

> Please setup the Philips Hue Play HDMI Syncbox with the Hue App first and make sure it works before setting up this integration.



### Home Assistant Community Store (HACS)



HACS is a 3rd party downloader for Home Assistant to easily install and update custom integrations made by the community. More information and installation instructions can be found on the [HACS website](https://hacs.xyz/).



* Install the integration from within HACS (you can use the search box to find it)

* Restart Home Assistant

* Devices will be found automatically or can be added manually from the Home Assistant integrations screen



### Manually



* Install the custom component

  * Download the zip from the releases section on GitHub

  * Unzip it

  * Copy it to the custom_components directory of your Home Assistant install as usual

* Restart Home Assistant

* Devices will be found automatically or can be added manually from the Home Assistant integrations screen