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
|
"""XKNX is an Asynchronous Python module for reading and writing KNX/IP packets."""
from __future__ import annotations
import asyncio
import logging
from logging.handlers import TimedRotatingFileHandler
from pathlib import Path
import signal
from sys import platform
from types import TracebackType
from xknx.cemi import CEMIHandler
from xknx.core import (
ConnectionManager,
GroupAddressDPT,
TaskRegistry,
TelegramQueue,
)
from xknx.core.state_updater import StateUpdater, TrackerOptionType
from xknx.devices import Device, Devices
from xknx.io import (
DEFAULT_MCAST_GRP,
DEFAULT_MCAST_PORT,
ConnectionConfig,
knx_interface_factory,
)
from xknx.management import Management
from xknx.telegram import GroupAddress, GroupAddressType, IndividualAddress, Telegram
from xknx.typing import (
ConnectionChangeCallbackType,
DeviceCallbackType,
TelegramCallbackType,
)
from .__version__ import __version__ as VERSION
logger = logging.getLogger("xknx.log")
class XKNX:
"""Class for reading and writing KNX/IP packets."""
def __init__(
self,
address_format: GroupAddressType = GroupAddressType.LONG,
telegram_received_cb: TelegramCallbackType | None = None,
device_updated_cb: DeviceCallbackType[Device] | None = None,
connection_state_changed_cb: ConnectionChangeCallbackType | None = None,
rate_limit: int = 0,
multicast_group: str = DEFAULT_MCAST_GRP,
multicast_port: int = DEFAULT_MCAST_PORT,
log_directory: str | None = None,
state_updater: TrackerOptionType = False,
daemon_mode: bool = False,
connection_config: ConnectionConfig | None = None,
) -> None:
"""Initialize XKNX class."""
self.connection_manager = ConnectionManager()
self.knxip_interface = knx_interface_factory(
self, connection_config=connection_config or ConnectionConfig()
)
self.management = Management(self)
self.telegrams: asyncio.Queue[Telegram | None] = asyncio.Queue()
self.telegram_queue = TelegramQueue(self)
self.cemi_handler = CEMIHandler(self)
self.state_updater = StateUpdater(self, default_tracker_option=state_updater)
self.task_registry = TaskRegistry(self)
self.group_address_dpt = GroupAddressDPT()
self.current_address = IndividualAddress(0)
self.daemon_mode = daemon_mode
self.multicast_group = multicast_group
self.multicast_port = multicast_port
self.rate_limit = rate_limit
self.sigint_received = asyncio.Event()
self.started = asyncio.Event()
self.devices = Devices(started=self.started)
self.version = VERSION
GroupAddress.address_format = address_format # for global string representation
if log_directory is not None:
self.setup_logging(log_directory)
if telegram_received_cb is not None:
self.telegram_queue.register_telegram_received_cb(telegram_received_cb)
if device_updated_cb is not None:
self.devices.register_device_updated_cb(device_updated_cb)
if connection_state_changed_cb is not None:
self.connection_manager.register_connection_state_changed_cb(
connection_state_changed_cb
)
def __del__(self) -> None:
"""Destructor. Cleaning up if this was not done before."""
if self.started.is_set():
try:
loop = asyncio.get_event_loop()
loop.run_until_complete(self.stop())
except RuntimeError as exp:
logger.warning("Could not close loop, reason: %s", exp)
async def __aenter__(self) -> XKNX:
"""Start XKNX from context manager."""
await self.start()
return self
async def __aexit__(
self,
exc_type: type[BaseException] | None,
exc: BaseException | None,
traceback: TracebackType | None,
) -> None:
"""Stop XKNX from context manager."""
await self.stop()
async def start(self) -> None:
"""Start XKNX module. Connect to KNX/IP devices and start state updater."""
if self.knxip_interface.connection_config.threaded:
await self.connection_manager.register_loop()
self.task_registry.start()
logger.info(
"XKNX v%s starting %s connection to KNX bus.",
VERSION,
self.knxip_interface.connection_config.connection_type.name.lower(),
)
await self.knxip_interface.start()
await self.telegram_queue.start()
self.state_updater.start()
self.devices.async_start_device_tasks()
self.started.set()
if self.daemon_mode:
await self.loop_until_sigint()
async def join(self) -> None:
"""Wait until all telegrams were processed."""
await self.telegrams.join()
async def stop(self) -> None:
"""Stop XKNX module."""
self.devices.async_remove_device_tasks()
self.task_registry.stop()
self.state_updater.stop()
await self.join()
await self.telegram_queue.stop()
await self.knxip_interface.stop()
self.started.clear()
async def loop_until_sigint(self) -> None:
"""Loop until Crtl-C was pressed."""
def sigint_handler() -> None:
"""End loop."""
self.sigint_received.set()
if platform == "win32":
logger.warning("Windows does not support signals")
else:
loop = asyncio.get_running_loop()
loop.add_signal_handler(signal.SIGINT, sigint_handler)
logger.warning("Press Ctrl+C to stop")
await self.sigint_received.wait()
@staticmethod
def setup_logging(log_directory: str) -> None:
"""Configure logging to file."""
log_path = Path(log_directory)
if not log_path.is_dir():
logger.warning("The provided log directory does not exist.")
return
_handler = TimedRotatingFileHandler(
filename=log_path / "xknx.log",
when="midnight",
backupCount=7,
encoding="utf-8",
)
_formatter = logging.Formatter(
"%(asctime)s | %(name)s | %(levelname)s | %(message)s",
datefmt="%Y-%m-%d %H:%M:%S",
)
_handler.setFormatter(_formatter)
_handler.setLevel(logging.DEBUG)
for log_namespace in [
"xknx.cemi",
"xknx.log",
"xknx.knx",
"xknx.raw_socket",
"xknx.telegram",
"xknx.state_updater",
]:
_logger = logging.getLogger(log_namespace)
_logger.addHandler(_handler)
|
