Add button platform to Edifier Infrared

homeassistant/components/edifier_infrared/__init__.py

@@ -4,7 +4,7 @@ from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import Platform
 from homeassistant.core import HomeAssistant
 
-PLATFORMS = [Platform.MEDIA_PLAYER]
+PLATFORMS = [Platform.BUTTON, Platform.MEDIA_PLAYER]
 
 
 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:

homeassistant/components/edifier_infrared/button.py

@@ -0,0 +1,180 @@
+"""Button platform for Edifier infrared integration."""
+
+from dataclasses import dataclass
+
+from infrared_protocols.codes.edifier.models import EdifierCommandSet, EdifierModel
+from infrared_protocols.codes.edifier.r1280db import EdifierR1280DBCode
+from infrared_protocols.codes.edifier.r1700bt import EdifierR1700BTCode
+from infrared_protocols.codes.edifier.rc20g import EdifierRC20GCode
+from infrared_protocols.codes.edifier.s360db import EdifierS360DBCode
+
+from homeassistant.components.button import ButtonEntity, ButtonEntityDescription
+from homeassistant.components.infrared import InfraredEmitterConsumerEntity
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import CONF_MODEL
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
+
+from .const import CONF_COMMAND_SET, CONF_INFRARED_ENTITY_ID, EdifierCode
+from .entity import EdifierIrEntity
+
+PARALLEL_UPDATES = 1
+
+
+@dataclass(frozen=True, kw_only=True)
+class EdifierIrButtonEntityDescription(ButtonEntityDescription):
+    """Describes Edifier IR button entity."""
+
+    command_code: EdifierCode
+
+
+COMMAND_SET_BUTTONS: dict[
+    EdifierCommandSet,
+    tuple[EdifierIrButtonEntityDescription, ...],
+] = {
+    EdifierCommandSet.R1700BT: (
+        EdifierIrButtonEntityDescription(
+            key="bluetooth",
+            translation_key="bluetooth",
+            command_code=EdifierR1700BTCode.BLUETOOTH,
+        ),
+        EdifierIrButtonEntityDescription(
+            key="line_1",
+            translation_key="line_1",
+            command_code=EdifierR1700BTCode.LINE_1,
+        ),
+        EdifierIrButtonEntityDescription(
+            key="line_2",
+            translation_key="line_2",
+            command_code=EdifierR1700BTCode.LINE_2,
+        ),
+        EdifierIrButtonEntityDescription(
+            key="fx_on",
+            translation_key="fx_on",
+            command_code=EdifierR1700BTCode.FX_ON,
+        ),
+        EdifierIrButtonEntityDescription(
+            key="fx_off",
+            translation_key="fx_off",
+            command_code=EdifierR1700BTCode.FX_OFF,
+        ),
+    ),
+    EdifierCommandSet.R1280DB: (
+        EdifierIrButtonEntityDescription(
+            key="bluetooth",
+            translation_key="bluetooth",
+            command_code=EdifierR1280DBCode.BLUETOOTH,
+        ),
+        EdifierIrButtonEntityDescription(
+            key="line_1",
+            translation_key="line_1",
+            command_code=EdifierR1280DBCode.LINE_1,
+        ),
+        EdifierIrButtonEntityDescription(
+            key="line_2",
+            translation_key="line_2",
+            command_code=EdifierR1280DBCode.LINE_2,
+        ),
+        EdifierIrButtonEntityDescription(
+            key="optical",
+            translation_key="optical",
+            command_code=EdifierR1280DBCode.OPTICAL,
+        ),
+        EdifierIrButtonEntityDescription(
+            key="coax",
+            translation_key="coax",
+            command_code=EdifierR1280DBCode.COAX,
+        ),
+    ),
+    EdifierCommandSet.S360DB: (
+        EdifierIrButtonEntityDescription(
+            key="bluetooth",
+            translation_key="bluetooth",
+            command_code=EdifierS360DBCode.BLUETOOTH,
+        ),
+        EdifierIrButtonEntityDescription(
+            key="optical",
+            translation_key="optical",
+            command_code=EdifierS360DBCode.OPTICAL,
+        ),
+        EdifierIrButtonEntityDescription(
+            key="coax",
+            translation_key="coax",
+            command_code=EdifierS360DBCode.COAX,
+        ),
+        EdifierIrButtonEntityDescription(
+            key="pc",
+            translation_key="pc",
+            command_code=EdifierS360DBCode.PC,
+        ),
+        EdifierIrButtonEntityDescription(
+            key="aux",
+            translation_key="aux",
+            command_code=EdifierS360DBCode.AUX,
+        ),
+    ),
+    EdifierCommandSet.RC20G: (
+        EdifierIrButtonEntityDescription(
+            key="bluetooth",
+            translation_key="bluetooth",
+            command_code=EdifierRC20GCode.BLUETOOTH,
+        ),
+        EdifierIrButtonEntityDescription(
+            key="pc",
+            translation_key="pc",
+            command_code=EdifierRC20GCode.PC,
+        ),
+        EdifierIrButtonEntityDescription(
+            key="aux",
+            translation_key="aux",
+            command_code=EdifierRC20GCode.AUX,
+        ),
+        EdifierIrButtonEntityDescription(
+            key="optical",
+            translation_key="optical",
+            command_code=EdifierRC20GCode.OPTICAL,
+        ),
+        EdifierIrButtonEntityDescription(
+            key="coax",
+            translation_key="coax",
+            command_code=EdifierRC20GCode.COAX,
+        ),
+    ),
+}
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    entry: ConfigEntry,
+    async_add_entities: AddConfigEntryEntitiesCallback,
+) -> None:
+    """Set up Edifier IR buttons from a config entry."""
+    infrared_entity_id = entry.data[CONF_INFRARED_ENTITY_ID]
+    command_set = EdifierCommandSet(entry.data[CONF_COMMAND_SET])
+    model = EdifierModel(entry.data[CONF_MODEL])
+    async_add_entities(
+        EdifierIrButton(entry, model, infrared_entity_id, description)
+        for description in COMMAND_SET_BUTTONS.get(command_set, ())
+    )
+
+
+class EdifierIrButton(EdifierIrEntity, InfraredEmitterConsumerEntity, ButtonEntity):
+    """Edifier IR button entity."""
+
+    entity_description: EdifierIrButtonEntityDescription
+
+    def __init__(
+        self,
+        entry: ConfigEntry,
+        model: EdifierModel,
+        infrared_entity_id: str,
+        description: EdifierIrButtonEntityDescription,
+    ) -> None:
+        """Initialize Edifier IR button."""
+        super().__init__(entry, model, unique_id_suffix=description.key)
+        self._infrared_emitter_entity_id = infrared_entity_id
+        self.entity_description = description
+
+    async def async_press(self) -> None:
+        """Press the button."""
+        await self._send_command(self.entity_description.command_code.to_command())

