v2.0.0
Breaking Changes
Warning
All automations and dashboards using this integration will need to be updated!
Make sure you have time for that when upgrading!
- Removed
media_playerentity - Removed/changed most custom services
- Minimum required Home Assistant Core version is now 2023.8.0
- Due to large amount of changes translations need to be re-done
Read the changes section below and/or the main README.md for more details.
Changes
Before this version the functionality of the Philips Hue Play HDMI Sync Box was all exposed through one single mediaplayer entity. Several features of the media_player were abused to control things on the box. E.g. brightness was controlled by the volume slider. While this initially seemed like a good idea (easy controls on the dashboard and only one entity to implement) this turned out to be confusing and limiting in the long run. Next to that the way the integration was built did not allow for more entities so it was not possible to extend it.
The 2.0.0 version is a complete rewrite to allow for multiple entities and modernize the integration in general. Having multiple entities should make it clear what the function of the entity is. And because they are standard Home Assistant entities like switch, number, select and sensor they are familiar to most users already.
With the rewrite several features are added that are nowadays standard for integrations, but did not exist back when this integration was created like reauth, diagnostics, select entities, easy enabling of logging and translations for everything. This rewrite also addresses most open issues and feature requests.
Since the integration is now using the latest and greatest Home Assistant features the minimum Home Assistant Core version is 2023.8.0.
Next to all the moving around of functionality, there are also a few new features.
The following entities were added:
- Dolby Vision compatibility switch
- LED indicator mode select
- IP address sensor
- Wifi quality sensor
Migration info
Notes
- On the upgrade a repair issue will be be created that indicates which automations are impacted to help find most automations that need updating (if any). This repair will stay available until February 2024.
- Home Assistant will not load automations that use the removed services, so these have to be updated to use the new entities. Look for automations with the "broken" robot icon.
- If you still have the
huesyncbox:entry inconfiguration.yamlit should be removed as it is not supported anymore.
Entities
With the rewrite the existing media_player entity has been replaced with several new entities.
Below is a table with the old and new situation.
| Old | New entity |
|---|---|
| Media player on/off | Power switch |
| Mediaplayer play/pause | Light sync switch |
| Mediaplayer sound modes | Intensity select |
| Mediaplayer next/previous track | Mode select |
| Mediaplayer source | HDMI input select |
| Mediaplayer volume | Brightness number. Note that the range is now a percentage (1-100%) to match the values in the Hue app. Volume was a range from 0 to 1 |
hdmi1-4_status attributes of mediaplayer |
HDMI1-4 connection status sensors |
bridge_unique_id attribute of mediaplayer |
Bridge ID sensor |
bridge_connection_state attribute of mediaplayer |
Bridge connection status sensor |
Services
With the transition to the new entities most custom services that were offered became obsolete as native Home Assistant services of the entities can be used now. The table links to the documentation of the standard Home Assistant services that can be used instead.
| Old service name | Replaced by |
|---|---|
| set_brightness | Use services of the brightness number entity. Note that the range is now 1 to 100% to match the numbers in the Hue app. The range used to be 0 to 1 |
| set_syncmode | Use services of the sync mode select entity |
| set_intensity | Use services of the intensity select entity |
| set_entertainment_area | Use services of the entertainment area select entity |
| set_sync_state | For toggle or cycle options use the services on the relevant entities. The service can still be used to set multiple states at once for covenience so you don't have to worry about the order in which to set them. |
| set_bridge | Not changed |
Full Changelog: v1.23.0...v2.0.0