Add proper Beosound Premiere support to Bang & Olufsen (home-assistant#156954)

Author: mj23000

homeassistant/components/bang_olufsen/const.py

@@ -71,9 +71,26 @@ class BangOlufsenModel(StrEnum):
     BEOSOUND_BALANCE = "Beosound Balance"
     BEOSOUND_EMERGE = "Beosound Emerge"
     BEOSOUND_LEVEL = "Beosound Level"
+    BEOSOUND_PREMIERE = "Beosound Premiere"
     BEOSOUND_THEATRE = "Beosound Theatre"
 
 
+# Physical "buttons" on devices
+class BangOlufsenButtons(StrEnum):
+    """Enum for device buttons."""
+
+    BLUETOOTH = "Bluetooth"
+    MICROPHONE = "Microphone"
+    NEXT = "Next"
+    PLAY_PAUSE = "PlayPause"
+    PRESET_1 = "Preset1"
+    PRESET_2 = "Preset2"
+    PRESET_3 = "Preset3"
+    PRESET_4 = "Preset4"
+    PREVIOUS = "Previous"
+    VOLUME = "Volume"
+
+
 # Dispatcher events
 class WebsocketNotification(StrEnum):
     """Enum for WebSocket notification types."""
@@ -204,23 +221,6 @@ class WebsocketNotification(StrEnum):
         ),
     ]
 )
-# Map for storing compatibility of devices.
-
-MODEL_SUPPORT_DEVICE_BUTTONS: Final[str] = "device_buttons"
-
-MODEL_SUPPORT_MAP = {
-    MODEL_SUPPORT_DEVICE_BUTTONS: (
-        BangOlufsenModel.BEOLAB_8,
-        BangOlufsenModel.BEOLAB_28,
-        BangOlufsenModel.BEOSOUND_2,
-        BangOlufsenModel.BEOSOUND_A5,
-        BangOlufsenModel.BEOSOUND_A9,
-        BangOlufsenModel.BEOSOUND_BALANCE,
-        BangOlufsenModel.BEOSOUND_EMERGE,
-        BangOlufsenModel.BEOSOUND_LEVEL,
-        BangOlufsenModel.BEOSOUND_THEATRE,
-    )
-}
 
 # Device events
 BANG_OLUFSEN_WEBSOCKET_EVENT: Final[str] = f"{DOMAIN}_websocket_event"
@@ -236,18 +236,7 @@ class WebsocketNotification(StrEnum):
 
 CONNECTION_STATUS: Final[str] = "CONNECTION_STATUS"
 
