Table of Contents

Class VacuumConfig

Namespace
HaMqttDiscoverable.Entities
Assembly
HaMqttDiscoverable.dll

Configuration for a Vacuum entity: a robot vacuum with start/pause/stop/return/locate controls and an optional fan speed.

public sealed class VacuumConfig : EntityConfig
Inheritance
VacuumConfig
Inherited Members

Properties

Component

The MQTT component Home Assistant should treat this entity as, e.g. sensor or switch. Used to build the discovery topic; not part of the discovery payload itself.

public override string Component { get; }

Property Value

string

FanSpeedList

The fan speeds this vacuum supports (e.g. "low", "medium", "high"). When non-empty, a fan speed command topic is added - see FanSpeedCommandReceived.

[JsonPropertyName("fan_speed_list")]
public List<string> FanSpeedList { get; set; }

Property Value

List<string>

PayloadCleanSpot

The payload meaning "clean the current spot". Defaults to "clean_spot".

[JsonPropertyName("payload_clean_spot")]
public string PayloadCleanSpot { get; set; }

Property Value

string

PayloadLocate

The payload meaning "locate" (e.g. play a sound). Defaults to "locate".

[JsonPropertyName("payload_locate")]
public string PayloadLocate { get; set; }

Property Value

string

PayloadPause

The payload meaning "pause". Defaults to "pause".

[JsonPropertyName("payload_pause")]
public string PayloadPause { get; set; }

Property Value

string

PayloadReturnToBase

The payload meaning "return to the dock". Defaults to "return_to_base".

[JsonPropertyName("payload_return_to_base")]
public string PayloadReturnToBase { get; set; }

Property Value

string

PayloadStart

The payload meaning "start cleaning". Defaults to "start".

[JsonPropertyName("payload_start")]
public string PayloadStart { get; set; }

Property Value

string

PayloadStop

The payload meaning "stop". Defaults to "stop".

[JsonPropertyName("payload_stop")]
public string PayloadStop { get; set; }

Property Value

string

SupportedFeatures

Restricts which actions Home Assistant exposes, as a subset of "start", "pause", "stop", "return_home", "fan_speed", "clean_spot", "locate". Defaults to "start", "stop", "return_home", "clean_spot".

[JsonPropertyName("supported_features")]
public List<string>? SupportedFeatures { get; set; }

Property Value

List<string>
Edit this page