homeassistant/components/edifier_infrared/strings.json

@@ -18,5 +18,36 @@
         "title": "Set up Edifier IR speaker"
       }
     }
+  },
+  "entity": {
+    "button": {
+      "aux": {
+        "name": "AUX"
+      },
+      "bluetooth": {
+        "name": "Bluetooth"
+      },
+      "coax": {
+        "name": "Coaxial"
+      },
+      "fx_off": {
+        "name": "FX off"
+      },
+      "fx_on": {
+        "name": "FX on"
+      },
+      "line_1": {
+        "name": "Line 1"
+      },
+      "line_2": {
+        "name": "Line 2"
+      },
+      "optical": {
+        "name": "Optical"
+      },
+      "pc": {
+        "name": "PC"
+      }
+    }
   }
 }

tests/components/edifier_infrared/snapshots/test_button.ambr

@@ -0,0 +1,251 @@
+# serializer version: 1
+# name: test_entities[button.edifier_r1700bt_bluetooth-entry]
+  EntityRegistryEntrySnapshot({
+    'aliases': list([
+      None,
+    ]),
+    'area_id': None,
+    'capabilities': None,
+    'config_entry_id': <ANY>,
+    'config_subentry_id': <ANY>,
+    'device_class': None,
+    'device_id': <ANY>,
+    'disabled_by': None,
+    'domain': 'button',
+    'entity_category': None,
+    'entity_id': 'button.edifier_r1700bt_bluetooth',
+    'has_entity_name': True,
+    'hidden_by': None,
+    'icon': None,
+    'id': <ANY>,
+    'labels': set({
+    }),
+    'name': None,
+    'object_id_base': 'Bluetooth',
+    'options': dict({
+    }),
+    'original_device_class': None,
+    'original_icon': None,
+    'original_name': 'Bluetooth',
+    'platform': 'edifier_infrared',
+    'previous_unique_id': None,
+    'suggested_object_id': None,
+    'supported_features': 0,
+    'translation_key': 'bluetooth',
+    'unique_id': '01JTEST0000000000000000000_bluetooth',
+    'unit_of_measurement': None,
+  })
+# ---
+# name: test_entities[button.edifier_r1700bt_bluetooth-state]
+  StateSnapshot({
+    'attributes': ReadOnlyDict({
+      'friendly_name': 'Edifier R1700BT Bluetooth',
+    }),
+    'context': <ANY>,
+    'entity_id': 'button.edifier_r1700bt_bluetooth',
+    'last_changed': <ANY>,
+    'last_reported': <ANY>,
+    'last_updated': <ANY>,
+    'state': 'unknown',
+  })
+# ---
+# name: test_entities[button.edifier_r1700bt_fx_off-entry]
+  EntityRegistryEntrySnapshot({
+    'aliases': list([
+      None,
+    ]),
+    'area_id': None,
+    'capabilities': None,
+    'config_entry_id': <ANY>,
+    'config_subentry_id': <ANY>,
+    'device_class': None,
+    'device_id': <ANY>,
+    'disabled_by': None,
+    'domain': 'button',
+    'entity_category': None,
+    'entity_id': 'button.edifier_r1700bt_fx_off',
+    'has_entity_name': True,
+    'hidden_by': None,
+    'icon': None,
+    'id': <ANY>,
+    'labels': set({
+    }),
+    'name': None,
+    'object_id_base': 'FX off',
+    'options': dict({
+    }),
+    'original_device_class': None,
+    'original_icon': None,
+    'original_name': 'FX off',
+    'platform': 'edifier_infrared',
+    'previous_unique_id': None,
+    'suggested_object_id': None,
+    'supported_features': 0,
+    'translation_key': 'fx_off',
+    'unique_id': '01JTEST0000000000000000000_fx_off',
+    'unit_of_measurement': None,
+  })
+# ---
+# name: test_entities[button.edifier_r1700bt_fx_off-state]
+  StateSnapshot({
+    'attributes': ReadOnlyDict({
+      'friendly_name': 'Edifier R1700BT FX off',
+    }),
+    'context': <ANY>,
+    'entity_id': 'button.edifier_r1700bt_fx_off',
+    'last_changed': <ANY>,
+    'last_reported': <ANY>,
+    'last_updated': <ANY>,
+    'state': 'unknown',
+  })
+# ---
+# name: test_entities[button.edifier_r1700bt_fx_on-entry]
+  EntityRegistryEntrySnapshot({
+    'aliases': list([
+      None,
+    ]),
+    'area_id': None,
+    'capabilities': None,
+    'config_entry_id': <ANY>,
+    'config_subentry_id': <ANY>,
+    'device_class': None,
+    'device_id': <ANY>,
+    'disabled_by': None,
+    'domain': 'button',
+    'entity_category': None,
+    'entity_id': 'button.edifier_r1700bt_fx_on',
+    'has_entity_name': True,
+    'hidden_by': None,
+    'icon': None,
+    'id': <ANY>,
+    'labels': set({
+    }),
+    'name': None,
+    'object_id_base': 'FX on',
+    'options': dict({
+    }),
+    'original_device_class': None,
+    'original_icon': None,
+    'original_name': 'FX on',
+    'platform': 'edifier_infrared',
+    'previous_unique_id': None,
+    'suggested_object_id': None,
+    'supported_features': 0,
+    'translation_key': 'fx_on',
+    'unique_id': '01JTEST0000000000000000000_fx_on',
+    'unit_of_measurement': None,
+  })
+# ---
+# name: test_entities[button.edifier_r1700bt_fx_on-state]
+  StateSnapshot({
+    'attributes': ReadOnlyDict({
+      'friendly_name': 'Edifier R1700BT FX on',
+    }),
+    'context': <ANY>,
+    'entity_id': 'button.edifier_r1700bt_fx_on',
+    'last_changed': <ANY>,
+    'last_reported': <ANY>,
+    'last_updated': <ANY>,
+    'state': 'unknown',
+  })
+# ---
+# name: test_entities[button.edifier_r1700bt_line_1-entry]
+  EntityRegistryEntrySnapshot({
+    'aliases': list([
+      None,
+    ]),
+    'area_id': None,
+    'capabilities': None,
+    'config_entry_id': <ANY>,
+    'config_subentry_id': <ANY>,
+    'device_class': None,
+    'device_id': <ANY>,
+    'disabled_by': None,
+    'domain': 'button',
+    'entity_category': None,
+    'entity_id': 'button.edifier_r1700bt_line_1',
+    'has_entity_name': True,
+    'hidden_by': None,
+    'icon': None,
+    'id': <ANY>,
+    'labels': set({
+    }),
+    'name': None,
+    'object_id_base': 'Line 1',
+    'options': dict({
+    }),
+    'original_device_class': None,
+    'original_icon': None,
+    'original_name': 'Line 1',
+    'platform': 'edifier_infrared',
+    'previous_unique_id': None,
+    'suggested_object_id': None,
+    'supported_features': 0,
+    'translation_key': 'line_1',
+    'unique_id': '01JTEST0000000000000000000_line_1',
+    'unit_of_measurement': None,
+  })
+# ---
+# name: test_entities[button.edifier_r1700bt_line_1-state]
+  StateSnapshot({
+    'attributes': ReadOnlyDict({
+      'friendly_name': 'Edifier R1700BT Line 1',
+    }),
+    'context': <ANY>,
+    'entity_id': 'button.edifier_r1700bt_line_1',
+    'last_changed': <ANY>,
+    'last_reported': <ANY>,
+    'last_updated': <ANY>,
+    'state': 'unknown',
+  })
+# ---
+# name: test_entities[button.edifier_r1700bt_line_2-entry]
+  EntityRegistryEntrySnapshot({
+    'aliases': list([
+      None,
+    ]),
+    'area_id': None,
+    'capabilities': None,
+    'config_entry_id': <ANY>,
+    'config_subentry_id': <ANY>,
+    'device_class': None,
+    'device_id': <ANY>,
+    'disabled_by': None,
+    'domain': 'button',
+    'entity_category': None,
+    'entity_id': 'button.edifier_r1700bt_line_2',
+    'has_entity_name': True,
+    'hidden_by': None,
+    'icon': None,
+    'id': <ANY>,
+    'labels': set({
+    }),
+    'name': None,
+    'object_id_base': 'Line 2',
+    'options': dict({
+    }),
+    'original_device_class': None,
+    'original_icon': None,
+    'original_name': 'Line 2',
+    'platform': 'edifier_infrared',
+    'previous_unique_id': None,
+    'suggested_object_id': None,
+    'supported_features': 0,
+    'translation_key': 'line_2',
+    'unique_id': '01JTEST0000000000000000000_line_2',
+    'unit_of_measurement': None,
+  })
+# ---
+# name: test_entities[button.edifier_r1700bt_line_2-state]
+  StateSnapshot({
+    'attributes': ReadOnlyDict({
+      'friendly_name': 'Edifier R1700BT Line 2',
+    }),
+    'context': <ANY>,
+    'entity_id': 'button.edifier_r1700bt_line_2',
+    'last_changed': <ANY>,
+    'last_reported': <ANY>,
+    'last_updated': <ANY>,
+    'state': 'unknown',
+  })
+# ---

