Merge pull request #3101 from bramstroker/feat/config-flow-sub-profile-remarks

Add sub profile remarks to config flow

Author: bramstroker

custom_components/powercalc/config_flow.py

@@ -1154,11 +1154,9 @@ async def _validate(user_input: dict[str, Any]) -> dict[str, str]:
             return {CONF_MODEL: f"{self.sensor_config.get(CONF_MODEL)}/{user_input.get(CONF_SUB_PROFILE)}"}
 
         async def _create_schema(
-            model_info: ModelInfo,
+            profile: PowerProfile,
         ) -> vol.Schema:
             """Create sub profile schema."""
-            library = await ProfileLibrary.factory(self.hass)
-            profile = await library.get_profile(model_info, process_variables=False)
             sub_profiles = [
                 selector.SelectOptionDict(
                     value=sub_profile[0],
@@ -1177,18 +1175,30 @@ async def _create_schema(
                 },
             )
 
+        library = await ProfileLibrary.factory(self.hass)
+        profile = await library.get_profile(
+            ModelInfo(
+                str(self.sensor_config.get(CONF_MANUFACTURER)),
+                str(self.sensor_config.get(CONF_MODEL)),
+            ),
+            process_variables=False,
+        )
+        remarks = profile.config_flow_sub_profile_remarks
+        if remarks:
+            remarks = "\n\n" + remarks
+
         return await self.handle_form_step(
             PowercalcFormStep(
                 step=Step.SUB_PROFILE,
-                schema=await _create_schema(
-                    ModelInfo(
-                        str(self.sensor_config.get(CONF_MANUFACTURER)),
-                        str(self.sensor_config.get(CONF_MODEL)),
-                    ),
-                ),
+                schema=await _create_schema(profile),
                 next_step=Step.POWER_ADVANCED,
                 validate_user_input=_validate,
-                form_kwarg={"description_placeholders": {"entity_id": self.source_entity_id}},
+                form_kwarg={
+                    "description_placeholders": {
+                        "entity_id": self.source_entity_id,
+                        "remarks": remarks,
+                    },
+                },
             ),
             user_input,
         )

custom_components/powercalc/power_profile/power_profile.py

@@ -302,6 +302,11 @@ def config_flow_discovery_remarks(self) -> str | None:
 
         return remarks
 
+    @property
+    def config_flow_sub_profile_remarks(self) -> str | None:
+        """Get extra remarks to show at the config flow sub profile step."""
+        return self._json_data.get("config_flow_sub_profile_remarks")
+
     def get_default_discovery_remarks_translation_key(self) -> str | None:
         """When no remarks are provided in the profile, see if we need to show a default remark."""
         if self.device_type == DeviceType.SMART_SWITCH and self.needs_fixed_config:

custom_components/powercalc/translations/cz.json

@@ -325,7 +325,7 @@
         "data": {
           "sub_profile": "Sub profile"
         },
-        "description": "This model has multiple sub profiles. Select one that suites your device\n\n\"{entity_id}\"",
+        "description": "This model has multiple sub profiles. Select one that suites your device\n\n\"{entity_id}\"{remarks}",
         "title": "Sub profile config"
       },
       "smart_switch": {

custom_components/powercalc/translations/de.json

@@ -325,7 +325,7 @@
         "data": {
           "sub_profile": "Unterprofil"
         },
-        "description": "Dieses Gerät besitzt ein Modell mit mehreren Unterprofilen. Wählen Sie das Unterprofil aus, welches zu der folgenden Entität gehört:\n\n\"{entity_id}\"",
+        "description": "Dieses Gerät besitzt ein Modell mit mehreren Unterprofilen. Wählen Sie das Unterprofil aus, welches zu der folgenden Entität gehört:\n\n\"{entity_id}\"{remarks}",
         "title": "Unterprofil Konfiguration"
       },
       "smart_switch": {

custom_components/powercalc/translations/en.json

@@ -325,7 +325,7 @@
         "data": {
           "sub_profile": "Sub profile"
         },
-        "description": "This device has a model with multiple sub profiles. Select one that corresponds to the following entity of this device:\n\n\"{entity_id}\"",
+        "description": "This device has a model with multiple sub profiles. Select one that corresponds to the following entity of this device:\n\n\"{entity_id}\"{remarks}",
         "title": "Sub profile config"
       },
       "smart_switch": {

custom_components/powercalc/translations/es.json

@@ -325,7 +325,7 @@
         "data": {
           "sub_profile": "Subperfil"
         },
-        "description": "Este modelo tiene múltiples subperfiles. Seleccione uno que se adapte a su dispositivo\n\n\"{entity_id}\"",
+        "description": "Este modelo tiene múltiples subperfiles. Seleccione uno que se adapte a su dispositivo\n\n\"{entity_id}\"{remarks}",
         "title": "Configuración del subperfil"
       },
       "smart_switch": {

custom_components/powercalc/translations/fr.json

@@ -325,7 +325,7 @@
         "data": {
           "sub_profile": "Sous-profil"
         },
-        "description": "Ce modèle a plusieurs sous-profils. Sélectionnez celui qui convient à votre appareil",
+        "description": "Ce modèle a plusieurs sous-profils. Sélectionnez celui qui convient à votre appareil{remarks}",
         "title": "Configuration du sous-profil"
       },
       "smart_switch": {

custom_components/powercalc/translations/it.json

@@ -325,7 +325,7 @@
         "data": {
           "sub_profile": "Sub profile"
         },
-        "description": "This model has multiple sub profiles. Select one that suites your device\n\n\"{entity_id}\"",
+        "description": "This model has multiple sub profiles. Select one that suites your device\n\n\"{entity_id}\"{remarks}",
         "title": "Sub profile config"
       },
       "smart_switch": {

custom_components/powercalc/translations/nl.json

@@ -325,7 +325,7 @@
         "data": {
           "sub_profile": "Sub profiel"
         },
-        "description": "Dit model heeft meerdere profielen. Selecteer de juiste voor je apparaat\n\n\"{entity_id}\"",
+        "description": "Dit model heeft meerdere profielen. Selecteer de juiste voor je apparaat\n\n\"{entity_id}\"{remarks}",
         "title": "Sub profiel configuratie"
       },
       "smart_switch": {

custom_components/powercalc/translations/pl.json

@@ -325,7 +325,7 @@
         "data": {
           "sub_profile": "Podprofile"
         },
-        "description": "Ten model ma wiele podprofili. Wybierz taki, który pasuje do Twojego urządzenia\n\n\"{entity_id}\"",
+        "description": "Ten model ma wiele podprofili. Wybierz taki, który pasuje do Twojego urządzenia\n\n\"{entity_id}\"{remarks}",
         "title": "Konfiguracja podprofili"
       },
       "smart_switch": {