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 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
|
"""Package for management communication."""
from __future__ import annotations
import asyncio
from collections.abc import AsyncGenerator, AsyncIterator, Callable, Generator
from contextlib import asynccontextmanager
import logging
import time
from typing import TYPE_CHECKING
from xknx.exceptions import (
CommunicationError,
ConfirmationError,
ManagementConnectionError,
ManagementConnectionRefused,
ManagementConnectionTimeout,
)
from xknx.telegram import GroupAddress, IndividualAddress, Telegram
from xknx.telegram.apci import APCI
from xknx.telegram.tpci import (
TAck,
TConnect,
TDataBroadcast,
TDataConnected,
TDisconnect,
TNak,
)
from xknx.util import asyncio_timeout
if TYPE_CHECKING:
from xknx.xknx import XKNX
logger = logging.getLogger("xknx.management")
MANAGAMENT_ACK_TIMEOUT = 3
MANAGAMENT_CONNECTION_TIMEOUT = 6
class Management:
"""Class for management procedures as described in KNX-Standard 3.5.2."""
__slots__ = ("_broadcast_contexts", "_connections", "xknx")
def __init__(self, xknx: XKNX) -> None:
"""Initialize Management class."""
self.xknx = xknx
self._connections: dict[IndividualAddress, P2PConnection] = {}
self._broadcast_contexts: set[BroadcastContext] = set()
def process(self, telegram: Telegram) -> None:
"""Process incoming telegrams."""
if isinstance(telegram.tpci, TDataConnected):
ack = Telegram(
destination_address=telegram.source_address,
tpci=TAck(sequence_number=telegram.tpci.sequence_number),
)
self.xknx.task_registry.background(
self.xknx.cemi_handler.send_telegram(ack)
)
if conn := self._connections.get(telegram.source_address):
conn.process(telegram)
return
if telegram.tpci.numbered:
logger.warning(
"No active point-to-point connection for received telegram: %s",
telegram,
)
return
if isinstance(telegram.tpci, TConnect):
# refuse incoming connections
# TODO: handle incoming telegrams for connections
# not initiated by us, connection-less and broadcast
disconnect = Telegram(
destination_address=telegram.source_address, tpci=TDisconnect()
)
self.xknx.task_registry.background(
self.xknx.cemi_handler.send_telegram(disconnect)
)
return
if isinstance(telegram.tpci, TDataBroadcast):
for context in self._broadcast_contexts:
context.queue.put_nowait(telegram)
return
logger.debug("Unhandled management telegram: %r", telegram)
return
async def connect(
self, address: IndividualAddress, rate_limit: int = 20
) -> P2PConnection:
"""Open a point-to-point connection to a KNX device."""
if address in self._connections:
raise ManagementConnectionError(f"Connection to {address} already exists.")
p2p_connection = P2PConnection(self.xknx, address, rate_limit)
try:
await p2p_connection.connect()
except ManagementConnectionError as exc:
logger.error("Establishing connection to %s failed: %s", address, exc)
raise
self._connections[address] = p2p_connection
def remove_connection_hook() -> None:
"""Remove connection from management."""
try:
del self._connections[address]
except KeyError:
logger.error("Connection to %s already closed.", address)
p2p_connection.disconnect_hook = remove_connection_hook
return p2p_connection
async def disconnect(self, address: IndividualAddress) -> None:
"""Close a point-to-point connection to a KNX device."""
connection = self._connections.get(address)
if connection is None:
logger.error(
"Closing connection to %s failed - connection does not exist.",
address,
)
return
try:
await connection.disconnect()
except ManagementConnectionError as exc:
logger.error("Closing connection to %s failed: %s", connection.address, exc)
raise
@asynccontextmanager
async def connection(
self, address: IndividualAddress, rate_limit: int = 20
) -> AsyncIterator[P2PConnection]:
"""Provide a point-to-point connection to a KNX device."""
conn = await self.connect(address, rate_limit)
try:
yield conn
finally:
await self.disconnect(address)
async def send_broadcast(self, payload: APCI) -> None:
"""Send a broadcast message."""
await self.xknx.cemi_handler.send_telegram(
Telegram(
GroupAddress("0/0/0"),
tpci=TDataBroadcast(),
payload=payload,
)
)
@asynccontextmanager
async def broadcast(self) -> AsyncIterator[BroadcastContext]:
"""Provide a broadcast context."""
context = BroadcastContext()
self._broadcast_contexts.add(context)
try:
yield context
finally:
self._broadcast_contexts.remove(context)
class BroadcastContext:
"""Class providing broadcast contexts."""
__slots__ = ("queue",)
def __init__(self) -> None:
"""Initialize BroadcastContext class."""
self.queue: asyncio.Queue[Telegram] = asyncio.Queue()
async def receive(
self,
timeout: float | None = 3,
) -> AsyncGenerator[Telegram, None]:
"""Receive telegrams from the broadcast context."""
try:
async with asyncio_timeout(timeout):
while True:
try:
yield await self.queue.get()
except GeneratorExit:
return
except asyncio.TimeoutError:
return
class P2PConnection:
"""Class to manage a point-to-point connection with a KNX device."""
__slots__ = (
"_ack_waiter",
"_connected",
"_expected_sequence_number",
"_last_response_time",
"_response_waiter",
"address",
"disconnect_hook",
"rate_limit",
"sequence_number",
"xknx",
)
def __init__(
self, xknx: XKNX, address: IndividualAddress, rate_limit: int = 20
) -> None:
"""Initialize P2PConnection class."""
self.xknx = xknx
self.address = address
self.disconnect_hook: Callable[[], None]
self.rate_limit = rate_limit
self.sequence_number = self._sequence_number_generator()
self._expected_sequence_number = 0
self._connected = False
self._last_response_time: float = 0
self._ack_waiter: asyncio.Future[TAck | TNak] | None = None
self._response_waiter: asyncio.Future[Telegram] = (
asyncio.get_event_loop().create_future()
)
@staticmethod
def _sequence_number_generator() -> Generator[int, None, None]:
"""Generate sequence numbers."""
seq_num = 0
while True:
yield seq_num
seq_num = seq_num + 1 & 0xF
async def connect(self) -> None:
"""Connect to the KNX device."""
connect = Telegram(
destination_address=self.address,
source_address=self.xknx.current_address,
tpci=TConnect(),
)
try:
await self.xknx.cemi_handler.send_telegram(connect)
except ConfirmationError as exc:
self._response_waiter.cancel()
raise ManagementConnectionError(
f"Connection to {self.address} failed: {exc}"
) from exc
except CommunicationError as exc:
self._response_waiter.cancel()
raise ManagementConnectionError("Error while sending Telegram") from exc
self._connected = True
async def disconnect(self) -> None:
"""Disconnect from the KNX device."""
if not self._connected:
self.disconnect_hook() # remove connection from management class
raise ManagementConnectionRefused(
"Management connection disconnected by the peer."
)
self._connected = False
disconnect = Telegram(
destination_address=self.address,
source_address=self.xknx.current_address,
tpci=TDisconnect(),
)
try:
await self.xknx.cemi_handler.send_telegram(disconnect)
except ConfirmationError as exc:
raise ManagementConnectionError(
f"Disconnect from {self.address} failed: {exc}"
) from exc
except CommunicationError as exc:
raise ManagementConnectionError("Error while sending Telegram") from exc
finally:
if self._ack_waiter:
self._ack_waiter.cancel()
self._response_waiter.cancel()
self.disconnect_hook() # remove connection from management class
def process(self, telegram: Telegram) -> None:
"""Process incoming telegrams."""
if isinstance(telegram.tpci, TDisconnect):
logger.info("%s disconnected management session.", self.address)
self._connected = False
if self._ack_waiter:
self._response_waiter.set_exception(ManagementConnectionRefused())
if not self._response_waiter.done():
self._response_waiter.set_exception(ManagementConnectionRefused())
return
if isinstance(telegram.tpci, TAck | TNak):
if not self._ack_waiter:
logger.warning("Received unexpected ACK/NAK: %s", telegram)
return
self._ack_waiter.set_result(telegram.tpci)
return
if self._response_waiter.done():
logger.warning(
"Received unexpected point-to-point telegram for %s: %s",
self.address,
telegram,
)
return
if telegram.tpci.sequence_number != self._expected_sequence_number:
logger.warning(
"Received unexpected sequence number: %s (expected: %s)",
telegram.tpci.sequence_number,
self._expected_sequence_number,
)
return
self._response_waiter.set_result(telegram)
self._expected_sequence_number = self._expected_sequence_number + 1 & 0xF
async def _send_data(self, payload: APCI) -> None:
"""
Send a payload to the KNX device.
A response has to be processed by `_receive` before sending the next telegram.
"""
if not self._connected:
raise ManagementConnectionRefused(
"Management connection disconnected by the peer."
)
self._ack_waiter = asyncio.get_event_loop().create_future()
seq_num = next(self.sequence_number)
telegram = Telegram(
destination_address=self.address,
source_address=self.xknx.current_address,
payload=payload,
tpci=TDataConnected(sequence_number=seq_num),
)
try:
await self.xknx.cemi_handler.send_telegram(telegram)
async with asyncio_timeout(MANAGAMENT_ACK_TIMEOUT):
ack = await self._ack_waiter
except asyncio.TimeoutError:
logger.info(
"%s: timeout while waiting for ACK. Resending Telegram.", self.address
)
# resend once after 3 seconds without ACK
# on timeout the Future is cancelled so create a new
self._ack_waiter = asyncio.get_event_loop().create_future()
await self.xknx.cemi_handler.send_telegram(telegram)
try:
async with asyncio_timeout(MANAGAMENT_ACK_TIMEOUT):
ack = await self._ack_waiter
except asyncio.TimeoutError:
raise ManagementConnectionTimeout(
"No ACK received for repeated telegram."
) from None
except ConfirmationError as exc:
raise ManagementConnectionError(
f"Error while sending Telegram: {exc}"
) from exc
except CommunicationError as exc:
raise ManagementConnectionError("Error while sending Telegram") from exc
finally:
self._ack_waiter = None
if isinstance(ack, TNak):
raise ManagementConnectionError(
f"Received no_ack from sending Telegram: {telegram}"
)
if ack.sequence_number != seq_num:
raise ManagementConnectionError(
f"Ack sequence number {ack.sequence_number} does not match request sequence number of {telegram}"
)
async def _receive(self, expected_payload: type[APCI] | None) -> Telegram:
"""Wait for a telegram from the KNX device."""
try:
async with asyncio_timeout(MANAGAMENT_CONNECTION_TIMEOUT):
telegram = await self._response_waiter
except asyncio.TimeoutError:
raise ManagementConnectionTimeout(
f"Timeout while waiting for {expected_payload}"
) from None
finally:
# set up new Future for the next request
self._response_waiter = asyncio.get_event_loop().create_future()
if expected_payload and not isinstance(telegram.payload, expected_payload):
raise ManagementConnectionError(
f"Received unexpected telegram: {telegram.payload}"
)
return telegram
async def request(self, payload: APCI, expected: type[APCI] | None) -> Telegram:
"""Send a payload to the KNX device and wait for the response."""
if not self._connected:
raise ManagementConnectionRefused(
"Management connection disconnected by the peer."
)
if self.rate_limit:
# time in seconds since the last request operation
time_diff = time.time() - self._last_response_time
wait_time = 1 / self.rate_limit
if time_diff < wait_time:
await asyncio.sleep(wait_time - time_diff)
await self._send_data(payload)
response = await self._receive(expected)
self._last_response_time = time.time()
return response
|