From 09394aef47967c0287b34e73383b2c21723409e3 Mon Sep 17 00:00:00 2001 From: Hans Oischinger Date: Thu, 22 Aug 2019 21:57:48 +0200 Subject: [PATCH 01/10] Create vicare.markdown --- source/_components/vicare.markdown | 52 ++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 source/_components/vicare.markdown diff --git a/source/_components/vicare.markdown b/source/_components/vicare.markdown new file mode 100644 index 000000000000..6df57e1492ed --- /dev/null +++ b/source/_components/vicare.markdown @@ -0,0 +1,52 @@ +--- +title: "Viessmann climate controller" +description: "Instructions how to integrate Viessmann heating devices with Home Assistant" +logo: viessmann.png +ha_category: Climate +ha_release: 0.97 +ha_iot_class: Cloud Push +--- + +The `ViCare` climate platform lets you control [Viessmann](https://www.viessmann.com) devices via the ViCare cloud. +All Viessmann gas boilers with WiFi or Ethernet connection should be supported. + +## Configuration + +To set it up, add the following information to your `configuration.yaml` file: + +```yaml +climate: + - platform: vicare + username: [VICARE_EMAIL] + password: [VICARE_PASSWORD] +``` + +{% configuration %} +username: + description: Your username for the ViCare App + required: true + type: string +password: + description: Your password for the ViCare App + required: true + type: string +{% endconfiguration %} + +This component opens a TCP connection with the ViCare API to receive temperature and status updates, and to issue commands. + +Two climate components will be created: climate.vicare_heating and climate.vicare_water (for domestic hot water). + +The climate.vicare_heating component has the following mapping of hvac modes to Viessmann operation modes: + - HVAC_OFF - ForcedReduced + - HVAC_AUTO - DHWandHeating + - HVAC_HEAT - ForcedNormal +The presets eco and comfort are a 1:1 mapping to the respective Viessmann programs. + +It is not possible to turn on/off water heating via the climate.vicare_water component since this would conflict with the operation modes of the heating component. Therefore the hvac modes are *information only* and only the temperature can be set. + +### Supported services + +Available services: + +- `climate.set_temperature` +- `climate.set_hvac_mode` From f0b22e2839afc9e4017255a2b7c7e9733da277ee Mon Sep 17 00:00:00 2001 From: Hans Oischinger Date: Thu, 22 Aug 2019 22:06:11 +0200 Subject: [PATCH 02/10] Add viessmann.png for vicare component --- source/images/supported_brands/viessmann.png | Bin 0 -> 3229 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 source/images/supported_brands/viessmann.png diff --git a/source/images/supported_brands/viessmann.png b/source/images/supported_brands/viessmann.png new file mode 100644 index 0000000000000000000000000000000000000000..a6e304ef67062b84db25241ced326d65e0d9e362 GIT binary patch literal 3229 zcmV;O3}W+%P)b?>8>`%**dRHS~vs{NLXD+S&c<>+n!Y z_ot-wm6GveUhq~>^L26h&du;kMejyG^n-x*otypS9q=-3#FlWaNv<<_Aq9ps~T1F^n5bbW$;Tn{GVuS3@-=*MMt)LBRc z|MxUEr^V^n(H+wC>gmum4Qi>e=~1s7E~s>%)5+<{p=%q|MrV!Z#d)gU!dTry9r@&n zbM^Po^$qgYlX8=-DZ3A|;@-(KU7UxBm8Ih$kmQ|$;+uHHcx3;7ZXCEEzso9)^EBg? zLpH81`i0MZW!}@gQK_2fy^aJ|kDeYBvd?%dUk_aFfw{_D4T!X`O7)VKSDU6dv42rZ z7?vyJ|cZZm%_s$u<*o*G9Udyz_Nxr7@}#_GL1^lAW0WS{k#EpR`` z1dR{Pm>O}dcRD2E=*c*FeqH>ZMO?XLL#_ye*iMX8QcPeCBeoo-7Kr0Ku7vQ>q48H1P)n&)r0atvbAVQPc8oUndNL<~A$WX8|bh-(!& zC}MLmSG6^dIGt`v{9=s~Bj#FrErnyJ9O78j;t#D5$LU2?NJNaD}% zBhDH{w-#5IZdpEV)jmAp!rNdb#W9C?CS<jJxb85uLmca>oQxR7fr%N@=OC^3 zG`@(l+2xg_?O_i}yOnWQ<`EaOJ!VoIGl(T4UY&F9hd4<~hp8pvSdE$?MtctO53>lJ zJ|?+X4F}?skCN8);Jx9c9@r2NZ^BW+@BtB{cyFc338;%l9OvgnKiC#=tRA+79Ej0~ zR35w0gggb>VCao_6g5!`#7SBnEg+7+hk_eEYK9Oq;p|chCFumjl_9l8oD?2_12LNa z8}1r1Vlxxd9mKT>s)%?s7L0}85n{WU?2tnKLXQy<$JuuLZjHDMl(`V2Y=mLPz=+KN zT6YlFOi4n#o*J{0;us>fjW{`*Sd5Vwi--${sXgL2-&E9v7{zSrW=tJ2y9K;GYA)bx zIB_iy*DXmxyq?rcOG*IZ8>^89L%Vu8P4YPqZylx`5N|W&PQ>E@$bnXg*B8ajd3I5Tk5FX~w{a?WeUHh!Zo# zCL)gGdugcwLHuPK@pmKIF~3^Z*AVflH#pf5@%q7TfEZ*WibrxzjhMKOoj{x>=9A|@ zoJfBX#CGstv;K*gvE9A75wAmuJ0gzN*R2~d%0_H$^_m*-ynBd~R2_|tYZAob+L8Rj zXaF0r{hSw*M%!hxos_Uq%+7@BRw_H$k=VzguTc32P~2D2Btgll;oF-Q9abPzF`LVTMsFk-sG zVNZyUUoM*H_VW_0WVR5Wy$h8{m!}2`3o$X`@@G3_pe-{dh?AwWEgXomsq=jKuEua69$a!O&Z_D| z#3&n~p1^-Ku$Vo~i+2-2yky74{4JUah{3dx$#an;9Ys8jUL3peT!^otQwL)Pu{|wV z-^ewM52SbCSbxOlSbMc%Zf)K7vn(N|0bE{*nQKRgqeuCCZp6{dFl_R2C7Ck5pxT9 z*8Z`8*vE+N1*{OUk}?vuDKP;q^el9fV}rS6m$h5aU?N_v(5cvG+T% z>$!9Wu{fAELM%RcEMmAfg0H<)jh|WAvpxBd9yD#`dM^nOqafaPqR%4sHDYsfCx=*a ztD7N~+-e@N^Zn1<8|-`$C(jqxk|wq2%7{)(c)1Xdz(c%QJINxZ%Zr_rsC6YQV!^F$ zh&cMoFa6^YqrDL|(Z#nd5yy!flB_LCe)HOV>OvfWv1pSX;t->C<}THSGam5*B++lp<-du?3eugbg4l&&~-=G$iQ_3Ue-Rj1O$DCU& zAr_xmv~Xq5h-aP$IuX-Y&R`@Vru*hW2Sn^*P~N_Pn02cgBaVJCZncD1bRXd=(!C<~ z3p&IN5Rs~ic$F?MsBqO zF|!rku9|#@KZ4kN!$Ul{UJget)nbPn;(BGP#2G?N*5UFVCmB<=p1Kn;aH~BL1Gn0R z810RS<>eUrL2P|Ez;{6ihq%5Yv1)LDxVaHSGyblx8!>gOeGx}f5|NWEavg^+?)6W8I};PdyumK0!)n@7ZNe}9z&O8}&FAWartj5o-wcV!JcYgpl-?=u?~wqdM01QI;;oioBR;x z3cW`;sMGR6oa;aA3x$F@tA>b^JR7J<*bC7|HTp!g*5{MiFvPTi{)hSpCi(Y{;j-gI P00000NkvXXu0mjfkYy)J literal 0 HcmV?d00001 From e364325b4975c90dd678ac983c88618b9440f2ba Mon Sep 17 00:00:00 2001 From: Hans Oischinger Date: Fri, 23 Aug 2019 09:18:44 +0200 Subject: [PATCH 03/10] Update vicare.markdown More documentation on services --- source/_components/vicare.markdown | 77 ++++++++++++++++++++++++------ 1 file changed, 62 insertions(+), 15 deletions(-) diff --git a/source/_components/vicare.markdown b/source/_components/vicare.markdown index 6df57e1492ed..085a7ee9cf7c 100644 --- a/source/_components/vicare.markdown +++ b/source/_components/vicare.markdown @@ -3,12 +3,12 @@ title: "Viessmann climate controller" description: "Instructions how to integrate Viessmann heating devices with Home Assistant" logo: viessmann.png ha_category: Climate -ha_release: 0.97 +ha_release: 0.99 ha_iot_class: Cloud Push --- The `ViCare` climate platform lets you control [Viessmann](https://www.viessmann.com) devices via the ViCare cloud. -All Viessmann gas boilers with WiFi or Ethernet connection should be supported. +All Viessmann heating devices (e.g. gas boilers) th WiFi or Ethernet connection should be supported. ## Configuration @@ -17,8 +17,8 @@ To set it up, add the following information to your `configuration.yaml` file: ```yaml climate: - platform: vicare - username: [VICARE_EMAIL] - password: [VICARE_PASSWORD] + username: VICARE_EMAIL + password: VICARE_PASSWORD ``` {% configuration %} @@ -30,23 +30,70 @@ password: description: Your password for the ViCare App required: true type: string +circuit: + description: Heating circuit of your heating device if multiple exist + required: false + default: defaults to the first heating circuit of your installation + type: integer {% endconfiguration %} This component opens a TCP connection with the ViCare API to receive temperature and status updates, and to issue commands. -Two climate components will be created: climate.vicare_heating and climate.vicare_water (for domestic hot water). +Two climate components will be created: `climate.vicare_heating` and `climate.vicare_water` (for domestic hot water). -The climate.vicare_heating component has the following mapping of hvac modes to Viessmann operation modes: - - HVAC_OFF - ForcedReduced - - HVAC_AUTO - DHWandHeating - - HVAC_HEAT - ForcedNormal -The presets eco and comfort are a 1:1 mapping to the respective Viessmann programs. +It is not possible to turn on/off water heating via the climate.vicare_water component since this would conflict with the operation modes of the heating component. Therefore the hvac modes of that component are *information only* and only the temperature can be set. -It is not possible to turn on/off water heating via the climate.vicare_water component since this would conflict with the operation modes of the heating component. Therefore the hvac modes are *information only* and only the temperature can be set. +## Supported services `climate.vicare_heating` -### Supported services +The following services of the [Climate component](/components/climate/) are provided by the Vicare Thermostat: `set_temperature`, `set_hvac_mode`, `set_preset_mode` + +### Service `set_temperature` + +Sets the target temperature to the given temperature. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. +| `temperature` | no | Desired target temperature + +Note that `set_temperature` will always affect the current normal temperature or, if a preset is set, the temperature of the preset (i.e. Viessman program like eco or comfort). + +### Service `climate.set_hvac_mode` + +Set HVAC mode for the climate device. The following modes are supported: + +The `climate.vicare_heating` component has the following mapping of hvac modes to Viessmann operation modes: +| HVAC mode | Viessmann mode | Description | +| ---------------------- | -------- | ----------- | +| `off` | `ForcedReduced` | Permanently set heating to reduced temperature. Note: This will also deactivate domestic hot water +| `heat` | `ForcedNormal` | Permanently set heating to normal temperature. +| `auto` | `DHWandHeating` | Switches between reduced and normal temperature as by the heating schedule programmed in your device + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. +| `hvac_mode` | no | New value of HVAC mode + +### Service `set_preset_mode` + +Sets the preset mode. Supported preset modes are *eco* and *comfort*. These are identical to the respective Viessmann programs and are only temporary. Please consult your heating device manual for more information. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. +| `hold_mode` | no | New value of hold mode. + +## Supported services `climate.vicare_water` + +The following services of the [Climate component](/components/climate/) are provided by the Vicare Thermostat: `set_temperature` + +### Service `set_temperature` + +Sets the target temperature of domestic hot water to the given temperature. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. +| `temperature` | no | Desired target temperature -Available services: -- `climate.set_temperature` -- `climate.set_hvac_mode` From 5a6a832c25ab6719a248e26572195bc34d3e919f Mon Sep 17 00:00:00 2001 From: Hans Oischinger Date: Fri, 23 Aug 2019 20:57:52 +0200 Subject: [PATCH 04/10] Update vicare.markdown Added missing configuration parameter. Thanks @klaasnicolaas --- source/_components/vicare.markdown | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/source/_components/vicare.markdown b/source/_components/vicare.markdown index 085a7ee9cf7c..9383b15e5342 100644 --- a/source/_components/vicare.markdown +++ b/source/_components/vicare.markdown @@ -30,16 +30,22 @@ password: description: Your password for the ViCare App required: true type: string +name: + description: The friendly_name for the climate devices, will be appended with *Heating* or *Water* + required: false + default: ViCare + type: string circuit: description: Heating circuit of your heating device if multiple exist required: false - default: defaults to the first heating circuit of your installation + default: -1 type: integer {% endconfiguration %} This component opens a TCP connection with the ViCare API to receive temperature and status updates, and to issue commands. Two climate components will be created: `climate.vicare_heating` and `climate.vicare_water` (for domestic hot water). +Unless you specify a `circuit` parameter it will pick up the first heating circuit of your installation. It is not possible to turn on/off water heating via the climate.vicare_water component since this would conflict with the operation modes of the heating component. Therefore the hvac modes of that component are *information only* and only the temperature can be set. From 795b2d5f23bbd167ba1614720558897c7f43c08e Mon Sep 17 00:00:00 2001 From: Hans Oischinger Date: Mon, 2 Sep 2019 18:11:01 +0200 Subject: [PATCH 05/10] Document Water Heater component --- source/_components/vicare.markdown | 49 +++++++++++++++++------------- 1 file changed, 28 insertions(+), 21 deletions(-) diff --git a/source/_components/vicare.markdown b/source/_components/vicare.markdown index 9383b15e5342..74723077d10c 100644 --- a/source/_components/vicare.markdown +++ b/source/_components/vicare.markdown @@ -7,18 +7,22 @@ ha_release: 0.99 ha_iot_class: Cloud Push --- -The `ViCare` climate platform lets you control [Viessmann](https://www.viessmann.com) devices via the ViCare cloud. -All Viessmann heating devices (e.g. gas boilers) th WiFi or Ethernet connection should be supported. +The `ViCare` integration lets you control [Viessmann](https://www.viessmann.com) devices via the Viessmann ViCare (REST) API. +Most recent network-connected Viessmann heating devices (e.g. gas boilers) should be supported. + +There is currently support for the following device types within Home Assistant: + +- Climate (Heating) +- Water Heater (Domestic Hot Water) ## Configuration To set it up, add the following information to your `configuration.yaml` file: ```yaml -climate: - - platform: vicare - username: VICARE_EMAIL - password: VICARE_PASSWORD +vicare: + username: VICARE_EMAIL + password: VICARE_PASSWORD ``` {% configuration %} @@ -31,7 +35,7 @@ password: required: true type: string name: - description: The friendly_name for the climate devices, will be appended with *Heating* or *Water* + description: The friendly_name of the device (will be appended with *Heating* or *Water*) required: false default: ViCare type: string @@ -42,18 +46,17 @@ circuit: type: integer {% endconfiguration %} -This component opens a TCP connection with the ViCare API to receive temperature and status updates, and to issue commands. - -Two climate components will be created: `climate.vicare_heating` and `climate.vicare_water` (for domestic hot water). +Two components will be created: `climate.vicare_heating` and `water_heater.vicare_water` (for domestic hot water). Unless you specify a `circuit` parameter it will pick up the first heating circuit of your installation. -It is not possible to turn on/off water heating via the climate.vicare_water component since this would conflict with the operation modes of the heating component. Therefore the hvac modes of that component are *information only* and only the temperature can be set. +## Climate +A note about the current temperature attribute: Viessmann devices with room temperature sensing will shown the current room temperature via `current_temperature`. All other devices will show the current supply temperature of the heating circuit. -## Supported services `climate.vicare_heating` +### Supported services `climate.vicare_heating` -The following services of the [Climate component](/components/climate/) are provided by the Vicare Thermostat: `set_temperature`, `set_hvac_mode`, `set_preset_mode` +The following services of the [Climate component](/components/climate/) are provided by the ViCare integration: `set_temperature`, `set_hvac_mode`, `set_preset_mode` -### Service `set_temperature` +#### Service `set_temperature` Sets the target temperature to the given temperature. @@ -64,7 +67,7 @@ Sets the target temperature to the given temperature. Note that `set_temperature` will always affect the current normal temperature or, if a preset is set, the temperature of the preset (i.e. Viessman program like eco or comfort). -### Service `climate.set_hvac_mode` +#### Service `climate.set_hvac_mode` Set HVAC mode for the climate device. The following modes are supported: @@ -80,7 +83,7 @@ The `climate.vicare_heating` component has the following mapping of hvac modes t | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `hvac_mode` | no | New value of HVAC mode -### Service `set_preset_mode` +#### Service `set_preset_mode` Sets the preset mode. Supported preset modes are *eco* and *comfort*. These are identical to the respective Viessmann programs and are only temporary. Please consult your heating device manual for more information. @@ -89,17 +92,21 @@ Sets the preset mode. Supported preset modes are *eco* and *comfort*. These are | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `hold_mode` | no | New value of hold mode. -## Supported services `climate.vicare_water` +## Water Heater + +It is not possible to turn on/off water heating via the Water Heater component since this would conflict with the operation modes of the heating component. Therefore the operation mode of that component is just available as an attribute and cannot be modified. -The following services of the [Climate component](/components/climate/) are provided by the Vicare Thermostat: `set_temperature` +### Supported services `water_heater.vicare_water` -### Service `set_temperature` +The following services of the [Water Heater component](/components/water_heater/) are provided by the ViCare integration: `set_temperature` + +##### Service `set_temperature` Sets the target temperature of domestic hot water to the given temperature. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | -| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. -| `temperature` | no | Desired target temperature +| `entity_id` | yes | String or list of strings that point at `entity_id`'s of water heater devices to control. Else targets all. +| `temperature` | no | New target temperature for water heater From f1887c713a07e4acdf261c37c855b758e6703dd3 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Mon, 2 Sep 2019 18:26:03 +0200 Subject: [PATCH 06/10] :pencil2: Tweak --- source/_components/vicare.markdown | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/source/_components/vicare.markdown b/source/_components/vicare.markdown index 74723077d10c..34c1f09a08d6 100644 --- a/source/_components/vicare.markdown +++ b/source/_components/vicare.markdown @@ -12,8 +12,8 @@ Most recent network-connected Viessmann heating devices (e.g. gas boilers) shoul There is currently support for the following device types within Home Assistant: -- Climate (Heating) -- Water Heater (Domestic Hot Water) +- [Climate](#climate) (Heating) +- [Water Heater](#water-heater) (Domestic Hot Water) ## Configuration @@ -50,6 +50,7 @@ Two components will be created: `climate.vicare_heating` and `water_heater.vicar Unless you specify a `circuit` parameter it will pick up the first heating circuit of your installation. ## Climate + A note about the current temperature attribute: Viessmann devices with room temperature sensing will shown the current room temperature via `current_temperature`. All other devices will show the current supply temperature of the heating circuit. ### Supported services `climate.vicare_heating` From 821341baa6d234f4fb5e8d2b2c601448d1d024e1 Mon Sep 17 00:00:00 2001 From: Hans Oischinger Date: Fri, 6 Sep 2019 22:48:11 +0200 Subject: [PATCH 07/10] Apply suggestions from code review Co-Authored-By: Martin Hjelmare --- source/_components/vicare.markdown | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/_components/vicare.markdown b/source/_components/vicare.markdown index 34c1f09a08d6..99f608f5fa8d 100644 --- a/source/_components/vicare.markdown +++ b/source/_components/vicare.markdown @@ -4,7 +4,7 @@ description: "Instructions how to integrate Viessmann heating devices with Home logo: viessmann.png ha_category: Climate ha_release: 0.99 -ha_iot_class: Cloud Push +ha_iot_class: Cloud Polling --- The `ViCare` integration lets you control [Viessmann](https://www.viessmann.com) devices via the Viessmann ViCare (REST) API. @@ -51,7 +51,7 @@ Unless you specify a `circuit` parameter it will pick up the first heating circu ## Climate -A note about the current temperature attribute: Viessmann devices with room temperature sensing will shown the current room temperature via `current_temperature`. All other devices will show the current supply temperature of the heating circuit. +A note about the current temperature attribute: Viessmann devices with room temperature sensing will show the current room temperature via `current_temperature`. All other devices will show the current supply temperature of the heating circuit. ### Supported services `climate.vicare_heating` @@ -91,7 +91,7 @@ Sets the preset mode. Supported preset modes are *eco* and *comfort*. These are | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. -| `hold_mode` | no | New value of hold mode. +| `preset_mode` | no | New value of hold mode. ## Water Heater From 780254804bc242f6d016e13a6283e5ef1604d381 Mon Sep 17 00:00:00 2001 From: Hans Oischinger Date: Fri, 6 Sep 2019 22:51:59 +0200 Subject: [PATCH 08/10] Mention all keyword in service calls --- source/_components/vicare.markdown | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/source/_components/vicare.markdown b/source/_components/vicare.markdown index 99f608f5fa8d..424c81ac07f8 100644 --- a/source/_components/vicare.markdown +++ b/source/_components/vicare.markdown @@ -42,7 +42,6 @@ name: circuit: description: Heating circuit of your heating device if multiple exist required: false - default: -1 type: integer {% endconfiguration %} @@ -63,7 +62,7 @@ Sets the target temperature to the given temperature. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | -| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. +| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. To target all entities, use `all` keyword instead of entity_id. | `temperature` | no | Desired target temperature Note that `set_temperature` will always affect the current normal temperature or, if a preset is set, the temperature of the preset (i.e. Viessman program like eco or comfort). @@ -81,7 +80,7 @@ The `climate.vicare_heating` component has the following mapping of hvac modes t | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | -| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. +| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. To target all entities, use `all` keyword instead of entity_id. | `hvac_mode` | no | New value of HVAC mode #### Service `set_preset_mode` @@ -90,7 +89,7 @@ Sets the preset mode. Supported preset modes are *eco* and *comfort*. These are | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | -| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. +| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. To target all entities, use `all` keyword instead of entity_id. | `preset_mode` | no | New value of hold mode. ## Water Heater From 5e3df4fbfd5e11208862f1d3134357a5fd100da3 Mon Sep 17 00:00:00 2001 From: Hans Oischinger Date: Fri, 6 Sep 2019 23:03:44 +0200 Subject: [PATCH 09/10] Add missing all keyword reference --- source/_components/vicare.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/vicare.markdown b/source/_components/vicare.markdown index 424c81ac07f8..bcd7b84d6ddb 100644 --- a/source/_components/vicare.markdown +++ b/source/_components/vicare.markdown @@ -106,7 +106,7 @@ Sets the target temperature of domestic hot water to the given temperature. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | -| `entity_id` | yes | String or list of strings that point at `entity_id`'s of water heater devices to control. Else targets all. +| `entity_id` | yes | String or list of strings that point at `entity_id`'s of water heater devices to control. To target all entities, use `all` keyword instead of entity_id. | `temperature` | no | New target temperature for water heater From 46ae9e45a7ca1c6dbbccc6cc31e14c21a3c99148 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Sat, 7 Sep 2019 22:01:54 +0200 Subject: [PATCH 10/10] :pencil2: Tweaks --- source/_components/vicare.markdown | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/source/_components/vicare.markdown b/source/_components/vicare.markdown index bcd7b84d6ddb..f01f51402825 100644 --- a/source/_components/vicare.markdown +++ b/source/_components/vicare.markdown @@ -8,7 +8,7 @@ ha_iot_class: Cloud Polling --- The `ViCare` integration lets you control [Viessmann](https://www.viessmann.com) devices via the Viessmann ViCare (REST) API. -Most recent network-connected Viessmann heating devices (e.g. gas boilers) should be supported. +Most recent network-connected Viessmann heating devices (e.g., gas boilers) should be supported. There is currently support for the following device types within Home Assistant: @@ -46,7 +46,7 @@ circuit: {% endconfiguration %} Two components will be created: `climate.vicare_heating` and `water_heater.vicare_water` (for domestic hot water). -Unless you specify a `circuit` parameter it will pick up the first heating circuit of your installation. +Unless you specify a `circuit` parameter, it will pick up the first heating circuit of your installation. ## Climate @@ -65,13 +65,14 @@ Sets the target temperature to the given temperature. | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. To target all entities, use `all` keyword instead of entity_id. | `temperature` | no | Desired target temperature -Note that `set_temperature` will always affect the current normal temperature or, if a preset is set, the temperature of the preset (i.e. Viessman program like eco or comfort). +Note that `set_temperature` will always affect the current normal temperature or, if a preset is set, the temperature of the preset (i.e., Viessman program like eco or comfort). #### Service `climate.set_hvac_mode` Set HVAC mode for the climate device. The following modes are supported: -The `climate.vicare_heating` component has the following mapping of hvac modes to Viessmann operation modes: +The `climate.vicare_heating` component has the following mapping of HVAC modes to Viessmann operation modes: + | HVAC mode | Viessmann mode | Description | | ---------------------- | -------- | ----------- | | `off` | `ForcedReduced` | Permanently set heating to reduced temperature. Note: This will also deactivate domestic hot water @@ -100,7 +101,7 @@ It is not possible to turn on/off water heating via the Water Heater component s The following services of the [Water Heater component](/components/water_heater/) are provided by the ViCare integration: `set_temperature` -##### Service `set_temperature` +#### Service `set_temperature` Sets the target temperature of domestic hot water to the given temperature.