Feature request: Add dishwasher warnings

[martkopecky]

Please add dishwasher warnings like:

• Machine clean recommended
• Salt supply running low
• Rinse aid supply running low

[ekutner]

I don't believe these are made available by the API. The mobile app is using a different, undocumented API, that is also able to talk directly to the appliances on the local network. Unless they document it it can't be done.

[hondzik]

Hi.
there are events Dishcare.Dishwasher.Event.SaltNearlyEmpty and Dishcare.Dishwasher.Event.RinseAidNearlyEmpty:
https://api-docs.home-connect.com/events?#availability-matrix

[tomeralgai]

Just adding my upvote for this feature. It would be fantastic to be able to use these options to send notifications to users in the kitchen when rinse aid needs to be added.

[bjkluft]

Question: How do I open this location (.storage\core.device_registry) from within HA?
I'm running it on a Raspberry with HA OS.

[kwbeck]

You can use the Samba Add-on to open that location from a remote device, but if you are just looking to find the device id, there is a simpler way.

Go to Developer Tools and select the Services tab, and then in the Service pull-down, select one of the Home Connect Alt services (like Home Connect Alt: Select program).

Then select your appliance from the device_id pull-down, and then click "GO TO YAML MODE" at the bottom left.

You'll see your device id there.

[bjkluft]

Thanks!

[tomeralgai]

@martkopecky am I missing something is there any way to know when the dishwasher asks to run the Machine Care cycle? I get the notification in the Home Connect app like for when Rinse Aid is low. Anyway to capture that info?

[kwbeck]

I don't believe that event is made available on the public API (unlike the Rinse Aid and Salt). The app uses a different non-public API.

You could try asking the API development team through the developer's website feedback/question thingy, however. I once asked them about a newer option on my dishwasher and they replied that it was in progress and they did eventually release it.

Ref Issue #257

[kwbeck]

For anyone interested, here's what I've done. Used these events to make a binary sensor that turns on and off with the "Present" and "Off" values of the StateEnumeration.

https://api-docs.home-connect.com/events/#event-present-state-enumeration

Caveat: The Home Assistant "state" of the binary sensor depends upon listening for the Dishcare.Dishwasher.Event.SaltNearlyEmpty and Dishcare.Dishwasher.Event.RinseAidNearlyEmpty events from the API, and therefore may not always be in sync if they aren't heard (e.g. if Home Assistant happened to be rebooting at the time the event happened), but it works well enough for my purposes. If one of them isn't cleared, I can always manually fire the "Off" event on the event bus.

EDIT: My original config did not reliably update the icons based on the state of the binary sensor, due to issues/limitations with trigger-based template sensors. This is referred to here: https://www.home-assistant.io/integrations/template

Trigger-based entities do not automatically update when states referenced in the templates change. This functionality can be added back by defining a state trigger for each entity that you want to trigger updates.

Here is the new version which properly updates the icons

- trigger:
  - platform: event
    event_type: home_connect_alt_event
    event_data:
        device_id: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        key: "Dishcare.Dishwasher.Event.RinseAidNearlyEmpty"
        value: "BSH.Common.EnumType.EventPresentState.Present" 
    id: "on"	
  - platform: state
    entity_id: binary_sensor.dishwasher_rinse_aid_nearly_empty
    to: "on"
  - platform: event
    event_type: home_connect_alt_event
    event_data:
        device_id: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        key: "Dishcare.Dishwasher.Event.RinseAidNearlyEmpty"
        value: "BSH.Common.EnumType.EventPresentState.Off" 
    id: "off"	
  - platform: state
    entity_id: binary_sensor.dishwasher_rinse_aid_nearly_empty
    to: "off"
  binary_sensor:
    - name: "Rinse Aid Nearly Empty"
      unique_id: binary_sensor.dishwasher_rinse_aid_nearly_empty
      state: "{{trigger.id}}"      
      icon: "{{ 'mdi:flask-empty-off-outline' if is_state('binary_sensor.dishwasher_rinse_aid_nearly_empty', 'on') else 'mdi:flask' }}" 

          