-DEVICE_BUTTONS: Final[list[str]] = [
-    "Bluetooth",
-    "Microphone",
-    "Next",
-    "PlayPause",
-    "Preset1",
-    "Preset2",
-    "Preset3",
-    "Preset4",
-    "Previous",
-    "Volume",
-]
+DEVICE_BUTTONS: Final[list[str]] = [x.value for x in BangOlufsenButtons]
 
 
 DEVICE_BUTTON_EVENTS: Final[list[str]] = [

homeassistant/components/bang_olufsen/diagnostics.py

@@ -6,11 +6,13 @@
 
 from homeassistant.components.event import DOMAIN as EVENT_DOMAIN
 from homeassistant.components.media_player import DOMAIN as MEDIA_PLAYER_DOMAIN
+from homeassistant.const import CONF_MODEL
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers import entity_registry as er
 
 from . import BangOlufsenConfigEntry
-from .const import DEVICE_BUTTONS, DOMAIN
+from .const import DOMAIN
+from .util import get_device_buttons
 
 
 async def async_get_config_entry_diagnostics(
@@ -40,7 +42,7 @@ async def async_get_config_entry_diagnostics(
             data["media_player"] = state_dict
 
     # Add button Event entity states (if enabled)
-    for device_button in DEVICE_BUTTONS:
+    for device_button in get_device_buttons(config_entry.data[CONF_MODEL]):
         if entity_id := entity_registry.async_get_entity_id(
             EVENT_DOMAIN, DOMAIN, f"{config_entry.unique_id}_{device_button}"
         ):

homeassistant/components/bang_olufsen/event.py

@@ -9,15 +9,9 @@
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
 from . import BangOlufsenConfigEntry
-from .const import (
-    CONNECTION_STATUS,
-    DEVICE_BUTTON_EVENTS,
-    DEVICE_BUTTONS,
-    MODEL_SUPPORT_DEVICE_BUTTONS,
-    MODEL_SUPPORT_MAP,
-    WebsocketNotification,
-)
+from .const import CONNECTION_STATUS, DEVICE_BUTTON_EVENTS, WebsocketNotification
 from .entity import BangOlufsenEntity
+from .util import get_device_buttons
 
 PARALLEL_UPDATES = 0
 
@@ -29,11 +23,10 @@ async def async_setup_entry(
 ) -> None:
     """Set up Sensor entities from config entry."""
 
-    if config_entry.data[CONF_MODEL] in MODEL_SUPPORT_MAP[MODEL_SUPPORT_DEVICE_BUTTONS]:
-        async_add_entities(
-            BangOlufsenButtonEvent(config_entry, button_type)
-            for button_type in DEVICE_BUTTONS
-        )
+    async_add_entities(
+        BangOlufsenButtonEvent(config_entry, button_type)
+        for button_type in get_device_buttons(config_entry.data[CONF_MODEL])
+    )
 
 
 class BangOlufsenButtonEvent(BangOlufsenEntity, EventEntity):

homeassistant/components/bang_olufsen/util.py

@@ -6,7 +6,7 @@
 from homeassistant.helpers import device_registry as dr
 from homeassistant.helpers.device_registry import DeviceEntry
 
-from .const import DOMAIN
+from .const import DEVICE_BUTTONS, DOMAIN, BangOlufsenButtons, BangOlufsenModel
 
 
 def get_device(hass: HomeAssistant, unique_id: str) -> DeviceEntry:
@@ -21,3 +21,18 @@ def get_device(hass: HomeAssistant, unique_id: str) -> DeviceEntry:
 def get_serial_number_from_jid(jid: str) -> str:
     """Get serial number from Beolink JID."""
     return jid.split(".")[2].split("@")[0]
+
+
+def get_device_buttons(model: BangOlufsenModel) -> list[str]:
+    """Get supported buttons for a given model."""
+    buttons = DEVICE_BUTTONS.copy()
+
+    # Beosound Premiere does not have a bluetooth button
+    if model == BangOlufsenModel.BEOSOUND_PREMIERE:
+        buttons.remove(BangOlufsenButtons.BLUETOOTH)
+
+    # Beoconnect Core does not have any buttons
+    elif model == BangOlufsenModel.BEOCONNECT_CORE:
+        buttons = []
+
+    return buttons

tests/components/bang_olufsen/conftest.py

@@ -34,6 +34,7 @@
 from .const import (
     TEST_DATA_CREATE_ENTRY,
     TEST_DATA_CREATE_ENTRY_2,
+    TEST_DATA_CREATE_ENTRY_3,
     TEST_FRIENDLY_NAME,
     TEST_FRIENDLY_NAME_3,
     TEST_FRIENDLY_NAME_4,
@@ -44,8 +45,10 @@
     TEST_JID_4,
     TEST_NAME,
     TEST_NAME_2,
+    TEST_NAME_3,
     TEST_SERIAL_NUMBER,
     TEST_SERIAL_NUMBER_2,
+    TEST_SERIAL_NUMBER_3,
     TEST_SOUND_MODE,
     TEST_SOUND_MODE_2,
     TEST_SOUND_MODE_NAME,
@@ -76,6 +79,17 @@ def mock_config_entry_core() -> MockConfigEntry:
     )
 
 
+@pytest.fixture
+def mock_config_entry_premiere() -> MockConfigEntry:
+    """Mock config entry for Beosound Premiere."""
+    return MockConfigEntry(
+        domain=DOMAIN,
+        unique_id=TEST_SERIAL_NUMBER_3,
+        data=TEST_DATA_CREATE_ENTRY_3,
+        title=TEST_NAME_3,
+    )
+
+
 async def mock_websocket_connection(
     hass: HomeAssistant, mock_mozart_client: AsyncMock
 ) -> None:

tests/components/bang_olufsen/const.py

@@ -39,6 +39,7 @@
 TEST_HOST_IPV6 = "1111:2222:3333:4444:5555:6666:7777:8888"
 TEST_MODEL_BALANCE = "Beosound Balance"
 TEST_MODEL_CORE = "Beoconnect Core"
+TEST_MODEL_PREMIERE = "Beosound Premiere"
 TEST_MODEL_THEATRE = "Beosound Theatre"
 TEST_MODEL_LEVEL = "Beosound Level"
 TEST_SERIAL_NUMBER = "11111111"
@@ -56,9 +57,11 @@
 TEST_MEDIA_PLAYER_ENTITY_ID_2 = "media_player.beoconnect_core_22222222"
 TEST_HOST_2 = "192.168.0.2"
 
-TEST_FRIENDLY_NAME_3 = "Lego room Balance"
-TEST_JID_3 = f"{TEST_TYPE_NUMBER}.{TEST_ITEM_NUMBER}[email protected]"
-TEST_MEDIA_PLAYER_ENTITY_ID_3 = "media_player.beosound_balance_33333333"
+TEST_FRIENDLY_NAME_3 = "Bedroom Premiere"
+TEST_SERIAL_NUMBER_3 = "33333333"
+TEST_NAME_3 = f"{TEST_MODEL_PREMIERE}-{TEST_SERIAL_NUMBER_3}"
+TEST_JID_3 = f"{TEST_TYPE_NUMBER}.{TEST_ITEM_NUMBER}.{TEST_SERIAL_NUMBER_3}@products.bang-olufsen.com"
+TEST_MEDIA_PLAYER_ENTITY_ID_3 = f"media_player.beosound_premiere_{TEST_SERIAL_NUMBER_3}"
 TEST_HOST_3 = "192.168.0.3"
 
 TEST_FRIENDLY_NAME_4 = "Lounge room Balance"
@@ -90,6 +93,13 @@
     CONF_NAME: TEST_NAME_2,
 }
 
+TEST_DATA_CREATE_ENTRY_3 = {
+    CONF_HOST: TEST_HOST_3,
+    CONF_MODEL: TEST_MODEL_PREMIERE,
+    CONF_BEOLINK_JID: TEST_JID_3,
+    CONF_NAME: TEST_NAME_3,
+}
+
 TEST_DATA_ZEROCONF = ZeroconfServiceInfo(
     ip_address=IPv4Address(TEST_HOST),
     ip_addresses=[IPv4Address(TEST_HOST)],

tests/components/bang_olufsen/snapshots/test_diagnostics.ambr

@@ -44,11 +44,11 @@
       'attributes': dict({
         'beolink': dict({
           'listeners': dict({
-            'Lego room Balance': '[email protected]',
+            'Bedroom Premiere': '[email protected]',
             'Lounge room Balance': '[email protected]',
           }),
           'peers': dict({
-            'Lego room Balance': '[email protected]',
+            'Bedroom Premiere': '[email protected]',
             'Lounge room Balance': '[email protected]',
           }),
           'self': dict({

tests/components/bang_olufsen/snapshots/test_event.ambr

@@ -1,5 +1,5 @@
 # serializer version: 1
-# name: test_button_event_creation
+# name: test_button_event_creation_balance
   list([
     'event.beosound_balance_11111111_bluetooth',
     'event.beosound_balance_11111111_microphone',
@@ -19,3 +19,17 @@
     'media_player.beoconnect_core_22222222',
   ])
 # ---
+# name: test_button_event_creation_beosound_premiere
+  list([
+    'event.beosound_premiere_33333333_microphone',
+    'event.beosound_premiere_33333333_next',
+    'event.beosound_premiere_33333333_play_pause',
+    'event.beosound_premiere_33333333_favorite_1',
+    'event.beosound_premiere_33333333_favorite_2',
+    'event.beosound_premiere_33333333_favorite_3',
+    'event.beosound_premiere_33333333_favorite_4',
+    'event.beosound_premiere_33333333_previous',
+    'event.beosound_premiere_33333333_volume',
+    'media_player.beosound_premiere_33333333',
+  ])
+# ---