Implement weather entity issue handling and repair flow

alepee · alepee · commit 6f6a0e6c9023 · 2025-11-09T10:01:28.000+01:00
- Added functionality to create and delete issues related to weather entities that do not support hourly forecasts.
- Introduced a new repair flow for users to select a new weather entity or remove the existing one.
- Updated translations for the new repair options and issue descriptions in both English and French.
- Refactored existing repair flow methods to accommodate the new structure and improve user experience.
diff --git a/custom_components/heating_cooling_degree_days/coordinator.py b/custom_components/heating_cooling_degree_days/coordinator.py
@@ -103,6 +103,29 @@ def __init__(
             weather_entity if weather_entity else "none",
         )
 
+        ir.async_delete_issue(
+            self.hass,
+            DOMAIN,
+            ISSUE_WEATHER_NO_HOURLY_FORECAST,
+        )
+
+        ir.async_create_issue(
+            self.hass,
+            DOMAIN,
+            ISSUE_WEATHER_NO_HOURLY_FORECAST,
+            is_fixable=True,
+            is_persistent=True,
+            severity=ir.IssueSeverity.ERROR,
+            translation_key="weather_no_hourly_forecast",
+            translation_placeholders={
+                "entity_id": self.weather_entity,
+            },
+            data={
+                "entry_id": self.entry_id,
+                "entity_id": self.weather_entity,
+            },
+        )
+
     async def async_load_stored_data(self):
         """Load stored daily values from persistent storage."""
         try:
@@ -337,7 +360,8 @@ async def _async_update_data(self):
                     result[SENSOR_TYPE_CDD_ESTIMATED_TOMORROW] = None
         else:
             # No weather entity configured, delete any existing issue
-            ir.async_delete_issue(self.hass, DOMAIN, ISSUE_WEATHER_NO_HOURLY_FORECAST)
+            # TODO: ir.async_delete_issue(self.hass, DOMAIN, ISSUE_WEATHER_NO_HOURLY_FORECAST)
+            print("No weather entity configured, deleting issue")
 
         return result
 
@@ -440,7 +464,7 @@ async def _get_weather_forecast(self) -> list[dict] | None:
 
             # If we successfully got forecast data, delete any existing issue
             # (in case it was fixed by changing the entity or the entity was updated)
-            ir.async_delete_issue(self.hass, DOMAIN, ISSUE_WEATHER_NO_HOURLY_FORECAST)
+            # TODO: ir.async_delete_issue(self.hass, DOMAIN, ISSUE_WEATHER_NO_HOURLY_FORECAST)
 
             return forecast
 
diff --git a/custom_components/heating_cooling_degree_days/repairs.py b/custom_components/heating_cooling_degree_days/repairs.py
@@ -25,15 +25,20 @@ async def async_create_fix_flow(
     data: dict[str, str | int | float | None] | None,
 ) -> RepairsFlow:
     """Create flow."""
-    if issue_id == ISSUE_WEATHER_NO_HOURLY_FORECAST:
-        return WeatherEntityRepairFlow(hass, data)
 
-    return ConfirmRepairFlow()
+    for repair_flow_cls in [WeatherNoHourlyForecastRepairFlow]:
+        if repair_flow_cls.is_issue_supported(issue_id):
+            return repair_flow_cls(hass, data)
 
 
-class WeatherEntityRepairFlow(RepairsFlow):
+class WeatherNoHourlyForecastRepairFlow(RepairsFlow):
     """Handler for weather entity repair flow."""
 
+    @staticmethod
+    def is_issue_supported(issue_id: str) -> bool:
+        """Return True if this flow supports the given issue_id."""
+        return issue_id == ISSUE_WEATHER_NO_HOURLY_FORECAST
+
     def __init__(
         self, hass: HomeAssistant, data: dict[str, str | int | float | None] | None
     ) -> None:
