1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
|
"""Provide a model for the Z-Wave JS node's events."""
from __future__ import annotations
from typing import Literal
from pydantic import BaseModel
from ...const import CommandClass
from ...event import BaseEventModel
from ..notification import (
EntryControlNotificationArgsDataType,
MultilevelSwitchNotificationArgsDataType,
NotificationNotificationArgsDataType,
PowerLevelNotificationArgsDataType,
)
from ..value import ValueDataType
from .data_model import NodeDataType
from .firmware import (
NodeFirmwareUpdateProgressDataType,
NodeFirmwareUpdateResultDataType,
)
from .statistics import NodeStatisticsDataType
class BaseNodeEventModel(BaseEventModel):
"""Base model for a node event."""
source: Literal["node"]
nodeId: int
@classmethod
def from_dict(cls, data: dict) -> BaseNodeEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
nodeId=data["nodeId"],
)
class AliveEventModel(BaseNodeEventModel):
"""Model for `alive` event data."""
event: Literal["alive"]
class CheckHealthProgressEventModel(BaseNodeEventModel):
"""
Model for `check health progress` type events data.
Includes `check lifeline health progress` and `check route health progress` events.
"""
rounds: int
totalRounds: int
lastRating: int
@classmethod
def from_dict(cls, data: dict) -> CheckHealthProgressEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
nodeId=data["nodeId"],
rounds=data["rounds"],
totalRounds=data["totalRounds"],
lastRating=data["lastRating"],
)
class CheckLifelineHealthProgressEventModel(CheckHealthProgressEventModel):
"""Model for `check lifeline health progress` event data."""
event: Literal["check lifeline health progress"]
class CheckRouteHealthProgressEventModel(CheckHealthProgressEventModel):
"""Model for `check route health progress` event data."""
event: Literal["check route health progress"]
class DeadEventModel(BaseNodeEventModel):
"""Model for `dead` event data."""
event: Literal["dead"]
class InterviewCompletedEventModel(BaseNodeEventModel):
"""Model for `interview completed` event data."""
event: Literal["interview completed"]
class InterviewFailedEventArgsModel(BaseModel):
"""Model for `interview failed` event args."""
errorMessage: str
isFinal: bool
attempt: int | None = None
maxAttempts: int | None = None
@classmethod
def from_dict(cls, data: dict) -> InterviewFailedEventArgsModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
nodeId=data["nodeId"],
errorMessage=data["errorMessage"],
isFinal=data["isFinal"],
attempt=data["attempt"],
maxAttempts=data["maxAttempts"],
)
class InterviewFailedEventModel(BaseNodeEventModel):
"""Model for `interview failed` event data."""
event: Literal["interview failed"]
args: InterviewFailedEventArgsModel
@classmethod
def from_dict(cls, data: dict) -> InterviewFailedEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
nodeId=data["nodeId"],
args=data["args"],
)
class InterviewStageCompletedEventModel(BaseNodeEventModel):
"""Model for `interview stage completed` event data."""
event: Literal["interview stage completed"]
stageName: str
@classmethod
def from_dict(cls, data: dict) -> InterviewStageCompletedEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
nodeId=data["nodeId"],
stageName=data["stageName"],
)
class InterviewStartedEventModel(BaseNodeEventModel):
"""Model for `interview started` event data."""
event: Literal["interview started"]
class NotificationEventModel(BaseNodeEventModel):
"""Model for `notification` event data."""
event: Literal["notification"]
nodeId: int
endpointIndex: int
ccId: CommandClass
args: (
NotificationNotificationArgsDataType
| EntryControlNotificationArgsDataType
| PowerLevelNotificationArgsDataType
| MultilevelSwitchNotificationArgsDataType
)
@classmethod
def from_dict(cls, data: dict) -> NotificationEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
nodeId=data["nodeId"],
endpointIndex=data["endpointIndex"],
ccId=data["ccId"],
args=data["args"],
)
class ReadyEventModel(BaseNodeEventModel):
"""Model for `ready` event data."""
event: Literal["ready"]
nodeState: NodeDataType
@classmethod
def from_dict(cls, data: dict) -> ReadyEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
nodeId=data["nodeId"],
nodeState=data["nodeState"],
)
class SleepEventModel(BaseNodeEventModel):
"""Model for `sleep` event data."""
event: Literal["sleep"]
class StatisticsUpdatedEventModel(BaseNodeEventModel):
"""Model for `statistics updated` event data."""
event: Literal["statistics updated"]
statistics: NodeStatisticsDataType
@classmethod
def from_dict(cls, data: dict) -> StatisticsUpdatedEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
nodeId=data["nodeId"],
statistics=data["statistics"],
)
class TestPowerLevelProgressEventModel(BaseNodeEventModel):
"""Model for `test powerlevel progress` event data."""
event: Literal["test powerlevel progress"]
acknowledged: int
total: int
@classmethod
def from_dict(cls, data: dict) -> TestPowerLevelProgressEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
nodeId=data["nodeId"],
acknowledged=data["acknowledged"],
total=data["total"],
)
class ValueEventModel(BaseNodeEventModel):
"""
Model for `value` events data.
Subclass for event models for `metadata updated`, `value added`,
`value notification`, `value removed`, and `value updated`.
"""
args: ValueDataType
@classmethod
def from_dict(cls, data: dict) -> ValueEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
nodeId=data["nodeId"],
args=data["args"],
)
class MetadataUpdatedEventModel(ValueEventModel):
"""Model for `metadata updated` event data."""
event: Literal["metadata updated"]
class ValueAddedEventModel(ValueEventModel):
"""Model for `value added` event data."""
event: Literal["value added"]
class ValueNotificationEventModel(ValueEventModel):
"""Model for `value notification` event data."""
event: Literal["value notification"]
class ValueRemovedEventModel(ValueEventModel):
"""Model for `value removed` event data."""
event: Literal["value removed"]
class ValueUpdatedEventModel(ValueEventModel):
"""Model for `value updated` event data."""
event: Literal["value updated"]
class WakeUpEventModel(BaseNodeEventModel):
"""Model for `wake up` event data."""
event: Literal["wake up"]
class FirmwareUpdateFinishedEventModel(BaseNodeEventModel):
"""Model for `firmware update finished` event data."""
event: Literal["firmware update finished"]
result: NodeFirmwareUpdateResultDataType
@classmethod
def from_dict(cls, data: dict) -> FirmwareUpdateFinishedEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
nodeId=data["nodeId"],
result=data["result"],
)
class FirmwareUpdateProgressEventModel(BaseNodeEventModel):
"""Model for `firmware update progress` event data."""
event: Literal["firmware update progress"]
progress: NodeFirmwareUpdateProgressDataType
@classmethod
def from_dict(cls, data: dict) -> FirmwareUpdateProgressEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
nodeId=data["nodeId"],
progress=data["progress"],
)
NODE_EVENT_MODEL_MAP: dict[str, type[BaseNodeEventModel]] = {
"alive": AliveEventModel,
"check lifeline health progress": CheckLifelineHealthProgressEventModel,
"check route health progress": CheckRouteHealthProgressEventModel,
"dead": DeadEventModel,
"firmware update finished": FirmwareUpdateFinishedEventModel,
"firmware update progress": FirmwareUpdateProgressEventModel,
"interview completed": InterviewCompletedEventModel,
"interview failed": InterviewFailedEventModel,
"interview stage completed": InterviewStageCompletedEventModel,
"interview started": InterviewStartedEventModel,
"metadata updated": MetadataUpdatedEventModel,
"notification": NotificationEventModel,
"ready": ReadyEventModel,
"sleep": SleepEventModel,
"statistics updated": StatisticsUpdatedEventModel,
"test powerlevel progress": TestPowerLevelProgressEventModel,
"value added": ValueAddedEventModel,
"value notification": ValueNotificationEventModel,
"value removed": ValueRemovedEventModel,
"value updated": ValueUpdatedEventModel,
"wake up": WakeUpEventModel,
}
|