MQTT Vacuum


The mqtt vacuum integration allows you to control your MQTT-enabled vacuum. There are two possible message schemas - legacy and state, chosen by setting the schema configuration parameter. New installations should use the state schema as legacy is deprecated and might be removed someday in the future. The state schema is preferred because the vacuum will then be represented as a StateVacuumDevice which is the preferred parent vacuum entity.

This documentation has 3 sections. Configuration for legacy vacuum with examples, configuration 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

availabilitylist(Optional)

A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with availability_topic.

payload_availablestring(Optional, default: online)

The payload that represents the available state.

payload_not_availablestring(Optional, default: offline)

The payload that represents the unavailable state.

topicstringRequired

An MQTT topic subscribed to receive availability (online/offline) updates.

availability_topicstring(Optional)

The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability.

battery_level_templatestring(Optional)

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

battery_level_topicstring(Optional)

The MQTT topic subscribed to receive battery level values from the vacuum.

charging_templatestring(Optional)

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

charging_topicstring(Optional)

The MQTT topic subscribed to receive charging state values from the vacuum.

cleaning_templatestring(Optional)

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

cleaning_topicstring(Optional)

The MQTT topic subscribed to receive cleaning state values from the vacuum.

command_topicstring(Optional)

The MQTT topic to publish commands to control the vacuum.

docked_templatestring(Optional)

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

docked_topicstring(Optional)

The MQTT topic subscribed to receive docked state values from the vacuum.

error_templatestring(Optional)

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

error_topicstring(Optional)

The MQTT topic subscribed to receive error messages from the vacuum.

fan_speed_liststring | list(Optional)

List of possible fan speeds for the vacuum.

fan_speed_templatestring(Optional)

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

fan_speed_topicstring(Optional)

The MQTT topic subscribed to receive fan speed values from the vacuum.

json_attributes_templatetemplate(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.

json_attributes_topicstring(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.

namestring(Optional, default: MQTT Vacuum)

The name of the vacuum.

payload_availablestring(Optional, default: online)

The payload that represents the available state.

payload_clean_spotstring(Optional, default: clean_spot)

The payload to send to the command_topic to begin a spot cleaning cycle.

payload_locatestring(Optional, default: locate)

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

payload_not_availablestring(Optional, default: offline)

The payload that represents the unavailable state.

payload_return_to_basestring(Optional, default: return_to_base)

The payload to send to the command_topic to tell the vacuum to return to base.

payload_start_pausestring(Optional, default: start_pause)

The payload to send to the command_topic to start or pause the vacuum.

payload_stopstring(Optional, default: stop)

The payload to send to the command_topic to stop the vacuum.

payload_turn_offstring(Optional, default: turn_off)

The payload to send to the command_topic to turn the vacuum off.

payload_turn_onstring(Optional, default: turn_on)

The payload to send to the command_topic to begin the cleaning cycle.

qosinteger(Optional, default: 0)

The maximum QoS level of the state topic.

retainboolean(Optional, default: false)

If the published message should have the retain flag on or not.

schemastring(Optional, default: legacy)

The schema to use. Must be legacy or omitted to select the legacy schema.

send_command_topicstring(Optional)

The MQTT topic to publish custom commands to the vacuum.

set_fan_speed_topicstring(Optional)

The MQTT topic to publish commands to control the vacuum’s fan speed.

supported_featuresstring | 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:

turn_on, turn_off, stop, return_home, status, battery, clean_spot

unique_idstring(Optional)

An ID that uniquely identifies this vacuum. If two vacuums have the same unique ID, Home Assistant will raise an exception.

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 integration expects an MQTT protocol like the following. See also Shared MQTT Protocol.

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

availabilitylist(Optional)

A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with availability_topic.

payload_availablestring(Optional, default: online)

The payload that represents the available state.

payload_not_availablestring(Optional, default: offline)

The payload that represents the unavailable state.

topicstringRequired

An MQTT topic subscribed to receive availability (online/offline) updates.

availability_topicstring(Optional)

The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability.

command_topicstring(Optional)

The MQTT topic to publish commands to control the vacuum.

devicemap(Optional)

Information about the device this switch is a part of to tie it into the device registry. Only works through MQTT discovery and when unique_id is set.

connectionslist(Optional)

A list of connections of the device to the outside world as a list of tuples [connection_type, connection_identifier]. For example the MAC address of a network interface: "connections": [["mac", "02:5b:26:a8:dc:12"]].

identifiersstring | list(Optional)

A list of IDs that uniquely identify the device. For example a serial number.

manufacturerstring(Optional)

The manufacturer of the device.

modelstring(Optional)

The model of the device.

namestring(Optional)

The name of the device.

sw_versionstring(Optional)

The firmware version of the device.

via_devicestring(Optional)

Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.

fan_speed_liststring | list(Optional)

List of possible fan speeds for the vacuum.

json_attributes_templatetemplate(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.

json_attributes_topicstring(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.

namestring(Optional, default: MQTT Vacuum)

The name of the vacuum.

payload_availablestring(Optional, default: online)

The payload that represents the available state.

payload_clean_spotstring(Optional, default: clean_spot)

The payload to send to the command_topic to begin a spot cleaning cycle.

payload_locatestring(Optional, default: locate)

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

payload_not_availablestring(Optional, default: offline)

The payload that represents the unavailable state.

payload_pausestring(Optional, default: pause)

The payload to send to the command_topic to pause the vacuum.

payload_return_to_basestring(Optional, default: return_to_base)

The payload to send to the command_topic to tell the vacuum to return to base.

payload_startstring(Optional, default: start)

The payload to send to the command_topic to begin the cleaning cycle.

payload_stopstring(Optional, default: stop)

The payload to send to the command_topic to stop cleaning.

qosinteger(Optional, default: 0)

The maximum QoS level of the state topic.

retainboolean(Optional, default: false)

If the published message should have the retain flag on or not.

schemastring(Optional, default: legacy)

The schema to use. Must be state to select the state schema.

send_command_topicstring(Optional)

The MQTT topic to publish custom commands to the vacuum.

set_fan_speed_topicstring(Optional)

The MQTT topic to publish commands to control the vacuum’s fan speed.

state_topicstring(Optional)

The MQTT topic subscribed to receive state messages from the vacuum. Messages received on the state_topic must be a valid JSON dictionary, with a mandatory state key and optionally battery_level and fan_speed keys as shown in the example.

supported_featuresstring | 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:

start, stop, return_home, status, battery, clean_spot

unique_idstring(Optional)

An ID that uniquely identifies this vacuum. If two vacuums have the same unique ID, Home Assistant will raise an exception.

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 integration expects an MQTT protocol like the following. See also Shared MQTT Protocol.

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 integration 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 examples

Usage with cloudless Xiaomi vacuums

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

Retrofitting non-wifi vacuums

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