tests/components/edifier_infrared/test_button.py

@@ -0,0 +1,73 @@
+"""Tests for the Edifier Infrared button platform."""
+
+from infrared_protocols.codes.edifier.r1700bt import EdifierR1700BTCode
+import pytest
+from syrupy.assertion import SnapshotAssertion
+
+from homeassistant.components.button import DOMAIN as BUTTON_DOMAIN, SERVICE_PRESS
+from homeassistant.const import ATTR_ENTITY_ID, Platform
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers import entity_registry as er
+
+from tests.common import MockConfigEntry, snapshot_platform
+from tests.components.common import assert_availability_follows_source_entity
+from tests.components.infrared import EMITTER_ENTITY_ID
+from tests.components.infrared.common import MockInfraredEmitterEntity
+
+BLUETOOTH_BUTTON_ENTITY_ID = "button.edifier_r1700bt_bluetooth"
+
+
+@pytest.fixture
+def platforms() -> list[Platform]:
+    """Return platforms to set up."""
+    return [Platform.BUTTON]
+
+
+@pytest.mark.usefixtures("init_integration")
+async def test_entities(
+    hass: HomeAssistant,
+    snapshot: SnapshotAssertion,
+    entity_registry: er.EntityRegistry,
+    mock_config_entry: MockConfigEntry,
+) -> None:
+    """Test the button entities are created with correct attributes."""
+    await snapshot_platform(hass, entity_registry, snapshot, mock_config_entry.entry_id)
+
+
+@pytest.mark.parametrize(
+    ("entity_id", "expected_code"),
+    [
+        ("button.edifier_r1700bt_bluetooth", EdifierR1700BTCode.BLUETOOTH),
+        ("button.edifier_r1700bt_line_1", EdifierR1700BTCode.LINE_1),
+        ("button.edifier_r1700bt_line_2", EdifierR1700BTCode.LINE_2),
+        ("button.edifier_r1700bt_fx_on", EdifierR1700BTCode.FX_ON),
+        ("button.edifier_r1700bt_fx_off", EdifierR1700BTCode.FX_OFF),
+    ],
+)
+@pytest.mark.usefixtures("init_integration")
+async def test_button_press_sends_correct_code(
+    hass: HomeAssistant,
+    mock_infrared_emitter_entity: MockInfraredEmitterEntity,
+    entity_id: str,
+    expected_code: EdifierR1700BTCode,
+) -> None:
+    """Test each button press sends the correct IR code."""
+    await hass.services.async_call(
+        BUTTON_DOMAIN,
+        SERVICE_PRESS,
+        {ATTR_ENTITY_ID: entity_id},
+        blocking=True,
+    )
+
+    assert len(mock_infrared_emitter_entity.send_command_calls) == 1
+    assert mock_infrared_emitter_entity.send_command_calls[0] == expected_code
+
+
+@pytest.mark.usefixtures("init_integration")
+async def test_button_availability_follows_ir_entity(
+    hass: HomeAssistant,
+) -> None:
+    """Test button becomes unavailable when IR entity is unavailable."""
+    await assert_availability_follows_source_entity(
+        hass, BLUETOOTH_BUTTON_ENTITY_ID, EMITTER_ENTITY_ID
+    )