diff --git a/source/_integrations/vicare.markdown b/source/_integrations/vicare.markdown index 6d7cf2d7385..6d521a5e6be 100644 --- a/source/_integrations/vicare.markdown +++ b/source/_integrations/vicare.markdown @@ -6,6 +6,7 @@ ha_release: 0.99 ha_iot_class: Cloud Polling ha_codeowners: - '@oischinger' +ha_config_flow: true ha_domain: vicare ha_platforms: - binary_sensor @@ -23,18 +24,10 @@ There is currently support for the following device types within Home Assistant: - [Water Heater](#water-heater) (Domestic Hot Water) - [Sensor](#sensor) (Sensor) -## Configuration +{% include integrations/config_flow.md %} -To set it up, add the following information to your `configuration.yaml` file: - -```yaml -vicare: - username: VICARE_EMAIL - password: VICARE_PASSWORD - client_id: VICARE_CLIENT_ID -``` - -The above-required configuration parameters can be obtained as follows: +Set `username`and `password` to your Viessmann Developer Portal login credentials. +The required Client ID can be obtained as follows: 1. Register and login in the [Viessmann Developer Portal](https://developer.viessmann.com). 2. In the menu navigate to API Keys. 3. Create a new OAuth client using the following data: @@ -43,39 +36,6 @@ The above-required configuration parameters can be obtained as follows: Google reCAPTCHA: Disabled Redirect URIs: vicare://oauth-callback/everest ``` -4. Copy the Client ID to the configuration, e.g., `client_id: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"`. -5. Set `username`and `password` to your Viessmann Developer Portal login credentials. - - -{% configuration %} -username: - description: Your username for the Viessmann developer portal - required: true - type: string -password: - description: Your password for the Viessmann developer portal - required: true - type: string -client_id: - description: Your API key from the Viessmann developer portal - 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 -heating_type: - description: One of `generic`, `gas`, `heatpump` or `fuelcell`. Specifying the heating_type provides additional attributes and sensors specific for the heating system. - required: false - type: string - default: generic -scan_interval: - description: The update frequency of this component in seconds. See [Viessmann API limits](#viessmann-api-limits) - default: 60 - required: false - type: integer -{% endconfiguration %} Multiple device instances might be generated depending on the number of burners and/or circuits of your installation. If there is more than a single instance all devices are suffixed with the circuit or burner ID.