clean up

dmulcahey · dmulcahey · commit d542e4996a01 · 2024-11-25T13:24:35.000-05:00
diff --git a/tests/websocket/test_client_controller.py b/tests/websocket/test_client_controller.py
@@ -22,7 +22,7 @@
 from zha.application.model import DeviceJoinedEvent, DeviceLeftEvent
 from zha.application.platforms import WebSocketClientEntity
 from zha.application.platforms.switch import WebSocketClientSwitchEntity
-from zha.websocket.const import ControllerEvents
+from zha.const import ControllerEvents
 from zha.websocket.server.api.model import (
     ReadClusterAttributesResponse,
     WriteClusterAttributeResponse,
diff --git a/zha/application/gateway.py b/zha/application/gateway.py
@@ -78,6 +78,7 @@
     create_eager_task,
     gather_with_limited_concurrency,
 )
+from zha.const import ControllerEvents, DeviceEvents
 from zha.event import EventBase
 from zha.model import BaseEvent
 from zha.websocket import ZHAWebSocketException
@@ -102,7 +103,7 @@
     SwitchHelper,
     UpdateHelper,
 )
-from zha.websocket.const import WEBSOCKET_API, ControllerEvents, DeviceEvents
+from zha.websocket.const import WEBSOCKET_API
 from zha.websocket.server.client import ClientManager, load_api as load_client_api
 from zha.zigbee.device import BaseDevice, Device, WebSocketClientDevice
 from zha.zigbee.endpoint import ATTR_IN_CLUSTERS, ATTR_OUT_CLUSTERS
@@ -1126,7 +1127,7 @@ def handle_zha_event(self, event: ZHAEvent) -> None:
         if device is None:
             _LOGGER.warning("Received zha_event from unknown device: %s", event)
             return
