-
-
Notifications
You must be signed in to change notification settings - Fork 228
Add turnonbehaviormodule for iot #1288
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
rytilahti
wants to merge
1
commit into
master
Choose a base branch
from
feat/iotbulb_turnonbehavior
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8000
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,125 @@ | ||
"""Implementation of the turn on behavior for bulbs.""" | ||
|
||
from __future__ import annotations | ||
|
||
import logging | ||
from dataclasses import dataclass | ||
from enum import Enum | ||
from typing import Annotated | ||
|
||
from mashumaro import DataClassDictMixin | ||
from mashumaro.config import BaseConfig | ||
from mashumaro.types import Alias | ||
|
||
from ...feature import Feature | ||
from ..iotmodule import IotModule | ||
|
||
_LOGGER = logging.getLogger(__name__) | ||
|
||
|
||
class TurnOnBehaviorModule(IotModule): | ||
"""Implements the turn on behavior module.""" | ||
|
||
def query(self) -> dict: | ||
"""Request default behavior configuration.""" | ||
return self.query_for_command("get_default_behavior") | ||
|
||
def _initialize_features(self) -> None: | ||
"""Initialize features after the initial update.""" | ||
# Only add features if the device supports the module | ||
if "get_default_behavior" not in self.data: | ||
return | ||
|
||
self._add_feature( | ||
Feature( | ||
device=self._device, | ||
container=self, | ||
id="turn_on_hard", | ||
name="Turn on hard", | ||
icon="mdi:motion-sensor", | ||
attribute_getter="turn_on_hard", | ||
# attribute_setter="set_turn_on_hard", | ||
type=Feature.Type.Choice, | ||
choices_getter=lambda: list(BehaviorMode), | ||
category=Feature.Category.Config, | ||
) | ||
) | ||
|
||
self._add_feature( | ||
Feature( | ||
device=self._device, | ||
container=self, | ||
id="turn_on_soft", | ||
name="Turn on soft", | ||
icon="mdi:motion-sensor", | ||
attribute_getter="turn_on_soft", | ||
# attribute_setter="set_turn_on_hard", | ||
type=Feature.Type.Choice, | ||
choices_getter=lambda: list(BehaviorMode), | ||
category=Feature.Category.Config, | ||
) | ||
) | ||
|
||
@property | ||
def behaviors(self) -> TurnOnBehaviors: | ||
"""Current turn on behaviors.""" | ||
return TurnOnBehaviors.from_dict(self.data["get_default_behavior"]) | ||
|
||
@property | ||
def turn_on_hard(self) -> BehaviorMode: | ||
"""Current turn on hard behavior.""" | ||
return self.behaviors.hard.mode | ||
|
||
@property | ||
def turn_on_soft(self) -> BehaviorMode: | ||
"""Current turn on soft behavior.""" | ||
return self.behaviors.hard.mode | ||
|
||
|
||
class BehaviorMode(str, Enum): | ||
"""Enum to present type of turn on behavior.""" | ||
|
||
#: Return to the last state known state. | ||
Last = "last_status" | ||
#: Use chosen preset. | ||
Preset = "customize_preset" | ||
#: Circadian | ||
Circadian = "circadian" | ||
|
||
|
||
@dataclass | ||
class TurnOnBehavior(DataClassDictMixin): | ||
"""Model to present a single turn on behavior. | ||
|
||
:param int preset: the index number of wanted preset. | ||
:param BehaviorMode mode: last status or preset mode. | ||
If you are changing existing settings, you should not set this manually. | ||
|
||
To change the behavior, it is only necessary to change the :attr:`preset` field | ||
to contain either the preset index, or ``None`` for the last known state. | ||
""" | ||
|
||
class Config(BaseConfig): | ||
"""Serialization config.""" | ||
|
||
omit_none = True | ||
serialize_by_alias = True | ||
|
||
#: Wanted behavior | ||
mode: BehaviorMode | ||
#: Index of preset to use, or ``None`` for the last known state. | ||
preset: Annotated[int | None, Alias("index")] = None | ||
brightness: int | None = None | ||
color_temp: int | None = None | ||
hue: int | None = None | ||
saturation: int | None = None | ||
|
||
|
||
@dataclass | ||
class TurnOnBehaviors(DataClassDictMixin): | ||
"""Model to contain turn on behaviors.""" | ||
|
||
#: The behavior when the bulb is turned on programmatically. | ||
soft: Annotated[TurnOnBehavior, Alias("soft_on")] | ||
#: The behavior when the bulb has been off from mains power. | ||
hard: Annotated[TurnOnBehavior, Alias("hard_on")] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Named as Module, as TurnOnBehavior is already taken by the model... We probably want to make a breaking change here, and rename the models to something else.