mirror of
https://github.com/python-kasa/python-kasa.git
synced 2026-07-11 01:42:05 +00:00
b2206841dd
Update SmartCam time handling to apply timezone-only changes with explicit warnings, while keeping common time and CLI tests focused on devices that support setting clock time and adding SmartCam-specific coverage for the special behavior.
115 lines
3.8 KiB
Python
115 lines
3.8 KiB
Python
"""Implementation of time module."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
from datetime import UTC, datetime, timedelta, tzinfo
|
|
from typing import cast
|
|
from zoneinfo import ZoneInfo, ZoneInfoNotFoundError
|
|
|
|
from ...cachedzoneinfo import CachedZoneInfo
|
|
from ...exceptions import KasaException
|
|
from ...feature import Feature
|
|
from ...interfaces import Time as TimeInterface
|
|
from ...smart.smartmodule import allow_update_after
|
|
from ..smartcammodule import SmartCamModule
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
class Time(SmartCamModule, TimeInterface):
|
|
"""Implementation of device_local_time."""
|
|
|
|
QUERY_GETTER_NAME = "getTimezone"
|
|
QUERY_MODULE_NAME = "system"
|
|
QUERY_SECTION_NAMES = "basic"
|
|
|
|
_timezone: tzinfo = UTC
|
|
_time: datetime
|
|
|
|
def _initialize_features(self) -> None:
|
|
"""Initialize features after the initial update."""
|
|
self._add_feature(
|
|
Feature(
|
|
device=self._device,
|
|
id="device_time",
|
|
name="Device time",
|
|
attribute_getter="time",
|
|
container=self,
|
|
category=Feature.Category.Debug,
|
|
type=Feature.Type.Sensor,
|
|
)
|
|
)
|
|
|
|
def query(self) -> dict:
|
|
"""Query to execute during the update cycle."""
|
|
q = super().query()
|
|
q["getClockStatus"] = {self.QUERY_MODULE_NAME: {"name": "clock_status"}}
|
|
|
|
return q
|
|
|
|
async def _post_update_hook(self) -> None:
|
|
"""Perform actions after a device update."""
|
|
time_data = self.data["getClockStatus"]["system"]["clock_status"]
|
|
timezone_data = self.data["getTimezone"]["system"]["basic"]
|
|
zone_id = timezone_data["zone_id"]
|
|
timestamp = time_data["seconds_from_1970"]
|
|
try:
|
|
# Zoneinfo will return a DST aware object
|
|
tz: tzinfo = await CachedZoneInfo.get_cached_zone_info(zone_id)
|
|
except ZoneInfoNotFoundError:
|
|
# timezone string like: UTC+10:00
|
|
timezone_str = timezone_data["timezone"]
|
|
tz = cast(tzinfo, datetime.strptime(timezone_str[-6:], "%z").tzinfo)
|
|
|
|
self._timezone = tz
|
|
self._time = datetime.fromtimestamp(
|
|
cast(float, timestamp),
|
|
tz=tz,
|
|
)
|
|
|
|
@property
|
|
def timezone(self) -> tzinfo:
|
|
"""Return current timezone."""
|
|
return self._timezone
|
|
|
|
@property
|
|
def time(self) -> datetime:
|
|
"""Return device's current datetime."""
|
|
return self._time
|
|
|
|
@allow_update_after
|
|
async def set_time(self, dt: datetime) -> dict:
|
|
"""Set device timezone derived from the datetime."""
|
|
_LOGGER.warning(
|
|
"SmartCam devices do not support setting clock time directly; "
|
|
"only timezone settings will be updated."
|
|
)
|
|
timezone = dt.tzinfo or self.timezone
|
|
if not isinstance(timezone, ZoneInfo):
|
|
raise KasaException(
|
|
"SmartCam devices can only update timezone using zoneinfo "
|
|
"timezones; setting clock time is not supported."
|
|
)
|
|
|
|
utc_offset = cast(timedelta | None, timezone.utcoffset(dt))
|
|
params: dict[str, str] = {
|
|
"timezone": self._format_utc_offset(utc_offset),
|
|
"zone_id": timezone.key,
|
|
}
|
|
|
|
return await self.call("setTimezone", {"system": {"basic": params}})
|
|
|
|
@staticmethod
|
|
def _format_utc_offset(offset: timedelta | None) -> str:
|
|
"""Format a timedelta offset as UTC+HH:MM/UTC-HH:MM."""
|
|
if offset is None:
|
|
offset = timedelta(0)
|
|
|
|
total_seconds = int(offset.total_seconds())
|
|
sign = "+" if total_seconds >= 0 else "-"
|
|
total_seconds = abs(total_seconds)
|
|
hours, remainder = divmod(total_seconds, 3600)
|
|
minutes = remainder // 60
|
|
return f"UTC{sign}{hours:02d}:{minutes:02d}"
|