@@ -45,6 +50,12 @@ def __init__(
 
     async def async_step_init(
         self, user_input: dict[str, str] | None = None
+    ) -> data_entry_flow.FlowResult:
+        """Handle the first step of a fix flow."""
+        return await self.async_step_weather_no_hourly_forecast(user_input)
+
+    async def async_step_weather_no_hourly_forecast(
+        self, user_input: dict[str, str] | None = None
     ) -> data_entry_flow.FlowResult:
         """Handle the first step of a fix flow."""
         if not self.entry_id:
@@ -58,29 +69,24 @@ async def async_step_init(
         if user_input is not None:
             action = user_input.get("action")
             if action == "select_new":
-                return await self.async_step_select_weather()
+                return await self.async_step_weather_no_hourly_forecast_select_weather()
             elif action == "remove":
-                return await self.async_step_confirm_remove()
+                return await self.async_step_weather_no_hourly_forecast_confirm_remove()
 
-        # Show form to choose action
-        return self.async_show_form(
-            step_id="init",
-            data_schema=vol.Schema(
-                {
-                    vol.Required("action", default="select_new"): vol.In(
-                        {
-                            "select_new": "Select a new weather entity",
-                            "remove": "Remove weather entity (disable forecast sensors)",
-                        }
-                    ),
-                }
-            ),
+        _LOGGER.debug("user_input: %s", user_input)
+
+        return self.async_show_menu(
+            step_id="weather_no_hourly_forecast",
+            menu_options=[
+                "weather_no_hourly_forecast_select_weather",
+                "weather_no_hourly_forecast_confirm_remove",
+            ],
             description_placeholders={
-                "current_entity": self.current_entity or "unknown",
+                "current_entity": self.current_entity,
             },
         )
 
-    async def async_step_select_weather(
+    async def async_step_weather_no_hourly_forecast_select_weather(
         self, user_input: dict[str, str] | None = None
     ) -> data_entry_flow.FlowResult:
         """Handle the weather entity selection step."""
@@ -116,7 +122,7 @@ async def async_step_select_weather(
                     return self.async_abort(reason="entry_not_found")
             else:
                 return self.async_show_form(
-                    step_id="select_weather",
+                    step_id="weather_no_hourly_forecast_select_weather",
                     data_schema=vol.Schema(
                         {
                             vol.Optional(CONF_WEATHER_ENTITY): selector.EntitySelector(
@@ -129,7 +135,7 @@ async def async_step_select_weather(
 
         # Show form to select new weather entity
         return self.async_show_form(
-            step_id="select_weather",
+            step_id="weather_no_hourly_forecast_select_weather",
             data_schema=vol.Schema(
                 {
                     vol.Optional(CONF_WEATHER_ENTITY): selector.EntitySelector(
@@ -172,7 +178,7 @@ async def _validate_weather_entity(self, entity_id: str) -> bool:
         )
         return True
 
-    async def async_step_confirm_remove(
+    async def async_step_weather_no_hourly_forecast_confirm_remove(
         self, user_input: dict[str, str] | None = None
     ) -> data_entry_flow.FlowResult:
         """Handle the confirmation step for removing weather entity."""
@@ -200,7 +206,7 @@ async def async_step_confirm_remove(
 
         # Show confirmation form
         return self.async_show_form(
-            step_id="confirm_remove",
+            step_id="weather_no_hourly_forecast_confirm_remove",
             data_schema=vol.Schema({}),
             description_placeholders={
                 "current_entity": self.current_entity or "unknown",
diff --git a/custom_components/heating_cooling_degree_days/translations/en.json b/custom_components/heating_cooling_degree_days/translations/en.json
@@ -32,11 +32,35 @@
           "base_temperature": "The default base temperature is 18°C for Celsius or 65°F for Fahrenheit, depending on your unit system",
           "weather_entity": "If provided, this weather entity enables forecast data for 24h and 48h estimates"
         }
+      },
+      "weather_no_hourly_forecast": {
+        "title": "Fix weather entity issue",
+        "description": "The weather entity '{current_entity}' no longer supports hourly forecasts. Choose how to fix this:",
+        "data": {
+          "action": "Action"
+        },
+        "menu_options": {
+          "weather_no_hourly_forecast_select_weather": "Select new weather entity",
+          "weather_no_hourly_forecast_confirm_remove": "Remove weather entity (disable forecast sensors)"
+        }
+      },
+      "weather_no_hourly_forecast_select_weather": {
+        "title": "Select new weather entity",
+        "description": "Select a weather entity that supports hourly forecasts:",
+        "data": {
+          "weather_entity": "Weather Entity"
+        }
+      },
+      "weather_no_hourly_forecast_confirm_remove": {
+        "title": "Remove weather entity",
+        "description": "This will remove the weather entity '{current_entity}' from the configuration and disable the forecast sensors (HDD Estimated Today/Tomorrow and CDD Estimated Today/Tomorrow if enabled)."
       }
     },
     "error": {
       "invalid_temperature_sensor": "Invalid temperature sensor. Please select a valid temperature sensor.",
-      "invalid_weather_entity": "Invalid weather entity. Please select a valid weather entity with forecast data."
+      "invalid_weather_entity": "Invalid weather entity. Please select a valid weather entity with forecast data.",
+      "no_entry_id": "No entry ID provided",
+      "entry_not_found": "Configuration entry not found"
     },
     "abort": {
       "reconfigure_successful": "Configuration updated successfully"
@@ -79,22 +103,7 @@
   "issues": {
     "weather_no_hourly_forecast": {
       "title": "Weather entity no longer supports hourly forecasts",
-      "description": "The weather entity '{entity_id}' configured for this integration no longer supports hourly forecasts, which are required for estimated degree days calculations. Please select a different weather entity that supports hourly forecasts."
-    }
-  },
-  "repairs": {
-    "weather_no_hourly_forecast": {
-      "init": {
-        "title": "Fix weather entity issue",
-        "description": "The weather entity '{current_entity}' no longer supports hourly forecasts. Choose how to fix this:",
-        "data": {
-          "action": "Action"
-        }
-      },
-      "confirm_remove": {
-        "title": "Remove weather entity",
-        "description": "This will remove the weather entity '{current_entity}' from the configuration and disable the forecast sensors (HDD Estimated Today/Tomorrow and CDD Estimated Today/Tomorrow if enabled)."
-      }
+      "description": "The weather entity {entity_id} configured for this integration no longer supports hourly forecasts, which are required for estimated degree days calculations. Please select a different weather entity that supports hourly forecasts."
     }
   }
 }
diff --git a/custom_components/heating_cooling_degree_days/translations/fr.json b/custom_components/heating_cooling_degree_days/translations/fr.json
@@ -32,11 +32,35 @@
           "base_temperature": "La température de base par défaut est de 18°C pour Celsius ou 65°F pour Fahrenheit, selon votre système d'unités",
           "weather_entity": "Si fournie, cette entité météo permet de fournir des données prévisionnelles à 24h et 48h"
         }
+      },
+      "weather_no_hourly_forecast": {
+        "title": "Corriger le problème de l'entité météo",
+        "description": "L'entité météo '{current_entity}' ne supporte plus les prévisions horaires. Choisissez comment corriger cela :",
+        "data": {
+          "action": "Action"
+        },
+        "menu_options": {
+          "weather_no_hourly_forecast_select_weather": "Sélectionner une nouvelle entité météo",
+          "weather_no_hourly_forecast_confirm_remove": "Supprimer l'entité météo (désactiver les capteurs de prévision)"
+        }
+      },
+      "weather_no_hourly_forecast_select_weather": {
+        "title": "Sélectionner une nouvelle entité météo",
+        "description": "Sélectionnez une entité météo qui supporte les prévisions horaires :",
+        "data": {
+          "weather_entity": "Entité météo"
+        }
+      },
+      "weather_no_hourly_forecast_confirm_remove": {
+        "title": "Supprimer l'entité météo",
+        "description": "Cela supprimera l'entité météo '{current_entity}' de la configuration et désactivera les capteurs de prévision (DJC Estimé Aujourd'hui/Demain et DJR Estimé Aujourd'hui/Demain si activés)."
       }
     },
     "error": {
       "invalid_temperature_sensor": "Capteur de température invalide. Veuillez sélectionner un capteur de température valide.",
-      "invalid_weather_entity": "Entité météo invalide. Veuillez sélectionner une entité météo valide avec des données de prévision."
+      "invalid_weather_entity": "Entité météo invalide. Veuillez sélectionner une entité météo valide avec des données de prévision.",
+      "no_entry_id": "Aucun ID d'entrée fourni",
+      "entry_not_found": "Entrée de configuration introuvable"
     },
     "abort": {
       "reconfigure_successful": "Configuration mise à jour avec succès"
@@ -79,22 +103,7 @@
   "issues": {
     "weather_no_hourly_forecast": {
       "title": "L'entité météo ne supporte plus les prévisions horaires",
-      "description": "L'entité météo '{entity_id}' configurée pour cette intégration ne supporte plus les prévisions horaires, qui sont nécessaires pour les calculs de degrés-jours estimés. Veuillez sélectionner une autre entité météo qui supporte les prévisions horaires."
-    }
-  },
-  "repairs": {
-    "weather_no_hourly_forecast": {
-      "init": {
-        "title": "Corriger le problème de l'entité météo",
-        "description": "L'entité météo '{current_entity}' ne supporte plus les prévisions horaires. Choisissez comment corriger cela :",
-        "data": {
-          "action": "Action"
-        }
-      },
-      "confirm_remove": {
-        "title": "Supprimer l'entité météo",
-        "description": "Cela supprimera l'entité météo '{current_entity}' de la configuration et désactivera les capteurs de prévision (DJC Estimé Aujourd'hui/Demain et DJR Estimé Aujourd'hui/Demain si activés)."
-      }
+      "description": "L'entité météo {entity_id} configurée pour cette intégration ne supporte plus les prévisions horaires, qui sont nécessaires pour les calculs de degrés-jours estimés. Veuillez sélectionner une autre entité météo qui supporte les prévisions horaires."
     }
   }
 }
