Viessmann Component

crazyfx1 · March 23, 2020, 8:45pm

They are sent directly to the API.

oischinger · March 24, 2020, 8:40pm

I have uploaded a new custom component which makes use of PyViCare 0.1.10 which reduces the number of API requests towards the Viessmann services (thanks @crazyfx1 !).

Now you can set a scan_interval parameter to whatever suits your needs. The default value is 60 seconds.

Let’s see how it holds up.

crazyfx1 · March 25, 2020, 6:58am

Nice work. I will try it out as soon as my daily ban is expired

Tommmii · March 25, 2020, 9:26am

guys…could some-one please give detailed instructions how to get the custom_component installed & active ?
And, after installation - is there a way to verify that HA is actually using the custom instead of the normal integration ?

stefanwi · March 25, 2020, 10:57am

Things that I did (have installed HA in Python venv on my raspi 4 4GB):

Updating PyViCare to 0.1.10:
Login via shell then change user to homeassistant, and enter Python venv:

sudo -u homeassistant -H -s
cd /srv/homeassistant
source bin/activate

Now update PyViCare:

pip3 install --upgrade PyViCare
exit

Now clone ha_vicare custom component (https://github.com/oischinger/ha_vicare) from git:

cd ~
sudo git clone https://github.com/oischinger/ha_vicare.git

Now move downloaded folder into homeassistant custom component folder:

mv ha_vicare/vicare /home/homeassistant/.homeassistant/custom_components

Then restart HA and it will automatically choose the custom component instead of the official.

@oischinger: I saw, that SCAN_INTERVAL = 900 secs. which was introduced 8 days ago, is still alive in code. Is that correct? I thought, that from version 0.1.10, PyViCare will manage that the Viessmann api will not be fired with requests. Thanks for a short statement.

oischinger · March 25, 2020, 10:57am

@Tommmii
Installing it is super-simple: Just download the files in here: https://github.com/oischinger/ha_vicare/tree/master/vicare and put them under HOME_ASSISTANT_CONFIG_DIR/custom_components/vicare

On startup you will get a log entry in Home Assistant that vicare is a custom component and might not have been tested, etc.
You will also notice it because the update frequency of the ViCare data is higher if you plot it on a graoh

oischinger · March 25, 2020, 11:00am

Thanks for the hint with the SCAN_INTERVAL=900. I fixed that now on master.

Note that you should not have to manually update to pyvicare 0.1.10. In my case Home assistent did that for me because I added it to manifest.json

stefanwi · March 25, 2020, 11:09am

Ah okay, thanks for information. I didn’t knew, that HA will update to version concerning manifest.json

Tommmii · March 25, 2020, 11:28am

Is adding vicare: to the yaml configuration needed, or is the custom component added via the Integrations page ?

Tommmii · March 25, 2020, 11:50am

well, something isn’t working as expected, values don’t update.

➜  vicare pwd
/config/custom_components/vicare
➜  vicare ls -lha
total 44K    
drwxr-xr-x    3 root     root        4.0K Mar 25 11:21 .
drwxr-xr-x    3 root     root        4.0K Mar 25 10:17 ..
-rw-r--r--    1 root     root          17 Mar 24 21:38 .gitignore
-rw-r--r--    1 root     root        2.7K Mar 24 21:38 __init__.py
drwxr-xr-x    2 root     root        4.0K Mar 25 11:21 __pycache__
-rw-r--r--    1 root     root       11.5K Mar 24 21:38 climate.py
-rw-r--r--    1 root     root         222 Mar 24 21:38 manifest.json
-rw-r--r--    1 root     root        5.9K Mar 24 21:38 water_heater.py
➜  vicare 
➜  vicare ha core restart & tail -f /config/home-assistant.log
[1] 1047
⣾ Processing... 
⣯ Processing... 2020-03-25 12:40:35 WARNING (MainThread) [homeassistant.loader] You are using a custom integration for vicare which has not been tested by Home Assistant. This component might cause stability problems, be sure to disable it if you experience issues with Home Assistant.
⣯ Processing... 2020-03-25 12:40:53 ERROR (MainThread) [homeassistant.helpers.entity] Update for sensor.vicare_heatcurve_target_temperature fails
Traceback (most recent call last):
  File "/usr/src/homeassistant/homeassistant/helpers/entity.py", line 279, in async_update_ha_state
    await self.async_device_update()
  File "/usr/src/homeassistant/homeassistant/helpers/entity.py", line 474, in async_device_update
    await self.async_update()
  File "/usr/src/homeassistant/homeassistant/components/template/sensor.py", line 224, in async_update
    self._state = self._template.async_render()
  File "/usr/src/homeassistant/homeassistant/helpers/template.py", line 221, in async_render
    return compiled.render(kwargs).strip()
  File "/usr/local/lib/python3.7/site-packages/jinja2/environment.py", line 1090, in render
    self.environment.handle_exception()
  File "/usr/local/lib/python3.7/site-packages/jinja2/environment.py", line 832, in handle_exception
    reraise(*rewrite_traceback_stack(source=source))
  File "/usr/local/lib/python3.7/site-packages/jinja2/_compat.py", line 28, in reraise
    raise value.with_traceback(tb)
  File "<template>", line 1, in top-level template code
TypeError: unsupported operand type(s) for +: 'NoneType' and 'NoneType'
Processing... Done.
Command completed successfully.

[1]  + 1047 done       ha core restart

My yaml config :

vicare:
  username: !secret vicare_email
  password: !secret vicare_password
  heating_type: gas
  scan_interval: 60

oischinger · March 25, 2020, 12:41pm

This is a failure of a sensor that is not from my integration: sensor.vicare_heatcurve_target_temperature

Does the integration also fail?

Tommmii · March 25, 2020, 12:43pm

Yours didn’t refresh, but then I saw above that the 900s interval was still hardcoded.
Updated to the newer version, seems ok now.

I did get the sensor.vicare_heatcurve_target_temperature from you, indirectly :

oischinger · March 25, 2020, 12:57pm

The sensor.vicare_heatcurve_target_temperature seems to not cope well with None-values, which occur when there was no update from the servers yet.
The template can be written differently. Once I find some time I’ll upload some better yaml examples for monitoring with individual sensors.

Tommmii · March 26, 2020, 11:22am

So far so good, on the custom component, 24hours with scan_interval: 60 and no ban from VSMN.

stefanwi · March 26, 2020, 10:12pm

Same here. Works good so far…

oischinger · March 27, 2020, 7:31pm

I created a PR towards the next home assistant release. So expect this to be integrated soon.

I also documented the scan_interval feature explaining a little bit Viessman’s rate limits and the consequences here:

github.com

home-assistant/home-assistant.io/blob/36b2422aa1aae5911c3439809583a49f6742bbc8/source/_integrations/vicare.markdown#viessmann-api-limits

---
title: Viessmann ViCare
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
ha_codeowners:
  - '@oischinger'
ha_domain: vicare
---

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)

