Add Beoremote One support to Bang & Olufsen (home-assistant#155082)

Co-authored-by: Joost Lekkerkerker <[email protected]>
Co-authored-by: Martin Hjelmare <[email protected]>

Author: 3 people

homeassistant/components/bang_olufsen/config_flow.py

@@ -21,10 +21,10 @@
     ATTR_ITEM_NUMBER,
     ATTR_SERIAL_NUMBER,
     ATTR_TYPE_NUMBER,
-    COMPATIBLE_MODELS,
     CONF_SERIAL_NUMBER,
     DEFAULT_MODEL,
     DOMAIN,
+    SELECTABLE_MODELS,
 )
 from .util import get_serial_number_from_jid
 
@@ -70,7 +70,7 @@ async def async_step_user(
             {
                 vol.Required(CONF_HOST): str,
                 vol.Required(CONF_MODEL, default=DEFAULT_MODEL): SelectSelector(
-                    SelectSelectorConfig(options=COMPATIBLE_MODELS)
+                    SelectSelectorConfig(options=SELECTABLE_MODELS)
                 ),
             }
         )

homeassistant/components/bang_olufsen/const.py

@@ -62,6 +62,7 @@ class BangOlufsenMediaType(StrEnum):
 class BangOlufsenModel(StrEnum):
     """Enum for compatible model names."""
 
+    # Mozart devices
     BEOCONNECT_CORE = "Beoconnect Core"
     BEOLAB_8 = "BeoLab 8"
     BEOLAB_28 = "BeoLab 28"
@@ -73,6 +74,8 @@ class BangOlufsenModel(StrEnum):
     BEOSOUND_LEVEL = "Beosound Level"
     BEOSOUND_PREMIERE = "Beosound Premiere"
     BEOSOUND_THEATRE = "Beosound Theatre"
+    # Remote devices
+    BEOREMOTE_ONE = "Beoremote One"
 
 
 # Physical "buttons" on devices
@@ -96,6 +99,7 @@ class WebsocketNotification(StrEnum):
     """Enum for WebSocket notification types."""
 
     ACTIVE_LISTENING_MODE = "active_listening_mode"
+    BEO_REMOTE_BUTTON = "beo_remote_button"
     BUTTON = "button"
     PLAYBACK_ERROR = "playback_error"
     PLAYBACK_METADATA = "playback_metadata"
@@ -113,6 +117,7 @@ class WebsocketNotification(StrEnum):
     BEOLINK_AVAILABLE_LISTENERS = "beolinkAvailableListeners"
     CONFIGURATION = "configuration"
     NOTIFICATION = "notification"
+    REMOTE_CONTROL_DEVICES = "remoteControlDevices"
     REMOTE_MENU_CHANGED = "remoteMenuChanged"
 
     ALL = "all"
@@ -128,7 +133,11 @@ class WebsocketNotification(StrEnum):
 CONF_BEOLINK_JID: Final = "jid"
 
 # Models to choose from in manual configuration.
-COMPATIBLE_MODELS: list[str] = [x.value for x in BangOlufsenModel]
+SELECTABLE_MODELS: list[str] = [
+    model.value for model in BangOlufsenModel if model != BangOlufsenModel.BEOREMOTE_ONE
+]
+
+MANUFACTURER: Final[str] = "Bang & Olufsen"
 
 # Attribute names for zeroconf discovery.
 ATTR_TYPE_NUMBER: Final[str] = "tn"
@@ -227,6 +236,10 @@ class WebsocketNotification(StrEnum):
 
 # Dict used to translate native Bang & Olufsen event names to string.json compatible ones
 EVENT_TRANSLATION_MAP: dict[str, str] = {
+    # Beoremote One
+    "KeyPress": "key_press",
+    "KeyRelease": "key_release",
+    # Physical "buttons"
     "shortPress (Release)": "short_press_release",
     "longPress (Timeout)": "long_press_timeout",
     "longPress (Release)": "long_press_release",
@@ -247,6 +260,70 @@ class WebsocketNotification(StrEnum):
     "very_long_press_release",
 ]
 
