Vacuum
The Vacuum integration集成将 Home Assistant 与您的设备、服务等连接和集成。 [Learn more] enables the ability to control home cleaning robots within Home Assistant.
构建模块集成
这个 vacuum 是一个构建模块集成，无法直接添加到你的 Home Assistant 中，但可以被其他集成使用和提供。
构建模块集成不同于典型的与设备或服务连接的集成。相反，其他将设备或服务集成到 Home Assistant 中的集成使用这个 vacuum 构建模块来提供实体、服务和其他你可以在自动化或仪表板中使用的功能。
如果你的某个集成具有这个构建模块，这个页面记录了 vacuum 构建模块所提供的功能。
The state of a vacuum entity
A vacuum entity实体表示 Home Assistant 中的传感器、执行器或功能。实体用于监控物理属性或控制其他实体。实体通常是设备或服务的一部分。 [Learn more] can have the following states:
- Cleaning: The vacuum is currently cleaning.
- Docked: The vacuum is currently docked. It is assumed that docked can also mean charging.
- Error: The vacuum encountered an error while cleaning.
- Idle: The vacuum is not paused, not docked, and does not have any errors.
- Paused: The vacuum was cleaning but was paused without returning to the dock.
- Returning: The vacuum is done cleaning and is currently returning to the dock, but not yet docked.
- Unavailable: The entity is currently unavailable.
- Unknown: The state is not yet known.
Actions
Available actions: start, pause, stop, return_to_base, locate, clean_spot, set_fan_speed and send_command.
Before calling one of these actions, make sure your vacuum platform supports it.
Action vacuum.start
Start or resume a cleaning task.
| Data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Action vacuum.pause
Pause a cleaning task.
| Data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Action vacuum.stop
Stop the current activity of the vacuum.
| Data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Action vacuum.return_to_base
Tell the vacuum to return home.
| Data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Action vacuum.locate
Locate the vacuum cleaner robot.
| Data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Action vacuum.clean_spot
Tell the vacuum cleaner to do a spot clean-up.
| Data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
Action vacuum.set_fan_speed
Set the fan speed of the vacuum. The fanspeed can be a label, as balanced or turbo, or be a number; it depends on the vacuum platform.
| Data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
fan_speed |
no | Platform dependent vacuum cleaner fan speed, with speed steps, like ‘medium’, or by percentage, between 0 and 100. |
Action vacuum.send_command
Send a platform-specific command to the vacuum cleaner.
| Data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Only act on specific vacuum. Use entity_id: all to target all. |
command |
no | Command to execute. |
params |
yes | Parameters for the command. |