Add support for ZHA entities exposed by Zigpy quirks

homeassistant/components/zha/binary_sensor.py

@@ -4,6 +4,7 @@
 import functools
 from typing import Any
 
+from zigpy.quirks.v2 import BinarySensorMetadata, EntityMetadata
 import zigpy.types as t
 from zigpy.zcl.clusters.general import OnOff
 from zigpy.zcl.clusters.security import IasZone
@@ -26,6 +27,7 @@
     CLUSTER_HANDLER_OCCUPANCY,
     CLUSTER_HANDLER_ON_OFF,
     CLUSTER_HANDLER_ZONE,
+    QUIRK_METADATA,
     SIGNAL_ADD_ENTITIES,
     SIGNAL_ATTR_UPDATED,
 )
@@ -76,8 +78,16 @@ class BinarySensor(ZhaEntity, BinarySensorEntity):
 
     def __init__(self, unique_id, zha_device, cluster_handlers, **kwargs) -> None:
         """Initialize the ZHA binary sensor."""
-        super().__init__(unique_id, zha_device, cluster_handlers, **kwargs)
         self._cluster_handler = cluster_handlers[0]
+        if QUIRK_METADATA in kwargs:
+            self._init_from_quirks_metadata(kwargs[QUIRK_METADATA])
+        super().__init__(unique_id, zha_device, cluster_handlers, **kwargs)
+
+    def _init_from_quirks_metadata(self, entity_metadata: EntityMetadata) -> None:
+        """Init this entity from the quirks metadata."""
+        super()._init_from_quirks_metadata(entity_metadata)
+        binary_sensor_metadata: BinarySensorMetadata = entity_metadata.entity_metadata
+        self._attribute_name = binary_sensor_metadata.attribute_name
 
     async def async_added_to_hass(self) -> None:
         """Run when about to be added to hass."""

homeassistant/components/zha/button.py

@@ -1,11 +1,16 @@
 """Support for ZHA button."""
 from __future__ import annotations
 
-import abc
 import functools
 import logging
 from typing import TYPE_CHECKING, Any, Self
 
+from zigpy.quirks.v2 import (
+    EntityMetadata,
+    WriteAttributeButtonMetadata,
+    ZCLCommandButtonMetadata,
+)
+
 from homeassistant.components.button import ButtonDeviceClass, ButtonEntity
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import EntityCategory, Platform
@@ -14,7 +19,7 @@
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
 from .core import discovery
-from .core.const import CLUSTER_HANDLER_IDENTIFY, SIGNAL_ADD_ENTITIES
+from .core.const import CLUSTER_HANDLER_IDENTIFY, QUIRK_METADATA, SIGNAL_ADD_ENTITIES
 from .core.helpers import get_zha_data
 from .core.registries import ZHA_ENTITIES
 from .entity import ZhaEntity
@@ -58,6 +63,8 @@ class ZHAButton(ZhaEntity, ButtonEntity):
     """Defines a ZHA button."""
 
     _command_name: str
