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
|
from __future__ import annotations
import abc
import asyncio
import binascii
import functools
import logging
import sys
from typing import TYPE_CHECKING, Any, AsyncGenerator, Callable, Iterable
import zigpy.state
if sys.version_info[:2] < (3, 11):
from async_timeout import timeout as asyncio_timeout # pragma: no cover
else:
from asyncio import timeout as asyncio_timeout # pragma: no cover
from bellows.config import CONF_EZSP_POLICIES
from bellows.exception import InvalidCommandError
import bellows.types as t
if TYPE_CHECKING:
from bellows.uart import Gateway
LOGGER = logging.getLogger(__name__)
EZSP_CMD_TIMEOUT = 6 # Sum of all ASH retry timeouts: 0.4 + 0.8 + 1.6 + 3.2
class ProtocolHandler(abc.ABC):
"""EZSP protocol specific handler."""
COMMANDS = {}
VERSION = None
def __init__(self, cb_handler: Callable, gateway: Gateway) -> None:
self._handle_callback = cb_handler
self._awaiting = {}
self._gw = gateway
self._seq = 0
self.COMMANDS_BY_ID = {
cmd_id: (name, tx_schema, rx_schema)
for name, (cmd_id, tx_schema, rx_schema) in self.COMMANDS.items()
}
self.tc_policy = 0
# Cached by `set_extended_timeout` so subsequent calls are a little faster
self._address_table_size: int | None = None
def _ezsp_frame(self, name: str, *args: Any, **kwargs: Any) -> bytes:
"""Serialize the named frame and data."""
c, tx_schema, rx_schema = self.COMMANDS[name]
frame = self._ezsp_frame_tx(name)
if isinstance(tx_schema, dict):
data = t.serialize_dict(args, kwargs, tx_schema)
else:
data = tx_schema(*args, **kwargs).serialize()
return frame + data
@abc.abstractmethod
def _ezsp_frame_rx(self, data: bytes) -> tuple[int, int, bytes]:
"""Handler for received data frame."""
@abc.abstractmethod
def _ezsp_frame_tx(self, name: str) -> bytes:
"""Serialize the named frame."""
async def command(self, name, *args, **kwargs) -> Any:
"""Serialize command and send it."""
LOGGER.debug("Sending command %s: %s %s", name, args, kwargs)
data = self._ezsp_frame(name, *args, **kwargs)
cmd_id, _, rx_schema = self.COMMANDS[name]
future = asyncio.get_running_loop().create_future()
self._awaiting[self._seq] = (cmd_id, rx_schema, future)
self._seq = (self._seq + 1) % 256
async with asyncio_timeout(EZSP_CMD_TIMEOUT):
await self._gw.send_data(data)
return await future
async def update_policies(self, policy_config: dict) -> None:
"""Set up the policies for what the NCP should do."""
policies = self.SCHEMAS[CONF_EZSP_POLICIES](policy_config)
self.tc_policy = policies[t.EzspPolicyId.TRUST_CENTER_POLICY.name]
for policy, value in policies.items():
(status,) = await self.setPolicy(t.EzspPolicyId[policy], value)
assert (
t.sl_Status.from_ember_status(status) == t.sl_Status.OK
) # TODO: Better check
def __call__(self, data: bytes) -> None:
"""Handler for received data frame."""
orig_data = data
sequence, frame_id, data = self._ezsp_frame_rx(data)
try:
frame_name, _, rx_schema = self.COMMANDS_BY_ID[frame_id]
except KeyError:
LOGGER.warning(
"Unknown application frame 0x%04X received: %s (%s). This is a bug!",
frame_id,
binascii.hexlify(data),
binascii.hexlify(orig_data),
)
return
try:
if isinstance(rx_schema, dict):
result, data = t.deserialize_dict(data, rx_schema)
LOGGER.debug("Received command %s: %s", frame_name, result)
result = list(result.values())
else:
result, data = rx_schema.deserialize(data)
LOGGER.debug("Received command %s: %s", frame_name, result)
except Exception:
LOGGER.warning(
"Failed to parse frame %s: %s",
frame_name,
binascii.hexlify(data),
exc_info=True,
)
raise
if data:
LOGGER.debug("Frame contains trailing data: %s", data)
if sequence in self._awaiting:
expected_id, schema, future = self._awaiting.pop(sequence)
try:
if frame_name == "invalidCommand":
sent_cmd_name = self.COMMANDS_BY_ID[expected_id][0]
future.set_exception(
InvalidCommandError(
f"{sent_cmd_name} command is an {frame_name}, was sent "
f"under {sequence} sequence number: {result[0].name}"
)
)
return
assert expected_id == frame_id
future.set_result(result)
except asyncio.InvalidStateError:
LOGGER.debug(
"Error processing %s response. %s command timed out?",
sequence,
self.COMMANDS_BY_ID.get(expected_id, [expected_id])[0],
)
else:
self._handle_callback(frame_name, result)
def __getattr__(self, name: str) -> Callable:
if name not in self.COMMANDS:
raise AttributeError(f"{name} not found in COMMANDS")
return functools.partial(self.command, name)
async def pre_permit(self, time_s: int) -> None:
"""Schedule task before allowing new joins."""
@abc.abstractmethod
async def add_transient_link_key(
self, ieee: t.EUI64, key: t.KeyData
) -> t.sl_Status:
raise NotImplementedError
@abc.abstractmethod
async def read_child_data(
self,
) -> AsyncGenerator[tuple[t.NWK, t.EUI64, t.EmberNodeType], None]:
raise NotImplementedError
@abc.abstractmethod
async def read_link_keys(self) -> AsyncGenerator[zigpy.state.Key, None]:
raise NotImplementedError
@abc.abstractmethod
async def read_address_table(self) -> AsyncGenerator[tuple[t.NWK, t.EUI64], None]:
raise NotImplementedError
@abc.abstractmethod
async def get_network_key(self) -> zigpy.state.Key:
raise NotImplementedError
@abc.abstractmethod
async def get_tc_link_key(self) -> zigpy.state.Key:
raise NotImplementedError
@abc.abstractmethod
async def write_nwk_frame_counter(self, frame_counter: t.uint32_t) -> None:
raise NotImplementedError
@abc.abstractmethod
async def write_aps_frame_counter(self, frame_counter: t.uint32_t) -> None:
raise NotImplementedError
@abc.abstractmethod
async def write_link_keys(self, keys: Iterable[zigpy.state.Key]) -> None:
raise NotImplementedError
@abc.abstractmethod
async def write_child_data(self, children: dict[t.EUI64, t.NWK]) -> None:
raise NotImplementedError
@abc.abstractmethod
async def initialize_network(self) -> t.sl_Status:
raise NotImplementedError
@abc.abstractmethod
async def factory_reset(self) -> None:
raise NotImplementedError
@abc.abstractmethod
async def send_unicast(
self,
nwk: t.NWK,
aps_frame: t.EmberApsFrame,
message_tag: t.uint8_t,
data: bytes,
) -> tuple[t.sl_Status, t.uint8_t]:
raise NotImplementedError
@abc.abstractmethod
async def send_multicast(
self,
aps_frame: t.EmberApsFrame,
radius: t.uint8_t,
non_member_radius: t.uint8_t,
message_tag: t.uint8_t,
data: bytes,
) -> tuple[t.sl_Status, t.uint8_t]:
raise NotImplementedError
@abc.abstractmethod
async def send_broadcast(
self,
address: t.BroadcastAddress,
aps_frame: t.EmberApsFrame,
radius: t.uint8_t,
message_tag: t.uint8_t,
aps_sequence: t.uint8_t,
data: bytes,
) -> tuple[t.sl_Status, t.uint8_t]:
raise NotImplementedError
@abc.abstractmethod
async def set_source_route(self, nwk: t.NWK, relays: list[t.NWK]) -> t.sl_Status:
raise NotImplementedError
@abc.abstractmethod
async def read_counters(self) -> dict[t.EmberCounterType, int]:
raise NotImplementedError
@abc.abstractmethod
async def read_and_clear_counters(self) -> dict[t.EmberCounterType, int]:
raise NotImplementedError
@abc.abstractmethod
async def set_extended_timeout(
self, nwk: t.NWK, ieee: t.EUI64, extended_timeout: bool = True
) -> None:
raise NotImplementedError()
|
