Class UpdateState

Namespace

HaMqttDiscoverable.Entities

Assembly

HaMqttDiscoverable.dll

The JSON body published to an Update entity's state topic.

public sealed class UpdateState

Inheritance

object

UpdateState

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

EntityPicture

A URL for an image representing the software (e.g. an app icon).

[JsonPropertyName("entity_picture")]
public string? EntityPicture { get; set; }

Property Value

string

InProgress

Whether an update/install is currently in progress.

[JsonPropertyName("in_progress")]
public bool? InProgress { get; set; }

Property Value

bool?

InstalledVersion

The currently installed version. Required for Home Assistant to know whether an update is available.

[JsonPropertyName("installed_version")]
public string? InstalledVersion { get; set; }

Property Value

string

LatestVersion

The latest available version. Home Assistant shows an update as available when this differs from InstalledVersion.

[JsonPropertyName("latest_version")]
public string? LatestVersion { get; set; }

Property Value

string

ReleaseSummary

A short summary of what's in the release, shown in Home Assistant's UI (supports Markdown).

[JsonPropertyName("release_summary")]
public string? ReleaseSummary { get; set; }

Property Value

string

ReleaseUrl

A URL with more information about the release.

[JsonPropertyName("release_url")]
public string? ReleaseUrl { get; set; }

Property Value

string

Title

Overrides Title for this specific update.

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

Property Value

string

UpdatePercentage

The install progress, 0-100, or null if not known/applicable.

[JsonPropertyName("update_percentage")]
public int? UpdatePercentage { get; set; }

Property Value

int?