Class CoverConfig

Namespace

HaMqttDiscoverable.Entities

Assembly

HaMqttDiscoverable.dll

Configuration for a Cover entity: a blind, garage door, shade, etc. that can be opened/closed/stopped, optionally with position and tilt.

public sealed class CoverConfig : EntityConfig

Inheritance

object

EntityConfig

CoverConfig

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. Defaults to "CLOSE".

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

Property Value

string

PayloadOpen

The payload sent to open. Defaults to "OPEN".

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

Property Value

string

PayloadStop

The payload sent to stop mid-movement. Defaults to "STOP".

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

Property Value

string

PositionClosed

The position value meaning fully closed. Defaults to 0.

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

Property Value

int

PositionOpen

The position value meaning fully open. Defaults to 100.

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

Property Value

int

StateClosed

The state value meaning "closed". 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". 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

StateStopped

The state value meaning "stopped" partway. Defaults to "stopped".

[JsonPropertyName("state_stopped")]
public string StateStopped { get; set; }

Property Value

string

SupportsPosition

When true, this cover reports (and, via PositionCommandReceived, accepts) a 0-100 position rather than just open/closed.

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

Property Value

bool

SupportsTilt

When true, this cover supports independent tilt control (e.g. venetian blinds).

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

Property Value

bool

TiltClosedPosition

The tilt value meaning fully closed. Defaults to 0.

[JsonPropertyName("tilt_closed_value")]
public int TiltClosedPosition { get; set; }

Property Value

int

TiltMax

The maximum tilt value. Defaults to 100.

[JsonPropertyName("tilt_max")]
public int TiltMax { get; set; }

Property Value

int

TiltMin

The minimum tilt value. Defaults to 0.

[JsonPropertyName("tilt_min")]
public int TiltMin { get; set; }

Property Value

int

TiltOpenPosition

The tilt value meaning fully open. Defaults to 100.

[JsonPropertyName("tilt_opened_value")]
public int TiltOpenPosition { get; set; }

Property Value

int