MQTT Vacuum


The mqtt vacuum component allows you to control your MQTT-enabled vacuum. There are 2 possible message schemas - legacy and state. New installation should use state schema as legacy is deprecated and might be removed someday in the future. state schema is preferred because the vacuum will then be represented as a StateVacuumDevice which is preferred parent vacuum entity.

This documentation has 3 sections. Config for legacy vacuum with examples, config for state vacuum with examples and shared section with examples which are the same for both schemas.

Configuration

To add your MQTT vacuum to your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
vacuum:
  - platform: mqtt

Legacy Configuration

Legacy MQTT vacuum configuration section.

Configuration Variables

name

(string)(Optional)The name of the vacuum.

Default value: MQTT Vacuum

schema

(string)(Optional)The schema to use.

Default value: legacy

supported_features

(string list)(Optional)List of features that the vacuum supports (possible values are turn_on, turn_off, pause, stop, return_home, battery, status, locate, clean_spot, fan_speed, send_command).”

Default value: turn_on, turn_off, stop, return_home, status, battery, clean_spot

command_topic

(string)(Optional)The MQTT topic to publish commands to control the vacuum.

qos

(integer)(Optional)The maximum QoS level of the state topic.

Default value: 0

retain

(boolean)(Optional)If the published message should have the retain flag on or not.

Default value: false

payload_turn_on

(string)(Optional)The payload to send to the command_topic to begin the cleaning cycle.

Default value: turn_on

payload_turn_off

(string)(Optional)The payload to send to the command_topic to turn the vacuum off.

Default value: turn_off

payload_return_to_base

(string)(Optional)The payload to send to the command_topic to tell the vacuum to return to base.

Default value: return_to_base

payload_stop

(string)(Optional)The payload to send to the command_topic to stop the vacuum.

Default value: stop

payload_clean_spot

(string)(Optional)The payload to send to the command_topic to begin a spot cleaning cycle.

Default value: clean_spot

payload_locate

(string)(Optional)The payload to send to the command_topic to locate the vacuum (typically plays a song).

Default value: locate

payload_start_pause

(string)(Optional)The payload to send to the command_topic to start or pause the vacuum.

Default value: start_pause

battery_level_topic

(string)(Optional)The MQTT topic subscribed to receive battery level values from the vacuum.

battery_level_template

(string)(Optional)Defines a template to define the battery level of the vacuum. This is required if battery_level_topic is set.

charging_topic

(string)(Optional)The MQTT topic subscribed to receive charging state values from the vacuum.

charging_template

(string)(Optional)Defines a template to define the charging state of the vacuum. This is required if charging_topic is set.

cleaning_topic

(string)(Optional)The MQTT topic subscribed to receive cleaning state values from the vacuum.

cleaning_template

(string)(Optional)Defines a template to define the cleaning state of the vacuum. This is required if cleaning_topic is set.

docked_topic

(string)(Optional)The MQTT topic subscribed to receive docked state values from the vacuum.

docked_template

(string)(Optional)Defines a template to define the docked state of the vacuum. This is required if docked_topic is set.

error_topic

(string)(Optional)The MQTT topic subscribed to receive error messages from the vacuum.

error_template

(string)(Optional)Defines a template to define potential error messages emitted by the vacuum. This is required if error_topic is set.

fan_speed_topic

(string)(Optional)The MQTT topic subscribed to receive fan speed values from the vacuum.

fan_speed_template

(string)(Optional)Defines a template to define the fan speed of the vacuum. This is required if fan_speed_topic is set.

set_fan_speed_topic

(string)(Optional)The MQTT topic to publish commands to control the vacuum’s fan speed.

fan_speed_list

(string list)(Optional)List of possible fan speeds for the vacuum.

send_command_topic

(string)(Optional)The MQTT topic to publish custom commands to the vacuum.

availability_topic

(string)(Optional)The MQTT topic subscribed to receive availability (online/offline) updates.

payload_available