This file has been truncated. show original

Tommmii · March 28, 2020, 9:54am

Good work , thank you !!

Just letting you know ; something went wrong with the formatting of the Configuration chapter on the Github docs page.

Sangoku · March 29, 2020, 2:43pm

I cant get the sensors to show up i used the config:

sensor:
 platform: template
 sensors:
   vicare_outside_temperature:
        friendly_name: "Vanjska Temperatura"
        unit_of_measurement: '°C'
        value_template: "{{ state_attr('climate.vicare_heating', 'outside_temperature') }}" 

   vicare_inside_temperature:
        friendly_name: "unutrasnja Temperatura"
        unit_of_measurement: '°C'
        value_template: "{{ state_attr('climate.vicare_heating', 'temperature') }}"

type is:
heating_type: heatpump

No logs, no errors just gets stuck on no data. Any idea what i could have done wrong?

Temparature display works without problems and heating pump also… so no idea what i am missing.

realfire · March 29, 2020, 4:56pm

I can just write you for vicare. They kicked me out (maybe you too ?)

4 weeks ago they wrote me an email that they will check the API IFC because to many calls -_- 1 week ago they said they gonna turn it down.

Tommmii · March 29, 2020, 7:59pm

we all got that email, no one got permanently banned. 24 hour ban is the max they handed out.

@Sangoku , do you have the vicare: integration configured ?