mirror of
https://github.com/python-kasa/python-kasa.git
synced 2024-12-23 03:33:35 +00:00
64da736717
This adds a generic interface for all device classes to introspect available device features, that is necessary to make it easier to support a wide variety of supported devices with different set of features. This will allow constructing generic interfaces (e.g., in homeassistant) that fetch and change these features without hard-coding the API calls. `Device.features()` now returns a mapping of `<identifier, Feature>` where the `Feature` contains all necessary information (like the name, the icon, a way to get and change the setting) to present and change the defined feature through its interface.
73 lines
2.0 KiB
Python
73 lines
2.0 KiB
Python
"""Cloud module implementation."""
|
|
try:
|
|
from pydantic.v1 import BaseModel
|
|
except ImportError:
|
|
from pydantic import BaseModel
|
|
|
|
from ...feature import Feature, FeatureType
|
|
from .module import IotModule
|
|
|
|
|
|
class CloudInfo(BaseModel):
|
|
"""Container for cloud settings."""
|
|
|
|
binded: bool
|
|
cld_connection: int
|
|
fwDlPage: str
|
|
fwNotifyType: int
|
|
illegalType: int
|
|
server: str
|
|
stopConnect: int
|
|
tcspInfo: str
|
|
tcspStatus: int
|
|
username: str
|
|
|
|
|
|
class Cloud(IotModule):
|
|
"""Module implementing support for cloud services."""
|
|
|
|
def __init__(self, device, module):
|
|
super().__init__(device, module)
|
|
self._add_feature(
|
|
Feature(
|
|
device=device,
|
|
container=self,
|
|
name="Cloud connection",
|
|
icon="mdi:cloud",
|
|
attribute_getter="is_connected",
|
|
type=FeatureType.BinarySensor,
|
|
)
|
|
)
|
|
|
|
@property
|
|
def is_connected(self) -> bool:
|
|
"""Return true if device is connected to the cloud."""
|
|
return self.info.binded
|
|
|
|
def query(self):
|
|
"""Request cloud connectivity info."""
|
|
return self.query_for_command("get_info")
|
|
|
|
@property
|
|
def info(self) -> CloudInfo:
|
|
"""Return information about the cloud connectivity."""
|
|
return CloudInfo.parse_obj(self.data["get_info"])
|
|
|
|
def get_available_firmwares(self):
|
|
"""Return list of available firmwares."""
|
|
return self.query_for_command("get_intl_fw_list")
|
|
|
|
def set_server(self, url: str):
|
|
"""Set the update server URL."""
|
|
return self.query_for_command("set_server_url", {"server": url})
|
|
|
|
def connect(self, username: str, password: str):
|
|
"""Login to the cloud using given information."""
|
|
return self.query_for_command(
|
|
"bind", {"username": username, "password": password}
|
|
)
|
|
|
|
def disconnect(self):
|
|
"""Disconnect from the cloud."""
|
|
return self.query_for_command("unbind")
|