-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Add ViCare component documentation #10211
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
09394ae
Create vicare.markdown
oischinger f0b22e2
Add viessmann.png for vicare component
oischinger e364325
Update vicare.markdown
oischinger 5a6a832
Update vicare.markdown
oischinger 795b2d5
Document Water Heater component
oischinger f1887c7
:pencil2: Tweak
klaasnicolaas 821341b
Apply suggestions from code review
oischinger 7802548
Mention all keyword in service calls
oischinger 5e3df4f
Add missing all keyword reference
oischinger 46ae9e4
:pencil2: Tweaks
frenck File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| --- | ||
| title: "Viessmann climate controller" | ||
| description: "Instructions how to integrate Viessmann heating devices with Home Assistant" | ||
| logo: viessmann.png | ||
| ha_category: Climate | ||
| ha_release: 0.99 | ||
| 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. | ||
|
|
||
| There is currently support for the following device types within Home Assistant: | ||
|
|
||
| - [Climate](#climate) (Heating) | ||
| - [Water Heater](#water-heater) (Domestic Hot Water) | ||
|
|
||
| ## Configuration | ||
|
|
||
| To set it up, add the following information to your `configuration.yaml` file: | ||
|
|
||
| ```yaml | ||
| 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 | ||
| name: | ||
| description: The friendly_name of the device (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 | ||
| type: integer | ||
| {% 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. | ||
|
|
||
| ## Climate | ||
|
|
||
| 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` | ||
|
|
||
| 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` | ||
|
|
||
| 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. 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). | ||
|
|
||
| #### 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. To target all entities, use `all` keyword instead of entity_id. | ||
| | `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. To target all entities, use `all` keyword instead of entity_id. | ||
| | `preset_mode` | no | New value of hold mode. | ||
|
|
||
| ## 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. | ||
|
|
||
| ### Supported services `water_heater.vicare_water` | ||
|
|
||
| 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 water heater devices to control. To target all entities, use `all` keyword instead of entity_id. | ||
| | `temperature` | no | New target temperature for water heater | ||
|
|
||
|
|
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.