v2.0.0b3

[mvdwetering]

Note
This is a beta version, hopefully last one before release.

Changes compared to 2.0.0b2

• Fix errors on services calls in certain situations
• Redact SSID in diagnostics
• Added more unittests

Changes compared to 2.0.0b1

• Fix brightness entity showing lots of decimals

Changes compared to 2.0.0b0

• Update/improve README.md
• Create repair with impacted automations on upgrade from versions below 2.0.0 (so won't trigger if you are already on 2.0.0b0)
• Change brightness range to 1-100% to match Hue app (was 0-100%)
• Improve handling of connection issues
• Fix adding box found by zeroconf flow
• Update configentry name when name of box changes
• Add set_sync_state service to allow setting of multiple states at once.

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_player entity
• Removed/changed most custom services
• Minimum required Home Assistant Core version is now 2023.8.0

Read the changes section below and/or 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 quite 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 exists back when this integration was created like select entity, reauth, diagnostics, 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 now 2023.8.0.

Note that no functionality is lost. It just moved to a different place.

Warning
Because of the nature of the changes it means all automations and dashboards using this integration need to be updated.
A repair will be be created when upgrading that indicates which automations are impacted to help find them.
Home Assistant will not load automations that use the removed services, so these have to be updated to use the new entities.

To start with, the yaml configuration option has been removed. It has not been used in a long time. If you still have the huesyncbox: entry in configuration.yaml it should be removed.

With the rewrite the existing media_player entity has been removed and replaced with several new entities.
Below is a table with the new and old situation.

New entity	Was implemented by
Power switch	Media player on/off
Light sync switch	Mediaplayer play/pause
Intensity select	Mediaplayer sound modes
Mode select	Mediaplayer next/previous track
HDMI input select	Mediaplayer source
Brightness number	Mediaplayer volume or custom set_brightness service. Note that the range is now a percentage (1-100%) to match the values in the Hue app. It used to be a range from 0 to 1
HDMI1-4 connection status sensors	hdmi1-4_status attributes of mediaplayer
Bridge connection status sensor	bridge_connection_state attribute of mediaplayer
Bridge ID sensor	bridge_unique_id attribute of mediaplayer
Dolby Vision compatibility switch	New feature
LED indicator select	New feature
IP address sensor	New feature
Wifi quality sensor	New feature

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
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.0b3

---

This discussion was created from the release v2.0.0b3.

[mvdwetering]

v2.0.0 has been released, please continue disussion there