Add mop and empty bin support to the vacuum component

[shred86]

Context

Many robot vacuums (e.g. Roborock, Ecovacs, iRobot, etc.) have a mop and auto-empty bin feature with associated controls. For example, the Roborock S7 has the option to set the mop mode to standard or deep and adjust the mop scrub intensity to close (lifted), mild, moderate or intense. There is also the ability to start/stop the auto-emptying bin. These are not features or controls unique to a specific robot vacuum vendor or model.

This conversation started in issue #371.

Proposal

Add the following supported features to the base vacuum component:

• Mop mode: controls the routing for more thorough cleaning (i.e. overlap)
• Mop intensity: controls the scrub intensity of the mop
• Water flow: amount of water used while mopping
• Empty bin: start or stop the auto-emptying station when the robot vacuum is docked

Consequences

Each integration implements the actual options for the supported feature (e.g. mop mode standard and deep). I do not see any consequences with adding these supported features.

[MikaBENOIT]

I'm interested in those features too.
It look like more and more vacuum tend to wash and scrub the floor too.
What are we waiting for a validation of this proposal ?

[Lash-L]

I think it makes sense for mopping functionality to potentially be a separate architecture issue than docking as they will both pose their own problems.

I'm going to only focus on mopping for right now. Mopping is being included in most mid-tier+ robot vacuums and there are even mop specific robot vacuums now, that just mop and don't vacuum. I don't think there is any issue with any integrations that wish to use a mop just implementing the Vacuum entity, but just something to keep in mind.

To add mopping, there are a few problems that would have to be solved

Cleaning Actions

The Vacuum Entity should have a new CleaningAction attribute similar to climate's HVACAction

• MOPPING
• VACUUMING
• MOP_VACUUM? What is a good name for doing both at the same time?
• DOCKING? I know I said I was just focusing on mopping for right now, but this would probably make sense to be in the action
• OFF

Cleaning Mode (Potentially these would just use the STATES that already exist?)

Similar to the actions, there should be new modes.

• OFF
• MOP
• VACUUM
• MOP_VACUUM
• DOCK

VacuumEntityFeature

There should be new flags that can be enabled as a supported feature

• MOP_MODE
• MOP_INTENSITY
• MOP
• Vacuum? Right now it assumes the Vacuum entity can vacuum(which is logical) but if we add mopping functionality and we assume mop-only robot cleaners should use the Vacuum entity, I'm not sure how that would work.

Current Functions

When we start the vacuum, we need to check state/ mode to determine what we should do. i.e. clean spot could either vacuum and mop or it could just mop or it could just vacuum.

Does anyone have any further thoughts? I'd be happy to do a MVP/ initial implementation, but I'd be curious what core maintainers think. As the highest upvoted discussion post - there is obviously a high desire for this functionality.

[emontnemery]

The suggestion seems fine, but please list core integrations which could make use of the new features

[emontnemery]

@shred86 @MikaBENOIT @Lash-L Can you please list some brands of vacuum cleaners which could make use of this? It's preferred to list brands which already have a Home Assistant integration, but it's OK to also list brands which don't.

[Lash-L]

A few with mopping capabilities are
Roborock
Irobot
Ecovacs
dreamtech
Eufy

Most Robot vacuums are coming out with a mop even for the lower tiered versions now

[emontnemery]

Thanks, @Lash-L 👍

[CodeFatherG]

I am here searching for these features on a tuya vacuum, so Include tuya in the list

[emontnemery]

@Lash-L @shred86 the proposal is not clear enough to make a decision on.

To set the constraints a bit:

• The VacuumEntity class is deprecated and should not be considered in this proposal.
• The StateVacuumEntity is what should be considered to be updated

Please try to come up with a clear proposal outlining:

• New states, if any. The allowed states today are documented here: https://developers.home-assistant.io/docs/core/entity/vacuum#states
• New services, if any
• New feature flags, if any
• New state attributes, if any

[CodeFatherG]

I have a proposal to put forward. I am not as experienced at the auto empty docks but threw it in for completeness. I am taking an approach of rather than just cleaning or mopping, you leave it open ended for the integration to instead choose the mode to perform. IE, you can vacuum, or vacuum and mop, etc

• New states, if any. The allowed states today are documented here: https://developers.home-assistant.io/docs/core/entity/vacuum#states
  • STATE_CLEANING should remain to indicate that the vacuum is cleaning
    • However my proposal is that there should be an attribute to indicate the cleaning type. This allows integrations to implement their own types of clean; ie, vacuum, mop, vacuum and mop, deep clean, fast clean, etc
  • STATE_EMPTYING should be added to indicate the vacuum is in the action of emptying and not docking for charging
    • This would give state difference between STATE_RETURNING and STATE_EMPTYING
• New services, if any
  • set_cleaning_mode or async_set_cleaning_mode
    • Used to set the vacuum cleaning mode
  • empty or async_empty
    • Used to tell the vacuum to perform an empty at the dock
• New feature flags, if any
  • AUTO_EMPTY
    • Used to indicate this vacuum can perform emptying
• New state attributes, if any
  • cleaning_mode
    • Would indicate the cleaning action currently taking place
  • cleaning_modes
    • A list of cleaning modes for the vacuum
  • water_level
    • Some vacuums have the ability to set their water level independent of their cleaning modes.
  • some_variable_to_indicate_a_empty_required
    • I couldn't decide on a name, but this should indicate that the device needs an empty. Could be used for triggering an automation to notify the user when a manual empty is required (IE after 15 empties, empty the dock)

[CodeFatherG]

@emontnemery hi mate, been a long time since activity. I think it would be great to get this functionality off the ground given that now you can pick up this functionality for less than $400 AUD. It is so accessible now days that it feels like we are behind the curve on this one.

[CodeFatherG]

I have auto empty docks on the way for my vacuums so would love to get the ball rolling on this proposal and kick the discussion up again