Rename instance_name to central_name (#2002)

* Rename instance_name to central_name

changelog.md

@@ -1,6 +1,7 @@
 # Version 2025.1.11 (2025-01-20)
 
 - Delay start of scheduler until devices are created
+- Rename instance_name to central_name
 - Slugify cache file name
 
 # Version 2025.1.10 (2025-01-17)

hahomematic/caches/dynamic.py

@@ -451,7 +451,7 @@ def _fire_event(mismatch_count: int) -> None:
                             EventKey.INTERFACE_ID: self._interface_id,
                             EventKey.TYPE: event_type,
                             EventKey.DATA: {
-                                EventKey.INSTANCE_NAME: self._central.name,
+                                EventKey.CENTRAL_NAME: self._central.name,
                                 EventKey.PONG_MISMATCH_COUNT: mismatch_count,
                             },
                         }

hahomematic/caches/persistent.py

@@ -391,3 +391,10 @@ async def load(self) -> DataOperationResult:
     async def save(self) -> DataOperationResult:
         """Save current paramset descriptions to disk."""
         return await super().save()
+
+
+def cleanup_cache_dirs(central_name: str, storage_folder: str) -> None:
+    """Clean up the used cached directories."""
+    cache_dir = f"{storage_folder}/{CACHE_PATH}"
+    for file_to_delete in (FILE_DEVICES, FILE_PARAMSETS):
+        delete_file(folder=cache_dir, file_name=f"{slugify(central_name)}_{file_to_delete}")

hahomematic/central/__init__.py

@@ -102,7 +102,7 @@
 
 _LOGGER: Final = logging.getLogger(__name__)
 
-# {instance_name, central}
+# {central_name, central}
 CENTRAL_INSTANCES: Final[dict[str, CentralUnit]] = {}
 ConnectionProblemIssuer = JsonRpcAioHttpClient | XmlRpcProxy
 

hahomematic/const.py

@@ -225,9 +225,9 @@ class EventKey(StrEnum):
 
     ADDRESS = "address"
     AVAILABLE = "available"
+    CENTRAL_NAME = "central_name"
     CHANNEL_NO = "channel_no"
     DATA = "data"
-    INSTANCE_NAME = "instance_name"
     INTERFACE_ID = "interface_id"
     MODEL = "model"
     PARAMETER = "parameter"

hahomematic/support.py

@@ -23,12 +23,9 @@
 from hahomematic.const import (
     ADDRESS_SEPARATOR,
     ALLOWED_HOSTNAME_PATTERN,
-    CACHE_PATH,
     CCU_PASSWORD_PATTERN,
     CHANNEL_ADDRESS_PATTERN,
     DEVICE_ADDRESS_PATTERN,
-    FILE_DEVICES,
-    FILE_PARAMSETS,
     HTMLTAG_PATTERN,
     IDENTIFIER_SEPARATOR,
     INIT_DATETIME,
@@ -386,15 +383,6 @@ def _get_search_key(search_elements: Collection[str], search_key: str) -> str |
     return None
 
 
-def cleanup_cache_dirs(instance_name: str, storage_folder: str) -> None:
-    """Clean up the used cached directories."""
-    cache_dir = f"{storage_folder}/{CACHE_PATH}"
-    files_to_delete = [FILE_DEVICES, FILE_PARAMSETS]
-
-    for file_to_delete in files_to_delete:
-        delete_file(folder=cache_dir, file_name=f"{instance_name}_{file_to_delete}")
-
-
 @dataclass(frozen=True, kw_only=True, slots=True)
 class CacheEntry:
     """An entry for the value cache."""

tests/test_central.py

@@ -907,7 +907,7 @@ async def test_pending_pong_failure(
         EventType.INTERFACE,
         {
             "data": {
-                "instance_name": "CentralTest",
+                "central_name": "CentralTest",
                 "pong_mismatch_count": 16,
             },
             "interface_id": "CentralTest-BidCos-RF",