Add brightness module (#806)

Add module for controlling the brightness.
This commit is contained in:
Teemu R
2024-03-05 15:41:40 +01:00
committed by GitHub
parent eb4c048b57
commit 0d5a3c8439
5 changed files with 74 additions and 10 deletions

View File

@@ -2,6 +2,7 @@
from .alarmmodule import AlarmModule
from .autooffmodule import AutoOffModule
from .battery import BatterySensor
from .brightness import Brightness
from .childdevicemodule import ChildDeviceModule
from .cloudmodule import CloudModule
from .devicemodule import DeviceModule
@@ -26,6 +27,7 @@ __all__ = [
"ReportModule",
"AutoOffModule",
"LedModule",
"Brightness",
"Firmware",
"CloudModule",
"LightTransitionModule",

View File

@@ -0,0 +1,43 @@
"""Implementation of brightness module."""
from typing import TYPE_CHECKING, Dict
from ...feature import Feature, FeatureType
from ..smartmodule import SmartModule
if TYPE_CHECKING:
from ..smartdevice import SmartDevice
class Brightness(SmartModule):
"""Implementation of brightness module."""
REQUIRED_COMPONENT = "brightness"
def __init__(self, device: "SmartDevice", module: str):
super().__init__(device, module)
self._add_feature(
Feature(
device,
"Brightness",
container=self,
attribute_getter="brightness",
attribute_setter="set_brightness",
minimum_value=1,
maximum_value=100,
type=FeatureType.Number,
)
)
def query(self) -> Dict:
"""Query to execute during the update cycle."""
# Brightness is contained in the main device info response.
return {}
@property
def brightness(self):
"""Return current brightness."""
return self.data["brightness"]
async def set_brightness(self, brightness: int):
"""Set the brightness."""
return await self.call("set_device_info", {"brightness": brightness})

View File

@@ -53,14 +53,19 @@ class SmartModule(Module):
def data(self):
"""Return response data for the module.
If module performs only a single query, the resulting response is unwrapped.
If the module performs only a single query, the resulting response is unwrapped.
If the module does not define a query, this property returns a reference
to the main "get_device_info" response.
"""
dev = self._device
q = self.query()
if not q:
return dev.internal_state["get_device_info"]
q_keys = list(q.keys())
query_key = q_keys[0]
dev = self._device
# TODO: hacky way to check if update has been called.
# The way this falls back to parent may not always be wanted.
# Especially, devices can have their own firmware updates.