Update documentation for 1.0 release

README.md

@@ -3,8 +3,9 @@
 [![License][license-shield]](LICENSE)
 [![hacs][hacs_badge]][hacs]
 
+!!! IMPORTANT This thermostat integration aims to drastically simplify your automations around climate management. Because all classical events in climate are natively handled by the thermostat (nobody at home ?, activity detected in a room ?, window open ?, power shedding ?) you don't have to build over complicated scripts and automations to manage your climates ;-).
 
-_Component developed by using the amazing development template [blueprint][blueprint]._
+_Component developed by using the amazing development template [[blueprint](https://github.com/custom-components/integration_blueprint)]._
 
 This custom component for Home Assistant is an upgrade and is a complete rewrite of the component "Awesome thermostat" (see [Github](https://github.com/dadge/awesome_thermostat)) with addition of features.
 
@@ -17,19 +18,22 @@ This thermostat aims to command a heater which works only in on/off mode. The mi
 Because this integration aims to command the heater considering the preset configured and the room temperature, those informations are mandatory.
 
 ## Why another thermostat implementation ?
-For my personnal usage, I needed to add a couple of features and also to update the behavior that I implemented in my previous component "Awesome thermostat".
-This new component "Versatile thermostat" now manage the following use cases :
-- Configuration through GUI using Config Entry flow,
-- Explicitely define the temperature for all presets mode,
-- Unset the preset mode when the temperature is manually defined on a thermostat,
-- Turn off/on a thermostat when a door or windows is opened/closed after a certain delay,
-- Set a preset when an activity is detected in a room, and another one after no activity has been detected for a defined time,
-- Use a proportional algorithm with two function (see below),
-- Add power management to avoid exceeding a defined total power. When max power is exceeded, a new 'power' preset is set on the climate entity. When power goes below the max, the previous preset is restored.
 
-## How to install this incredible thermostat
+For my personnal usage, I needed to add a couple of features and also to update the behavior that implemented in the previous component "Awesome thermostat".
+This component named __Versatile thermostat__ manage the following use cases :
+- Configuration through standard integration GUI (using Config Entry flow),
+- Full uses of **presets mode**,
+- Unset the preset mode when the temperature is **manually defined** on a thermostat,
+- Turn off/on a thermostat when a **door or windows is opened/closed** after a certain delay,
+- Change preset when an **activity is detected** or not in a room for a defined time,
+- Use a **TPI (Time Proportional Interval) algorithm** thank's to [[Argonaute](https://forum.hacf.fr/u/argonaute/summary)] algorithm ,
+- Add **power shedding management** or regulation to avoid exceeding a defined total power. When max power is exceeded, a hidden 'power' preset is set on the climate entity. When power goes below the max, the previous preset is restored.
+- Add **home presence management**. This feature allows you to dynamically change the temperature of preset considering a occupancy sensor of your home.
+- Add **services to interact with the thermostat** from others integration: you can force the presence / un-presence using a service, and you can dynamically change the temperature of the presets.
 
-### HACS installation
+## How to install this incredible Versatile Thermostat ?
+
+### HACS installation (recommended)
 
 1. Install [HACS](https://hacs.xyz/). That way you get updates automatically.
 2. Add this Github repository as custom repository in HACS settings.
@@ -47,68 +51,80 @@ This new component "Versatile thermostat" now manage the following use cases :
 6. Restart Home Assistant
 7. Configure new Versatile Thermostat integration
 
-## Minimum requirements
-
-* This implementation can override or superseed the core generic thermostat
 
 ## Configuration
 
-No configuration in configuration.yaml is needed because all configuration is done through the standard GUI when adding the integration.
-Click on Add integration button in the integration page
-![image](https://github.com/jmcollin78/versatile_thermostat/blob/dev/images/add-an-integration.png?raw=true)
+Note: no configuration in configuration.yaml is needed because all configuration is done through the standard GUI when adding the integration.
 
-Follow the configurations steps as follow:
+Click on Add integration button in the integration page
+![image](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/add-an-integration.png?raw=true)
+
+The configuration can be change through the same interface. Simply select the thermostat to change, hit "Configure" and you will be able to change some parameters or configuration. Don't forget to reload (dot menu / reload) to take the new configuration into account.
+
+Then follow the configurations steps as follow:
 
 ### Minimal configuration update
-![image](https://github.com/jmcollin78/versatile_thermostat/blob/dev/images/config-page-1.png?raw=true)
+![image](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/config-main.png?raw=true)
 
 Give the main mandatory attributes:
 1. a name (will be the integration name and also the climate entity name)
 2. an equipment entity id which represent the heater. This equipment should be able to switch on or off,
-3. a sensor entity id which gives the temperature of the room in which the heater is installed,
-4. a cycle duration in minutes. At each cycle, the heater will be turned on then off for a calculated period in order to reach the targeted temperature (see presents below)
-5. a function used by the algorithm. 'linear' is the most common function. 'atan' is more aggressive and the targeted temperature will be reach sooner (but the power consumption is greater). Use it for room badly isolated,
-6. a bias value of type float. Proportional algorithm are known to never reach the targeted temperature. Depending of the room and heater configuration set a bias to reach the target. To evaluate the correct value, set it to 0, set the preset to a target temperature and see the current temperature reach. If it is below the target temperature, set the bias accordingly.
+3. a temporature sensor entity id which gives the temperature of the room in which the heater is installed,
+4. a temperature sensor entity giving the external temperature. If don't have any external sensor, you can use the local meteo integration
+5. a cycle duration in minutes. At each cycle, the heater will be turned on then off for a calculated period in order to reach the targeted temperature (see [preset](#configure-the-preset-temperature) below),
+6. Algorithm to use. Today only the TPI algorithm is available. See [algorithm](#algorithm)
+
+!!!IMPORTANT Notes
+1. Calculation are done at each cycle. So in case of conditions change, you will have to wait for the next cycle to see a change. For this reason, the cycle should not be too long. **5 min is a good value**,
+2. if the cycle is too short, the heater could never reach the target temperature indeed for heater with accumulation features and it will be unnecessary solicited
+
+### Configure the TPI algorithm coefficients
+Click on 'Validate' on the previous page and you will get there:
+![image](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/config-tpi.png?raw=true)
+
+For more informations on the TPI algorithm and tuned please refer to [algorithm](#algorithm).
 
 ### Configure the preset temperature
 Click on 'Validate' on the previous page and you will get there:
-![image](https://github.com/jmcollin78/versatile_thermostat/blob/dev/images/config-page-2.png?raw=true)
+![image](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/config-presets.png?raw=true)
 
-Concerning the preset modes, you first have to know that, as defined in the core development documentation (https://developers.home-assistant.io/docs/core/entity/climate/), the preset mode handled are the following :
- - ECO : Device is running an energy-saving mode
- - AWAY :	Device is in away mode
- - BOOST : Device turn all valve full up
- - COMFORT :	Device is in comfort mode
- - POWER :	An extra preset used when the power management detects an overpowering situation
+The preset mode allows you to pre-configurate targeted temperature. Used in conjonction with Scheduler (see [scheduler](#even-better-with-scheduler-component) you will have a powerfull and simple way to optimize the temperature vs electrical consumption of your hous. Preset handled are the following :
+ - **Eco** : device is running an energy-saving mode
+ - **Comfort** : device is in comfort mode
+ - **Boost** : device turn all valve full up
 
-'None' is always added in the list of modes, as it is a way to not use the presets modes but a manual temperature instead.
+**None** is always added in the list of modes, as it is a way to not use the presets modes but a **manual temperature** instead.
 
-!!! IMPORTANT !!! Changing manually the target temperature, set the preset to None (no preset). This way you can always set a target temperature even if no preset are available.
+!!! IMPORTANT Notes
+1. Changing manually the target temperature, set the preset to None (no preset). This way you can always set a target temperature even if no preset are available.
+2. standard **Away** preset is a hidden preset which is not directly selectable. Versatile Thermostat uses the presence management or movement management to set automatically and dynamically the target temperature depending on a presence in the home or an activity in the room. See [presence management](#configure-the-presence-management).
+3. if you uses the power shedding management, you will see a hidden preset named **power**. The heater preset is set to **power** when overpowering conditions are encountered and shedding is active for this heater. See [power management](#configure-the-power-management).
+4. If you don't want to use the preseet, give 0 as temperature. The preset will then been ignored and will not displayed in the front component
 
 ### Configure the doors/windows turning on/off the thermostats
 Click on 'Validate' on the previous page and you will get there:
-![image](https://github.com/jmcollin78/versatile_thermostat/blob/dev/images/config-page-3.png?raw=true)
+![image](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/config-window.png?raw=true)
 
 Give the following attributes:
-1. an entity id of a window/door sensor. This should be a binary_sensor or a input_boolean. The state of the entity should be 'on' or 'off'
-2. a delay in secondes before any change. This allow to quickly open a window without stopping the heater.
+1. an entity id of a **window/door sensor**. This should be a binary_sensor or a input_boolean. The state of the entity should be 'on' when the window is open or 'off' when closed
+2. a **delay in seconds** before any change. This allow to quickly open a window without stopping the heater.
 
 And that's it ! your thermostat will turn off when the windows is open and be turned back on when it's closed afer the delay.
 
-Note 1 : this implementation is based on 'normal' door/windows behavior, that's mean it considers it's closed when the state is 'off' and open when the state is 'on'
-
-Note 2 : If you want to use several door/windows sensors to automatize your thermostat, just create a group with the regular behavior (https://www.home-assistant.io/integrations/binary_sensor.group/).
+!!! IMPORTANT Notes
+1. If you want to use **several door/windows sensors** to automatize your thermostat, just create a group with the regular behavior (https://www.home-assistant.io/integrations/binary_sensor.group/)
+2. If you don't have any window/door sensor in your room, just leave the sensor entity id empty
 
 ### Configure the activity mode or motion detection
 Click on 'Validate' on the previous page and you will get there:
-![image](https://github.com/jmcollin78/versatile_thermostat/blob/dev/images/config-page-4.png?raw=true)
+![image](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/config-motion.png?raw=true)
 
 We will now see how to configure the new Activity mode.
 What we need:
-- a motion sensor. The entity id of a motion sensor. Motion sensor states should be 'on' (motion detected) or 'off' (no motion detected)
-- a "motion delay" duration defining how many time we leave the temperature like in "motion" mode after the last motion is detected.
-- a target "motion" preset. We will used the same temperature than this preset when an activity is detected.
-- a target "no motion" preset. We will used the same temperature than this preset when no activity is detected.
+- a **motion sensor**. The entity id of a motion sensor. Motion sensor states should be 'on' (motion detected) or 'off' (no motion detected)
+- a **motion delay** (in seconds) duration defining how long we wait for motion confirmation before considering the motion
+- a **target "motion" preset**. We will used the temperature of this preset when an activity is detected.
+- a **target "no motion" preset**. We will used the temperature of this second preset when no activity is detected.
 
 So imagine we want to have the following behavior :
 - we have room with a thermostat set in activity mode, the "motion" mode chosen is comfort (21.5C), the "no motion" mode chosen is Eco (18.5 C) and the motion delay is 5 min.
@@ -116,34 +132,114 @@ So imagine we want to have the following behavior :
 - somebody enters into the room, an activity is detected the temperature is set to 21.5 C
 - the person leaves the room, after 5 min the temperature is set back to 18.5 C
 
-For this to work, the climate thermostat should be in 'activity' preset mode.
+For this to work, the climate thermostat should be in ``Activity`` preset mode.
 
-Be aware that as for the others preset modes, Activity will only be proposed if it's correctly configure. In other words, the 4 configuration keys have to be set if you want to see Activity in home assistant Interface
+!!! IMPORTANT Notes
+1. Be aware that as for the others preset modes, ``Activity`` will only be proposed if it's correctly configure. In other words, the 4 configuration keys have to be set if you want to see Activity in home assistant Interface
 
 ### Configure the power management
-This feature allows you to regulate the power consumption of your radiators. Give a sensor to the current power consumption of your house, a sensor to the max power that should not be exceeded, the power consumption of your radiator and the algorithm will not start a radiator if the max power will be exceeded after radiator starts.
+Click on 'Validate' on the previous page and you will get there:
 
-![image](https://github.com/jmcollin78/versatile_thermostat/blob/dev/images/config-page-5.png?raw=true)
+This feature allows you to regulate the power consumption of your radiators. Known as shedding, this feature allows you to limit the electrical power consumption of your heater if overpowering conditions are detected. Give a **sensor to the current power consumption of your house**, a **sensor to the max power** that should not be exceeded, the **power consumption of your heater** and the algorithm will not start a radiator if the max power will be exceeded after radiator starts.
+
+![image](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/config-power.png?raw=true)
 
 Note that all power values should have the same units (kW or W for example).
-This allows you to change the max power along time using a Sceduler or whatever you like.
+This allows you to change the max power along time using a Scheduler or whatever you like.
 
+!!! IMPORTANT Notes
+1. When shedding is encountered, the heater is set to the preset named ``power``. This is a hidden preset, you cannot select it manually.
+2. I use this to avoid exceeded the limit of my electrical power contract when an electrical vehicle is charging. This makes a kind of auto-regulation.
+3. Always keep a margin, because max power can be briefly exceeded while waiting for the next cycle calculation typically or by not regulated equipement.
+4. If you don't want to use this feature, just leave the entities id empty
+
+### Configure the presence or occupancy
+This feature allows you to dynamically changes the temperature of all configured Versatile thermostat's presets when nobody is at home or when someone comes back home. For this, you have to configure the temperature that will be used for each preset when presence is off. When the occupancy sensor turns to off, those tempoeratures will be used. When it turns on again the "normal" temperature configured for the preset is used. See [preset management](#configure-the-preset-temperature).
+
+For this you need to configure:
+1. A **occupancy sensor** which state should be 'on' or 'home' if someone is present or 'off' or 'not_home' else,
+2. The **temperature used in Eco** preset when absent,
+3. The **temperature used in Comfort** preset when absent,
+4. The **temperature used in Boost** preset when absent
+
+!!!IMPORTANT Notes
+1. the switch of temperature is immediate and is reflected on the front component. The calculation will take the new target temperature into account at the next cycle calculation,
+2. you can use direct person.xxxx sensor or group of sensors of Home Assistant. The presence sensor handles ``on`` or ``home`` states as present and ``off`` or ``not_home`` state as absent.
 
 ## Algorithm
 This integration uses a proportional algorithm. A Proportional algorithm is useful to avoid the oscillation around the target temperature. This algorithm is based on a cycle which alternate heating and stop heating. The proportion of heating vs not heating is determined by the difference between the temperature and the target temperature. Bigger the difference is and bigger is the proportion of heating inside the cycle.
+
 This algorithm make the temperature converge and stop oscillating.
 
-Depending of your area and heater, the convergente temperature can be under the targeted temperature. So a bias parameter is available to fix this. To find the right value of biais, just set it to 0 (no biais), let the temperature converge and see if it is near the targeted temperature. If not adjust the biais. A good value is 0.25 with my accumulator radiator (which are long to heat but keeps the heat for a long time).
+## TPI algorithm
+The TPI algorithm consist in the calculation at each cycle of a percentage of On state vs Off state for the heater using the target temperature, the current temperature in the room and the current external temperature.
 
-A function parameter is available. Set it to "Linear" to have a linéar growth of temperature or set it to "Atan" to have a more aggressive curve to target temperature depending of your need.
+The percentage is calculated with this formula:
+
+    on_percent = coef_int * (target temperature - current temperature) + coef_ext * (target temperature - external temperature)
+    Then make 0 <= on_percent <= 1
+
+Defaults values for coef_int and coef_ext are respectively: ``0.6`` and ``0.01``. Those defaults values are suitable for a standard well isolated room.
+
+To tune those coefficients keep in mind that:
+1. **if target temperature is not reach** after stable situation, you have to augment the ``coef_ext`` (the ``on_percent`` is too high),
+2. **if target temperature is exceeded** after stable situation, you have to decrease the ``coef_ext`` (the ``on_percent`` is too low),
+3. **if reaching the target temperature is too slow**, you can increase the ``coef_int`` to give more power to the heater,
+4. **if reaching the target temperature is too fast and some oscillations appears** around the target, you can decrease the ``coef_int`` to give less power to the heater
+
+See some situations at [examples](#some-results).
+
+### Custom attributes
+
+To tune the algorithm you have access to all context seen and calculted by the thermostat through dedicated attributes. You can see (and use) those attributes in the "Development tools / states" HMI of HA. Enter your thermostat and you will see something like this:
+![image](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/dev-tools-climate.png?raw=true)
+
+Custom attributes are the following:
+
+| Attribute | Meaning |
+| ----------| --------|
+| ``hvac_modes`` | The list of modes supported by the thermostat |
+| ``min_temp`` | The minimal temperature |
+| ``max_temp`` | The maximal temperature |
+| ``preset_modes`` | The presets visible for this thermostat. Hidden presets are not showed here |
+| ``current_temperature`` | The current temperature as reported by the sensor |
+| ``temperature`` | The target temperature |
+| ``hvac_action`` | The action currently running by the heater. Can be idle, heating |
+| ``preset_mode`` | The currently selected preset. Can be one of the 'preset_modes' or a hidden preset like power |
+| ``[eco/comfort/boost]_temp`` | The temperature configured for the preset xxx |
+| ``[eco/comfort/boost]_away_temp`` | The temperature configured for the preset xxx when presence is off or not_home |
+| ``power_temp`` | The temperature used when shedding is detected |
+| ``on_percent`` | The percentage on calculated by the TPI algorithm |
+| ``on_time_sec`` | The On period in sec. Should be ```on_percent * cycle_min``` |
+| ``off_time_sec`` | The Off period in sec. Should be ```(1 - on_percent) * cycle_min``` |
+| ``cycle_min`` | The calculation cycle in minutes |
+| ``function`` | The algorithm used for cycle calculation |
+| ``tpi_coef_int`` | The ``coef_int`` of the TPI algorithm |
+| ``tpi_coef_ext`` | The ``coef_ext`` of the TPI algorithm |
+| ``saved_preset_mode`` | The last preset used before automatic switch of the preset |
+| ``saved_target_temp`` | The last temperature used before automatic switching |
+| ``window_state`` | The last known state of the window sensor. None if window is not configured |
+| ``motion_state`` | The last known state of the motion sensor. None if motion is not configured |
+| ``overpowering_state`` | The last known state of the overpowering sensor. None if power management is not configured |
+| ``presence_state`` | The last known state of the presence sensor. None if presence management is not configured |
+| ``last_update_datetime`` | The date and time in ISO8866 format of this state |
+| ``friendly_name`` | The name of the thermostat |
+| ``supported_features`` | A combination of all features supported by this thermostat. See official climate integration documentation for more informations |
 
 ### Some results
 
 Convergence of temperature to target configured by preset:
-![image](https://github.com/jmcollin78/versatile_thermostat/blob/dev/images/results-1.png?raw=true)
+![image](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/results-1.png?raw=true)
 
 Cycle of on/off calculated by the integration:
-![image](https://github.com/jmcollin78/versatile_thermostat/blob/dev/images/results-2.png?raw=true)
+![image](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/results-2.png?raw=true)
+
+Coef_int too high (oscillations around the target)
+![image](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/results-3.png?raw=true)
+
+Algorithm calculation evolution
+![image](https://github.com/jmcollin78/versatile_thermostat/blob/main/images/results-4.png?raw=true)
+
 
 Enjoy !
 
@@ -173,7 +269,7 @@ In this example I set ECO mode during the night and the day when nobody's at hom
 
 I hope this example helps you, don't hesitate to give me your feedbacks !
 
-## Even / even better with custom:simple-thermostat front integration
+## Even-even better with custom:simple-thermostat front integration
 The custom:simple-thermostat (see https://home.clouderial.fr/hacs/repository/158654878) is a great integration which allow some customisation which fits well with this thermostat.
 You can have something like that very easily ![image](https://github.com/jmcollin78/versatile_thermostat/blob/dev/images/simple-thermostat.png?raw=true)
 Example configuration:
@@ -202,6 +298,45 @@ Example configuration:
           name: Porte sam
 ```
 
+## Even-Even-Even better with Apex-chart to tune your Thermostat
+You can get curve like presented in [some results](#some-results) with kind of Apex-chart configuration only using the custom attributes of the thermostat described [here](#custom-attributes):
+
+```
+type: custom:apexcharts-card
+header:
+  show: true
+  title: Tuning chauffage
+  show_states: true
+  colorize_states: true
+update_interval: 60sec
+graph_span: 4h
+yaxis:
+  - id: left
+    show: true
+    decimals: 2
+  - id: right
+    decimals: 2
+    show: true
+    opposite: true
+series:
+  - entity: climate.thermostat_mythermostat
+    attribute: temperature
+    type: line
+    name: Target temp
+    curve: smooth
+    yaxis_id: left
+  - entity: climate.thermostat_mythermostat
+    attribute: current_temperature
+    name: Current temp
+    curve: smooth
+    yaxis_id: left
+  - entity: climate.thermostat_mythermostat
+    attribute: on_percent
+    name: Power percent
+    curve: stepline
+    yaxis_id: right
+```
+
 ## Contributions are welcome!
 
 If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md)