mirror of
https://github.com/python-kasa/python-kasa.git
synced 2025-01-08 22:07:06 +00:00
b73c0d222e
* Move dimmer support to its own class SmartDimmer extends SmartPlug with brightness settings. This will make the API of SmartPlug less confusing and will make it simpler to downstream users to act with dimmers. Fixes #33 * Lint & make tests pass * Fix rebase after cache and emeter cleanups, hopefully everything went smoothly.. * oopsie, has_emeter was mistakenly included in smartplug
95 lines
2.7 KiB
Python
95 lines
2.7 KiB
Python
"""Module for dimmers (currently only HS220)."""
|
|
from typing import Any, Dict
|
|
|
|
from kasa import DeviceType, SmartDeviceException
|
|
from kasa.smartdevice import requires_update
|
|
from kasa.smartplug import SmartPlug
|
|
|
|
|
|
class SmartDimmer(SmartPlug):
|
|
"""Representation of a TP-Link Smart Dimmer.
|
|
|
|
Dimmers work similarly to plugs, but provide also support for
|
|
adjusting the brightness. This class extends SmartPlug interface.
|
|
|
|
Example:
|
|
```
|
|
dimmer = SmartDimmer("192.168.1.105")
|
|
await dimmer.turn_on()
|
|
print("Current brightness: %s" % dimmer.brightness)
|
|
|
|
await dimmer.set_brightness(100)
|
|
```
|
|
|
|
Refer to SmartPlug for the full API.
|
|
"""
|
|
|
|
def __init__(self, host: str) -> None:
|
|
super().__init__(host)
|
|
self._device_type = DeviceType.Dimmer
|
|
|
|
@property # type: ignore
|
|
@requires_update
|
|
def brightness(self) -> int:
|
|
"""Return current brightness on dimmers.
|
|
|
|
Will return a range between 0 - 100.
|
|
|
|
:returns: integer
|
|
:rtype: int
|
|
"""
|
|
if not self.is_dimmable:
|
|
raise SmartDeviceException("Device is not dimmable.")
|
|
|
|
sys_info = self.sys_info
|
|
return int(sys_info["brightness"])
|
|
|
|
@requires_update
|
|
async def set_brightness(self, value: int):
|
|
"""Set the new dimmer brightness level.
|
|
|
|
Note:
|
|
When setting brightness, if the light is not
|
|
already on, it will be turned on automatically.
|
|
|
|
:param value: integer between 1 and 100
|
|
|
|
"""
|
|
if not self.is_dimmable:
|
|
raise SmartDeviceException("Device is not dimmable.")
|
|
|
|
if not isinstance(value, int):
|
|
raise ValueError("Brightness must be integer, " "not of %s.", type(value))
|
|
elif 0 < value <= 100:
|
|
await self.turn_on()
|
|
await self._query_helper(
|
|
"smartlife.iot.dimmer", "set_brightness", {"brightness": value}
|
|
)
|
|
await self.update()
|
|
else:
|
|
raise ValueError("Brightness value %s is not valid." % value)
|
|
|
|
@property # type: ignore
|
|
@requires_update
|
|
def is_dimmable(self):
|
|
"""Whether the switch supports brightness changes.
|
|
|
|
:return: True if switch supports brightness changes, False otherwise
|
|
:rtype: bool
|
|
"""
|
|
sys_info = self.sys_info
|
|
return "brightness" in sys_info
|
|
|
|
@property # type: ignore
|
|
@requires_update
|
|
def state_information(self) -> Dict[str, Any]:
|
|
"""Return switch-specific state information.
|
|
|
|
:return: Switch information dict, keys in user-presentable form.
|
|
:rtype: dict
|
|
"""
|
|
info = super().state_information
|
|
info["Brightness"] = self.brightness
|
|
|
|
return info
|