Mirrored_Repos/python-kasa
1
0
Fork 0
mirror of https://github.com/python-kasa/python-kasa.git synced 2025-01-09 06:17:08 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Add value checks

Browse Source
This commit is contained in:
Teemu Rytilahti 2024-12-05 16:06:37 +01:00
parent 8a2ed721ee
commit 000ae509d2
1 changed files with 25 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
kasa/smart/modules/alarm.py
View File

@ -81,8 +81,7 @@ class Alarm(SmartModule):
attribute_setter="set_alarm_duration", attribute_setter="set_alarm_duration",
category=Feature.Category.Config, category=Feature.Category.Config,
type=Feature.Type.Number, type=Feature.Type.Number,
# TODO: needs testing the duration limits. range_getter=lambda: (1, 10 * 60),
range_getter=lambda: (1, 60),
) )
) )
self._add_feature( self._add_feature(
@ -116,6 +115,7 @@ class Alarm(SmartModule):
See *alarm_sounds* for list of available sounds. See *alarm_sounds* for list of available sounds.
""" """
self._check_sound(sound)
payload = self.data["get_alarm_configure"].copy() payload = self.data["get_alarm_configure"].copy()
payload["type"] = sound payload["type"] = sound
return await self.call("set_alarm_configure", payload) return await self.call("set_alarm_configure", payload)
@ -132,6 +132,7 @@ class Alarm(SmartModule):
async def set_alarm_volume(self, volume: Literal["low", "normal", "high"]) -> dict: async def set_alarm_volume(self, volume: Literal["low", "normal", "high"]) -> dict:
"""Set alarm volume.""" """Set alarm volume."""
self._check_volume(volume)
payload = self.data["get_alarm_configure"].copy() payload = self.data["get_alarm_configure"].copy()
payload["volume"] = volume payload["volume"] = volume
return await self.call("set_alarm_configure", payload) return await self.call("set_alarm_configure", payload)
@ -143,6 +144,7 @@ class Alarm(SmartModule):
async def set_alarm_duration(self, duration: int) -> dict: async def set_alarm_duration(self, duration: int) -> dict:
"""Set alarm duration.""" """Set alarm duration."""
self._check_duration(duration)
payload = self.data["get_alarm_configure"].copy() payload = self.data["get_alarm_configure"].copy()
payload["duration"] = duration payload["duration"] = duration
return await self.call("set_alarm_configure", payload) return await self.call("set_alarm_configure", payload)
@ -173,11 +175,17 @@ class Alarm(SmartModule):
See *alarm_sounds* for the list of sounds available for the device. See *alarm_sounds* for the list of sounds available for the device.
""" """
params: dict[str, str | int] = {} params: dict[str, str | int] = {}
if duration is not None: if duration is not None:
self._check_duration(duration)
params["alarm_duration"] = duration params["alarm_duration"] = duration
if volume is not None: if volume is not None:
self._check_volume(volume)
params["alarm_volume"] = volume params["alarm_volume"] = volume
if sound is not None: if sound is not None:
self._check_sound(sound)
params["alarm_type"] = sound params["alarm_type"] = sound
return await self.call("play_alarm", params) return await self.call("play_alarm", params)
@ -185,3 +193,18 @@ class Alarm(SmartModule):
async def stop(self) -> dict: async def stop(self) -> dict:
"""Stop alarm.""" """Stop alarm."""
return await self.call("stop_alarm") return await self.call("stop_alarm")
def _check_volume(self, volume: str) -> None:
"""Raise an exception on invalid volume."""
if volume not in ["low", "normal", "high"]:
raise ValueError(f"Invalid volume {volume} [low, normal, high]")
def _check_duration(self, duration: int) -> None:
"""Raise an exception on invalid duration."""
if duration < 1 or duration > 10 * 60:
raise ValueError(f"Invalid duration {duration} (wanted: 1-600)")
def _check_sound(self, sound: str) -> None:
"""Raise an exception on invalid sound."""
if sound not in self.alarm_sounds:
raise ValueError(f"Invalid sound {sound} [{self.alarm_sounds}]")