Class WaterHeaterConfig

Namespace

HaMqttDiscoverable.Entities

Assembly

HaMqttDiscoverable.dll

Configuration for a WaterHeater entity: an operating mode plus a target/current temperature.

public sealed class WaterHeaterConfig : EntityConfig

Inheritance

object

EntityConfig

WaterHeaterConfig

Inherited Members

EntityConfig.Name

EntityConfig.UniqueId

EntityConfig.ObjectId

EntityConfig.Device

EntityConfig.HasEntityName

EntityConfig.Icon

EntityConfig.DeviceClass

EntityConfig.EntityCategory

EntityConfig.EnabledByDefault

EntityConfig.Qos

EntityConfig.Availability

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

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

Modes

The operating modes this water heater supports. Defaults to Home Assistant's standard set: "eco", "electric", "gas", "heat_pump", "high_demand", "performance", "off".

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

Property Value

List<string>

PayloadOff

The payload sent/expected to mean "off". Defaults to "OFF".

[JsonPropertyName("payload_off")]
public string PayloadOff { get; set; }

Property Value

string

PayloadOn

The payload sent/expected to mean "on". Defaults to "ON".

[JsonPropertyName("payload_on")]
public string PayloadOn { get; set; }

Property Value

string

SupportsPower

When true, a separate power on/off toggle (distinct from setting the mode to "off") is added - see PowerCommandReceived.

[JsonIgnore]
public bool SupportsPower { get; set; }

Property Value

bool

TempInitial

The target temperature to suggest when the entity is first added.

[JsonPropertyName("initial")]
public double? TempInitial { get; set; }

Property Value

double?

TempMax

The maximum target temperature.

[JsonPropertyName("max_temp")]
public double? TempMax { get; set; }

Property Value

double?

TempMin

The minimum target temperature.

[JsonPropertyName("min_temp")]
public double? TempMin { get; set; }

Property Value

double?