Home Connect add WasherDryer support

[stickpin]

Proposed change

Add WasherDryer support. #90520
This PR also handles multi-type programs issues discussed in this thread: DavidMStraub/homeassistant-homeconnect#119
I cannot fully test it myself as I don't have a WasherDryer appliance.

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New integration (thank you!)
• New feature (which adds functionality to an existing integration)
• Deprecation (breaking change to happen in the future)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Additional information

• This PR fixes or closes issue: fixes #
• This PR is related to issue: Home Connect warning with Home Assistant 2023.4.0b0 #90520
• Link to documentation pull request:

Checklist

• The code change is tested and works locally.
• Local tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist
• I have followed the perfect PR recommendations
• The code has been formatted using Black (black --fast homeassistant tests)
• Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

• The manifest file has all fields filled out correctly.
  Updated and included derived files by running: python3 -m script.hassfest.
• New or updated dependencies have been added to requirements_all.txt.
  Updated by running python3 -m script.gen_requirements_all.
• For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
• Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[home-assistant]

Hey there @DavidMStraub, mind taking a look at this pull request as it has been labeled with an integration (home_connect) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of home_connect can trigger bot actions by commenting:

• @home-assistant close Closes the pull request.
• @home-assistant rename Awesome new title Renames the pull request.
• @home-assistant reopen Reopen the pull request.
• @home-assistant unassign home_connect Removes the current integration label and assignees on the pull request, add the integration domain after the command.

[BraveChicken1]

This change probably has the same issue as DavidMStraub/homeassistant-homeconnect#119

[stickpin]

@BraveChicken1 Thanks for pointing that out. Yes, I guess you are right.
It seems that the only way to resolve it, it's to make a breaking change.
Unfortunately, I cannot test it myself, as I don't have a WasherDryer.

desc = " ".join(["Program", program_name.split(".")[-1]])

I need to see how to change the PR so it will only affect the WasherDryer.

[stickpin]

@BraveChicken1, I think I have a solution.

For appliance types like WasherDryer programs will be displayed with a program type and program name.

As I don't have WasherDryer I did POC with my Dishwasher.

For example: if the full program name is Dishcare.Dishwasher.Program.Auto2 the program will be displayed as Program Dishwasher Auto2 this will solve the issue for multi-type program appliances.

Here is the result in Home Assistant:

I will submit the PR in a few minutes.

[stickpin]

@BraveChicken1 submitted the fix. Thanks for pointing this out once again! :)

[DavidMStraub]

What about #89113?

[stickpin]

@DavidMStraub it's outdated. I already commented there.
It's still using an "old" static programs list and doesn't have a fix for WasherDryer program names.

[BraveChicken1]

I think this should work. Thank you!

[BraveChicken1]

Not tested but looks good to me

[DennisGaida]

Can't test right now, but I'm one of the persons that own a WasherDryer. Will test once I get back - if still necessary then. The PR looks simple enough though.

[stickpin]

Hi @DennisGaida,

Yes, it will be great if you can test it with a real appliance.
Please let me know in case of any issues.

Thanks a lot! :)

[MoeweX]

Hi @stickpin, I only started to use HomeAssistant today and landed quite quickly on this PR because my WashDryer was not found. I now also have finally managed to get your branch running and validated that the WashDryer shows up. As I do not know to much about HomeAssistant yet, I don't know if what I see is what one would expect, so please find attached a screenshot of the device overview. Should I test something else? Is it normal that "duration" is not available?

If I were to toggle the Power or Program switch, is the program that actually aborted? I do not dare to try that right now.

[frenck]

Thanks, @stickpin 👍

../Frenck

[stickpin]

@frenck thanks! :)

Hi @MoeweX,

Thanks a lot for reporting back!
Interesting that integration found only one program for you. I guess you added the integration when your appliance was running.
Can you please try to turn on the device and restart the Home Assitant? Integration should fetch all the available programs for your device. It should be much more than one. :)

Regarding the behavior. I don't have WasherDryer to test it with but in general, If you switch off the program, the current running operation will be aborted. If you power off the device, it will turn off and the program will be resumed once you turn it on. At least that's what's happening with my Dishwasher.

[MoeweX]

Hi @stickpin ,

yes I initially onboarded it while running a program, now I tried again and many more programs showed up :).

While playing around with the controls, I noticed the power button is not working:

Logger: homeassistant.components.home_connect.switch
Source: components/home_connect/switch.py:132
Integration: Home Connect (documentation, issues)
First occurred: 13:55:57 (2 occurrences)
Last logged: 13:56:00

Error while trying to turn off device: {'description': 'Key BSH.Common.Setting.PowerState has unknown enum type or enum member BSH.Common.EnumType.PowerState.Off.', 'key': 'SDK.Error.InvalidSettingValue'}

Once I switch of the machine via physical controls, interestingly the log indicates the real state while the button still shows that it is turned on

[stickpin]

Hi @MoeweX,

It seems like you disabled a Remote control. At least this is what Log is reporting on your screenshot. In this case, your actual appliance status will not be reflected in Home Assistant. As well as you wouldn't be able to control your appliance remotely.

Try to re-enable the Remote control on the appliance again and after that try to turn on/off your appliance, the actual status should be reflected in the Home Assistant as well.

P.S. Just out of my curiosity, can you please post the full Programs list screenshot?

Thanks a lot! :)

[DennisGaida]

I promised I would test, only now got the time for it. Works for me - Duration also seems empty, though remaining program time is filled.

A full screenshot here:

Checking the API response, I also don't see any duration, the relevant API response is:

      {
        "key": "BSH.Common.Option.ProgramProgress",
        "value": 94,
        "unit": "%",
        "name": "Current program progress"
      },
      {
        "key": "BSH.Common.Option.RemainingProgramTime",
        "value": 801,
        "unit": "seconds",
        "name": "Remaining program running time"
      },
      {
        "key": "BSH.Common.Option.RemainingProgramTimeIsEstimated",
        "value": true,
        "name": "Estimated remaining program time"
      },

As far as I can tell duration is not used with the WasherDryer device class, but would be used with an oven. Example reponse for an oven:

{
  "data": {
    "key": "Cooking.Oven.Program.HeatingMode.HotAir",
    "options": [
      {
        "key": "Cooking.Oven.Option.SetpointTemperature",
        "value": 230,
        "unit": "°C"
      },
      {
        "key": "BSH.Common.Option.Duration",
        "value": 1200,
        "unit": "seconds"
      }
    ]
  }
}

so maybe some checking logic might be nice, i.e. "is duration available? then create sensor, otherwise don't"

[stickpin]

Thanks for reporting back @DennisGaida!
Strangely it's not showing a proper naming in your case... hmmm... did you rename it manually?

[DennisGaida]

Could very well be - I previously implemented this myself: #89113. Didn't care about device creation now anyways, just wanted to see if it works (which it does since you can see the live updates of the times / current program etc).