(string)(Optional)The payload that represents the available state.

Default value: online

payload_not_available

(string)(Optional)The payload that represents the unavailable state.

Default value: offline

json_attributes_topic

(string)(Optional)The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in MQTT sensor documentation.

json_attributes_template

(template)(Optional)Defines a template to extract the JSON dictionary from messages received on the json_attributes_topic. Usage example can be found in MQTT sensor documentation.

Legacy configuration example

# Example configuration.yaml entry
vacuum:
  - platform: mqtt
    name: "MQTT Vacuum"
    supported_features:
      - turn_on
      - turn_off
      - pause
      - stop
      - return_home
      - battery
      - status
      - locate
      - clean_spot
      - fan_speed
      - send_command
    command_topic: "vacuum/command"
    battery_level_topic: "vacuum/state"
    battery_level_template: "{{ value_json.battery_level }}"
    charging_topic: "vacuum/state"
    charging_template: "{{ value_json.charging }}"
    cleaning_topic: "vacuum/state"
    cleaning_template: "{{ value_json.cleaning }}"
    docked_topic: "vacuum/state"
    docked_template: "{{ value_json.docked }}"
    error_topic: "vacuum/state"
    error_template: "{{ value_json.error }}"
    fan_speed_topic: "vacuum/state"
    fan_speed_template: "{{ value_json.fan_speed }}"
    set_fan_speed_topic: "vacuum/set_fan_speed"
    fan_speed_list:
      - min
      - medium
      - high
      - max
    send_command_topic: 'vacuum/send_command'

Legacy MQTT Protocol

The above configuration for this component expects an MQTT protocol like the following.

Legacy Basic Commands

MQTT topic: vacuum/command

Possible MQTT payloads:

  • turn_on - Begin cleaning
  • turn_off - Turn the Vacuum off
  • return_to_base - Return to base/dock
  • stop - Stop the Vacuum
  • clean_spot - Initialize a spot cleaning cycle
  • locate - Locate the vacuum (typically by playing a song)
  • start_pause - Toggle the vacuum between cleaning and stopping

Status/Sensor Updates

MQTT topic: vacuum/state

MQTT payload:

{
    "battery_level": 61,
    "docked": true,
    "cleaning": false,
    "charging": true,
    "fan_speed": "off",
    "error": "Error message"
}

State Configuration

State MQTT vacuum configuration section.

Configuration Variables

name

(string)(Optional)The name of the vacuum.

Default value: MQTT Vacuum

schema

(string)(Optional)The schema to use.

Default value: legacy

supported_features

(string list)(Optional)List of features that the vacuum supports (possible values are start, stop, pause, return_home, battery, status, locate, clean_spot, fan_speed, send_command).

Default value: start, stop, return_home, status, battery, clean_spot

command_topic

(string)(Optional)The MQTT topic to publish commands to control the vacuum.

qos

(integer)(Optional)The maximum QoS level of the state topic.

Default value: 0

retain

(boolean)(Optional)If the published message should have the retain flag on or not.

Default value: false

payload_start

(string)(Optional)The payload to send to the command_topic to begin the cleaning cycle.

Default value: start

payload_stop

(string)(Optional)The payload to send to the command_topic to stop cleaning.

Default value: stop

payload_return_to_base

(string)(Optional)The payload to send to the command_topic to tell the vacuum to return to base.

Default value: return_to_base

payload_clean_spot

(string)(Optional)The payload to send to the command_topic to begin a spot cleaning cycle.

Default value: clean_spot

payload_locate

(string)(Optional)The payload to send to the command_topic to locate the vacuum (typically plays a song).

Default value: locate

payload_pause

(string)(Optional)The payload to send to the command_topic to pause the vacuum.

Default value: pause

state_topic

(string)(Optional)The MQTT topic subscribed to receive state messages from the vacuum. State topic is extracting json if no value_template is defined.

value_template

(string)(Optional)Defines a template to extract possible states from the vacuum.