+    _args: list[Any]
+    _kwargs: dict[str, Any]
 
     def __init__(
         self,
@@ -67,18 +74,33 @@ def __init__(
         **kwargs: Any,
     ) -> None:
         """Init this button."""
-        super().__init__(unique_id, zha_device, cluster_handlers, **kwargs)
         self._cluster_handler: ClusterHandler = cluster_handlers[0]
+        if QUIRK_METADATA in kwargs:
+            self._init_from_quirks_metadata(kwargs[QUIRK_METADATA])
+        super().__init__(unique_id, zha_device, cluster_handlers, **kwargs)
+
+    def _init_from_quirks_metadata(self, entity_metadata: EntityMetadata) -> None:
+        """Init this entity from the quirks metadata."""
+        super()._init_from_quirks_metadata(entity_metadata)
+        button_metadata: ZCLCommandButtonMetadata = entity_metadata.entity_metadata
+        self._command_name = button_metadata.command_name
+        self._args = button_metadata.args
+        self._kwargs = button_metadata.kwargs
 
-    @abc.abstractmethod
     def get_args(self) -> list[Any]:
         """Return the arguments to use in the command."""
+        return list(self._args) if self._args else []
+
+    def get_kwargs(self) -> dict[str, Any]:
+        """Return the keyword arguments to use in the command."""
+        return self._kwargs
 
     async def async_press(self) -> None:
         """Send out a update command."""
         command = getattr(self._cluster_handler, self._command_name)
-        arguments = self.get_args()
-        await command(*arguments)
+        arguments = self.get_args() or []
+        kwargs = self.get_kwargs() or {}
+        await command(*arguments, **kwargs)
 
 
 @MULTI_MATCH(cluster_handler_names=CLUSTER_HANDLER_IDENTIFY)
@@ -106,11 +128,8 @@ def create_entity(
     _attr_device_class = ButtonDeviceClass.IDENTIFY
     _attr_entity_category = EntityCategory.DIAGNOSTIC
     _command_name = "identify"
-
-    def get_args(self) -> list[Any]:
-        """Return the arguments to use in the command."""
-
-        return [DEFAULT_DURATION]
+    _kwargs = {}
+    _args = [DEFAULT_DURATION]
 
 
 class ZHAAttributeButton(ZhaEntity, ButtonEntity):
@@ -127,8 +146,17 @@ def __init__(
         **kwargs: Any,
     ) -> None:
         """Init this button."""
-        super().__init__(unique_id, zha_device, cluster_handlers, **kwargs)
         self._cluster_handler: ClusterHandler = cluster_handlers[0]
+        if QUIRK_METADATA in kwargs:
+            self._init_from_quirks_metadata(kwargs[QUIRK_METADATA])
+        super().__init__(unique_id, zha_device, cluster_handlers, **kwargs)
+
+    def _init_from_quirks_metadata(self, entity_metadata: EntityMetadata) -> None:
+        """Init this entity from the quirks metadata."""
+        super()._init_from_quirks_metadata(entity_metadata)
+        button_metadata: WriteAttributeButtonMetadata = entity_metadata.entity_metadata
+        self._attribute_name = button_metadata.attribute_name
+        self._attribute_value = button_metadata.attribute_value
 
     async def async_press(self) -> None:
         """Write attribute with defined value."""

homeassistant/components/zha/core/const.py

@@ -64,6 +64,8 @@
 BAUD_RATES = [2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200, 128000, 256000]
 BINDINGS = "bindings"
 
+CLUSTER_DETAILS = "cluster_details"
+
 CLUSTER_HANDLER_ACCELEROMETER = "accelerometer"
 CLUSTER_HANDLER_BINARY_INPUT = "binary_input"
 CLUSTER_HANDLER_ANALOG_INPUT = "analog_input"
@@ -230,6 +232,10 @@
 PRESET_COMPLEX = "Complex"
 PRESET_TEMP_MANUAL = "Temporary manual"
 
+QUIRK_METADATA = "quirk_metadata"
+
+ZCL_INIT_ATTRS = "ZCL_INIT_ATTRS"
+
 ZHA_ALARM_OPTIONS = "zha_alarm_options"
 ZHA_OPTIONS = "zha_options"
 

homeassistant/components/zha/core/device.py

@@ -15,6 +15,7 @@
 import zigpy.exceptions
 from zigpy.profiles import PROFILES
 import zigpy.quirks
+from zigpy.quirks.v2 import CustomDeviceV2
 from zigpy.types.named import EUI64, NWK
 from zigpy.zcl.clusters import Cluster
 from zigpy.zcl.clusters.general import Groups, Identify
@@ -582,6 +583,9 @@ async def async_configure(self) -> None:
         await asyncio.gather(
             *(endpoint.async_configure() for endpoint in self._endpoints.values())
         )
+        if isinstance(self._zigpy_device, CustomDeviceV2):
+            self.debug("applying quirks v2 custom device configuration")
+            await self._zigpy_device.apply_custom_configuration()
         async_dispatcher_send(
             self.hass,
             const.ZHA_CLUSTER_HANDLER_MSG,