Fix KNX BinarySensor config_store data (home-assistant#151808)

Author: farmio

homeassistant/components/knx/storage/config_store.py

@@ -13,11 +13,12 @@
 
 from ..const import DOMAIN
 from .const import CONF_DATA
-from .migration import migrate_1_to_2
+from .migration import migrate_1_to_2, migrate_2_1_to_2_2
 
 _LOGGER = logging.getLogger(__name__)
 
 STORAGE_VERSION: Final = 2
+STORAGE_VERSION_MINOR: Final = 2
 STORAGE_KEY: Final = f"{DOMAIN}/config_store.json"
 
 type KNXPlatformStoreModel = dict[str, dict[str, Any]]  # unique_id: configuration
@@ -54,9 +55,13 @@ async def _async_migrate_func(
     ) -> dict[str, Any]:
         """Migrate to the new version."""
         if old_major_version == 1:
-            # version 2 introduced in 2025.8
+            # version 2.1 introduced in 2025.8
             migrate_1_to_2(old_data)
 
+        if old_major_version <= 2 and old_minor_version < 2:
+            # version 2.2 introduced in 2025.9.2
+            migrate_2_1_to_2_2(old_data)
+
         return old_data
 
 
@@ -71,7 +76,9 @@ def __init__(
         """Initialize config store."""
         self.hass = hass
         self.config_entry = config_entry
-        self._store = _KNXConfigStoreStorage(hass, STORAGE_VERSION, STORAGE_KEY)
+        self._store = _KNXConfigStoreStorage(
+            hass, STORAGE_VERSION, STORAGE_KEY, minor_version=STORAGE_VERSION_MINOR
+        )
         self.data = KNXConfigStoreModel(entities={})
         self._platform_controllers: dict[Platform, PlatformControllerBase] = {}
 

homeassistant/components/knx/storage/migration.py

@@ -4,6 +4,7 @@
 
 from homeassistant.const import Platform
 
+from ..const import CONF_RESPOND_TO_READ
 from . import const as store_const
 
 
@@ -40,3 +41,12 @@ def _migrate_light_schema_1_to_2(light_knx_data: dict[str, Any]) -> None:
 
     if color:
         light_knx_data[store_const.CONF_COLOR] = color
+
+
+def migrate_2_1_to_2_2(data: dict[str, Any]) -> None:
+    """Migrate from schema 2.1 to schema 2.2."""
+    if b_sensors := data.get("entities", {}).get(Platform.BINARY_SENSOR):
+        for b_sensor in b_sensors.values():
+            # "respond_to_read" was never used for binary_sensor and is not valid
+            #  in the new schema. It was set as default in Store schema v1 and v2.1
+            b_sensor["knx"].pop(CONF_RESPOND_TO_READ, None)

tests/components/knx/fixtures/config_store_binarysensor.json

@@ -1,6 +1,6 @@
 {
   "version": 2,
-  "minor_version": 1,
+  "minor_version": 2,
   "key": "knx/config_store.json",
   "data": {
     "entities": {
@@ -17,7 +17,6 @@
               "state": "3/2/21",
               "passive": []
             },
-            "respond_to_read": false,
             "sync_state": true
           }
         }

tests/components/knx/fixtures/config_store_binarysensor_v2_1.json

@@ -0,0 +1,27 @@
+{
+  "version": 2,
+  "minor_version": 1,
+  "key": "knx/config_store.json",
+  "data": {
+    "entities": {
+      "light": {},
+      "binary_sensor": {
+        "knx_es_01JJP1XDQRXB0W6YYGXW6Y1X10": {
+          "entity": {
+            "name": "test",
+            "device_info": null,
+            "entity_category": null
+          },
+          "knx": {
+            "ga_sensor": {
+              "state": "3/2/21",
+              "passive": []
+            },
+            "respond_to_read": false,
+            "sync_state": true
+          }
+        }
+      }
+    }
+  }
+}

tests/components/knx/fixtures/config_store_light.json

@@ -1,6 +1,6 @@
 {
   "version": 2,
-  "minor_version": 1,
+  "minor_version": 2,
   "key": "knx/config_store.json",
   "data": {
     "entities": {

tests/components/knx/test_config_store.py

@@ -458,3 +458,19 @@ async def test_migration_1_to_2(
         hass, "config_store_light.json", "knx"
     )
     assert hass_storage[KNX_CONFIG_STORAGE_KEY] == new_data
+
+
+async def test_migration_2_1_to_2_2(
+    hass: HomeAssistant,
+    knx: KNXTestKit,
+    hass_storage: dict[str, Any],
+) -> None:
+    """Test migration from schema 2.1 to schema 2.2."""
+    await knx.setup_integration(
+        config_store_fixture="config_store_binarysensor_v2_1.json",
+        state_updater=False,
+    )
+    new_data = await async_load_json_object_fixture(
+        hass, "config_store_binarysensor.json", "knx"
+    )
+    assert hass_storage[KNX_CONFIG_STORAGE_KEY] == new_data