set_fan_speed_topic

(string)(Optional)The MQTT topic to publish commands to control the vacuum’s fan speed.

fan_speed_list

(string list)(Optional)List of possible fan speeds for the vacuum.

send_command_topic

(string)(Optional)The MQTT topic to publish custom commands to the vacuum.

availability_topic

(string)(Optional)The MQTT topic subscribed to receive availability (online/offline) updates.

payload_available

(string)(Optional)The payload that represents the available state.

Default value: online

payload_not_available

(string)(Optional)The payload that represents the unavailable state.

Default value: offline

json_attributes_topic

(string)(Optional)The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in MQTT sensor documentation.

State configuration example

# Example configuration.yaml entry
vacuum:
  - platform: mqtt
    name: "MQTT Vacuum"
    schema: state
    supported_features:
      - start
      - pause
      - stop
      - return_home
      - battery
      - status
      - locate
      - clean_spot
      - fan_speed
      - send_command
    command_topic: "vacuum/command"
    state_topic: "vacuum/state"
    set_fan_speed_topic: "vacuum/set_fan_speed"
    fan_speed_list:
      - min
      - medium
      - high
      - max
    send_command_topic: 'vacuum/send_command'

State MQTT Protocol

The above configuration for this component expects an MQTT protocol like the following.

State Basic Commands

MQTT topic: vacuum/command

Possible MQTT payloads:

  • start - Start cleaning
  • pause - Pause cleaning
  • return_to_base - Return to base/dock
  • stop - Stop the vacuum.
  • clean_spot - Initialize a spot cleaning cycle
  • locate - Locate the vacuum (typically by playing a song)

Send Custom Command

Vacuum send_command allows three parameters:

  • entity_id
  • command
  • params - optional

If params are not provided it sends command as payload to MQTT send_command topic. If params are provided service sends json as payload with such structure:

{
  'command': 'command',
  'param1-key': 'param1-value'
}

Service trigger example:

- alias: Push command based on sensor
    trigger:
      - platform: state
        entity_id: sensor.sensor
    action:
      service: vacuum.send_command
      data:
        entity_id: 'vacuum.vacuum_entity'
        command: 'custom_command'
        params:
          - key: value

MQTT topic: vacuum/send_command

Status/Sensor Updates

MQTT topic: vacuum/state

MQTT payload:

{
    "battery_level": 61,
    "state": "docked",
    "fan_speed": "off"
}

State has to be one of vacuum states supported by Home Assistant:

  • cleaning,
  • docked,
  • paused,
  • idle,
  • returning,
  • error.

Shared MQTT Protocol

The configuration for this component expects an MQTT protocol like the following. These services are identical for both - legacy and state vacuum.

Set Fan Speed

MQTT topic: vacuum/set_fan_speed

Possible MQTT payloads:

  • min - Minimum fan speed
  • medium - Medium fan speed
  • high - High fan speed
  • max - Max fan speed

Send Custom Command

Vacuum send_command allows three parameters:

  • entity_id
  • command
  • params - optional

If params are not provided it sends command as payload to MQTT send_command topic. If params are provided service sends json as payload with such structure:

{
  'command': 'command',
  'param1-key': 'param1-value'
}

Service trigger example:

- alias: Push command based on sensor
    trigger:
      - platform: state
        entity_id: sensor.sensor
    action:
      service: vacuum.send_command
      data:
        entity_id: 'vacuum.vacuum_entity'
        command: 'custom_command'
        params:
          - key: value

MQTT topic: vacuum/send_command

Usage with cloudless Xiaomi vacuums

This component is supported by the cloud-free Xiaomi Vacuum Webinterface Valetudo.

Retrofitting a non-wifi vacuums

  • Retrofitting your old Roomba with an ESP8266. This repo provides MQTT client firmware.
  • In you own a non-wifi Neato, you can refer to this repo that uses a Raspberry Pi to retrofit an old Neato.