Class Image

Namespace

HaMqttDiscoverable.Entities

Assembly

HaMqttDiscoverable.dll

A still image published for Home Assistant to display, e.g. a camera snapshot or a generated chart. Images are always published base64-encoded, so this works over the same string-based MQTT publish path as every other entity in this library.

public sealed class Image : HaEntity<ImageConfig>, IAsyncDisposable

Inheritance

object

HaEntity<ImageConfig>

Image

Implements

IAsyncDisposable

Inherited Members

HaEntity<ImageConfig>.Config

HaEntity<ImageConfig>.DiscoveryTopic

HaEntity<ImageConfig>.StateTopic

HaEntity<ImageConfig>.CommandTopic

HaEntity<ImageConfig>.PublishDiscoveryAsync(CancellationToken)

HaEntity<ImageConfig>.PublishStateAsync(string, bool, CancellationToken)

HaEntity<ImageConfig>.PublishStateAsync<TState>(TState, bool, CancellationToken)

HaEntity<ImageConfig>.RemoveAsync(CancellationToken)

HaEntity<ImageConfig>.DisposeAsync()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Image(HaMqttConnection, ImageConfig)

Creates an image entity from the given config.

public Image(HaMqttConnection connection, ImageConfig config)

Parameters

connection HaMqttConnection

config ImageConfig

Properties

HasStateTopic

Whether this entity type reports a state at all. Stateless entities like Button override this to false.

protected override bool HasStateTopic { get; }

Property Value

bool

Methods

EnrichDiscoveryPayload(JsonObject)

Allows subclasses to add fields to the discovery payload that aren't part of EntityConfig directly.

protected override void EnrichDiscoveryPayload(JsonObject payload)

Parameters

payload JsonObject

PublishImageAsync(byte[], bool, CancellationToken)

Publishes new image bytes (e.g. the contents of a .jpg/.png file).

public Task PublishImageAsync(byte[] imageBytes, bool retain = true, CancellationToken cancellationToken = default)

Parameters

imageBytes byte[]

retain bool

cancellationToken CancellationToken

Returns

Task