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
|
"""Provide models for Z-Wave JS firmware."""
from __future__ import annotations
from dataclasses import asdict, dataclass, field
from enum import IntEnum
from typing import Literal, Required, TypedDict, cast
from zwave_js_server.const import RFRegion
from zwave_js_server.util.helpers import convert_bytes_to_base64
@dataclass
class FirmwareUpdateData:
"""Firmware update data."""
filename: str
file: bytes
file_format: str | None = None
def to_dict(self) -> FirmwareUpdateDataDataType:
"""Convert firmware update data to dict."""
data: FirmwareUpdateDataDataType = {
"filename": self.filename,
"file": convert_bytes_to_base64(self.file),
}
if self.file_format is not None:
data["fileFormat"] = self.file_format
return data
class FirmwareUpdateDataDataType(TypedDict, total=False):
"""Represent a firmware update data dict type."""
filename: Required[str]
file: Required[str]
fileFormat: str
@dataclass
class FirmwareUpdateInfo:
"""Represent a firmware update info."""
version: str
changelog: str
channel: Literal["stable", "beta"]
files: list[FirmwareUpdateFileInfo]
downgrade: bool
normalized_version: str
device: FirmwareUpdateDeviceID
@classmethod
def from_dict(cls, data: FirmwareUpdateInfoDataType) -> FirmwareUpdateInfo:
"""Initialize from dict."""
return cls(
version=data["version"],
changelog=data["changelog"],
channel=data["channel"],
files=[FirmwareUpdateFileInfo.from_dict(file) for file in data["files"]],
downgrade=data["downgrade"],
normalized_version=data["normalizedVersion"],
device=FirmwareUpdateDeviceID.from_dict(data["device"]),
)
def to_dict(self) -> FirmwareUpdateInfoDataType:
"""Return dict representation of the object."""
return cast(
FirmwareUpdateInfoDataType,
{
"version": self.version,
"changelog": self.changelog,
"channel": self.channel,
"files": [file.to_dict() for file in self.files],
"downgrade": self.downgrade,
"normalizedVersion": self.normalized_version,
"device": self.device.to_dict(),
},
)
class FirmwareUpdateInfoDataType(TypedDict, total=False):
"""Represent a firmware update info data dict type."""
version: str
changelog: str
channel: Literal["stable", "beta"]
files: list[FirmwareUpdateFileInfoDataType]
downgrade: bool
normalizedVersion: str
device: FirmwareUpdateDeviceIDDataType
@dataclass
class FirmwareUpdateDeviceID:
"""Represent a firmware update device ID."""
manufacturer_id: int
product_type: int
product_id: int
firmware_version: str
rf_region: RFRegion | None
@classmethod
def from_dict(cls, data: FirmwareUpdateDeviceIDDataType) -> FirmwareUpdateDeviceID:
"""Initialize from dict."""
return cls(
manufacturer_id=data["manufacturerId"],
product_type=data["productType"],
product_id=data["productId"],
firmware_version=data["firmwareVersion"],
rf_region=RFRegion(data["rfRegion"]) if "rfRegion" in data else None,
)
def to_dict(self) -> FirmwareUpdateDeviceIDDataType:
"""Return dict representation of the object."""
data = {
"manufacturerId": self.manufacturer_id,
"productType": self.product_type,
"productId": self.product_id,
"firmwareVersion": self.firmware_version,
}
if self.rf_region is not None:
data["rfRegion"] = self.rf_region
return cast(FirmwareUpdateDeviceIDDataType, data)
class FirmwareUpdateDeviceIDDataType(TypedDict, total=False):
"""Represent a firmware update device ID dict type."""
manufacturerId: Required[int]
productType: Required[int]
productId: Required[int]
firmwareVersion: Required[str]
rfRegion: int
@dataclass
class FirmwareUpdateFileInfo:
"""Represent a firmware update file info."""
target: int
url: str
integrity: str
@classmethod
def from_dict(cls, data: FirmwareUpdateFileInfoDataType) -> FirmwareUpdateFileInfo:
"""Initialize from dict."""
return cls(
target=data["target"],
url=data["url"],
integrity=data["integrity"],
)
def to_dict(self) -> FirmwareUpdateFileInfoDataType:
"""Return dict representation of the object."""
return cast(FirmwareUpdateFileInfoDataType, asdict(self))
class FirmwareUpdateFileInfoDataType(TypedDict):
"""Represent a firmware update file info data dict type."""
target: int
url: str
integrity: str # sha256
@dataclass
class FirmwareUpdateProgress:
"""Model for a firmware update progress."""
data: FirmwareUpdateProgressDataType = field(repr=False)
sent_fragments: int = field(init=False)
total_fragments: int = field(init=False)
progress: float = field(init=False)
def __post_init__(self) -> None:
"""Post initialize."""
self.sent_fragments = self.data["sentFragments"]
self.total_fragments = self.data["totalFragments"]
self.progress = float(self.data["progress"])
class FirmwareUpdateProgressDataType(TypedDict):
"""Represent a firmware update progress dict type."""
sentFragments: int
totalFragments: int
progress: float
@dataclass
class FirmwareUpdateResult:
"""Model for firmware update result data."""
data: FirmwareUpdateResultDataType = field(repr=False)
status: IntEnum = field(init=False)
success: bool = field(init=False)
_status_class: type[IntEnum] = field(init=False, repr=False)
def __post_init__(self) -> None:
"""Post initialize."""
self.status = self._status_class(self.data["status"])
self.success = self.data["success"]
class FirmwareUpdateResultDataType(TypedDict):
"""Represent a driver firmware update result dict type."""
status: int
success: bool
|
