Plugwise Anna integration start error

[w2cker]

Home Assistant release with the issue:
0.98.4

Last working Home Assistant release (if known):
unknown

Operating environment (Hass.io/Docker/Windows/etc.):
hass.io

Component/platform:
https://www.home-assistant.io/components/plugwise/

Description of problem:
The new plugwise component for the Anna thermostat wont load. I have a Anna running version 3.x firmware. The is a difference in xml output between 2.x and 3.x firmware. Is the component developed for the 2x firmware?

Problem-relevant configuration.yaml entries and (fill out even if it seems unimportant):

climate:
  - platform: plugwise
    password: ********
    host: 10.0.0.***
    port: 80
    min_temp: 10
    max_temp: 23

Traceback (if applicable):

2019-09-08 16:17:08 ERROR (MainThread) [homeassistant.core] Error doing job: Task exception was never retrieved
Traceback (most recent call last):
  File "/usr/src/homeassistant/homeassistant/helpers/entity.py", line 266, in async_update_ha_state
    self._async_write_ha_state()
  File "/usr/src/homeassistant/homeassistant/helpers/entity.py", line 307, in _async_write_ha_state
    attr.update(self.state_attributes or {})
  File "/usr/src/homeassistant/homeassistant/components/climate/__init__.py", line 246, in state_attributes
    data[ATTR_PRESET_MODES] = self.preset_modes
  File "/usr/src/homeassistant/homeassistant/components/plugwise/climate.py", line 156, in preset_modes
    presets = list(self._api.get_presets(self._domain_objects))
  File "/usr/local/lib/python3.7/site-packages/haanna/haanna.py", line 66, in get_presets
    raise RuleIdNotFoundException("Could not find the rule id.")
haanna.haanna.RuleIdNotFoundException: Could not find the rule id.

Additional information:

[probot-home-assistant]

Hey there @laetificat, @CoMPaTech, mind taking a look at this issue as its been labeled with a integration (plugwise) you are listed as a codeowner for? Thanks!

[CoMPaTech]

Hi @w2cker,

