Documentation

* issue #779 - error in ValveOpenPercent sensor at startup

* fix log

---------

Co-authored-by: Jean-Marc Collin <jean-marc.collin-extern@renault.com>

custom_components/versatile_thermostat/config_schema.py

@@ -232,7 +232,7 @@ STEP_TPI_DATA_SCHEMA = vol.Schema(  # pylint: disable=invalid-name
 STEP_CENTRAL_TPI_DATA_SCHEMA = vol.Schema(  # pylint: disable=invalid-name
     {
         vol.Required(CONF_TPI_COEF_INT, default=0.6): selector.NumberSelector(selector.NumberSelectorConfig(min=0.0, max=1.0, step=0.01, mode=selector.NumberSelectorMode.BOX)),
-        vol.Required(CONF_TPI_COEF_EXT, default=0.01): selector.NumberSelector(selector.NumberSelectorConfig(min=0.0, max=1.0, mode=selector.NumberSelectorMode.BOX)),
+        vol.Required(CONF_TPI_COEF_EXT, default=0.01): selector.NumberSelector(selector.NumberSelectorConfig(min=0.0, max=1.0, step=0.001, mode=selector.NumberSelectorMode.BOX)),
     }
 )
 

custom_components/versatile_thermostat/manifest.json

@@ -14,6 +14,6 @@
   "quality_scale": "silver",
   "requirements": [],
   "ssdp": [],
-  "version": "7.1.2",
+  "version": "7.1.3",
   "zeroconf": []
 }

custom_components/versatile_thermostat/sensor.py

@@ -303,6 +303,10 @@ class ValveOpenPercentSensor(VersatileThermostatBaseEntity, SensorEntity):
         """Called when my climate have change"""
         # _LOGGER.debug("%s - climate state change", self._attr_unique_id)
 
+        if not self.my_climate or not hasattr(self.my_climate, "valve_open_percent"):
+            _LOGGER.warning("%s - my_climate not found or no valve_open_percent property found. This could be normal at startup. Ignore the underlying device change.", self)
+            return
+
         old_state = self._attr_native_value
         self._attr_native_value = self.my_climate.valve_open_percent
         if old_state != self._attr_native_value:

custom_components/versatile_thermostat/thermostat_climate.py

@@ -833,7 +833,8 @@ class ThermostatOverClimate(BaseThermostat[UnderlyingClimate]):
             and under.last_sent_temperature is not None
         ):
             _LOGGER.debug(
-                "Do temperature check. under.last_sent_temperature is %s, new_target_temp is %s",
+                "%s - Do temperature check. under.last_sent_temperature is %s, new_target_temp is %s",
+                self,
                 under.last_sent_temperature,
                 new_target_temp,
             )

custom_components/versatile_thermostat/thermostat_climate_valve.py

@@ -255,6 +255,13 @@ class ThermostatOverClimateValve(ThermostatOverClimate):
                     self._attr_min_temp,
                 )
 
+        self._last_regulation_change = self.now
+        self.reset_last_change_time_from_vtherm()
+
+        _LOGGER.debug(
+            "%s - last_regulation_change is now: %s and last_change_from_vtherm is now: %s", self, self._last_regulation_change, self._last_change_time_from_vtherm
+        )  # pylint: disable=protected-access
+
         for under in self._underlyings_valve_regulation:
             await under.set_valve_open_percent()
 
@@ -263,11 +270,6 @@ class ThermostatOverClimateValve(ThermostatOverClimate):
         """True if the Thermostat is regulated by valve"""
         return True
 
-    # @property
-    # def hvac_modes(self) -> list[HVACMode]:
-    #    """Get the hvac_modes"""
-    #    return self._hvac_list
-
     @property
     def valve_open_percent(self) -> int:
         """Gives the percentage of valve needed"""

custom_components/versatile_thermostat/translations/fr.json

@@ -499,7 +499,7 @@
         "thermostat_central_config": "Configuration centrale",
         "thermostat_over_switch": "Thermostat sur un switch",
         "thermostat_over_climate": "Thermostat sur un autre thermostat",
