mirror of
https://github.com/python-kasa/python-kasa.git
synced 2024-12-22 11:13:34 +00:00
f259a8f162
Address the inconsistent naming of smart modules by removing all "Module" suffixes and aligning filenames with class names. Removes the casting of modules to the correct module type now that is is redundant. Update the adding of iot modules to use the ModuleName class rather than a free string.
124 lines
4.5 KiB
Python
124 lines
4.5 KiB
Python
"""Base class for all module implementations."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
from abc import ABC, abstractmethod
|
|
from typing import (
|
|
TYPE_CHECKING,
|
|
Final,
|
|
TypeVar,
|
|
)
|
|
|
|
from .exceptions import KasaException
|
|
from .feature import Feature
|
|
from .modulemapping import ModuleName
|
|
|
|
if TYPE_CHECKING:
|
|
from .device import Device
|
|
from .interfaces.led import Led
|
|
from .interfaces.lighteffect import LightEffect
|
|
from .iot import modules as iot
|
|
from .smart import modules as smart
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
ModuleT = TypeVar("ModuleT", bound="Module")
|
|
|
|
|
|
class Module(ABC):
|
|
"""Base class implemention for all modules.
|
|
|
|
The base classes should implement `query` to return the query they want to be
|
|
executed during the regular update cycle.
|
|
"""
|
|
|
|
# Common Modules
|
|
LightEffect: Final[ModuleName[LightEffect]] = ModuleName("LightEffect")
|
|
Led: Final[ModuleName[Led]] = ModuleName("Led")
|
|
|
|
# IOT only Modules
|
|
IotAmbientLight: Final[ModuleName[iot.AmbientLight]] = ModuleName("ambient")
|
|
IotAntitheft: Final[ModuleName[iot.Antitheft]] = ModuleName("anti_theft")
|
|
IotCountdown: Final[ModuleName[iot.Countdown]] = ModuleName("countdown")
|
|
IotEmeter: Final[ModuleName[iot.Emeter]] = ModuleName("emeter")
|
|
IotMotion: Final[ModuleName[iot.Motion]] = ModuleName("motion")
|
|
IotSchedule: Final[ModuleName[iot.Schedule]] = ModuleName("schedule")
|
|
IotUsage: Final[ModuleName[iot.Usage]] = ModuleName("usage")
|
|
IotCloud: Final[ModuleName[iot.Cloud]] = ModuleName("cloud")
|
|
IotTime: Final[ModuleName[iot.Time]] = ModuleName("time")
|
|
|
|
# SMART only Modules
|
|
Alarm: Final[ModuleName[smart.Alarm]] = ModuleName("Alarm")
|
|
AutoOff: Final[ModuleName[smart.AutoOff]] = ModuleName("AutoOff")
|
|
BatterySensor: Final[ModuleName[smart.BatterySensor]] = ModuleName("BatterySensor")
|
|
Brightness: Final[ModuleName[smart.Brightness]] = ModuleName("Brightness")
|
|
ChildDevice: Final[ModuleName[smart.ChildDevice]] = ModuleName("ChildDevice")
|
|
Cloud: Final[ModuleName[smart.Cloud]] = ModuleName("Cloud")
|
|
Color: Final[ModuleName[smart.Color]] = ModuleName("Color")
|
|
ColorTemperature: Final[ModuleName[smart.ColorTemperature]] = ModuleName(
|
|
"ColorTemperature"
|
|
)
|
|
ContactSensor: Final[ModuleName[smart.ContactSensor]] = ModuleName("ContactSensor")
|
|
DeviceModule: Final[ModuleName[smart.DeviceModule]] = ModuleName("DeviceModule")
|
|
Energy: Final[ModuleName[smart.Energy]] = ModuleName("Energy")
|
|
Fan: Final[ModuleName[smart.Fan]] = ModuleName("Fan")
|
|
Firmware: Final[ModuleName[smart.Firmware]] = ModuleName("Firmware")
|
|
FrostProtection: Final[ModuleName[smart.FrostProtection]] = ModuleName(
|
|
"FrostProtection"
|
|
)
|
|
HumiditySensor: Final[ModuleName[smart.HumiditySensor]] = ModuleName(
|
|
"HumiditySensor"
|
|
)
|
|
LightTransition: Final[ModuleName[smart.LightTransition]] = ModuleName(
|
|
"LightTransition"
|
|
)
|
|
ReportMode: Final[ModuleName[smart.ReportMode]] = ModuleName("ReportMode")
|
|
TemperatureSensor: Final[ModuleName[smart.TemperatureSensor]] = ModuleName(
|
|
"TemperatureSensor"
|
|
)
|
|
TemperatureControl: Final[ModuleName[smart.TemperatureControl]] = ModuleName(
|
|
"TemperatureControl"
|
|
)
|
|
Time: Final[ModuleName[smart.Time]] = ModuleName("Time")
|
|
WaterleakSensor: Final[ModuleName[smart.WaterleakSensor]] = ModuleName(
|
|
"WaterleakSensor"
|
|
)
|
|
|
|
def __init__(self, device: Device, module: str):
|
|
self._device = device
|
|
self._module = module
|
|
self._module_features: dict[str, Feature] = {}
|
|
|
|
@abstractmethod
|
|
def query(self):
|
|
"""Query to execute during the update cycle.
|
|
|
|
The inheriting modules implement this to include their wanted
|
|
queries to the query that gets executed when Device.update() gets called.
|
|
"""
|
|
|
|
@property
|
|
@abstractmethod
|
|
def data(self):
|
|
"""Return the module specific raw data from the last update."""
|
|
|
|
def _initialize_features(self): # noqa: B027
|
|
"""Initialize features after the initial update.
|
|
|
|
This can be implemented if features depend on module query responses.
|
|
"""
|
|
|
|
def _add_feature(self, feature: Feature):
|
|
"""Add module feature."""
|
|
id_ = feature.id
|
|
if id_ in self._module_features:
|
|
raise KasaException("Duplicate id detected %s" % id_)
|
|
self._module_features[id_] = feature
|
|
|
|
def __repr__(self) -> str:
|
|
return (
|
|
f"<Module {self.__class__.__name__} ({self._module})"
|
|
f" for {self._device.host}>"
|
|
)
|