The code was developed using 3.x and 1.8-ish? firmware using various contributions (see http://github.com/laetificat/anna-ha/). I'm actually on 3.1.8 according to the mobile app.

W.r.t. the problem: If you look at http://10.0.0.***/core/domain_objects using a web-browser can you (ctrl-f) find something like the below? That is what is actually missing (and why it complains)

        <rule id='88ada********'>
                <name>Thermostat presets</name>
                <description>Provides presets for a Location.</description>
                <template id="1b027c******" tag="zone_setpoint_and_state_based_on_preset"/>
                <active>true</active>
                **** snip *****
                <directives>
                        <when preset="home"><then setpoint="**"/></when>
                        <when preset="vacation"><then setpoint="**"/></when>
                        <when preset="no_frost"><then setpoint="**"/></when>
                        <when preset="asleep"><then setpoint="**"/></when>
                        <when preset="away"><then setpoint="**"/></when>
                </directives>

If you can't find that would you mind sharing the (xml) output of your smile? (http://10.0.0.***/core/domain_objects)

[w2cker]

Here is my preset, it does not have a name. Can that be the problem?:

	<rule id="07db9804adc5402da9197df17f8f7f1b">
		<name/>
		<description/>
		<template id="f37a3c361adf4f609c8d52d529d58c8a" tag="zone_setpoint_and_state_based_on_preset"/>
		<active>true</active>
		<created_date>2019-01-28T08:37:58.635+01:00</created_date>
		<modified_date>2019-01-28T08:37:59.699+01:00</modified_date>
		<deleted_date/>
		<directives>
			<when preset="no_frost"><then setpoint="10"/></when>
			<when preset="home"><then setpoint="20"/></when>
			<when preset="asleep"><then setpoint="15"/></when>
			<when preset="away"><then setpoint="17"/></when>
			<when preset="vacation"><then setpoint="15"/></when>
		</directives>
		<contexts>
			<context>
				<zone><location id="8d701daa1b1242999cde522b208ea035"/></zone>
			</context>
		</contexts>
	</rule>

[CoMPaTech]

Hmmm, wondering how/why it doesn't, even so it could be something thats user changeable then. At first thought I was thinking we might need to change searching from name to the tag being zone_setpoint_and_state_based_on_preset but then found that there is actually two.

Just for clarification, could you check if you have that in your XML? (ctrl-f for zone_setpoint_and_state_based_on_preset)?

For me the other one was right above it like shown below (and the template-id top-xml matches the referred template-id in the rule). Even so I think we should adjust the code to look for 'rule with template tag zone_setpoint_and_state_based_on_preset that is active, that should prevent it altogether, let me see if I can get that to work (that will be tomorrow though in all honesty). I'll cross-reference this in the haanna repo to track progress as well.

<template id="1b*****" tag="zone_setpoint_and_state_based_on_preset">
<name>Zone temperature/state schedule template</name>
<description>...</description>
<single_actor>true</single_actor>
<created_date>2019-01-31T12:18:31.874+01:00</created_date>
<modified_date>2019-08-30T05:22:08.425+02:00</modified_date>
<deleted_date/>
<objects>...</objects>
<parameters>...</parameters>
<results>...</results>
</template>
<rule id="88*****">
<name>Thermostat presets</name>
<description>Provides presets for a Location.</description>
<template id="1b*****" tag="zone_setpoint_and_state_based_on_preset"/>
<active>true</active>
<created_date>2019-04-23T20:32:39.223+02:00</created_date>
<modified_date>2019-04-24T21:12:42.545+02:00</modified_date>
<deleted_date/>
<directives>...</directives>
<contexts>...</contexts>
</rule>

[w2cker]

Thank you for your effort. I have 2 times the zone_setpoint_and_state_based_on_preset. Below is the second one. I also tried to change the name in the Anna gui, but cannot find an option to do that

	<template id="f37a3c361adf4f609c8d52d529d58c8a" tag="zone_setpoint_and_state_based_on_preset">
		<name>Zone temperature/state schedule template</name>
		<description>Template for actuating thermostats and relays on a preset basis.</description>
		<single_actor>true</single_actor>
		<created_date>2019-01-28T08:37:58.063+01:00</created_date>
		<modified_date>2019-09-09T05:38:28.274+02:00</modified_date>
		<deleted_date/>
		<objects>
			<object name="zone" type="Location"/>
		</objects>
		<parameters>
			<parameter name="preset" source="zone.preset" type="Preset"/>
		</parameters>
		<results>
			<result name="state" type="OnOff" action="zone.iterateFunctionalities('RelayFunctionality')().state = state"/>
			<result name="setpoint" type="Number" action="zone.iterateFunctionalities('ThermostatFunctionality')().setpoint = setpoint"/>
			<result name="domestic_hot_water_state" type="OnOff" action="zone.iterateFunctionalities('ToggleFunctionality', 'domestic_hot_water_state')().state = domestic_hot_water_state"/>
		</results>
	</template>

[CoMPaTech]

Thanks for reporting, highly appreciated!

Fix is prepped, so unless you want to tinker with it yourself I'm waiting for it to be pushed through (I do have control over the GitHub repo, but no control over uploading to PyPI :( ). Once that has completed we can ask HA to change the dependency to the new module.

If you are able to fix the in-place files it can be done quicker than included in the mentioned PR.
Just change the hanna.py code somewhere near line 62 to the below (where it now says get_rule_id_by_name but don't forget to also append the [0] :)

            rule_id = self.get_rule_id_by_template_tag(root,
                                                       'zone_setpoint_and_state_based_on_preset')[0]

[bouwew]

@CoMPaTech
This can be tested by you implementing the changes in the master-branch plus the version-bump and then w2cker can test this by changing the requirements-line in manifest.json to:
"requirements": ["https://github.com/laetificat/haanna/archive/master.zip#haanna==0.10.2"]

[w2cker]

I will wait for the official HA update. Thanks for the assistance.

[bouwew]

@w2cker, I think we might have fixed the error that you have reported. But, I expect there will be other errors, or missing functionality, caused by the missing schedule-name. As you xml-data is clearly abnormal, after comparing it to other peoples Anna-xml-data.

You should be able to change the name in the Plugwise App:
on the main screen press the setup-button in the right-bottom corner,
press on the schedule-line below the " + Create new schedule", the schedule should open,
press the setup-button in the top-right of the screen,
now you should be able to change the name

If that doesn't work I would suggest a hard reset of your Anna by by temporarily disconnecting it from the Smile.

[w2cker]

I tried renaming the schedule, adding extra schedules, deleting schedults, unplugging Anna. It did not help. I still have the same error. Rule id not found.