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
|
"""Handles Websocket connections to a Control4 Director, allowing for real-time
updates using callbacks.
"""
from __future__ import annotations
from typing import Any, Callable
from types import MappingProxyType
import aiohttp
import asyncio
import socketio # type: ignore[import-untyped]
import logging
from .error_handling import check_response_for_error
_LOGGER = logging.getLogger(__name__)
_NAMESPACE_URI = "/api/v1/items/datatoui"
_PROBE_MESSAGE = "2probe"
_STATUS_ACK_MESSAGE = "2"
class _C4DirectorNamespace(socketio.AsyncClientNamespace): # type: ignore[misc]
def __init__(self, *args: Any, **kwargs: Any) -> None:
self.url: str = kwargs.pop("url")
self.token: str = kwargs.pop("token")
self.callback: Callable[..., Any] = kwargs.pop("callback")
self.session: aiohttp.ClientSession | None = kwargs.pop("session")
self.connect_callback: Callable[..., Any] | None = kwargs.pop(
"connect_callback"
)
self.disconnect_callback: Callable[..., Any] | None = kwargs.pop(
"disconnect_callback"
)
super().__init__(*args, **kwargs)
self.uri = _NAMESPACE_URI
self.subscription_id: str | None = None
self.connected: bool = False
async def on_connect(self) -> None:
_LOGGER.debug("Control4 Director socket.io connection established!")
if self.connect_callback is not None:
await self.connect_callback()
async def on_disconnect(self) -> None:
self.connected = False
self.subscription_id = None
_LOGGER.debug("Control4 Director socket.io disconnected.")
if self.disconnect_callback is not None:
await self.disconnect_callback()
async def trigger_event(self, event: str, *args: Any) -> None:
if event == "subscribe":
await self.on_subscribe(*args)
elif event == "connect":
await self.on_connect()
elif event == "disconnect":
await self.on_disconnect()
elif event == "clientId":
await self.on_clientId(*args)
elif event == self.subscription_id:
msg = args[0]
if "status" in msg:
_LOGGER.debug(f'Status message received from Director: {msg["status"]}')
await self.emit(_STATUS_ACK_MESSAGE)
else:
await self.callback(args[0])
async def on_clientId(self, client_id: str) -> None:
await self.emit(_PROBE_MESSAGE)
if not self.connected and not self.subscription_id:
_LOGGER.debug("Fetching subscriptionID from Control4")
session = self.session or aiohttp.ClientSession(
connector=aiohttp.TCPConnector(verify_ssl=False)
)
try:
async with asyncio.timeout(10):
async with session.get(
self.url + self.uri,
params={"JWT": self.token, "SubscriptionClient": client_id},
) as resp:
check_response_for_error(await resp.text())
data = await resp.json()
subscription_id = data.get("subscriptionId")
if subscription_id is None:
raise ValueError(
"Failed to get subscription ID from Control4 Director"
)
self.connected = True
self.subscription_id = subscription_id
await self.emit("startSubscription", self.subscription_id)
finally:
if self.session is None:
await session.close()
async def on_subscribe(self, message: Any) -> None:
pass
class C4Websocket:
def __init__(
self,
ip: str,
session_no_verify_ssl: aiohttp.ClientSession | None = None,
connect_callback: Callable[..., Any] | None = None,
disconnect_callback: Callable[..., Any] | None = None,
):
"""Creates a Control4 Websocket object.
Parameters:
`ip` - The IP address of the Control4 Director/Controller.
`session_no_verify_ssl` - (Optional) Allows the use of an
`aiohttp.ClientSession` object
for all network requests. This
session will not be closed by the library.
If not provided, the library will open and
close its own `ClientSession`s as needed.
This session is also passed to the underlying
socketio/engineio client to avoid blocking
`ssl.create_default_context()` calls inside
the event loop.
`connect_callback` - (Optional) A callback to be called when the
Websocket connection is opened or reconnected after a network
error.
`disconnect_callback` - (Optional) A callback to be called when
the Websocket connection is lost due to a network error.
"""
self.base_url: str = f"https://{ip}"
self.wss_url: str = f"wss://{ip}"
self.session: aiohttp.ClientSession | None = session_no_verify_ssl
self.connect_callback: Callable[..., Any] | None = connect_callback
self.disconnect_callback: Callable[..., Any] | None = disconnect_callback
self._item_callbacks: dict[int, list[Callable[..., Any]]] = dict()
self._sio: socketio.AsyncClient | None = None
@property
def item_callbacks(self) -> MappingProxyType[int, list[Callable[..., Any]]]:
"""Returns a read-only view of registered item ids (key) and their
callbacks (value). Use add_item_callback() or remove_item_callback()
to modify callbacks.
"""
return MappingProxyType(self._item_callbacks)
def add_item_callback(self, item_id: int, callback: Callable[..., Any]) -> None:
"""Register a callback to receive updates about an item.
Parameters:
`item_id` - The Control4 item ID.
`callback` - The callback to be called when an update is received
for the provided item id.
"""
_LOGGER.debug("Subscribing to updates for item id: %s", item_id)
if item_id not in self._item_callbacks:
self._item_callbacks[item_id] = []
# Avoid duplicates
if callback not in self._item_callbacks[item_id]:
self._item_callbacks[item_id].append(callback)
def remove_item_callback(
self, item_id: int, callback: Callable[..., Any] | None = None
) -> None:
"""Unregister callback(s) for an item.
Parameters:
`item_id` - The Control4 item ID.
`callback` - (Optional) Specific callback to remove. If None,
removes all callbacks for this item_id.
"""
if item_id not in self._item_callbacks:
return
if callback is None:
# Remove all callbacks for this item_id
del self._item_callbacks[item_id]
else:
# Remove a specific callback
try:
self._item_callbacks[item_id].remove(callback)
# If no more callbacks, remove the entry
if not self._item_callbacks[item_id]:
del self._item_callbacks[item_id]
except ValueError:
pass
async def sio_connect(self, director_bearer_token: str) -> None:
"""Start WebSockets connection and listen, using the provided
director_bearer_token to authenticate with the Control4 Director. If a
connection already exists, it will be disconnected and a new connection
will be created.
This function should be called using a new token every 86400 seconds (the
expiry time of the director tokens), otherwise the Control4 Director will
stop sending WebSocket messages.
Parameters:
`director_bearer_token` - The bearer token used to authenticate
with the Director. See
`pyControl4.account.C4Account.get_director_bearer_token`
for how to get this.
"""
# Disconnect previous sio object
await self.sio_disconnect()
if self.session is not None:
# Create a new session using the caller's connector so engineio
# can safely close it in _reset() without affecting the caller's
# session. Setting ssl_verify=True prevents engineio from
# creating its own no-verify SSLContext, allowing the
# connector's SSL configuration to take effect.
http_session = aiohttp.ClientSession(
connector=self.session.connector, connector_owner=False
)
self._sio = socketio.AsyncClient(ssl_verify=True, http_session=http_session)
else:
self._sio = socketio.AsyncClient(ssl_verify=False)
self._sio.register_namespace(
_C4DirectorNamespace(
token=director_bearer_token,
url=self.base_url,
callback=self._callback,
session=self.session,
connect_callback=self.connect_callback,
disconnect_callback=self.disconnect_callback,
)
)
await self._sio.connect(
self.wss_url,
transports=["websocket"],
headers={"JWT": director_bearer_token},
)
async def sio_disconnect(self) -> None:
"""Disconnects the WebSockets connection, if it has been created."""
if isinstance(self._sio, socketio.AsyncClient):
await self._sio.disconnect()
async def _callback(self, message: Any) -> None:
if "status" in message:
_LOGGER.debug(f'Subscription {message["status"]}')
return
if isinstance(message, list):
for m in message:
await self._process_message(m)
else:
await self._process_message(message)
async def _process_message(self, message: Any) -> None:
"""Process an incoming event message."""
_LOGGER.debug(message)
device_id = message.get("iddevice") if isinstance(message, dict) else None
if device_id is None:
_LOGGER.debug("Received message without iddevice field")
return
callbacks = self._item_callbacks.get(device_id, [])
if not callbacks:
_LOGGER.debug(f"No Callback for device id {device_id}")
return
for callback in callbacks[:]:
try:
if isinstance(message, list):
for m in message:
await callback(device_id, m)
else:
await callback(device_id, message)
except Exception as exc:
_LOGGER.warning(f"Captured exception during callback: {str(exc)}")
|