-        "thermostat_over_valve": "Thermostat sur une valve"
+        "thermostat_over_valve": "Thermostat sur une vanne"
       }
     },
     "auto_regulation_mode": {

custom_components/versatile_thermostat/underlyings.py

@@ -635,6 +635,9 @@ class UnderlyingClimate(UnderlyingEntity):
         data = {
             ATTR_ENTITY_ID: self._entity_id,
         }
+
+        _LOGGER.info("%s - Set setpoint temperature to: %s", self, target_temp)
+
         # Issue 807 add TARGET_TEMPERATURE only if in the features
         if ClimateEntityFeature.TARGET_TEMPERATURE_RANGE in self._underlying_climate.supported_features:
             data.update(
@@ -654,6 +657,7 @@ class UnderlyingClimate(UnderlyingEntity):
         )
 
         self._last_sent_temperature = target_temp
+        _LOGGER.debug("%s - Last_sent_temperature is now: %s", self, self._last_sent_temperature)
 
     @property
     def last_sent_temperature(self) -> float | None:

documentation/en/over-climate.md

@@ -25,7 +25,8 @@ The installation should look like this:
 
 ## Configuration
 
-Click on the "Underlying Entities" option from the menu, and you will see this configuration page:
+First, configure the main settings common to all _VTherms_ (see [main settings](base-attributes.md)).
+Then, click on the "Underlying Entities" option from the menu, and you will see this configuration page:
 
 ![image](images/config-linked-entity2.png)
 

documentation/en/over-switch.md

@@ -26,7 +26,8 @@ The installation should look like this:
 
 ## Configuration
 
-Click on the "Underlying Entities" option from the menu, and you will see this configuration page:
+First, configure the main settings common to all _VTherms_ (see [main settings](base-attributes.md)).
+Then, click on the "Underlying Entities" option from the menu, and you will see this configuration page:
 
 ![image](images/config-linked-entity.png)
 

documentation/en/over-valve.md

@@ -21,7 +21,8 @@ The installation should be similar to the `over_switch` VTherm setup, except tha
 
 ## Configuration
 
-Click on the "Underlying Entities" option from the menu, and you will see this configuration page, you should add the `number` entities that will be controlled by VTherm. Only `number` or `input_number` entities are accepted.
+First, configure the main settings common to all _VTherms_ (see [main settings](base-attributes.md)).
+Then, click on the "Underlying Entities" option from the menu, and you will see this configuration page, you should add the `number` entities that will be controlled by VTherm. Only `number` or `input_number` entities are accepted.
 
 ![image](images/config-linked-entity3.png)
 

documentation/fr/over-climate.md

@@ -26,7 +26,8 @@ L'installation doit ressembler à ça :
 
 ## Configuration
 
-Cliquer sur l'option de menu "Sous-jacents" et vous allez avoir cette page de configuration :
+Configurez d'abord les paramètres principaux et communs à tous les _VTherm_ (cf. [paramètres principaux](base-attributes.md)).
+Cliquez ensuite sur l'option de menu "Sous-jacents" et vous allez avoir cette page de configuration :
 
 ![image](images/config-linked-entity2.png)
 

documentation/fr/over-switch.md

@@ -25,7 +25,8 @@ L'installation doit ressembler à ça :
 
 ## Configuration
 
-Cliquer sur l'option de menu "Sous-jacents" et vous allez avoir cette page de configuration :
+Configurez d'abord les paramètres principaux et communs à tous les _VTherm_ (cf. [paramètres principaux](base-attributes.md)).
+Ensuite cliquez sur l'option de menu "Sous-jacents" et vous allez avoir cette page de configuration :
 
 ![image](images/config-linked-entity.png)
 

documentation/fr/over-valve.md

@@ -22,11 +22,12 @@ L'installation doit ressembler à celle pour le VTherm `over_switch` sauf que l'
 
 ## Configuration
 
-Cliquer sur l'option de menu "Sous-jacents" et vous allez avoir cette page de configuration. Vous mettez les entités `numnber` ou `input_number`qui vont être controllés par le VTherm :
+Configurez d'abord les paramètres principaux et communs à tous les _VTherm_ (cf. [paramètres principaux](base-attributes.md)).
+Ensuite cliquez sur l'option de menu "Sous-jacents" et vous allez avoir cette page de configuration. Vous mettez les entités `numnber` ou `input_number`qui vont être controllés par le VTherm :
 
 ![image](images/config-linked-entity3.png)
 
 L'algorithme à utiliser est aujourd'hui limité à TPI est disponible. Voir [algorithme](#algorithme).
 
-Il est possible de choisir un thermostat over valve qui commande une climatisation en cochant la case "AC Mode". Dans ce cas, seul le mode refroidissement sera visible.
+Il est possible de choisir un thermostat `over-valve` qui commande une climatisation en cochant la case "AC Mode". Dans ce cas, seul le mode refroidissement sera visible.
 

documentation/fr/presentation.md

@@ -5,8 +5,8 @@ Ce thermostat peut piloter 3 types d'équipements :
    2. une sonde de température pour la pièce (ou un input_number),
    3. un capteur de température externe (pensez à l'intégration météo si vous n'en avez pas)
 2. un autre thermostat qui a ses propres modes de fonctionnement (nommé ```thermostat_over_climate```). Pour ce type de thermostat la configuration minimale nécessite :
-   1. un équipement - comme une climatisation, une valve thermostatique - qui est pilotée par sa propre entity de type ```climate```,
-3. un équipement qui peut prendre une valeur de 0 à 100% (nommée ```thermostat_over_valve```). A 0 le chauffage est coupé, 100% il est ouvert à fond. Ce type permet de piloter une valve thermostatique (cf. valve Shelly) qui expose une entité de type `number.` permetttant de piloter directement l'ouverture de la vanne. Versatile Thermostat régule la température de la pièce en jouant sur le pourcentage d'ouverture, à l'aide des capteurs de température intérieur et extérieur en utilisant l'algorithme TPI décrit ci-dessous.
+   1. un équipement - comme une climatisation, une vanne thermostatique - qui est pilotée par sa propre entity de type ```climate```,
+3. un équipement qui peut prendre une valeur de 0 à 100% (nommée ```thermostat_over_valve```). A 0 le chauffage est coupé, 100% il est ouvert à fond. Ce type permet de piloter une vanne thermostatique (cf. TRV Shelly) qui expose une entité de type `number.` permetttant de piloter directement l'ouverture de la vanne. Versatile Thermostat régule la température de la pièce en jouant sur le pourcentage d'ouverture, à l'aide des capteurs de température intérieur et extérieur en utilisant l'algorithme TPI décrit ci-dessous.
 
 Le type `over_climate` vous permet d'ajouter à votre équipement existant toutes les fonctionnalités apportées par VersatileThermostat. L'entité `climate` VersatileThermostat contrôlera votre entité climate sous-jacente, l'éteindra si les fenêtres sont ouvertes, la fera passer en mode Eco si personne n'est présent, etc. Voir [ici] (#pourquoi-un-nouveau-thermostat-implémentation). Pour ce type de thermostat, tous les cycles de chauffage sont contrôlés par l'entité climate sous-jacente et non par le thermostat polyvalent lui-même. Une fonction facultative d'auto-régulation permet au Versatile Thermostat d'ajuster la température donnée en consigne au sous-jacent afin d'atteindre la consigne.
 

documentation/fr/releases.md

@@ -27,7 +27,7 @@
 
 > * **Release 5.3** : Ajout d'une fonction de pilotage d'une chaudière centrale [#234](https://github.com/jmcollin78/versatile_thermostat/issues/234) - plus d'infos ici: [Le contrôle d'une chaudière centrale](#le-contrôle-dune-chaudière-centrale). Ajout de la possibilité de désactiver le mode sécurité pour le thermomètre extérieur [#343](https://github.com/jmcollin78/versatile_thermostat/issues/343)
 > * **Release 5.2** : Ajout d'un `central_mode` permettant de piloter tous les VTherms de façon centralisée [#158](https://github.com/jmcollin78/versatile_thermostat/issues/158).
-> * **Release 5.1** : Limitation des valeurs envoyées aux valves et au température envoyées au climate sous-jacent.
+> * **Release 5.1** : Limitation des valeurs envoyées aux vannes et au température envoyées au climate sous-jacent.
 > * **Release 5.0** : Ajout d'une configuration centrale permettant de mettre en commun les attributs qui peuvent l'être [#239](https://github.com/jmcollin78/versatile_thermostat/issues/239).
 > * **Release 4.3** : Ajout d'un mode auto-fan pour le type `over_climate` permettant d'activer la ventilation si l'écart de température est important [#223](https://github.com/jmcollin78/versatile_thermostat/issues/223).
 > * **Release 4.2** : Le calcul de la pente de la courbe de température se fait maintenant en °/heure et non plus en °/min [#242](https://github.com/jmcollin78/versatile_thermostat/issues/242). Correction de la détection automatique des ouvertures par l'ajout d'un lissage de la courbe de température .