mirror of
https://github.com/python-kasa/python-kasa.git
synced 2024-12-23 03:33:35 +00:00
f6fd898faf
* Add DeviceConfig handling * Update post review * Further update post latest review * Update following latest review * Update docstrings and docs
107 lines
3.5 KiB
Python
107 lines
3.5 KiB
Python
"""Module for a TAPO Plug."""
|
|
import logging
|
|
from datetime import datetime, timedelta
|
|
from typing import Any, Dict, Optional, cast
|
|
|
|
from ..deviceconfig import DeviceConfig
|
|
from ..emeterstatus import EmeterStatus
|
|
from ..modules import Emeter
|
|
from ..protocol import TPLinkProtocol
|
|
from ..smartdevice import DeviceType, requires_update
|
|
from .tapodevice import TapoDevice
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
class TapoPlug(TapoDevice):
|
|
"""Class to represent a TAPO Plug."""
|
|
|
|
def __init__(
|
|
self,
|
|
host: str,
|
|
*,
|
|
config: Optional[DeviceConfig] = None,
|
|
protocol: Optional[TPLinkProtocol] = None,
|
|
) -> None:
|
|
super().__init__(host=host, config=config, protocol=protocol)
|
|
self._device_type = DeviceType.Plug
|
|
self.modules: Dict[str, Any] = {}
|
|
self.emeter_type = "emeter"
|
|
self.modules["emeter"] = Emeter(self, self.emeter_type)
|
|
|
|
@property # type: ignore
|
|
@requires_update
|
|
def has_emeter(self) -> bool:
|
|
"""Return that the plug has an emeter."""
|
|
return True
|
|
|
|
async def update(self, update_children: bool = True):
|
|
"""Call the device endpoint and update the device data."""
|
|
await super().update(update_children)
|
|
|
|
req = {
|
|
"get_energy_usage": None,
|
|
"get_current_power": None,
|
|
}
|
|
resp = await self.protocol.query(req)
|
|
self._energy = resp["get_energy_usage"]
|
|
self._emeter = resp["get_current_power"]
|
|
|
|
self._data["energy"] = self._energy
|
|
self._data["emeter"] = self._emeter
|
|
|
|
_LOGGER.debug("Got an update: %s %s", self._energy, self._emeter)
|
|
|
|
@property
|
|
def state_information(self) -> Dict[str, Any]:
|
|
"""Return the key state information."""
|
|
return {
|
|
**super().state_information,
|
|
**{
|
|
"On since": self.on_since,
|
|
"auto_off_status": self._info.get("auto_off_status"),
|
|
"auto_off_remain_time": self._info.get("auto_off_remain_time"),
|
|
},
|
|
}
|
|
|
|
@property
|
|
def emeter_realtime(self) -> EmeterStatus:
|
|
"""Get the emeter status."""
|
|
return EmeterStatus(
|
|
{
|
|
"power_mw": self._energy.get("current_power"),
|
|
"total": self._convert_energy_data(
|
|
self._energy.get("today_energy"), 1 / 1000
|
|
),
|
|
}
|
|
)
|
|
|
|
async def get_emeter_realtime(self) -> EmeterStatus:
|
|
"""Retrieve current energy readings."""
|
|
self._verify_emeter()
|
|
resp = await self.protocol.query("get_energy_usage")
|
|
self._energy = resp["get_energy_usage"]
|
|
return self.emeter_realtime
|
|
|
|
@property
|
|
def emeter_today(self) -> Optional[float]:
|
|
"""Get the emeter value for today."""
|
|
return self._convert_energy_data(self._energy.get("today_energy"), 1 / 1000)
|
|
|
|
@property
|
|
def emeter_this_month(self) -> Optional[float]:
|
|
"""Get the emeter value for this month."""
|
|
return self._convert_energy_data(self._energy.get("month_energy"), 1 / 1000)
|
|
|
|
@property
|
|
def on_since(self) -> Optional[datetime]:
|
|
"""Return the time that the device was turned on or None if turned off."""
|
|
if not self._info.get("device_on"):
|
|
return None
|
|
on_time = cast(float, self._info.get("on_time"))
|
|
return datetime.now().replace(microsecond=0) - timedelta(seconds=on_time)
|
|
|
|
def _convert_energy_data(self, data, scale) -> Optional[float]:
|
|
"""Return adjusted emeter information."""
|
|
return data if not data else data * scale
|