-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #86 from nobbi1991/bathroom_light
Bathroom light
- Loading branch information
Showing
34 changed files
with
701 additions
and
24 deletions.
There are no files selected for viewing
This file contains 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,50 @@ | ||
| name: Update pre-commit hooks | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| schedule: | ||
| - cron: '0 0 * * 0' # Runs every Sunday at midnight UTC | ||
| push: | ||
| branches: | ||
| - main # Runs when changes are pushed to the main branch | ||
|
|
||
| jobs: | ||
| update-pre-commit-hooks: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| # Checkout the repository | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v2 | ||
|
|
||
| # Install pre-commit | ||
| - name: Install pre-commit | ||
| run: | | ||
| python -m pip install --upgrade pip | ||
| pip install pre-commit | ||
| - name: Run pre-commit autoupdate | ||
| # Run pre-commit autoupdate to update the hook versions | ||
| run: pre-commit autoupdate | ||
|
|
||
| # Create a new branch and push changes (if the branch does not exist) | ||
| - name: Create branch and push updates | ||
| run: | | ||
| # Check if the branch exists, if not, create it | ||
| git fetch origin | ||
| BRANCH_NAME="pre-commit-updates" | ||
| if git rev-parse --verify origin/$BRANCH_NAME; then | ||
| echo "Branch $BRANCH_NAME exists, switching to it." | ||
| git checkout $BRANCH_NAME | ||
| else | ||
| echo "Branch $BRANCH_NAME does not exist, creating it." | ||
| git checkout -b $BRANCH_NAME | ||
| fi | ||
| # Add the updated .pre-commit-config.yaml file and commit changes | ||
| git add .pre-commit-config.yaml | ||
| git commit -m 'Update pre-commit hook versions' | ||
| # Push the changes to the branch | ||
| git push -u origin $BRANCH_NAME |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains 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 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 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 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 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,39 @@ | ||
| import HABApp | ||
| import pydantic | ||
|
|
||
| from habapp_rules.core.pydantic_base import ConfigBase, ItemBase, ParameterBase | ||
|
|
||
|
|
||
| class BathroomLightItems(ItemBase): | ||
| """Items for bathroom light.""" | ||
|
|
||
| # lights | ||
| light_main: HABApp.openhab.items.DimmerItem = pydantic.Field(..., description="main light item") | ||
| light_main_color: HABApp.openhab.items.NumberItem = pydantic.Field(..., description="main light color (Kelvin)") | ||
| light_main_hcl: HABApp.openhab.items.SwitchItem = pydantic.Field(..., description="set HCL mode from KNX actor active for main light") | ||
| light_mirror: HABApp.openhab.items.DimmerItem = pydantic.Field(..., description="mirror light item") | ||
|
|
||
| # environment | ||
| sleeping_state: HABApp.openhab.items.StringItem = pydantic.Field(..., description="sleeping state item") | ||
| presence_state: HABApp.openhab.items.StringItem = pydantic.Field(..., description="presence state item") | ||
|
|
||
| # state machine | ||
| manual: HABApp.openhab.items.SwitchItem = pydantic.Field(..., description="item to switch to manual mode and disable the automatic functions") | ||
| state: HABApp.openhab.items.StringItem = pydantic.Field(..., description="item to store the current state of the state machine") | ||
|
|
||
|
|
||
| class BathroomLightParameter(ParameterBase): | ||
| """Parameter for bathroom light.""" | ||
|
|
||
| color_mirror_sync: float = pydantic.Field(4000, description="color temperature for the mirror") | ||
| min_brightness_mirror_sync: int = pydantic.Field(80, description="minimum brightness for main light if main and mirror light is ON") | ||
| color_night: int = pydantic.Field(2600, description="color temperature for night mode") | ||
| brightness_night: int = pydantic.Field(40, description="brightness for night mode") | ||
| extended_sleep_time: int = pydantic.Field(15 * 60, description="additional sleep time in seconds", gt=0) | ||
|
|
||
|
|
||
| class BathroomLightConfig(ConfigBase): | ||
| """Config for bathroom light.""" | ||
|
|
||
| items: BathroomLightItems = pydantic.Field(..., description="items for the switch") | ||
| parameter: BathroomLightParameter = pydantic.Field(BathroomLightParameter(), description="parameter for the switch") |
This file contains 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 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 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,169 @@ | ||
| """Bathroom light rules.""" | ||
|
|
||
| import logging | ||
| import time | ||
| import typing | ||
|
|
||
| import HABApp | ||
|
|
||
| import habapp_rules.actors.config.energy_save_switch | ||
| import habapp_rules.actors.config.light_bathroom | ||
| import habapp_rules.actors.state_observer | ||
| import habapp_rules.core.helper | ||
| import habapp_rules.core.logger | ||
| import habapp_rules.core.state_machine_rule | ||
| import habapp_rules.system | ||
|
|
||
| LOGGER = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| class BathroomLight(habapp_rules.core.state_machine_rule.StateMachineRule): | ||
| """Bathroom light rule.""" | ||
|
|
||
| states: typing.ClassVar = [ | ||
| {"name": "Manual"}, | ||
| { | ||
| "name": "Auto", | ||
| "initial": "Init", | ||
| "children": [ | ||
| {"name": "Init"}, | ||
| {"name": "Off"}, | ||
| {"name": "On", "initial": "Init", "children": [{"name": "Init"}, {"name": "MainDay"}, {"name": "MainNight"}, {"name": "MainAndMirror"}]}, | ||
| ], | ||
| }, | ||
| ] | ||
|
|
||
| trans: typing.ClassVar = [ | ||
| # manual | ||
| {"trigger": "manual_on", "source": "Auto", "dest": "Manual"}, | ||
| {"trigger": "manual_off", "source": "Manual", "dest": "Auto"}, | ||
| # switch on | ||
| {"trigger": "hand_on", "source": "Auto_Off", "dest": "Auto_On"}, | ||
| # mirror | ||
| {"trigger": "mirror_on", "source": ["Auto_On_MainDay", "Auto_On_MainNight"], "dest": "Auto_On_MainAndMirror"}, | ||
| {"trigger": "mirror_off", "source": "Auto_On_MainAndMirror", "dest": "Auto_On_MainDay", "conditions": "_is_day"}, | ||
| {"trigger": "mirror_off", "source": "Auto_On_MainAndMirror", "dest": "Auto_On_MainNight", "unless": "_is_day"}, | ||
| # off | ||
| {"trigger": "hand_off", "source": "Auto_On", "dest": "Auto_Off"}, | ||
| {"trigger": "sleep_started", "source": "Auto_On", "dest": "Auto_Off"}, | ||
| {"trigger": "leaving", "source": "Auto_On", "dest": "Auto_Off"}, | ||
| ] | ||
|
|
||
| def __init__(self, config: habapp_rules.actors.config.light_bathroom.BathroomLightConfig) -> None: | ||
| """Init rule. | ||
| Args: | ||
| config: Config of bathroom light rule | ||
| """ | ||
| self._config = config | ||
| habapp_rules.core.state_machine_rule.StateMachineRule.__init__(self, self._config.items.state) | ||
| self._instance_logger = habapp_rules.core.logger.InstanceLogger(LOGGER, self._config.items.light_main.name) | ||
|
|
||
| self._sleep_end_time = 0 | ||
| self._light_main_observer = habapp_rules.actors.state_observer.StateObserverDimmer(self._config.items.light_main.name, cb_on=self._cb_hand_on, cb_off=self._cb_hand_off, value_tolerance=5) | ||
|
|
||
| # init state machine | ||
| self._previous_state = None | ||
| self.state_machine = habapp_rules.core.state_machine_rule.HierarchicalStateMachineWithTimeout(model=self, states=self.states, transitions=self.trans, ignore_invalid_triggers=True, after_state_change="_update_openhab_state") | ||
| self._set_state(self._get_initial_state()) | ||
|
|
||
| # callbacks | ||
| self._config.items.manual.listen_event(self._cb_manual, HABApp.openhab.events.ItemStateChangedEventFilter()) | ||
| self._config.items.light_mirror.listen_event(self._cb_mirror, HABApp.openhab.events.ItemStateChangedEventFilter()) | ||
| self._config.items.sleeping_state.listen_event(self._cb_sleeping_state, HABApp.openhab.events.ItemStateChangedEventFilter()) | ||
| self._config.items.presence_state.listen_event(self._cb_presence_state, HABApp.openhab.events.ItemStateChangedEventFilter()) | ||
|
|
||
| def _get_initial_state(self, default_value: str = "initial") -> str: # noqa: ARG002 | ||
| """Get initial state of state machine. | ||
| Args: | ||
| default_value: default / initial state | ||
| Returns: | ||
| if OpenHAB item has a state it will return it, otherwise return the given default value | ||
| """ | ||
| return "Manual" if self._config.items.manual.is_on() else "Auto" | ||
|
|
||
| def on_enter_Auto_Init(self) -> None: # noqa: N802 | ||
| """Callback, which is called on enter of Auto_Init state.""" | ||
| if self._config.items.light_main.is_on(): | ||
| self.to_Auto_On() | ||
| else: | ||
| self.to_Auto_Off() | ||
|
|
||
| def on_enter_Auto_On_Init(self) -> None: # noqa: N802 | ||
| """Callback, which is called on enter of Auto_On_Init state.""" | ||
| if self._mirror_is_on(): | ||
| self.to_Auto_On_MainAndMirror() | ||
| elif self._is_day(): | ||
| self.to_Auto_On_MainDay() | ||
| else: | ||
| self.to_Auto_On_MainNight() | ||
|
|
||
| def _update_openhab_state(self) -> None: | ||
| """Update OpenHAB state item and other states. | ||
| This should method should be set to "after_state_change" of the state machine. | ||
| """ | ||
| if self.state != self._previous_state: | ||
| super()._update_openhab_state() | ||
| self._instance_logger.debug(f"State change: {self._previous_state} -> {self.state}") | ||
|
|
||
| self._set_outputs() | ||
| self._previous_state = self.state | ||
|
|
||
| def _set_outputs(self) -> None: | ||
| if self.state == "Manual": | ||
| return | ||
|
|
||
| if self.state == "Auto_Off": | ||
| habapp_rules.core.helper.send_if_different(self._config.items.light_mirror, "OFF") | ||
| if self._light_main_observer.value: | ||
| self._light_main_observer.send_command(0) | ||
| elif self.state == "Auto_On_MainDay": | ||
| habapp_rules.core.helper.send_if_different(self._config.items.light_main_hcl, "ON") | ||
| elif self.state == "Auto_On_MainNight": | ||
| self._light_main_observer.send_command(self._config.parameter.brightness_night) | ||
| habapp_rules.core.helper.send_if_different(self._config.items.light_main_color, self._config.parameter.color_night) | ||
| elif self.state == "Auto_On_MainAndMirror": | ||
| habapp_rules.core.helper.send_if_different(self._config.items.light_main_color, self._config.parameter.color_mirror_sync) | ||
| new_brightness = max(self._config.parameter.min_brightness_mirror_sync, self._light_main_observer.value) | ||
| self._light_main_observer.send_command(new_brightness) | ||
|
|
||
| def _is_day(self) -> bool: | ||
| if self._config.items.sleeping_state.value != habapp_rules.system.SleepState.AWAKE.value: | ||
| return False | ||
|
|
||
| return time.time() - self._sleep_end_time > self._config.parameter.extended_sleep_time | ||
|
|
||
| def _mirror_is_on(self) -> bool: | ||
| return self._config.items.light_mirror.is_on() | ||
|
|
||
| def _cb_manual(self, event: HABApp.openhab.events.ItemStateChangedEvent) -> None: | ||
| if event.value == "ON": | ||
| self.manual_on() | ||
| else: | ||
| self.manual_off() | ||
|
|
||
| def _cb_hand_on(self, event: HABApp.openhab.events.ItemStateChangedEvent) -> None: # noqa: ARG002 | ||
| self.hand_on() | ||
|
|
||
| def _cb_hand_off(self, event: HABApp.openhab.events.ItemStateChangedEvent) -> None: # noqa: ARG002 | ||
| self.hand_off() | ||
|
|
||
| def _cb_mirror(self, event: HABApp.openhab.events.ItemStateChangedEvent) -> None: # noqa: ARG002 | ||
| if self._config.items.light_mirror.is_on(): | ||
| self.mirror_on() | ||
| else: | ||
| self.mirror_off() | ||
|
|
||
| def _cb_sleeping_state(self, event: HABApp.openhab.events.ItemStateChangedEvent) -> None: | ||
| if event.value == habapp_rules.system.SleepState.PRE_SLEEPING.value: | ||
| self.sleep_started() | ||
|
|
||
| if event.value == habapp_rules.system.SleepState.AWAKE.value: | ||
| self._sleep_end_time = time.time() | ||
|
|
||
| def _cb_presence_state(self, event: HABApp.openhab.events.ItemStateChangedEvent) -> None: | ||
| if event.value == habapp_rules.system.PresenceState.LEAVING.value: | ||
| self.leaving() |
Oops, something went wrong.