Skip to content
This repository was archived by the owner on Mar 19, 2024. It is now read-only.

Commit 1d98bff

Browse files
committed
feat: Climate presets
1 parent 5a180da commit 1d98bff

File tree

5 files changed

+145
-312
lines changed

5 files changed

+145
-312
lines changed

README.md

Lines changed: 104 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -10,51 +10,67 @@ Ideas are welcome ! Don't hesitate to create issue to suggest something, it will
1010
**This integration is also compatible with sensoAPP and has been tested with the vr920 and vr921 devices.**
1111

1212
## Installations
13+
1314
- Through HACS [custom repositories](https://hacs.xyz/docs/faq/custom_repositories/) !
14-
- Otherwise, download the zip from the latest release and copy `multimatic` folder and put it inside your `custom_components` folder.
15+
- Otherwise, download the zip from the latest release and copy `multimatic` folder and put it inside
16+
your `custom_components` folder.
1517

1618
You can configure it through the UI using integration.
17-
You have to provide your username and password (same as multimatic or senso app), if you have multiple serial numbers, you can choose for which number serial number you want the integration.
19+
You have to provide your username and password (same as multimatic or senso app), if you have multiple serial numbers,
20+
you can choose for which number serial number you want the integration.
1821
You can create multiple instance of the integration with different serial number (**This is still a beta feature**).
1922

2023
**It is strongly recommended using a dedicated user for HA**, for 2 reasons:
24+
2125
- As usual for security reason, if your HA got compromised somehow, you know which user to block
2226
- I cannot confirm it, but it seems multimatic and senso API only accept the same user to be connected at the same time
2327

2428
## Changelog
29+
2530
See [releases details](https://github.com/thomasgermain/vaillant-component/releases)
31+
2632
## Provided entities
33+
2734
- 1 water_heater entity, if any water heater: `water_heater.<water heater id>`, basically `water_heater.control_dhw`
2835
- 1 climate entity per zone (expect if the zone is controlled by room) `climate.<zone id>`
2936
- 1 climate entity per room `climate.<room name>`
30-
- 1 fan entity `fan.<ventilation_id>`
37+
- 1 fan entity `fan.<ventilation_id>`
3138
- 1 binary_sensor entity `binary_sensor.control_dhw` reflecting if the circulation is on or off
32-
- 1 binary_sensor entity `climate.<room name>_window` per room reflecting the state of the "open window" in a room (this is a feature of the multimatic API, if the temperature is going down pretty fast, the API assumes there is an open window and heating stops)
39+
- 1 binary_sensor entity `climate.<room name>_window` per room reflecting the state of the "open window" in a room (this
40+
is a feature of the multimatic API, if the temperature is going down pretty fast, the API assumes there is an open
41+
window and heating stops)
3342
- 1 binary_sensor entity `climate.<sgtin>_lock`per device reflecting if valves are "child locked" or not
34-
- 1 binary_sensor entity `binary_sensor.<sgtin>_battery` reflecting battery level for each device (VR50, VR51) in the system
35-
- 1 binary_sensor entity `binary_sensor.<sgtin>_battery` reflecting connectivity for each device (VR50, VR51) in the system
43+
- 1 binary_sensor entity `binary_sensor.<sgtin>_battery` reflecting battery level for each device (VR50, VR51) in the
44+
system
45+
- 1 binary_sensor entity `binary_sensor.<sgtin>_battery` reflecting connectivity for each device (VR50, VR51) in the
46+
system
3647
- 1 binary_sensor entity `binary_sensor.multimtic_system_update`to know if there is an update pending
3748
- 1 binary_sensor entity `binary_sensor.multimtic_system_online` to know if the vr900/920 is connected to the internet
38-
- 1 binary_sensor entity `binary_sensor.<boiler model>` to know if there is an error at the boiler. **Some boiler does not provide this information, so entity won't be available.**
49+
- 1 binary_sensor entity `binary_sensor.<boiler model>` to know if there is an error at the boiler. **Some boiler does
50+
not provide this information, so entity won't be available.**
3951
- 1 temperature sensor `sensor.outdoor_temperature` for outdoor temperature
4052
- 1 sensor for each report in live_report (boiler temperature, boiler water pressure, etc.)
4153
- 1 binary sensor `binary_sensor.multimtic_quick_mode` to know a quick mode is running on
4254
- 1 binary sensor ` binary_sensor.multimtic_holiday` to know the holiday mode is on/off
43-
- 1 binary sensor `binary_sensor.multimatic_errors`indicating if there are errors coming from the API (if `on`, details are in `state_attributes`)
55+
- 1 binary sensor `binary_sensor.multimatic_errors`indicating if there are errors coming from the API (if `on`, details
56+
are in `state_attributes`)
4457

4558
## Provided devices
59+
4660
- 1 device per VR50 or VR51
47-
- 1 device for the boiler (if supported). Some boilers don't provide enough information to be able to create a device in HA.
61+
- 1 device for the boiler (if supported). Some boilers don't provide enough information to be able to create a device in
62+
HA.
4863
- 1 device for the gateway (like VR920)
4964
- 1 "multimatic" (VRC700) device (the water pressure is linked to the VRC 700 inside the multimatic API)
5065
- hot water circuit
5166
- heating circuit
5267

68+
For the climate and water heater entities, you can also find
5369

54-
For the climate and water heater entities, you can also find
5570
- the 'real multimatic mode' running on (AUTO, MANUAL, DAY, etc)
5671

57-
For the boiler error entity, you can also find
72+
For the boiler error entity, you can also find
73+
5874
- the last update (this is not the last HA update, this is the last time multimatic checks the boiler)
5975
- the status code (these can be found in your documentation)
6076
- the title (human-readable description of the status code)
@@ -63,56 +79,97 @@ For the `binary_sensor.multimtic_quick_mode`, when on, you have the current quic
6379
For the `binary_sensor.multimtic_holiday`, when on, you have the start date, end date and target temperature
6480

6581
## Provided services
82+
6683
- `multimatic.set_holiday_mode` to set the holiday mode (see services in HA ui to get the params)
6784
- `multimatic.remove_holiday_mode` .. I guess you get it
6885
- `multimatic.set_quick_mode` to set a quick mode
69-
- `multimatic.remove_quick_mode` don't tell me you don't get it
86+
- `multimatic.remove_quick_mode` don't tell me you don't get it
7087
- `multimatic.set_quick_veto` to set a quick veto for a climate entity
7188
- `multimatic.remove_quick_veto` to remove a quick veto for a climate entity
72-
- `multimatic.request_hvac_update` to tell multimatic API to fetch data from your installation and made them available in the API
89+
- `multimatic.request_hvac_update` to tell multimatic API to fetch data from your installation and made them available
90+
in the API
7391
- `multimatic.set_ventilation_day_level` to set ventilation day level
7492
- `multimatic.set_ventilation_night_level` to set ventilation night level
7593
- `multimatic.set_datetime` to set the current date time of the system
7694

7795
This will allow you to create some buttons in UI to activate/deactivate quick mode or holiday mode with a single click
7896

79-
8097
## Expected behavior
8198

82-
On **room** climate:
99+
### Room climate
100+
101+
#### Changing temperature
83102

84-
Changing temperature while ...
85103
- `MANUAL` mode -> it simply changes target temperature
86-
- other modes -> it creates a quick_veto (duration = 3 hours) (it's also removing holiday or quick mode)
87-
88-
Modes mapping:
89-
- `AUTO` -> `HVAC_MODE_AUTO` & `PRESET_COMFORT`
90-
- `OFF` -> `HVAC_MODE_OFF` & no preset
91-
- `QUICK_VETO` -> hvac depends on state & `PRESET_QUICK_VETO` (custom)
92-
- `QM_SYSTEM_OFF` -> `HVAC_MODE_OFF` & `PRESET_SYSTEM_OFF` (custom)
93-
- `HOLIDAY` -> `HVAC_MODE_OFF` & `PRESET_HOLIDAY` (custom)
94-
- `MANUAL` -> no hvac & `PRESET_MANUAL` (custom)
95-
96-
On **zone** climate:
97-
- Changing temperature will lead to a quick veto with selected temperature for 6 hours (quick veto duration is not configurable for a zone)
98-
99-
Modes mapping:
100-
101-
| Vaillant Mode | HA Mode |
102-
| ------------- |-----------------------------------------------------|
103-
| AUTO | `HVAC_MODE_AUTO` & `PRESET_COMFORT` |
104-
| DAY | no hvac & `PRESET_DAY` (custom) |
105-
| NIGHT | no hvac & `PRESET_SLEEP` |
106-
| OFF | `HVAC_MODE_OFF` & no preset |
107-
| ON (= cooling ON) | no hvac & `PRESET_COOLING_ON` (custom) |
108-
| QUICK_VETO | depends on the state & `PRESET_QUICK_VETO` (custom) |
109-
| QM_ONE_DAY_AT_HOME | HVAC_MODE_AUTO & `PRESET_HOME` |
110-
| QM_PARTY | no hvac & `PRESET_PARTY` (custom) |
111-
| QM_VENTILATION_BOOST | `HVAC_MODE_FAN_ONLY` & no preset |
112-
| QM_ONE_DAY_AWAY | `HVAC_MODE_OFF` & `PRESET_AWAY` |
113-
| QM_SYSTEM_OFF | `HVAC_MODE_OFF` & `PRESET_SYSTEM_OFF` (custom) |
114-
| HOLIDAY | `HVAC_MODE_OFF` & `PRESET_HOLIDAY` (custom) |
115-
| QM_COOLING_FOR_X_DAYS | no hvac & `PRESET_COOLING_FOR_X_DAYS` |
104+
- other modes -> it creates a quick_veto (duration = 3 hours) and it removes holiday or quick mode.
105+
106+
#### Modes mapping
107+
108+
| Multimatic mode | HA HVAC | HA preset |
109+
|-------------------------|---------|----------------------------|
110+
| AUTO | AUTO | COMFORT |
111+
| OFF | OFF | / |
112+
| QUICK_VETO | HEAT | PRESET_QUICK_VETO (custom) |
113+
| SYSTEM_OFF (quick mode) | OFF | PRESET_SYSTEM_OFF (custom) |
114+
| HOLIDAY (quick mode) | OFF | PRESET_AWAY |
115+
| MANUAL | HEAT | PRESET_HOME |
116+
117+
#### Available HVAC mode
118+
119+
| HVAC mode | Multimatic mode |
120+
|-----------|-----------------|
121+
| AUTO | AUTO |
122+
| OFF | OFF |
123+
124+
#### Available preset mode
125+
126+
| preset mode | Multimatic mode |
127+
|----------------|-----------------|
128+
| PRESET_COMFORT | AUTO |
129+
| PRESET_HOME | MANUAL |
130+
131+
### Zone climate
132+
133+
#### Changing temperature
134+
135+
Changing temperature will lead to a quick veto with selected temperature for 6 hours (quick veto duration is not
136+
configurable for a zone)
137+
138+
#### Modes mapping
139+
140+
| Vaillant Mode | HA HVAC | HA preset |
141+
|---------------------------------|------------------------|----------------------------|
142+
| AUTO / TIMED CONTROLLED | AUTO | PRESET_COMFORT |
143+
| DAY | HEAT | PRESET_HOME |
144+
| NIGHT | OFF | PRESET_SLEEP |
145+
| MANUAL | Based on zone function | / |
146+
| OFF | OFF | / |
147+
| ON | Based on zone function | / |
148+
| QUICK_VETO | HEAT | PRESET_QUICK_VETO (custom) |
149+
| ONE_DAY_AT_HOME (quick mode) | AUTO | PRESET_HOME |
150+
| PARTY (quick mode) | OFF | PRESET_HOME |
151+
| VENTILATION_BOOST (quick mode) | FAN_ONLY | / |
152+
| ONE_DAY_AWAY (quick mode) | OFF | PRESET_AWAY |
153+
| SYSTEM_OFF (quick mode) | OFF | PRESET_SYSTEM_OFF (custom) |
154+
| HOLIDAY (quick mode) | OFF | PRESET_AWAY |
155+
| COOLING_FOR_X_DAYS (quick mode) | COOL | / |
156+
157+
#### Available HVAC mode
158+
159+
| HVAC mode | Multimatic mode |
160+
|-----------|---------------------------------|
161+
| AUTO | AUTO |
162+
| OFF | OFF |
163+
| FAN_ONLY | VENTILATION_BOOST (quick mode) |
164+
| COOL | COOLING_FOR_X_DAYS (quick mode) |
165+
166+
#### Available preset mode
167+
168+
| preset mode | Multimatic mode |
169+
|----------------|------------------------------|
170+
| PRESET_COMFORT | AUTO |
171+
| PRESET_HOME | ONE_DAY_AT_HOME (quick mode) |
172+
| PRESET_AWAY | ONE_DAY_AWWAY (quick mode) |
116173

117174
### DHW climate
118175

@@ -125,7 +182,7 @@ Modes mapping:
125182
| SYSTEM_OFF (quick mode) | OFF | PRESET_SYSTEM_OFF |
126183
| HOTWATER_BOOST (quick mode) | HEAT | PRESET_BOOST |
127184
| PARTY (quick mode) | OFF | PRESET_HOME |
128-
| ON | HEAT | PRESET_NONE |
185+
| ON | EAT | PRESET_NONE |
129186

130187
#### Available HVAC mode
131188

0 commit comments

Comments
 (0)