From f384225b0f5e947034020fc013423ad7ef1e414a Mon Sep 17 00:00:00 2001 From: Jean-Marc Collin Date: Sun, 15 Oct 2023 18:16:24 +0200 Subject: [PATCH] Maj documentation + issue #115 --- README-fr.md | 72 +++++++++++++++++- README.md | 76 ++++++++++++++++++- .../versatile_thermostat/strings.json | 10 +-- .../versatile_thermostat/translations/en.json | 10 +-- .../versatile_thermostat/translations/fr.json | 5 +- 5 files changed, 157 insertions(+), 16 deletions(-) diff --git a/README-fr.md b/README-fr.md index 03f439e..45650a6 100644 --- a/README-fr.md +++ b/README-fr.md @@ -26,6 +26,7 @@ - [Configurer la gestion de la puissance](#configurer-la-gestion-de-la-puissance) - [Configurer la présence ou l'occupation](#configurer-la-présence-ou-loccupation) - [Configuration avancée](#configuration-avancée) + - [Synthèse des paramètres](#synthèse-des-paramètres) - [Exemples de réglage](#exemples-de-réglage) - [Chauffage électrique](#chauffage-électrique) - [Chauffage central (chauffage gaz ou fuel)](#chauffage-central-chauffage-gaz-ou-fuel) @@ -65,7 +66,7 @@ Ce composant personnalisé pour Home Assistant est une mise à niveau et est une > * **release majeure 2.0** : ajout du thermostat "over climate" permettant de transformer n'importe quel thermostat en Versatile Thermostat et lui ajouter toutes les fonctions de ce dernier. # Merci pour la bière [buymecoffee](https://www.buymeacoffee.com/jmcollin78) -Un grand merci à @salabur, @pvince83 and @bergoglio pour les bières. Ca fait très plaisir. +Un grand merci à @salabur, @pvince83, @bergoglio, @EPicLURcher, @Kriss1670, @maia pour les bières. Ca fait très plaisir. # Quand l'utiliser et ne pas l'utiliser @@ -315,6 +316,64 @@ Voir [exemple de réglages](#examples-tuning) pour avoir des exemples de réglag 5. Pour un usage naturel, le ``security_default_on_percent`` doit être inférieur à ``security_min_on_percent``, 6. Lorsqu'un thermostat de type ``thermostat_over_climate`` passe en mode ``security`` il est éteint. Les paramètres ``security_min_on_percent`` et ``security_default_on_percent`` ne sont alors pas utilisés. +## Synthèse des paramètres + +| Paramètre | Libellé | "over switch" | "over climate" | +| ----------| --------| --- | ---| +| ``name`` | Nom | X | X | +| ``thermostat_type`` | Type de thermostat | X | X | +| ``temperature_sensor_entity_id`` | Temperature sensor entity id | X | - | +| ``external_temperature_sensor_entity_id`` | Température exterieure sensor entity id | X | - | +| ``cycle_min`` | Durée du cycle (minutes) | X | X | +| ``temp_min`` | Température minimale permise | X | X | +| ``temp_max`` | Température maximale permise | X | X | +| ``device_power`` | Puissance de l'équipement | X | X | +| ``use_window_feature`` | Avec détection des ouvertures | X | X | +| ``use_motion_feature`` | Avec détection de mouvement | X | X | +| ``use_power_feature`` | Avec gestion de la puissance | X | X | +| ``use_presence_feature`` | Avec détection de présence | X | X | +| ``heater_entity1_id`` | 1er radiateur | X | - | +| ``heater_entity2_id`` | 2ème radiateur | X | - | +| ``heater_entity3_id`` | 3ème radiateur | X | - | +| ``heater_entity4_id`` | 4ème radiateur | X | - | +| ``proportional_function`` | Algorithme | X | - | +| ``climate_entity1_id`` | Thermostat sous-jacent | - | X | +| ``climate_entity2_id`` | 2ème thermostat sous-jacent | - | X | +| ``climate_entity3_id`` | 3ème thermostat sous-jacent | - | X | +| ``climate_entity4_id`` | 4ème thermostat sous-jacent | - | X | +| ``ac_mode`` | utilisation de l'air conditionné (AC) ? | - | X | +| ``tpi_coef_int`` | Coefficient à utiliser pour le delta de température interne | X | - | +| ``tpi_coef_ext`` | Coefficient à utiliser pour le delta de température externe | X | - | +| ``eco_temp`` | Température en preset Eco | X | X | +| ``comfort_temp`` | Température en preset Confort | X | X | +| ``boost_temp`` | Température en preset Boost | X | X | +| ``eco_ac_temp`` | Température en preset Eco en mode AC | X | X | +| ``comfort_ac_temp`` | Température en preset Confort en mode AC | X | X | +| ``boost_ac_temp`` | Température en preset Boost en mode AC | X | X | +| ``window_sensor_entity_id`` | Détecteur d'ouverture (entity id) | X | X | +| ``window_delay`` | Délai avant extinction (secondes) | X | X | +| ``window_auto_open_threshold`` | Seuil haut de chute de température pour la détection automatique (en °/min) | X | X | +| ``window_auto_close_threshold`` | Seuil bas de chute de température pour la fin de détection automatique (en °/min) | X | X | +| ``window_auto_max_duration`` | Durée maximum d'une extinction automatique (en min) | X | X | +| ``motion_sensor_entity_id`` | Détecteur de mouvement entity id | X | X | +| ``motion_delay`` | Délai avant changement (seconds) | X | X | +| ``motion_preset`` | Preset à utiliser si mouvement détecté | X | X | +| ``no_motion_preset`` | Preset à utiliser si pas de mouvement détecté | X | X | +| ``power_sensor_entity_id`` | Capteur de puissance totale (entity id) | X | X | +| ``max_power_sensor_entity_id`` | Capteur de puissance Max (entity id) | X | X | +| ``power_temp`` | Température si délestaqe | X | X | +| ``presence_sensor_entity_id`` | Capteur de présence entity id (true si quelqu'un est présent) | X | X | +| ``eco_away_temp`` | Température en preset Eco en cas d'absence | X | X | +| ``comfort_away_temp`` | Température en preset Comfort en cas d'absence | X | X | +| ``boost_away_temp`` | Température en preset Boost en cas d'absence | X | X | +| ``eco_ac_away_temp`` | Température en preset Eco en cas d'absence en mode AC | X | X | +| ``comfort_ac_away_temp`` | Température en preset Comfort en cas d'absence en mode AC | X | X | +| ``boost_ac_away_temp`` | Température en preset Boost en cas d'absence en mode AC | X | X | +| ``minimal_activation_delay`` | Délai minimal d'activation | X | - | +| ``security_delay_min`` | Délai maximal entre 2 mesures de températures | X | - | +| ``security_min_on_percent`` | Pourcentage minimal de puissance pour passer en mode sécurité | X | - | +| ``security_default_on_percent`` | Pourcentage de puissance a utiliser en mode securité | X | - | + # Exemples de réglage ## Chauffage électrique @@ -451,6 +510,17 @@ target: entity_id : climate.my_thermostat ``` +Ou pour changer le pré-réglage du mode Air Conditionné (AC) ajoutez un préfixe `_ac`` au nom du preset comme ceci : +``` +service: versatile_thermostat.set_preset_temperature +data: + preset: boost_ac + temperature: 25 + temperature_away: 30 +target: + entity_id: climate.my_thermostat +``` + > ![Astuce](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/tips.png?raw=true) _*Notes*_ - après un redémarrage, les préréglages sont réinitialisés à la température configurée. Si vous souhaitez que votre changement soit permanent, vous devez modifier le préréglage de la température dans la configuration de l'intégration. diff --git a/README.md b/README.md index 66bf400..b9b77ae 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,7 @@ - [Configure the power management](#configure-the-power-management) - [Configure the presence or occupancy](#configure-the-presence-or-occupancy) - [Advanced configuration](#advanced-configuration) + - [Parameters synthesis](#parameters-synthesis) - [Examples tuning](#examples-tuning) - [Electrical heater](#electrical-heater) - [Central heating (gaz or fuel heating system)](#central-heating-gaz-or-fuel-heating-system) @@ -64,16 +65,16 @@ This custom component for Home Assistant is an upgrade and is a complete rewrite > * **major release 2.0**: addition of the "over climate" thermostat allowing you to transform any thermostat into a Versatile Thermostat and add all the functions of the latter. # Thanks for the beer [buymecoffee](https://www.buymeacoffee.com/jmcollin78) -Many thanks to @salabur, @pvince83 and @bergoglio for the beers. It's very pleasing. +Many thanks to @@salabur, @pvince83, @bergoglio, @EPicLURcher, @Kriss1670, @maia for the beers. It's very pleasing. # When to use / not use This thermostat can control 2 types of equipment: -1. a heater that only works in on/off mode (named ```thermostat_over_switch```). The minimum configuration required to use this type of thermostat is: +1. a heater that only works in on/off mode (named ```thermostat_over_switch```). Versatile Thermostat will regulate the length of a heating cycle and the pauses in-between by controlling a binary on/off switch. This mode is e.g. suitable for an electrical radiator controlled by a switch. The minimum configuration required to use this type of thermostat is: - an equipment such as a radiator (a ```switch``` or equivalent), - a temperature probe for the room (or an input_number), - an external temperature sensor (think about weather integration if you don't have one) -2. another thermostat that has its own operating modes (named ```thermostat_over_climate```). For this type of thermostat, the minimum configuration requires: +2. another thermostat that has its own operating modes (named ```thermostat_over_climate```). Versatile Thermostat will regulate the target temperature of a climate entity. Common examples for this mode are the control of thermostatic radiator valves (TRV), air-conditions (AC), floor heating systems and pellet heating. For this type of thermostat, the minimum configuration requires: - an equipment such as air conditioning which is controlled by its own ```climate``` type entity, - a temperature probe for the room (or an input_number), - an external temperature sensor (think about weather integration if you don't have one) @@ -300,6 +301,64 @@ See [example tuning](#examples-tuning) for common tuning examples 5. For natural usage, the ``security_default_on_percent`` should be less than ``security_min_on_percent``, 6. When a ``thermostat_over_climate`` type thermostat goes into ``security`` mode it is turned off. The ``security_min_on_percent`` and ``security_default_on_percent`` parameters are then not used. +## Parameters synthesis + +| Paramètre | Libellé | "over switch" | "over climate" | +| ----------| --------| --- | --- | +| ``name`` | Name | X | X | +| ``thermostat_type`` | Thermostat type | X | X | +| ``temperature_sensor_entity_id`` | Temperature sensor entity id | X | - | +| ``external_temperature_sensor_entity_id`` | External temperature sensor entity id | X | - | +| ``cycle_min`` | Cycle duration (minutes) | X | X | +| ``temp_min`` | Minimal temperature allowed | X | X | +| ``temp_max`` | Maximal temperature allowed | X | X | +| ``device_power`` | Device power | X | X | +| ``use_window_feature`` | Use window detection | X | X | +| ``use_motion_feature`` | Use motion detection | X | X | +| ``use_power_feature`` | Use power management | X | X | +| ``use_presence_feature`` | Use presence detection | X | X | +| ``heater_entity1_id`` | 1rst heater switch | X | - | +| ``heater_entity2_id`` | 2nd heater switch | X | - | +| ``heater_entity3_id`` | 3rd heater switch | X | - | +| ``heater_entity4_id`` | 4th heater switch | X | - | +| ``proportional_function`` | Algorithm | X | - | +| ``climate_entity1_id`` | 1rst underlying climate | - | X | +| ``climate_entity2_id`` | 2nd underlying climate | - | X | +| ``climate_entity3_id`` | 3rd underlying climate | - | X | +| ``climate_entity4_id`` | 4th underlying climate | - | X | +| ``ac_mode`` | Use the Air Conditioning (AC) mode | - | X | +| ``tpi_coef_int`` | Coefficient to use for internal temperature delta | X | - | +| ``tpi_coef_ext`` | Coefficient to use for external temperature delta | X | - | +| ``eco_temp`` | Temperature in Eco preset | X | X | +| ``comfort_temp`` | Temperature in Comfort preset | X | X | +| ``boost_temp`` | Temperature in Boost preset | X | X | +| ``eco_ac_temp`` | Temperature in Eco preset for AC mode | X | X | +| ``comfort_ac_temp`` | Temperature in Comfort preset for AC mode | X | X | +| ``boost_ac_temp`` | Temperature in Boost preset for AC mode | X | X | +| ``window_sensor_entity_id`` | Window sensor entity id | X | X | +| ``window_delay`` | Window sensor delay (seconds) | X | X | +| ``window_auto_open_threshold`` | Temperature decrease threshold for automatic window open detection (in °/min) | X | X | +| ``window_auto_close_threshold`` | Temperature increase threshold for end of automatic detection (in °/min) | X | X | +| ``window_auto_max_duration`` | Maximum duration of automatic window open detection (in min) | X | X | +| ``motion_sensor_entity_id`` | Motion sensor entity id | X | X | +| ``motion_delay`` | Motion delay (seconds) | X | X | +| ``motion_preset`` | Preset to use when motion is detected | X | X | +| ``no_motion_preset`` | Preset to use when no motion is detected | X | X | +| ``power_sensor_entity_id`` | Power sensor entity id | X | X | +| ``max_power_sensor_entity_id`` | Max power sensor entity id | X | X | +| ``power_temp`` | Temperature for Power shedding | X | X | +| ``presence_sensor_entity_id`` | Presence sensor entity id | X | X | +| ``eco_away_temp`` | Temperature in Eco preset when no presence | X | X | +| ``comfort_away_temp`` | Temperature in Comfort preset when no presence | X | X | +| ``boost_away_temp`` | Temperature in Boost preset when no presence | X | X | +| ``eco_ac_away_temp`` | Temperature in Eco preset when no presence in AC mode | X | X | +| ``comfort_ac_away_temp`` | Temperature in Comfort preset when no presence in AC mode | X | X | +| ``boost_ac_away_temp`` | Temperature in Boost preset when no presence in AC mode | X | X | +| ``minimal_activation_delay`` | Minimal activation delay | X | - | +| ``security_delay_min`` | Security delay (in minutes) | X | X | +| ``security_min_on_percent`` | Minimal power percent to enable security mode | X | X | +| ``security_default_on_percent`` | Power percent to use in security mode | X | X | + # Examples tuning ## Electrical heater @@ -436,6 +495,17 @@ target: entity_id: climate.my_thermostat ``` +Or to change the preset of the AC mode, add _ac to the preset name like this: +``` +service: versatile_thermostat.set_preset_temperature +data: + preset: boost_ac + temperature: 25 + temperature_away: 30 +target: + entity_id: climate.my_thermostat +``` + > ![Tip](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/tips.png?raw=true) _*Notes*_ - after a restart the preset are resetted to the configured temperature. If you want your change to be permanent you should modify the temperature preset into the confguration of the integration. diff --git a/custom_components/versatile_thermostat/strings.json b/custom_components/versatile_thermostat/strings.json index a59d018..c9c2f1e 100644 --- a/custom_components/versatile_thermostat/strings.json +++ b/custom_components/versatile_thermostat/strings.json @@ -14,7 +14,7 @@ "cycle_min": "Cycle duration (minutes)", "temp_min": "Minimal temperature allowed", "temp_max": "Maximal temperature allowed", - "device_power": "Device power (kW)", + "device_power": "Device power", "use_window_feature": "Use window detection", "use_motion_feature": "Use motion detection", "use_power_feature": "Use power management", @@ -25,12 +25,12 @@ "title": "Linked entities", "description": "Linked entities attributes", "data": { - "heater_entity_id": "Heater switch", + "heater_entity_id": "1rst heater switch", "heater_entity2_id": "2nd heater switch", "heater_entity3_id": "3rd heater switch", "heater_entity4_id": "4th heater switch", "proportional_function": "Algorithm", - "climate_entity_id": "Underlying climate", + "climate_entity_id": "1rst underlying climate", "climate_entity2_id": "2nd underlying climate", "climate_entity3_id": "3rd underlying climate", "climate_entity4_id": "4th underlying climate", @@ -110,7 +110,7 @@ "title": "Presence management", "description": "Presence management attributes.\nGives the a presence sensor of your home (true is someone is present).\nThen specify either the preset to use when presence sensor is false or the offset in temperature to apply.\nIf preset is given, the offset will not be used.\nLeave corresponding entity_id empty if not used.", "data": { - "presence_sensor_entity_id": "Presence sensor entity id (true is present)", + "presence_sensor_entity_id": "Presence sensor entity id", "eco_away_temp": "Temperature in Eco preset when no presence", "comfort_away_temp": "Temperature in Comfort preset when no presence", "boost_away_temp": "Temperature in Boost preset when no presence", @@ -125,7 +125,7 @@ "data": { "minimal_activation_delay": "Minimal activation delay", "security_delay_min": "Security delay (in minutes)", - "security_min_on_percent": "Minimal power percent for security mode", + "security_min_on_percent": "Minimal power percent to enable security mode", "security_default_on_percent": "Power percent to use in security mode" }, "data_description": { diff --git a/custom_components/versatile_thermostat/translations/en.json b/custom_components/versatile_thermostat/translations/en.json index a59d018..c9c2f1e 100644 --- a/custom_components/versatile_thermostat/translations/en.json +++ b/custom_components/versatile_thermostat/translations/en.json @@ -14,7 +14,7 @@ "cycle_min": "Cycle duration (minutes)", "temp_min": "Minimal temperature allowed", "temp_max": "Maximal temperature allowed", - "device_power": "Device power (kW)", + "device_power": "Device power", "use_window_feature": "Use window detection", "use_motion_feature": "Use motion detection", "use_power_feature": "Use power management", @@ -25,12 +25,12 @@ "title": "Linked entities", "description": "Linked entities attributes", "data": { - "heater_entity_id": "Heater switch", + "heater_entity_id": "1rst heater switch", "heater_entity2_id": "2nd heater switch", "heater_entity3_id": "3rd heater switch", "heater_entity4_id": "4th heater switch", "proportional_function": "Algorithm", - "climate_entity_id": "Underlying climate", + "climate_entity_id": "1rst underlying climate", "climate_entity2_id": "2nd underlying climate", "climate_entity3_id": "3rd underlying climate", "climate_entity4_id": "4th underlying climate", @@ -110,7 +110,7 @@ "title": "Presence management", "description": "Presence management attributes.\nGives the a presence sensor of your home (true is someone is present).\nThen specify either the preset to use when presence sensor is false or the offset in temperature to apply.\nIf preset is given, the offset will not be used.\nLeave corresponding entity_id empty if not used.", "data": { - "presence_sensor_entity_id": "Presence sensor entity id (true is present)", + "presence_sensor_entity_id": "Presence sensor entity id", "eco_away_temp": "Temperature in Eco preset when no presence", "comfort_away_temp": "Temperature in Comfort preset when no presence", "boost_away_temp": "Temperature in Boost preset when no presence", @@ -125,7 +125,7 @@ "data": { "minimal_activation_delay": "Minimal activation delay", "security_delay_min": "Security delay (in minutes)", - "security_min_on_percent": "Minimal power percent for security mode", + "security_min_on_percent": "Minimal power percent to enable security mode", "security_default_on_percent": "Power percent to use in security mode" }, "data_description": { diff --git a/custom_components/versatile_thermostat/translations/fr.json b/custom_components/versatile_thermostat/translations/fr.json index 6c890a6..9512001 100644 --- a/custom_components/versatile_thermostat/translations/fr.json +++ b/custom_components/versatile_thermostat/translations/fr.json @@ -8,8 +8,9 @@ "description": "Principaux attributs obligatoires", "data": { "name": "Nom", + "thermostat_type": "Type de thermostat", "temperature_sensor_entity_id": "Température sensor entity id", - "external_temperature_sensor_entity_id": "Temperature exterieure sensor entity id", + "external_temperature_sensor_entity_id": "Température exterieure sensor entity id", "cycle_min": "Durée du cycle (minutes)", "temp_min": "Température minimale permise", "temp_max": "Température maximale permise", @@ -74,7 +75,7 @@ "data": { "window_sensor_entity_id": "Détecteur d'ouverture (entity id)", "window_delay": "Délai avant extinction (secondes)", - "window_auto_open_threshold": "seuil haut de chute de température pour la détection automatique (en °/min)", + "window_auto_open_threshold": "Seuil haut de chute de température pour la détection automatique (en °/min)", "window_auto_close_threshold": "Seuil bas de chute de température pour la fin de détection automatique (en °/min)", "window_auto_max_duration": "Durée maximum d'une extinction automatique (en min)" },