From 05e31358a4a8d221f8443c42d2bbcc2e4eeb015b Mon Sep 17 00:00:00 2001 From: Jean-Marc Collin Date: Sun, 12 Jan 2025 17:06:28 +0000 Subject: [PATCH] Documentation --- custom_components/versatile_thermostat/translations/fr.json | 2 +- documentation/en/over-climate.md | 3 ++- documentation/en/over-switch.md | 3 ++- documentation/en/over-valve.md | 3 ++- documentation/fr/over-climate.md | 3 ++- documentation/fr/over-switch.md | 3 ++- documentation/fr/over-valve.md | 5 +++-- documentation/fr/presentation.md | 4 ++-- documentation/fr/releases.md | 2 +- 9 files changed, 17 insertions(+), 11 deletions(-) diff --git a/custom_components/versatile_thermostat/translations/fr.json b/custom_components/versatile_thermostat/translations/fr.json index bbeb9c6..f09541a 100644 --- a/custom_components/versatile_thermostat/translations/fr.json +++ b/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": { diff --git a/documentation/en/over-climate.md b/documentation/en/over-climate.md index af56064..0f0c112 100644 --- a/documentation/en/over-climate.md +++ b/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) diff --git a/documentation/en/over-switch.md b/documentation/en/over-switch.md index b86effc..c602beb 100644 --- a/documentation/en/over-switch.md +++ b/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) diff --git a/documentation/en/over-valve.md b/documentation/en/over-valve.md index 8c1bc16..be50ae0 100644 --- a/documentation/en/over-valve.md +++ b/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) diff --git a/documentation/fr/over-climate.md b/documentation/fr/over-climate.md index fa4e347..6cdcf4b 100644 --- a/documentation/fr/over-climate.md +++ b/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) diff --git a/documentation/fr/over-switch.md b/documentation/fr/over-switch.md index 92a92e4..009b019 100644 --- a/documentation/fr/over-switch.md +++ b/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) diff --git a/documentation/fr/over-valve.md b/documentation/fr/over-valve.md index ddcdaab..9ed55f1 100644 --- a/documentation/fr/over-valve.md +++ b/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. diff --git a/documentation/fr/presentation.md b/documentation/fr/presentation.md index 10aff23..f07811c 100644 --- a/documentation/fr/presentation.md +++ b/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. diff --git a/documentation/fr/releases.md b/documentation/fr/releases.md index 7ec5d19..b384aff 100644 --- a/documentation/fr/releases.md +++ b/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 .