+BEO_REMOTE_SUBMENU_CONTROL: Final[str] = "Control"
+BEO_REMOTE_SUBMENU_LIGHT: Final[str] = "Light"
+
+# Common for both submenus
+BEO_REMOTE_KEYS: Final[tuple[str, ...]] = (
+    "Blue",
+    "Digit0",
+    "Digit1",
+    "Digit2",
+    "Digit3",
+    "Digit4",
+    "Digit5",
+    "Digit6",
+    "Digit7",
+    "Digit8",
+    "Digit9",
+    "Down",
+    "Green",
+    "Left",
+    "Play",
+    "Red",
+    "Rewind",
+    "Right",
+    "Select",
+    "Stop",
+    "Up",
+    "Wind",
+    "Yellow",
+    "Func1",
+    "Func2",
+    "Func3",
+    "Func4",
+    "Func5",
+    "Func6",
+    "Func7",
+    "Func8",
+    "Func9",
+    "Func10",
+    "Func11",
+    "Func12",
+    "Func13",
+    "Func14",
+    "Func15",
+    "Func16",
+    "Func17",
+)
+
+# "keys" that are unique to the Control submenu
+BEO_REMOTE_CONTROL_KEYS: Final[tuple[str, ...]] = (
+    "Func18",
+    "Func19",
+    "Func20",
+    "Func21",
+    "Func22",
+    "Func23",
+    "Func24",
+    "Func25",
+    "Func26",
+    "Func27",
+)
+
+BEO_REMOTE_KEY_EVENTS: Final[list[str]] = ["key_press", "key_release"]
+
+
 # Beolink Converter NL/ML sources need to be transformed to upper case
 BEOLINK_JOIN_SOURCES_TO_UPPER = (
     "aux_a",

homeassistant/components/bang_olufsen/event.py

@@ -2,16 +2,34 @@
 
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
+from mozart_api.models import PairedRemote
+
 from homeassistant.components.event import EventDeviceClass, EventEntity
 from homeassistant.const import CONF_MODEL
 from homeassistant.core import HomeAssistant, callback
+from homeassistant.helpers import device_registry as dr
+from homeassistant.helpers.device_registry import DeviceInfo
 from homeassistant.helpers.dispatcher import async_dispatcher_connect
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
 from . import BangOlufsenConfigEntry
-from .const import CONNECTION_STATUS, DEVICE_BUTTON_EVENTS, WebsocketNotification
+from .const import (
+    BEO_REMOTE_CONTROL_KEYS,
+    BEO_REMOTE_KEY_EVENTS,
+    BEO_REMOTE_KEYS,
+    BEO_REMOTE_SUBMENU_CONTROL,
+    BEO_REMOTE_SUBMENU_LIGHT,
+    CONNECTION_STATUS,
+    DEVICE_BUTTON_EVENTS,
+    DOMAIN,
+    MANUFACTURER,
+    BangOlufsenModel,
+    WebsocketNotification,
+)
 from .entity import BangOlufsenEntity
-from .util import get_device_buttons
+from .util import get_device_buttons, get_remotes
 
 PARALLEL_UPDATES = 0
 
@@ -21,24 +39,87 @@ async def async_setup_entry(
     config_entry: BangOlufsenConfigEntry,
     async_add_entities: AddConfigEntryEntitiesCallback,
 ) -> None:
-    """Set up Sensor entities from config entry."""
+    """Set up Event entities from config entry."""
+    entities: list[BangOlufsenEvent] = []
 
     async_add_entities(
         BangOlufsenButtonEvent(config_entry, button_type)
         for button_type in get_device_buttons(config_entry.data[CONF_MODEL])
     )
 
+    # Check for connected Beoremote One
+    remotes = await get_remotes(config_entry.runtime_data.client)
+
+    for remote in remotes:
+        # Add Light keys
+        entities.extend(
+            [
+                BangOlufsenRemoteKeyEvent(
+                    config_entry,
+                    remote,
+                    f"{BEO_REMOTE_SUBMENU_LIGHT}/{key_type}",
+                )
+                for key_type in BEO_REMOTE_KEYS
+            ]
+        )
+
+        # Add Control keys
+        entities.extend(
+            [
+                BangOlufsenRemoteKeyEvent(
+                    config_entry,
+                    remote,
+                    f"{BEO_REMOTE_SUBMENU_CONTROL}/{key_type}",
+                )
+                for key_type in (*BEO_REMOTE_KEYS, *BEO_REMOTE_CONTROL_KEYS)
+            ]
+        )
 
-class BangOlufsenButtonEvent(BangOlufsenEntity, EventEntity):
-    """Event class for Button events."""
+    # If the remote is no longer available, then delete the device.
+    # The remote may appear as being available to the device after it has been unpaired on the remote
+    # As it has to be removed from the device on the app.
+
+    device_registry = dr.async_get(hass)
+    devices = device_registry.devices.get_devices_for_config_entry_id(
+        config_entry.entry_id
+    )
+    for device in devices:
+        if (
+            device.model == BangOlufsenModel.BEOREMOTE_ONE
+            and device.serial_number not in {remote.serial_number for remote in remotes}
+        ):
+            device_registry.async_update_device(
+                device.id, remove_config_entry_id=config_entry.entry_id
+            )
+
+    async_add_entities(new_entities=entities)
+
+
+class BangOlufsenEvent(BangOlufsenEntity, EventEntity):
+    """Base Event class."""
 
     _attr_device_class = EventDeviceClass.BUTTON
     _attr_entity_registry_enabled_default = False
+
+    def __init__(self, config_entry: BangOlufsenConfigEntry) -> None:
+        """Initialize Event."""
+        super().__init__(config_entry, config_entry.runtime_data.client)
+
+    @callback
+    def _async_handle_event(self, event: str) -> None:
+        """Handle event."""
+        self._trigger_event(event)
+        self.async_write_ha_state()
+
+
+class BangOlufsenButtonEvent(BangOlufsenEvent):
+    """Event class for Button events."""
+
     _attr_event_types = DEVICE_BUTTON_EVENTS
 
     def __init__(self, config_entry: BangOlufsenConfigEntry, button_type: str) -> None:
         """Initialize Button."""
-        super().__init__(config_entry, config_entry.runtime_data.client)
+        super().__init__(config_entry)
 
         self._attr_unique_id = f"{self._unique_id}_{button_type}"
 
@@ -52,20 +133,65 @@ async def async_added_to_hass(self) -> None:
         self.async_on_remove(
             async_dispatcher_connect(
                 self.hass,
-                f"{self._unique_id}_{CONNECTION_STATUS}",
+                f"{DOMAIN}_{self._unique_id}_{CONNECTION_STATUS}",
                 self._async_update_connection_state,
             )
         )
         self.async_on_remove(
             async_dispatcher_connect(
                 self.hass,
-                f"{self._unique_id}_{WebsocketNotification.BUTTON}_{self._button_type}",
+                f"{DOMAIN}_{self._unique_id}_{WebsocketNotification.BUTTON}_{self._button_type}",
                 self._async_handle_event,
             )
         )
 
-    @callback
-    def _async_handle_event(self, event: str) -> None:
-        """Handle event."""
-        self._trigger_event(event)
-        self.async_write_ha_state()
+
+class BangOlufsenRemoteKeyEvent(BangOlufsenEvent):
+    """Event class for Beoremote One key events."""
+
+    _attr_event_types = BEO_REMOTE_KEY_EVENTS
+
+    def __init__(
+        self,
+        config_entry: BangOlufsenConfigEntry,
+        remote: PairedRemote,
+        key_type: str,
+    ) -> None:
+        """Initialize Beoremote One key."""
+        super().__init__(config_entry)
+
+        if TYPE_CHECKING:
+            assert remote.serial_number
+
+        self._attr_unique_id = f"{remote.serial_number}_{self._unique_id}_{key_type}"
+        self._attr_device_info = DeviceInfo(
+            identifiers={(DOMAIN, f"{remote.serial_number}_{self._unique_id}")},
+            name=f"{BangOlufsenModel.BEOREMOTE_ONE}-{remote.serial_number}-{self._unique_id}",
+            model=BangOlufsenModel.BEOREMOTE_ONE,
+            serial_number=remote.serial_number,
+            sw_version=remote.app_version,
+            manufacturer=MANUFACTURER,
+            via_device=(DOMAIN, self._unique_id),
+        )
+
+        # Make the native key name Home Assistant compatible
+        self._attr_translation_key = key_type.lower().replace("/", "_")
+
+        self._key_type = key_type
+
+    async def async_added_to_hass(self) -> None:
+        """Listen to WebSocket Beoremote One key events."""
+        self.async_on_remove(
+            async_dispatcher_connect(
+                self.hass,
+                f"{DOMAIN}_{self._unique_id}_{CONNECTION_STATUS}",
+                self._async_update_connection_state,
+            )
+        )
+        self.async_on_remove(
+            async_dispatcher_connect(
+                self.hass,
+                f"{DOMAIN}_{self._unique_id}_{WebsocketNotification.BEO_REMOTE_BUTTON}_{self._key_type}",
+                self._async_handle_event,
+            )
+        )