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
|
"""Provide a model for the Z-Wave JS controller's events."""
from __future__ import annotations
from typing import Literal, TypedDict
from ...const import InclusionState, InclusionStrategy, RemoveNodeReason
from ...event import BaseEventModel
from ..node.data_model import FoundNodeDataType, NodeDataType
from .inclusion_and_provisioning import InclusionGrantDataType
from .statistics import ControllerStatisticsDataType
class InclusionResultDataType(TypedDict, total=False):
"""Represent an inclusion result data dict type."""
lowSecurity: bool # required
lowSecurityReason: int
class BaseControllerEventModel(BaseEventModel):
"""Base model for a controller event."""
source: Literal["controller"]
class ExclusionFailedEventModel(BaseControllerEventModel):
"""Model for `exclusion failed` event data."""
event: Literal["exclusion failed"]
class ExclusionStartedEventModel(BaseControllerEventModel):
"""Model for `exclusion started` event data."""
event: Literal["exclusion started"]
class ExclusionStoppedEventModel(BaseControllerEventModel):
"""Model for `exclusion stopped` event data."""
event: Literal["exclusion stopped"]
class GrantSecurityClassesEventModel(BaseControllerEventModel):
"""Model for `grant security classes` event data."""
event: Literal["grant security classes"]
requested: InclusionGrantDataType
@classmethod
def from_dict(cls, data: dict) -> GrantSecurityClassesEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
requested=data["requested"],
)
class RebuildRoutesDoneEventModel(BaseControllerEventModel):
"""Model for `rebuild routes done` event data."""
event: Literal["rebuild routes done"]
result: dict[str, str]
@classmethod
def from_dict(cls, data: dict) -> RebuildRoutesDoneEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
result=data["result"],
)
class RebuildRoutesProgressEventModel(BaseControllerEventModel):
"""Model for `rebuild routes progress` event data."""
event: Literal["rebuild routes progress"]
progress: dict[str, str]
@classmethod
def from_dict(cls, data: dict) -> RebuildRoutesProgressEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
progress=data["progress"],
)
class InclusionAbortedEventModel(BaseControllerEventModel):
"""Model for `inclusion aborted` event data."""
event: Literal["inclusion aborted"]
class InclusionFailedEventModel(BaseControllerEventModel):
"""Model for `inclusion failed` event data."""
event: Literal["inclusion failed"]
class InclusionStartedEventModel(BaseControllerEventModel):
"""Model for `inclusion started` event data."""
event: Literal["inclusion started"]
strategy: InclusionStrategy
@classmethod
def from_dict(cls, data: dict) -> InclusionStartedEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
strategy=data["strategy"],
)
class InclusionStateChangedEventModel(BaseControllerEventModel):
"""Model for `inclusion state changed` event data."""
event: Literal["inclusion state changed"]
state: InclusionState
@classmethod
def from_dict(cls, data: dict) -> InclusionStateChangedEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
state=data["state"],
)
class InclusionStoppedEventModel(BaseControllerEventModel):
"""Model for `inclusion stopped` event data."""
event: Literal["inclusion stopped"]
class NodeAddedEventModel(BaseControllerEventModel):
"""Model for `node added` event data."""
event: Literal["node added"]
node: NodeDataType
result: InclusionResultDataType
@classmethod
def from_dict(cls, data: dict) -> NodeAddedEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
node=data["node"],
result=data["result"],
)
class NodeFoundEventModel(BaseControllerEventModel):
"""Model for `node found` event data."""
event: Literal["node found"]
node: FoundNodeDataType
@classmethod
def from_dict(cls, data: dict) -> NodeFoundEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
node=data["node"],
)
class NodeRemovedEventModel(BaseControllerEventModel):
"""Model for `node removed` event data."""
event: Literal["node removed"]
node: NodeDataType
reason: RemoveNodeReason
@classmethod
def from_dict(cls, data: dict) -> NodeRemovedEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
node=data["node"],
reason=data["reason"],
)
class NVMBackupAndConvertProgressEventModel(BaseControllerEventModel):
"""Base model for `nvm backup progress` and `nvm convert progress` event data."""
bytesRead: int
total: int
@classmethod
def from_dict(cls, data: dict) -> NVMBackupAndConvertProgressEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
bytesRead=data["bytesRead"],
total=data["total"],
)
class NVMBackupProgressEventModel(NVMBackupAndConvertProgressEventModel):
"""Model for `nvm backup progress` event data."""
event: Literal["nvm backup progress"]
class NVMConvertProgressEventModel(NVMBackupAndConvertProgressEventModel):
"""Model for `nvm convert progress` event data."""
event: Literal["nvm convert progress"]
class NVMRestoreProgressEventModel(BaseControllerEventModel):
"""Model for `nvm restore progress` event data."""
event: Literal["nvm restore progress"]
bytesWritten: int
total: int
@classmethod
def from_dict(cls, data: dict) -> NVMRestoreProgressEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
bytesWritten=data["bytesWritten"],
total=data["total"],
)
class StatisticsUpdatedEventModel(BaseControllerEventModel):
"""Model for `statistics updated` event data."""
event: Literal["statistics updated"]
statistics: ControllerStatisticsDataType
@classmethod
def from_dict(cls, data: dict) -> StatisticsUpdatedEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
statistics=data["statistics"],
)
class ValidateDSKAndEnterPINEventModel(BaseControllerEventModel):
"""Model for `validate dsk and enter pin` event data."""
event: Literal["validate dsk and enter pin"]
dsk: str
@classmethod
def from_dict(cls, data: dict) -> ValidateDSKAndEnterPINEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
dsk=data["dsk"],
)
class IdentifyEventModel(BaseControllerEventModel):
"""Model for `identify` event data."""
event: Literal["identify"]
nodeId: int
@classmethod
def from_dict(cls, data: dict) -> IdentifyEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
nodeId=data["nodeId"],
)
class StatusChangedEventModel(BaseControllerEventModel):
"""Model for `status changed` event data."""
event: Literal["status changed"]
status: int
@classmethod
def from_dict(cls, data: dict) -> StatusChangedEventModel:
"""Initialize from dict."""
return cls(
source=data["source"],
event=data["event"],
status=data["status"],
)
CONTROLLER_EVENT_MODEL_MAP: dict[str, type[BaseControllerEventModel]] = {
"exclusion failed": ExclusionFailedEventModel,
"exclusion started": ExclusionStartedEventModel,
"exclusion stopped": ExclusionStoppedEventModel,
"grant security classes": GrantSecurityClassesEventModel,
"rebuild routes done": RebuildRoutesDoneEventModel,
"rebuild routes progress": RebuildRoutesProgressEventModel,
"identify": IdentifyEventModel,
"inclusion aborted": InclusionAbortedEventModel,
"inclusion failed": InclusionFailedEventModel,
"inclusion started": InclusionStartedEventModel,
"inclusion state changed": InclusionStateChangedEventModel,
"inclusion stopped": InclusionStoppedEventModel,
"node added": NodeAddedEventModel,
"node found": NodeFoundEventModel,
"node removed": NodeRemovedEventModel,
"nvm backup progress": NVMBackupProgressEventModel,
"nvm convert progress": NVMConvertProgressEventModel,
"nvm restore progress": NVMRestoreProgressEventModel,
"statistics updated": StatisticsUpdatedEventModel,
"status changed": StatusChangedEventModel,
"validate dsk and enter pin": ValidateDSKAndEnterPINEventModel,
}
|