- trigger:
  - platform: event
    event_type: home_connect_alt_event
    event_data:
       device_id: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
       key: "Dishcare.Dishwasher.Event.SaltNearlyEmpty"
       value: "BSH.Common.EnumType.EventPresentState.Present" 
    id: "on"
  - platform: state
    entity_id: binary_sensor.dishwasher_salt_nearly_empty
    to: "on"	
  - platform: event
    event_type: home_connect_alt_event
    event_data:
       device_id: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
       key: "Dishcare.Dishwasher.Event.SaltNearlyEmpty"
       value: "BSH.Common.EnumType.EventPresentState.Off" 
    id: "off"
  - platform: state
    entity_id: binary_sensor.dishwasher_salt_nearly_empty
    to: "off"	
  binary_sensor:
    - name: "Salt Nearly Empty"
      unique_id: binary_sensor.dishwasher_salt_nearly_empty
      state: "{{trigger.id}}"     
      icon: "{{ 'mdi:octahedron-off' if is_state('binary_sensor.dishwasher_salt_nearly_empty', 'on') else 'mdi:octahedron' }}"    

[arifroni]

Do you how often the event is triggered? its been 24hrs, mine hasn't been triggered yet!

[kwbeck]

Hmmm, no idea how often it is actually triggered, but in every case where the app showed that rinse aid was needed, I have seen the event in HA. You can manually listen for it in Developer Tools--> Events--> Listen to Events. For example, the rinse aid event is "Dishcare.Dishwasher.Event.RinseAidNearlyEmpty".

[arifroni]

A noob question. To listen to a event i have listen to 'home_connect_alt_event', and look for event 'Dishcare.Dishwasher.Event.RinseAidNearlyEmpty', right? like this.

And i should see something when dishwasher publishes something, right?

[MaximumFish]

See this is the same problem I'm having (below). The event listener dev page, I believe, is just there to show the user what events are firing to help with creating automations and is only really useful if an event fires frequently or can be made to fire on demand. Once you leave the page or close your browser or whatever it stops listening. Seeing as this event is so infrequent - once every few weeks for me, I can't really leave my PC on and watching that event stream just to see what comes through.

... Although I do have a desktop VM always running. Maybe I can do it there. 🤔

Edit: Just to confirm that leaving a Webtop Docker instance running on the event listener page appears to be working. I can see events from the washes I've done over the last few days, so now I'm just waiting for a consumables event to fire - or not, as the case may be!

[MaximumFish]

I've been trying to get this working for a few months now (kinda hard to test due to needing to wait until the rinse aid runs out!) but I don't know what I'm doing wrong.

@martkopecky I set up an automation as per your suggestion, and even tested it by firing the event manually from the developer tools, but it still doesn't trigger when it's supposed to.

@kwbeck I also tried creating sensors as per your suggestion but when looking at the sensor's settings it says "This template does not listen for any events and will not update automatically", so I've obviously done something wrong there.

Usually when I write something to ask for help I get new ideas popping into my head that helps me to fix it myself, but this time I've had nothing! Anybody got any ideas?

[kwbeck]

Ah, I have had this problem with another template in the past. The issue is that while "regular" template binary sensors can (now) be created through the Helper/UI, trigger-based template binary sensors cannot. (Hopefully, this gets enabled in the future).

