Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 072534e

Browse files
authoredJun 3, 2021
fix typos
1 parent 763b940 commit 072534e

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed
 

‎README.md

+22-22
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# PROGRAMMABLE THERMOSTAT
2-
This component is a revision of the official Home Assistant component 'Generic Thermostat' in order to have possibility to have target temperature variable according to a sensor state value.
2+
This component is a revision of the official Home Assistant component 'Generic Thermostat' to have the possibility to have the target temperature vary according to a sensor state value.
33

44
## HOW TO INSTALL
55
Use HACS to install the custom component and configure it through the user interface (settings/integration) to have easy and smooth usage.
66

77
If you are for the manual method:
88
Just copy paste the content of the `climate.programmable_thermostat/custom_components` folder in your `config/custom_components` directory.
99

10-
As example you will get the '.py' file in the following path: `/config/custom_components/programmable_thermostat/climate.py`.
10+
For example, you will get the '.py' file in the following path: `/config/custom_components/programmable_thermostat/climate.py`.
1111

1212
## EXAMPLE OF SETUP
1313
Config flow is available, so just configure all the entities you want through the user interface.
@@ -42,41 +42,41 @@ cooler | | *Conditional* | Switch that will activate/deactivate the cooling sys
4242
actual_temp_sensor | | *Required* | Sensor of actual room temperature.
4343
min_temp | 5 | Optional | Minimum temperature manually selectable.
4444
max_temp | 40 | Optional | Maximum temperature manually selectable.
45-
target_temp_sensor | | *Required* | Sensor that rapresent the desired temperature for the room. Suggestion: use my [`file_restore`][1] compontent or something similar.
45+
target_temp_sensor | | *Required* | Sensor that represent the desired temperature for the room. Suggestion: use my [`file_restore`][1] component or something similar.
4646
tolerance | 0.5 | Optional | Tolerance for turn on and off the switches mode.
47-
initial_hvac_mode | `heat_cool`, `heat`, `cool`, `off` | Optional | If not set, components will restore old state after restart. I suggest to not use it.
48-
related_climate | | Optional | To be used if the climate object is a slave of an other one. below 'Related climate' chapter a description.
49-
hvac_options | 7 | Optional | This define which combination of manual-auto-off options you want to active. Refer to chapter below for the value.
50-
auto_mode | `all`, `heating`, `cooling` | Optional | This allows to limit the the heating/cooling function with HVAC mode HEAT_COOL.
51-
min_cycle_duration | | Optional | TIMEDELTA type. This will allow to protect devices that request a minimum type of work/rest before changing status. On this you have to define hours, minutes, seconds as son elements.
47+
initial_hvac_mode | `heat_cool`, `heat`, `cool`, `off` | Optional | If not set, components will restore old state after restart. I suggest not to use it.
48+
related_climate | | Optional | To be used if the climate object is a slave of another one. below 'Related climate' chapter a description.
49+
hvac_options | 7 | Optional | This defines which combination of manual-auto-off options you want to activate. Refer to the chapter below for the value.
50+
auto_mode | `all`, `heating`, `cooling` | Optional | This allows limiting the heating/cooling function with HVAC mode HEAT_COOL.
51+
min_cycle_duration | | Optional | TIMEDELTA type. This will allow protecting devices that request a minimum type of work/rest before changing status. On this, you have to define hours, minutes and/or seconds as son elements.
5252

5353
## SPECIFICITIES
5454
### TARGET TEMPERATURE SENSOR
55-
`target_temp_sensor` is the Home Assistant `entity_id` of a sensor which state change accrodingly a specified temperature profile. This temperature profile should described the desired temperature for the room each day/hour.
56-
`target_temp_sensor` must have a temperature value (number with or without decimal) as state.
55+
`target_temp_sensor` is the Home Assistant `entity_id` of a sensor which' state change accordingly a specified temperature profile. This temperature profile should describe the desired temperature for the room each day/hour.
56+
`target_temp_sensor` must have a temperature value (a number with or without decimal) as a state.
5757

