Add code to migrate configuration

Author: mdeweerd

custom_components/zha_toolkit/__init__.py

@@ -4,6 +4,7 @@
 
 import homeassistant.helpers.config_validation as cv
 import voluptuous as vol
+from homeassistant.config_entries import ConfigEntry
 
 try:
     from homeassistant.components.zha import Gateway as ZHAGateway
@@ -16,11 +17,10 @@
 
 from . import params as PARDEFS
 from . import utils as u
+from .const import DOMAIN
 
 DEPENDENCIES = ["zha"]
 
-DOMAIN = "zha_toolkit"
-
 # Legacy parameters
 ATTR_COMMAND = "command"
 ATTR_COMMAND_DATA = "command_data"
@@ -935,3 +935,51 @@ async def command_handler_register_services(
     app, listener, ieee, cmd, data, service, params, event_data
 ):
     await _register_services(u.get_hass(listener))
+
+
+# For migrating from one version to another.
+# Added to migrate from a configuration.yaml entry to UI configuration
+# Example migration function
+# Return True when migration is successful
+#
+async def async_migrate_entry(hass, config_entry: ConfigEntry):
+    """Migrate old entry."""
+    LOGGER.debug(
+        "Migrating configuration from version %s.%s",
+        config_entry.version,
+        config_entry.minor_version,
+    )
+
+    from .config_flow import ZhaToolkitCustomConfigFlow as CF
+
+    new_data = {**config_entry.data}
+
+    # Sample code to  test version migration and update it
+    # if config_entry.version > 1:
+    #   # This means the user has downgraded from a future version
+    #   return False
+
+    # if config_entry.version == 1:
+
+    #   new_data = {**config_entry.data}
+    #   if config_entry.minor_version < 2:
+    #       # TODO: modify Config Entry data with changes in version 1.2
+    #       pass
+    #   if config_entry.minor_version < 3:
+    #       # TODO: modify Config Entry data with changes in version 1.3
+    #       pass
+
+    hass.config_entries.async_update_entry(
+        config_entry,
+        data=new_data,
+        minor_version=CF.MIN_VERSION,
+        version=CF.VERSION,
+    )
+
+    LOGGER.debug(
+        "Migration to configuration version %s.%s successful",
+        config_entry.version,
+        config_entry.minor_version,
+    )
+
+    return True

custom_components/zha_toolkit/config_flow.py

@@ -6,8 +6,8 @@
 
 from homeassistant import config_entries
 
-from . import DOMAIN
 from . import utils as u
+from .const import DOMAIN
 
 # from homeassistant.const import CONF_ACCESS_TOKEN,CONF_NAME
 # from homeassistant.const import CONF_PATH,CONF_URL
@@ -40,10 +40,13 @@
 class ZhaToolkitCustomConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
     """Zha Toolkit Custom config flow."""
 
+    VERSION = 0
+    MINOR_VERSION = 1
+
     data: Optional[dict[str, Any]]
 
     async def my_async_create_entry(self):
-        self.data["VERSION"] = u.getVersion()
+        self.data["VERSION"] = await u.getVersion()
         # Create the configuration entry
         return self.async_create_entry(title="ZHA Toolkit", data=self.data)