"""Device creation via DeviceConfig.""" from __future__ import annotations import logging import time from typing import Any from .device import Device from .device_type import DeviceType from .deviceconfig import DeviceConfig from .exceptions import KasaException, UnsupportedDeviceError from .experimental.smartcamera import SmartCamera from .experimental.smartcameraprotocol import SmartCameraProtocol from .experimental.sslaestransport import SslAesTransport from .iot import ( IotBulb, IotDevice, IotDimmer, IotLightStrip, IotPlug, IotStrip, IotWallSwitch, ) from .protocols import ( BaseProtocol, IotProtocol, SmartProtocol, ) from .smart import SmartDevice from .transports import ( AesTransport, BaseTransport, KlapTransport, KlapTransportV2, XorTransport, ) _LOGGER = logging.getLogger(__name__) GET_SYSINFO_QUERY: dict[str, dict[str, dict]] = { "system": {"get_sysinfo": {}}, } async def connect(*, host: str | None = None, config: DeviceConfig) -> Device: """Connect to a single device by the given hostname or device configuration. This method avoids the UDP based discovery process and will connect directly to the device. It is generally preferred to avoid :func:`discover_single()` and use this function instead as it should perform better when the WiFi network is congested or the device is not responding to discovery requests. Do not use this function directly, use SmartDevice.connect() :param host: Hostname of device to query :param config: Connection parameters to ensure the correct protocol and connection options are used. :rtype: SmartDevice :return: Object for querying/controlling found device. """ if host and config or (not host and not config): raise KasaException("One of host or config must be provded and not both") if host: config = DeviceConfig(host=host) if (protocol := get_protocol(config=config)) is None: raise UnsupportedDeviceError( f"Unsupported device for {config.host}: " + f"{config.connection_type.device_family.value}", host=config.host, ) try: return await _connect(config, protocol) except: await protocol.close() raise async def _connect(config: DeviceConfig, protocol: BaseProtocol) -> Device: debug_enabled = _LOGGER.isEnabledFor(logging.DEBUG) if debug_enabled: start_time = time.perf_counter() def _perf_log(has_params: bool, perf_type: str) -> None: nonlocal start_time if debug_enabled: end_time = time.perf_counter() _LOGGER.debug( "Device %s with connection params %s took %.2f seconds to %s", config.host, has_params, end_time - start_time, perf_type, ) start_time = time.perf_counter() device_class: type[Device] | None device: Device | None = None if isinstance(protocol, IotProtocol) and isinstance( protocol._transport, XorTransport ): info = await protocol.query(GET_SYSINFO_QUERY) _perf_log(True, "get_sysinfo") device_class = get_device_class_from_sys_info(info) device = device_class(config.host, protocol=protocol) device.update_from_discover_info(info) await device.update() _perf_log(True, "update") return device elif device_class := get_device_class_from_family( config.connection_type.device_family.value, https=config.connection_type.https ): device = device_class(host=config.host, protocol=protocol) await device.update() _perf_log(True, "update") return device else: raise UnsupportedDeviceError( f"Unsupported device for {config.host}: " + f"{config.connection_type.device_family.value}", host=config.host, ) def _get_device_type_from_sys_info(info: dict[str, Any]) -> DeviceType: """Find SmartDevice subclass for device described by passed data.""" if "system" not in info or "get_sysinfo" not in info["system"]: raise KasaException("No 'system' or 'get_sysinfo' in response") sysinfo: dict[str, Any] = info["system"]["get_sysinfo"] type_: str | None = sysinfo.get("type", sysinfo.get("mic_type")) if type_ is None: raise KasaException("Unable to find the device type field!") if "dev_name" in sysinfo and "Dimmer" in sysinfo["dev_name"]: return DeviceType.Dimmer if "smartplug" in type_.lower(): if "children" in sysinfo: return DeviceType.Strip if (dev_name := sysinfo.get("dev_name")) and "light" in dev_name.lower(): return DeviceType.WallSwitch return DeviceType.Plug if "smartbulb" in type_.lower(): if "length" in sysinfo: # strips have length return DeviceType.LightStrip return DeviceType.Bulb raise UnsupportedDeviceError(f"Unknown device type: {type_}") def get_device_class_from_sys_info(sysinfo: dict[str, Any]) -> type[IotDevice]: """Find SmartDevice subclass for device described by passed data.""" TYPE_TO_CLASS = { DeviceType.Bulb: IotBulb, DeviceType.Plug: IotPlug, DeviceType.Dimmer: IotDimmer, DeviceType.Strip: IotStrip, DeviceType.WallSwitch: IotWallSwitch, DeviceType.LightStrip: IotLightStrip, } return TYPE_TO_CLASS[_get_device_type_from_sys_info(sysinfo)] def get_device_class_from_family( device_type: str, *, https: bool, require_exact: bool = False ) -> type[Device] | None: """Return the device class from the type name.""" supported_device_types: dict[str, type[Device]] = { "SMART.TAPOPLUG": SmartDevice, "SMART.TAPOBULB": SmartDevice, "SMART.TAPOSWITCH": SmartDevice, "SMART.KASAPLUG": SmartDevice, "SMART.TAPOHUB": SmartDevice, "SMART.TAPOHUB.HTTPS": SmartCamera, "SMART.KASAHUB": SmartDevice, "SMART.KASASWITCH": SmartDevice, "SMART.IPCAMERA.HTTPS": SmartCamera, "IOT.SMARTPLUGSWITCH": IotPlug, "IOT.SMARTBULB": IotBulb, } lookup_key = f"{device_type}{'.HTTPS' if https else ''}" if ( (cls := supported_device_types.get(lookup_key)) is None and device_type.startswith("SMART.") and not require_exact ): _LOGGER.warning("Unknown SMART device with %s, using SmartDevice", device_type) cls = SmartDevice return cls def get_protocol( config: DeviceConfig, ) -> BaseProtocol | None: """Return the protocol from the connection name.""" protocol_name = config.connection_type.device_family.value.split(".")[0] ctype = config.connection_type protocol_transport_key = ( protocol_name + "." + ctype.encryption_type.value + (".HTTPS" if ctype.https else "") ) supported_device_protocols: dict[ str, tuple[type[BaseProtocol], type[BaseTransport]] ] = { "IOT.XOR": (IotProtocol, XorTransport), "IOT.KLAP": (IotProtocol, KlapTransport), "SMART.AES": (SmartProtocol, AesTransport), "SMART.KLAP": (SmartProtocol, KlapTransportV2), } if not (prot_tran_cls := supported_device_protocols.get(protocol_transport_key)): from .experimental import Experimental if Experimental.enabled() and protocol_transport_key == "SMART.AES.HTTPS": prot_tran_cls = (SmartCameraProtocol, SslAesTransport) else: return None return prot_tran_cls[0](transport=prot_tran_cls[1](config=config))