Merge pull request #1188 from charrus/use_appdaemon_452

Update to AppDaemon 4.5.2 to fix #1184

Author: xaviml

.github/workflows/cicd.yaml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.10", "3.11", "3.12"]
       fail-fast: false
     steps:
       - uses: actions/checkout@v4

.github/workflows/codeql-analysis.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python_version: ["3.9", "3.10", "3.11"]
+        python_version: ["3.10", "3.11", "3.12"]
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4

.gitignore

@@ -135,3 +135,4 @@ dmypy.json
 
 # Project
 apps.yaml
+appdaemon.yaml

.pre-commit-config.yaml

@@ -15,7 +15,7 @@ repos:
       - id: python-check-mock-methods
       - id: python-check-blanket-type-ignore
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.32.1
+    rev: 0.33.0
     hooks:
       - id: check-github-workflows
       - id: check-dependabot
@@ -37,19 +37,19 @@ repos:
     hooks:
       - id: black
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.19.1
+    rev: v3.20.0
     hooks:
       - id: pyupgrade
-        args: [--py39-plus]
+        args: [--py310-plus]
   - repo: https://github.com/PyCQA/flake8
     rev: 7.2.0
     hooks:
       - id: flake8
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.15.0
+    rev: v1.16.0
     hooks:
       - id: mypy
         additional_dependencies:
-          - types-PyYAML==6.0.12
-          - types-mock==5.0.0
-          - pytest==7.3.1
+          - types-PyYAML==6.0.12.20250516
+          - types-mock==5.2.0.20250516
+          - pytest==8.4.0

CONTRIBUTING.md

