Skip to content

Commit 70a2372

Browse files
committed
update(readme): document the services.
1 parent 01de1a2 commit 70a2372

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,47 @@ temperature changes) increase the noise band for system stability.
115115
However, it is recommended to save the new gains in the YAML configuration file to keep it in case of Home Assistant
116116
database's is corrupted.
117117

118+
### Services
119+
Services can be used in Home Assistant to configure the thermostat.\
120+
The following services are available:\
121+
122+
**Set PID gains:** `smart_thermostat.set_pid_gain`\
123+
Use this service to adjust the PID gains without requiring a restart of Home
124+
Assistant. Values are saved to Home Assistant database and restored after a restart. Please consider saving
125+
the final gain parameters in YAML configuration file when satisfied to keep it safe in case of database corruption.
126+
Optional parameters : kp, ki and kd, as float.
127+
Example:
128+
```
129+
service: smart_thermostat.set_pid_gain
130+
data:
131+
kp: 11.8
132+
ki: 0.00878
133+
target:
134+
entity_id: climate.salle_de_bain
135+
```
136+
137+
**Set preset modes temperatures:** `smart_thermostat.set_preset_temp`\
138+
Use this service to set the temperatures for the preset modes. It can be adjusted
139+
for all preset modes, if a preset mode is not enabled through YAML, it will be enabled. You can use any preset temp
140+
parameter available in smart thermostat settings.
141+
Example:
142+
```
143+
service: smart_thermostat.set_preset_temp
144+
data:
145+
away_temp: 14.6
146+
boost_temp: 22.5
147+
target:
148+
entity_id: climate.salle_de_bain
149+
```
150+
151+
**Clear the integral part:** `smart_thermostat.clear_integral`\
152+
Use this service to reset the integral part of the PID controller to 0. Useful
153+
when tuning the PID gains to quickly test the behavior without waiting the integral to stabilize by itself.
154+
155+
**Add integration reload service:**
156+
Use the `smart_thermostat.reload` service to reload the thermostat from scratch without requiring a restart of Home Assistant.
157+
158+
118159
## Parameters:
119160
* **name** (Optional): Name of the thermostat.
120161
* **unique_id** (Optional): unique entity_id for the smart thermostat.

0 commit comments

Comments
 (0)