Class ValveConfig

Namespace

HaMqttDiscoverable.Entities

Assembly

HaMqttDiscoverable.dll

Configuration for a Valve entity: open/close (optionally with a stop action), or an open-to-a-position valve.

public sealed class ValveConfig : EntityConfig

Inheritance

object

EntityConfig

ValveConfig

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

PayloadClose

The payload sent to close the valve (non-position mode). Defaults to "CLOSE".

[JsonPropertyName("payload_close")]
public string? PayloadClose { get; set; }

Property Value

string

PayloadOpen

The payload sent to open the valve (non-position mode). Defaults to "OPEN".

[JsonPropertyName("payload_open")]
public string? PayloadOpen { get; set; }

Property Value

string

PayloadStop

The payload sent to stop mid-movement, if supported. Null (the default) means "stop" isn't supported.

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

Property Value

string

PositionClosed

The position value meaning fully closed, in position mode. Defaults to 0.

[JsonPropertyName("position_closed")]
public int PositionClosed { get; set; }

Property Value

int

PositionOpen

The position value meaning fully open, in position mode. Defaults to 100.

[JsonPropertyName("position_open")]
public int PositionOpen { get; set; }

Property Value

int

ReportsPosition

When true, the valve reports and accepts a 0-100 position instead of just open/closed. When true, PayloadOpen/PayloadClose/StateOpen/StateClosed aren't used.

[JsonPropertyName("reports_position")]
public bool ReportsPosition { get; set; }

Property Value

bool

StateClosed

The state value meaning "closed" (non-position mode). Defaults to "closed".

[JsonPropertyName("state_closed")]
public string? StateClosed { get; set; }

Property Value

string

StateClosing

The state value meaning "closing" (in progress). Defaults to "closing".

[JsonPropertyName("state_closing")]
public string StateClosing { get; set; }

Property Value

string

StateOpen

The state value meaning "open" (non-position mode). Defaults to "open".

[JsonPropertyName("state_open")]
public string? StateOpen { get; set; }

Property Value

string

StateOpening

The state value meaning "opening" (in progress). Defaults to "opening".

[JsonPropertyName("state_opening")]
public string StateOpening { get; set; }

Property Value

string