@@ -10,7 +10,7 @@ poetry shell
 pre-commit install
 ```
 
-_Note: I recommend working with Python 3.8 since is the minimum version supported._
+_Note: I recommend working with Python 3.10 since is the minimum version supported._
 
 ## Adding a new controller
 
@@ -112,6 +112,7 @@ This will start AppDaemon with the apps on the `apps.yaml`. Note that if you wan
 docker run --pull=always --rm \
 -v $PWD/apps/controllerx:/usr/src/app/conf/apps/controllerx \
 -v $PWD/apps.yaml:/usr/src/app/conf/apps/apps.yaml \
+-v $PWD/appdaemon.yaml:/usr/src/app/conf/appdaemon.yaml.example \
 -e DASH_URL=http://127.0.0.1:5050 \
 -e HA_URL="http://YOUR_HA_IP:8123" \
 -e TOKEN="YOUR_HA_TOKEN" \

RELEASE_NOTES.md

@@ -1,14 +1,18 @@
 [![downloads](https://img.shields.io/github/downloads/xaviml/controllerx/VERSION_TAG/total?style=for-the-badge)](http://github.com/xaviml/controllerx/releases/VERSION_TAG)
 
-<!--:warning: This major/minor change contains a breaking change.-->
+Special thanks to @charrus for working on the quick fix for this release.
 
-_This minor change does not contain any breaking changes._
+:warning: This major change contains a breaking change.
+
+<!--_This minor change does not contain any breaking changes._-->
 
 **_Note: Remember to restart the AppDaemon addon/server after updating to a new version._**
 
-<!--
 ## :pencil2: Features
--->
+
+- :warning: Add support to AppDaemon 4.5.X. This is a breaking change, so if you are running on AppDaemon <4.5, make sure to update first.
+- Drop support for Python 3.9
+- Add support for Python 3.12
 
 <!--
 ## :video_game: New devices

apps/controllerx/cx_const.py

@@ -1,5 +1,5 @@
-from collections.abc import Awaitable
-from typing import Any, Callable, Optional, Union
+from collections.abc import Awaitable, Callable
+from typing import Any, Optional, Union
 
 ActionFunction = Callable[..., Awaitable[Any]]
 ActionParams = tuple[Any, ...]

apps/controllerx/cx_core/action_type/base.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from typing import TYPE_CHECKING, Any, Optional
+from typing import TYPE_CHECKING, Any
 
 from cx_core.integration import EventData
 
@@ -18,7 +18,7 @@ def initialize(self, **kwargs: Any) -> None:
         pass
 
     @abstractmethod
-    async def run(self, extra: Optional[EventData] = None) -> None:
+    async def run(self, extra: EventData | None = None) -> None:
         raise NotImplementedError
 
     def __str__(self) -> str:

apps/controllerx/cx_core/action_type/call_service_action_type.py

@@ -1,4 +1,4 @@
-from typing import TYPE_CHECKING, Any, Optional, cast
+from typing import TYPE_CHECKING, Any, cast
 
 from cx_core.action_type.base import ActionType
 from cx_core.integration import EventData
@@ -13,7 +13,7 @@ class CallServiceActionType(ActionType):
     # - Inside data
     # - In the same level as "service"
     # - From the main config if the domain matches
-    entity_id: Optional[str]
+    entity_id: str | None
     data: dict[str, Any]
 
     def initialize(self, **kwargs: Any) -> None:
@@ -40,7 +40,7 @@ def _check_controller_isinstance_type_controller(self) -> bool:
     def _get_service_domain(self, service: str) -> str:
         return service.replace(".", "/").split("/")[0]
 
-    async def run(self, extra: Optional[EventData] = None) -> None:
+    async def run(self, extra: EventData | None = None) -> None:
         if self.entity_id:
             await self.controller.call_service(
                 self.service, entity_id=self.entity_id, **self.data

apps/controllerx/cx_core/action_type/delay_action_type.py

@@ -1,4 +1,4 @@
-from typing import Any, Optional
+from typing import Any
 
 from cx_core.action_type.base import ActionType
 from cx_core.integration import EventData
@@ -10,7 +10,7 @@ class DelayActionType(ActionType):
     def initialize(self, **kwargs: Any) -> None:
         self.delay = kwargs["delay"]
 
-    async def run(self, extra: Optional[EventData] = None) -> None:
+    async def run(self, extra: EventData | None = None) -> None:
         await self.controller.sleep(self.delay)
 
     def __str__(self) -> str:

apps/controllerx/cx_core/action_type/predefined_action_type.py

@@ -1,5 +1,5 @@
 import inspect
-from typing import Any, Optional
+from typing import Any
 
 from cx_const import (
     ActionFunction,
@@ -23,7 +23,7 @@ def _get_arguments(
     action: ActionFunction,
     args: ActionParams,
     predefined_action_kwargs: dict[str, Any],
-    extra: Optional[EventData],
+    extra: EventData | None,
 ) -> tuple[ActionParams, dict[str, Any]]:
     action_parameters = inspect.signature(action).parameters
     action_parameters_without_extra = {
@@ -105,7 +105,7 @@ def initialize(self, **kwargs: Any) -> None:
                 self.predefined_action_key, self.predefined_actions_mapping
             )
 
-    async def run(self, extra: Optional[EventData] = None) -> None:
+    async def run(self, extra: EventData | None = None) -> None:
         action_key = await self.controller.render_value(self.predefined_action_key)
         if action_key not in self.predefined_actions_mapping:
             self._raise_action_key_not_found(

apps/controllerx/cx_core/action_type/scene_action_type.py

@@ -1,4 +1,4 @@
-from typing import Any, Optional
+from typing import Any
 
 from cx_core.action_type.base import ActionType
 from cx_core.integration import EventData
@@ -10,7 +10,7 @@ class SceneActionType(ActionType):
     def initialize(self, **kwargs: Any) -> None:
         self.scene = kwargs["scene"]
 
-    async def run(self, extra: Optional[EventData] = None) -> None:
+    async def run(self, extra: EventData | None = None) -> None:
         await self.controller.call_service("scene/turn_on", entity_id=self.scene)
 
     def __str__(self) -> str:

apps/controllerx/cx_core/color_helper.py

@@ -1,5 +1,3 @@
-from typing import Union
-
 Color = tuple[float, float]
 Colors = list[Color]
 
@@ -68,7 +66,7 @@
 }
 
 
-def get_color_wheel(colors: Union[str, Colors]) -> Colors:
+def get_color_wheel(colors: str | Colors) -> Colors:
     if isinstance(colors, str):
         if colors not in COLOR_WHEELS:
             raise ValueError(