You have to create these in your configuration.yaml under the "template:" integration section. (Which you may have to manually create if you haven't already)

Should look like this in your configuration.yaml file.

(FYI, the icons I chose were just what looked good to me, but obviously those can be changed to anything of your liking.)

  - trigger:
      - platform: event
        event_type: home_connect_alt_event
        event_data:
          device_id: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
          key: "Dishcare.Dishwasher.Event.RinseAidNearlyEmpty"
          value: "BSH.Common.EnumType.EventPresentState.Present"
        id: "on"
      - platform: state
        entity_id: binary_sensor.dishwasher_rinse_aid_nearly_empty
        to: "on"
      - platform: event
        event_type: home_connect_alt_event
        event_data:
          device_id: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
          key: "Dishcare.Dishwasher.Event.RinseAidNearlyEmpty"
          value: "BSH.Common.EnumType.EventPresentState.Off"
        id: "off"
      - platform: state
        entity_id: binary_sensor.dishwasher_rinse_aid_nearly_empty
        to: "off"
    binary_sensor:
      - name: "Rinse Aid Nearly Empty"
        unique_id: binary_sensor.dishwasher_rinse_aid_nearly_empty
        state: "{{trigger.id}}"
        icon: "{{ 'mdi:flask-empty-off-outline' if is_state('binary_sensor.dishwasher_rinse_aid_nearly_empty', 'on') else 'mdi:flask' }}"

  - trigger:
      - platform: event
        event_type: home_connect_alt_event
        event_data:
          device_id: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
          key: "Dishcare.Dishwasher.Event.SaltNearlyEmpty"
          value: "BSH.Common.EnumType.EventPresentState.Present"
        id: "on"
      - platform: state
        entity_id: binary_sensor.dishwasher_salt_nearly_empty
        to: "on"
      - platform: event
        event_type: home_connect_alt_event
        event_data:
          device_id: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
          key: "Dishcare.Dishwasher.Event.SaltNearlyEmpty"
          value: "BSH.Common.EnumType.EventPresentState.Off"
        id: "off"
      - platform: state
        entity_id: binary_sensor.dishwasher_salt_nearly_empty
        to: "off"
    binary_sensor:
      - name: "Salt Nearly Empty"
        unique_id: binary_sensor.dishwasher_salt_nearly_empty
        state: "{{trigger.id}}"
        icon: "{{ 'mdi:octahedron-off' if is_state('binary_sensor.dishwasher_salt_nearly_empty', 'on') else 'mdi:octahedron' }}"

FYI, I believe it may also be possible to define the displayed (text) states of the sensor in the template, but I just ended up doing it in a Mushroom Template card because I wanted to define the colors as well to match my color coding scheme.

So these say "OK" when OK, and "Refill" when they need a refill.

They look like this:

primary: Salt
secondary: '{{ is_state(entity, ''on'') | iif(''Refill'',''OK'') }}'
icon: '{{ state_attr(entity, ''icon'') }}'
entity: binary_sensor.dishwasher_salt_nearly_empty
icon_color: '{{ is_state(entity, ''on'') | iif(''purple'',''blue'') }}'
layout: vertical
fill_container: true
tap_action:
  action: more-info

type: custom:mushroom-template-card
primary: Rinse Aid
secondary: '{{ is_state(entity, ''on'') | iif(''Refill'',''OK'') }}'
icon: '{{ state_attr(entity, ''icon'') }}'
entity: binary_sensor.dishwasher_rinse_aid_nearly_empty
icon_color: '{{ is_state(entity, ''on'') | iif(''purple'',''blue'') }}'
layout: vertical
tap_action:
  action: more-info

[MaximumFish]

Aha! I'd been searching for "dishwasher" but your screenshot gave me the idea to change the search term and there they are!

For some reason they've both ignored the unique_id statement, though now that I've typed it out I have a vague recollection of that functionality getting changed sometime last year...? Regardless, I used a UUID generator to give them actual unique IDs and that let me change the entity_id from within the UI.

Thanks a lot for your help! I've test fired them both using the developer tools, so now to see if they actually update when the dishwasher flags it...

[kwbeck]

Excellent news!

[MaximumFish]

Well, that didn't work either. My dishwasher says it's out of rinse aid and the template sensor is still off. Back to square one. 😔

[kwbeck]

Hmmm, just guessing here, but when you previously said "...change the entity_id from within the UI.", did you mean that you manually changed the entity id to "binary_sensor.rinse_aid_nearly_empty" (i.e. removed the word "dishwasher"? If so, that could be the problem if the template is still looking for the entity_id version with "dishwasher" in it. If you have updated the template to reflect the new entity_id, then not sure what it could be.

Does it still work when you test fire the event using the developer tools? If so, to which entity_id is the test fire directed?

[MaximumFish]

No, so this is my rinse aid template in configuration.yaml (note the UUID for unique_id. I needed to set this in order to be able to change the entity ID as mentioned above - setting the entity ID directly using the unique_id statement no longer works):

  - trigger:
      - platform: event
        event_type: home_connect_alt_event
        event_data:
          device_id: "93dd6fc02010f77a1179cec71018c07a"
          key: "Dishcare.Dishwasher.Event.RinseAidNearlyEmpty"
          value: "BSH.Common.EnumType.EventPresentState.Present"
        id: "on"
      - platform: state
        entity_id: binary_sensor.dishwasher_rinse_aid_nearly_empty
        to: "on"
      - platform: event
        event_type: home_connect_alt_event
        event_data:
          device_id: "93dd6fc02010f77a1179cec71018c07a"
          key: "Dishcare.Dishwasher.Event.RinseAidNearlyEmpty"
          value: "BSH.Common.EnumType.EventPresentState.Off"
        id: "off"
      - platform: state
        entity_id: binary_sensor.dishwasher_rinse_aid_nearly_empty
        to: "off"
    binary_sensor:
      - name: "Rinse aid nearly empty"
        unique_id: 84fde5a9-6f71-474e-82fd-92553adcc5f5
        state: "{{trigger.id}}"
        icon: "{{ 'mdi:flask-empty-off-outline' if is_state('binary_sensor.dishwasher_rinse_aid_nearly_empty', 'on') else 'mdi:flask' }}"

And then here's the entity in the UI where I manually set the entity ID to match the template:

It worked perfectly when I test fired it in the dev tools so I don't know what's going on. It feels to me like the event just isn't coming through on the backend but I don't know how I can confirm that (can we log these events somewhere?), and having just refilled the rinse aid it's going to be a few weeks until it fires again!

[MaximumFish]

Not sure which of the sub-threads is best to reply to so I'm going to make a new post...

After having a VM sat on the event watcher page for the past week-and-a-bit waiting for the rinse aid to run out, it finally did and I can confirm that the event is simply not firing for me. Every wash I get the same 5 events and that's it (see image).

I'm completely at a loss as to what I'm missing here. Looking through the Home Connect dev account options everything's enabled and appears to be setup properly. It's honestly driving me a bit mad! 😬

[ekutner]

I don't know why but different appliance models behave differently, I've seen it many times. I don't know about these specific events but it can certainly be that some models will publish the events and some won't. As far as the integration itself is concerned it doesn't know anything about any appliance model, or even type, it just publishes to the HA event bus whatever is coming from the API.
Pro tip: instead of listening for unknown events in the HA developer tools it's better to enable debug logging for the integration and look for them in the log file (search for "Published event to Home Assistant event bus")

[MaximumFish]

Ha, good to know, thanks.

Yeah I'm convinced it's not an issue with HA or the integration but I can't think of a better place to discuss it as it's very niche! I've put my own ticket in with Bosch and we'll see what they say. The appliance certainly seems to think that it can report these events or it surely wouldn't be surfaced as an option by the appliance settings in the app. 🤔

[arifroni]

I got an reply from support, they asked me some questions. Now i realized that my dishwasher isn't firing any event at all. After a restart of the device, now start/stop/abort events are working as @MaximumFish showed before. But unfortunately i cant test the 2 event that we are looking for. I just filled up salt this morning :(.

@MaximumFish instead of listening all the time you can try this automation. Change your mobile notification sensor name.

alias: BSH Test2
description: ""
triggers:
  - trigger: event
    event_type: home_connect_alt_event
conditions: []
actions:
  - action: notify.mobile_app_pixel_7_pro_roni
    metadata: {}
    data:
      message: "{{ trigger.event.data }}"
mode: single

[arifroni]

After restarting the dishwasher, everything seems to be working now :)

[GSzabados]

I came here to look for how are the rinse aid and salt events are working for anybody else, but I am still unclear.

I am using the HA built in integration and not this one, because the sensors for rinse aid and salt has been added there recently a few months ago. But for some reason I don't get the salt one. There is no problem with the rinse aid, maybe a bit of delay, but the salt one has not showed up at all.

Has it showed up for any you in this discussion?

Otherwise, this is what I see:

Dishwasher finishes program, at the next start the machine already shows the icon, but no message anywhere else, once the next program finishes, and the machine turned on again, it shows a message about low rinse aid, and the app pings it as well, but not HA. HA gets the notification, when the program is started.

I assumed that would be the same for salt as well, but it has not showed up in HA. It was visible on the machine, and in the app as well, but not in HA.

So, has anybody got a salt level is low event from the Home Connect API?