-        device.emit("zha_event", event)
+        device.emit(DeviceEvents.ZHA_EVENT, event)
 
     def handle_device_joined(self, event: DeviceJoinedEvent) -> None:
         """Handle device joined.
diff --git a/zha/application/model.py b/zha/application/model.py
@@ -17,9 +17,8 @@
     CONF_DEFAULT_CONSIDER_UNAVAILABLE_BATTERY,
     CONF_DEFAULT_CONSIDER_UNAVAILABLE_MAINS,
 )
-from zha.const import EventTypes
+from zha.const import ControllerEvents, DeviceEvents, EventTypes
 from zha.model import BaseEvent, BaseModel
-from zha.websocket.const import ControllerEvents, DeviceEvents
 from zha.zigbee.model import DeviceInfo, ExtendedDeviceInfo, GroupInfo
 
 if TYPE_CHECKING:
diff --git a/zha/application/platforms/__init__.py b/zha/application/platforms/__init__.py
@@ -21,7 +21,7 @@
     PlatformEntityIdentifiers,
     T as BaseEntityInfoType,
 )
-from zha.const import STATE_CHANGED
+from zha.const import STATE_CHANGED, EntityEvents, EventTypes
 from zha.debounce import Debouncer
 from zha.event import EventBase
 from zha.mixins import LogMixin
@@ -44,8 +44,8 @@
 class EntityStateChangedEvent(BaseEvent):
     """Event for when an entity state changes."""
 
-    event_type: Literal["entity"] = "entity"
-    event: Literal["state_changed"] = "state_changed"
+    event_type: Literal[EventTypes.ENTITY_EVENT] = EventTypes.ENTITY_EVENT
+    event: Literal[EntityEvents.STATE_CHANGED] = EntityEvents.STATE_CHANGED
     platform: Platform
     unique_id: str
     device_ieee: EUI64 | None = None
diff --git a/zha/application/platforms/alarm_control_panel/__init__.py b/zha/application/platforms/alarm_control_panel/__init__.py
@@ -22,7 +22,7 @@
 )
 from zha.application.platforms.model import EntityState
 from zha.application.registries import PLATFORM_ENTITIES
-from zha.websocket.const import MODEL_CLASS_NAME
+from zha.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_IAS_ACE,
     CLUSTER_HANDLER_STATE_CHANGED,
diff --git a/zha/application/platforms/binary_sensor/__init__.py b/zha/application/platforms/binary_sensor/__init__.py
@@ -21,7 +21,7 @@
 from zha.application.platforms.helpers import validate_device_class
 from zha.application.platforms.model import EntityState
 from zha.application.registries import PLATFORM_ENTITIES
-from zha.websocket.const import MODEL_CLASS_NAME
+from zha.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ACCELEROMETER,
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
diff --git a/zha/application/platforms/button/__init__.py b/zha/application/platforms/button/__init__.py
@@ -21,7 +21,7 @@
 from zha.application.platforms.const import EntityCategory
 from zha.application.platforms.model import EntityState
 from zha.application.registries import PLATFORM_ENTITIES
-from zha.websocket.const import MODEL_CLASS_NAME
+from zha.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import CLUSTER_HANDLER_IDENTIFY
 
 if TYPE_CHECKING:
diff --git a/zha/application/platforms/climate/__init__.py b/zha/application/platforms/climate/__init__.py
@@ -42,9 +42,9 @@
     ThermostatState,
 )
 from zha.application.registries import PLATFORM_ENTITIES
+from zha.const import MODEL_CLASS_NAME
 from zha.decorators import periodic
 from zha.units import UnitOfTemperature
-from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
     CLUSTER_HANDLER_FAN,
diff --git a/zha/application/platforms/cover/__init__.py b/zha/application/platforms/cover/__init__.py
@@ -33,8 +33,8 @@
     ShadeState,
 )
 from zha.application.registries import PLATFORM_ENTITIES
+from zha.const import MODEL_CLASS_NAME
 from zha.exceptions import ZHAException
-from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.closures import WindowCoveringClusterHandler
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
diff --git a/zha/application/platforms/device_tracker/__init__.py b/zha/application/platforms/device_tracker/__init__.py
@@ -18,8 +18,8 @@
 )
 from zha.application.platforms.sensor import Battery
 from zha.application.registries import PLATFORM_ENTITIES
+from zha.const import MODEL_CLASS_NAME
 from zha.decorators import periodic
-from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
     CLUSTER_HANDLER_POWER_CONFIGURATION,
diff --git a/zha/application/platforms/events.py b/zha/application/platforms/events.py
@@ -23,6 +23,7 @@
 )
 from zha.application.platforms.switch.model import SwitchState
 from zha.application.platforms.update.model import FirmwareUpdateState
+from zha.const import EntityEvents, EventTypes
 from zha.model import BaseEvent, as_tagged_union
 
 EntityStateUnion = (
@@ -50,8 +51,8 @@
 class EntityStateChangedEvent(BaseEvent):
     """Event for when an entity state changes."""
 
-    event_type: Literal["entity"] = "entity"
-    event: Literal["state_changed"] = "state_changed"
+    event_type: Literal[EventTypes.ENTITY_EVENT] = EventTypes.ENTITY_EVENT
+    event: Literal[EntityEvents.STATE_CHANGED] = EntityEvents.STATE_CHANGED
     platform: Platform
     unique_id: str
     device_ieee: EUI64 | None = None
diff --git a/zha/application/platforms/fan/__init__.py b/zha/application/platforms/fan/__init__.py
@@ -39,7 +39,7 @@
 )
 from zha.application.platforms.fan.model import FanEntityInfo, FanState
 from zha.application.registries import PLATFORM_ENTITIES
-from zha.websocket.const import MODEL_CLASS_NAME
+from zha.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers import wrap_zigpy_exceptions
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
diff --git a/zha/application/platforms/light/__init__.py b/zha/application/platforms/light/__init__.py
@@ -62,9 +62,9 @@
 )
 from zha.application.platforms.light.model import LightEntityInfo, LightState
 from zha.application.registries import PLATFORM_ENTITIES
+from zha.const import MODEL_CLASS_NAME
 from zha.debounce import Debouncer
 from zha.decorators import periodic
-from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
     CLUSTER_HANDLER_COLOR,
diff --git a/zha/application/platforms/lock/__init__.py b/zha/application/platforms/lock/__init__.py
@@ -18,7 +18,7 @@
 )
 from zha.application.platforms.lock.model import LockEntityInfo, LockState
 from zha.application.registries import PLATFORM_ENTITIES
-from zha.websocket.const import MODEL_CLASS_NAME
+from zha.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
     CLUSTER_HANDLER_DOORLOCK,
diff --git a/zha/application/platforms/number/__init__.py b/zha/application/platforms/number/__init__.py
@@ -28,8 +28,8 @@
     NumberEntityInfo,
 )
 from zha.application.registries import PLATFORM_ENTITIES
+from zha.const import MODEL_CLASS_NAME
 from zha.units import UnitOfMass, UnitOfTemperature, UnitOfTime, validate_unit
-from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ANALOG_OUTPUT,
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
diff --git a/zha/application/platforms/select/__init__.py b/zha/application/platforms/select/__init__.py
@@ -31,7 +31,7 @@
     SelectEntityInfo,
 )
 from zha.application.registries import PLATFORM_ENTITIES
-from zha.websocket.const import MODEL_CLASS_NAME
+from zha.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
     CLUSTER_HANDLER_HUE_OCCUPANCY,
diff --git a/zha/application/platforms/sensor/__init__.py b/zha/application/platforms/sensor/__init__.py
@@ -49,6 +49,7 @@
     TimestampState,
 )
 from zha.application.registries import PLATFORM_ENTITIES
+from zha.const import MODEL_CLASS_NAME
 from zha.decorators import periodic
 from zha.units import (
     CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
@@ -71,7 +72,6 @@
     UnitOfVolumeFlowRate,
     validate_unit,
 )
-from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ANALOG_INPUT,
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
diff --git a/zha/application/platforms/siren/__init__.py b/zha/application/platforms/siren/__init__.py
@@ -35,7 +35,7 @@
 )
 from zha.application.platforms.siren.model import SirenEntityInfo
 from zha.application.registries import PLATFORM_ENTITIES
-from zha.websocket.const import MODEL_CLASS_NAME
+from zha.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import CLUSTER_HANDLER_IAS_WD
 from zha.zigbee.cluster_handlers.security import IasWdClusterHandler
 
diff --git a/zha/application/platforms/switch/__init__.py b/zha/application/platforms/switch/__init__.py
@@ -28,7 +28,7 @@
     SwitchState,
 )
 from zha.application.registries import PLATFORM_ENTITIES
-from zha.websocket.const import MODEL_CLASS_NAME
+from zha.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
     CLUSTER_HANDLER_BASIC,
diff --git a/zha/application/platforms/update/__init__.py b/zha/application/platforms/update/__init__.py
@@ -31,8 +31,8 @@
     FirmwareUpdateState,
 )
 from zha.application.registries import PLATFORM_ENTITIES
+from zha.const import MODEL_CLASS_NAME
 from zha.exceptions import ZHAException
-from zha.websocket.const import MODEL_CLASS_NAME
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ATTRIBUTE_UPDATED,
     CLUSTER_HANDLER_OTA,
diff --git a/zha/const.py b/zha/const.py
@@ -8,6 +8,9 @@
 EVENT_TYPE: Final[str] = "event_type"
 
 MESSAGE_TYPE: Final[str] = "message_type"
+MODEL_CLASS_NAME: Final[str] = "model_class_name"
+
+COMMAND: Final[str] = "command"
 
 
 class EventTypes(StrEnum):
@@ -17,3 +20,61 @@ class EventTypes(StrEnum):
     PLATFORM_ENTITY_EVENT = "platform_entity_event"
     RAW_ZCL_EVENT = "raw_zcl_event"
     DEVICE_EVENT = "device_event"
+    ENTITY_EVENT = "entity"
+    CLUSTER_HANDLER_EVENT = "cluster_handler_event"
+
+
+class ClusterHandlerEvents(StrEnum):
+    """Cluster handler events."""
+
+    CLUSTER_HANDLER_STATE_CHANGED = "cluster_handler_state_changed"
+    CLUSTER_HANDLER_ATTRIBUTE_UPDATED = "cluster_handler_attribute_updated"
+
+
+class EntityEvents(StrEnum):
+    """Entity events."""
+
+    STATE_CHANGED = "state_changed"
+
+
+class MessageTypes(StrEnum):
+    """WS message types."""
+
+    EVENT = "event"
+    RESULT = "result"
+
+
+class ControllerEvents(StrEnum):
+    """WS controller events."""
+
+    DEVICE_JOINED = "device_joined"
+    RAW_DEVICE_INITIALIZED = "raw_device_initialized"
+    DEVICE_REMOVED = "device_removed"
+    DEVICE_LEFT = "device_left"
+    DEVICE_FULLY_INITIALIZED = "device_fully_initialized"
+    DEVICE_CONFIGURED = "device_configured"
+    GROUP_MEMBER_ADDED = "group_member_added"
+    GROUP_MEMBER_REMOVED = "group_member_removed"
+    GROUP_ADDED = "group_added"
+    GROUP_REMOVED = "group_removed"
+    CONNECTION_LOST = "connection_lost"
+
+
+class PlatformEntityEvents(StrEnum):
+    """WS platform entity events."""
+
+    PLATFORM_ENTITY_STATE_CHANGED = "platform_entity_state_changed"
+
+
+class RawZCLEvents(StrEnum):
+    """WS raw ZCL events."""
+
+    ATTRIBUTE_UPDATED = "attribute_updated"
+
+
+class DeviceEvents(StrEnum):
+    """Events that devices can broadcast."""
+
+    DEVICE_OFFLINE = "device_offline"
+    DEVICE_ONLINE = "device_online"
+    ZHA_EVENT = "zha_event"
diff --git a/zha/model.py b/zha/model.py
@@ -19,8 +19,8 @@
 )
 from zigpy.types.named import EUI64, NWK
 
+from zha.const import MODEL_CLASS_NAME, MessageTypes
 from zha.event import EventBase
-from zha.websocket.const import MODEL_CLASS_NAME
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -162,7 +162,7 @@ def as_tagged_union(union):
 class BaseEvent(TypedBaseModel):
     """Base model for ZHA events."""
 
-    message_type: Literal["event"] = "event"
+    message_type: Literal[MessageTypes.EVENT] = MessageTypes.EVENT
     event_type: str
     event: str
 
diff --git a/zha/websocket/client/client.py b/zha/websocket/client/client.py
@@ -14,19 +14,17 @@
 from async_timeout import timeout
 from pydantic_core import ValidationError
 
+from zha.const import COMMAND, MESSAGE_TYPE, MessageTypes
 from zha.event import EventBase
 from zha.websocket import ZHAWebSocketException
 from zha.websocket.client.model.messages import Message
 from zha.websocket.const import (
-    COMMAND,
     ERROR_CODE,
     MESSAGE_ID,
-    MESSAGE_TYPE,
     SUCCESS,
     ZIGBEE_ERROR,
     ZIGBEE_ERROR_CODE,
     ZIGBEE_ERROR_MESSAGE,
-    MessageTypes,
 )
 from zha.websocket.server.api.model import WebSocketCommand, WebSocketCommandResponse
 
diff --git a/zha/websocket/const.py b/zha/websocket/const.py
diff --git a/zha/websocket/server/api/model.py b/zha/websocket/server/api/model.py
diff --git a/zha/websocket/server/client.py b/zha/websocket/server/client.py
diff --git a/zha/zigbee/cluster_handlers/model.py b/zha/zigbee/cluster_handlers/model.py
diff --git a/zha/zigbee/cluster_handlers/security.py b/zha/zigbee/cluster_handlers/security.py
diff --git a/zha/zigbee/model.py b/zha/zigbee/model.py

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`)`
`23`	`23`	`from zha.application.platforms.model import EntityState`
`24`	`24`	`from zha.application.registries import PLATFORM_ENTITIES`
`25`		`-from zha.websocket.const import MODEL_CLASS_NAME`
	`25`	`+from zha.const import MODEL_CLASS_NAME`
`26`	`26`	`from zha.zigbee.cluster_handlers.const import (`
`27`	`27`	`CLUSTER_HANDLER_IAS_ACE,`
`28`	`28`	`CLUSTER_HANDLER_STATE_CHANGED,`