Class UpdateConfig

Namespace

HaMqttDiscoverable.Entities

Assembly

HaMqttDiscoverable.dll

Configuration for an Update entity: reports available firmware/software updates, with an optional "Install" action.

public sealed class UpdateConfig : EntityConfig

Inheritance

object

EntityConfig

UpdateConfig

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

DisplayPrecision

Number of decimals to display for the update percentage. Defaults to 0.

[JsonPropertyName("display_precision")]
public int DisplayPrecision { get; set; }

Property Value

int

PayloadInstall

The payload published back to InstallRequested when the user clicks "Install". Defaults to "install".

[JsonPropertyName("payload_install")]
public string PayloadInstall { get; set; }

Property Value

string

Title

A static title for the software, e.g. "Firmware". Can also be reported per-update via Title.

[JsonPropertyName("title")]
public string? Title { get; set; }

Property Value

string