5858
Suggestion: use my [`file_restore`][1] custom components.
5959

6060
### ADDITIONAL INFO
61-
Programmed temperature will change accordingly to the one set by the `target_temp_sensor` when in `heat_cool` mode. You can still change it temporarly with the slider. Target temperature will be set, again, to the one of `target_temp_sensor` at its first change.
62-
`heat` and `cool` modes are the manual mode; in this mode the planning will not be followed.
61+
The programmed temperature will change accordingly to the one set by the `target_temp_sensor` when in `heat_cool` mode. You can still change it temporarily with the slider. Target temperature will be set, again, to the one of `target_temp_sensor` at its first change.
62+
`heat` and `cool` modes are the manual mode; in this mode, the planning will not be followed.
6363

6464
After a restart of Home Assistant, room temperature and planned room temperature will match till `actual_temp_sensor` will return a temperature value.
65-
This is done to avoid possible issues with Homekit support with temperature sensor that need some time to sync with Home Assistant.
65+
This is done to avoid possible issues with Homekit support with a temperature sensor that needs some time to sync with Home Assistant.
6666

6767
### RELATED CLIMATE
68-
This field is used if the climate 2 climate object are related each other, for example if they used the same heater.
68+
This field is used if the climate-to-climate objects are related to each other, for example, if they use the same heater.
6969
Set this field with the `entity_id` with a different climate object and this will prevent the heater/cooler to be turned off by the slavery climate if the master one is active.
7070

71-
For example I have 2 climate objects, one for the room and one for the boiler.
72-
Boiler's climate is used to prevent freezing and, if the temperature is lower the the programmed one, room heater is turned on.
73-
This means that, if the room's heater is on and boiler's heater is off, boiler will turn off the heater despite the room one.
74-
With this `master_climate` field this unwanted turn off will not happen.
71+
For example, I have two climate objects, one for the room and one for the boiler.
72+
The boiler's climate is used to prevent freezing and, if the temperature is lower than the programmed one, the room heater is turned on.
73+
This means that, if the room's heater is on and the boiler's heater is off, the boiler will turn off the heater despite the room climate demands heat.
74+
With this `master_climate` field this unwanted turn-off will not happen.
7575

76-
Note: my suggestion is to set it to both climates that are related each other.
76+
Note: my suggestion is to set it to both climates that are related to each other.
7777

7878
### HVAC OPTIONS
79-
This parameter allows you to define which mode you want to activate for that climate object. This is a number with a meaning of each single bit. Here below the table.
79+
This parameter allows you to define which mode you want to activate for that climate object. This is a number with a meaning of every single bit. Here below the table.
8080

8181
bit3 - AUTOMATIC | bit2 - MANUAL | bit1 - OFF | RESULT | Meaning
8282
--- | --- | --- | --- | ---
@@ -89,13 +89,13 @@ bit3 - AUTOMATIC | bit2 - MANUAL | bit1 - OFF | RESULT | Meaning
8989
1 | 1 | 0 | 6 | AUTOMATIC and MANUAL
9090
1 | 1 | 1 | 7 | DEAFAULT - Full mode, you will have active all the options.
9191

92-
### HEATERS AND COOLER SPECIFITIES
92+
### HEATERS AND COOLER SPECIFICS
9393
From version 7.6 you will be able to set `heaters` and `coolers` to the same list and you'll get the correct way of work in manual mode.
9494
This means that `heat` and `cool` mode will work correctly with the same list, but `heat_cool` mode will not (otherwise you will not be able to switch the real device between the 2 modes).
9595
My suggestion is to set `hvac_options: 3` to remove the auto mode.
9696

9797
## NOTE
98-
This component has been developed for the bigger project of building a smart thermostat using Home Assistant and way cheeper then the commercial ones.
98+
This component has been developed for the bigger project of building a smart thermostat using Home Assistant and way cheaper than the commercial ones.
9999
You can find more info on that [here][3]
100100

101101
***

0 commit comments

Comments
 (0)
Please sign in to comment.