Class Availability

Namespace

HaMqttDiscoverable

Assembly

HaMqttDiscoverable.dll

Describes an MQTT topic Home Assistant should watch to know whether an entity (or device) is currently online. When omitted, entities default to using the connection's own last-will/birth mechanism managed by HaMqttConnection.

public sealed class Availability

Inheritance

object

Availability

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Availability()

Creates an empty availability config. Set Topic before use.

public Availability()

Availability(string)

Creates an availability config for the given topic, using Home Assistant's default "online"/"offline" payloads.

public Availability(string topic)

Parameters

topic string

Properties

PayloadAvailable

The payload that indicates the entity/device is available. Defaults to "online".

[JsonPropertyName("payload_available")]
public string PayloadAvailable { get; set; }

Property Value

string

PayloadNotAvailable

The payload that indicates the entity/device is unavailable. Defaults to "offline".

[JsonPropertyName("payload_not_available")]
public string PayloadNotAvailable { get; set; }

Property Value

string

Topic

The MQTT topic Home Assistant subscribes to for availability updates.

[JsonPropertyName("topic")]
public string Topic { get; set; }

Property Value

string

ValueTemplate

Defines a JSONPath to extract the availability value from a JSON payload.

[JsonPropertyName("value_template")]
public string? ValueTemplate { get; set; }

Property Value

string