Class Siren

Namespace

HaMqttDiscoverable.Entities

Assembly

HaMqttDiscoverable.dll

An on/off alarm sounder. AvailableTones, SupportDuration and SupportVolumeSet only affect what Home Assistant's UI shows - without a command_template (which this library doesn't expose, matching its other entities), Home Assistant sends only the plain on/off payload over MQTT, so tone/duration/volume choices made in the UI aren't transmitted. If you need them, read them from the service call on the Home Assistant side via an automation, or use the raw HaMqttConnection APIs.

public sealed class Siren : HaEntity<SirenConfig>, IAsyncDisposable

Inheritance

object

HaEntity<SirenConfig>

Siren

Implements

IAsyncDisposable

Inherited Members

HaEntity<SirenConfig>.Config

HaEntity<SirenConfig>.DiscoveryTopic

HaEntity<SirenConfig>.StateTopic

HaEntity<SirenConfig>.CommandTopic

HaEntity<SirenConfig>.PublishDiscoveryAsync(CancellationToken)

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

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

HaEntity<SirenConfig>.RemoveAsync(CancellationToken)

HaEntity<SirenConfig>.DisposeAsync()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Siren(HaMqttConnection, SirenConfig, Func<bool, Task>?)

Creates a siren from the given config, optionally subscribing onCommand to CommandReceived.

public Siren(HaMqttConnection connection, SirenConfig config, Func<bool, Task>? onCommand = null)

Parameters

connection HaMqttConnection

config SirenConfig

onCommand Func<bool, Task>

Properties

SupportsCommands

Whether this entity type accepts commands from Home Assistant (e.g. switches, numbers). Sensors are read-only and return false.

protected override bool SupportsCommands { get; }

Property Value

bool

Methods

OnCommandReceivedAsync(string)

Called with the raw payload every time a message arrives on CommandTopic. Overridden by controllable entity types.

protected override Task OnCommandReceivedAsync(string payload)

Parameters

payload string

Returns

Task

PublishStateAsync(bool, bool, CancellationToken)

Publishes the siren's current on/off state.

public Task PublishStateAsync(bool isOn, bool retain = true, CancellationToken cancellationToken = default)

Parameters

isOn bool

retain bool

cancellationToken CancellationToken

Returns

Task

Events

CommandReceived

Raised when Home Assistant sends a command to turn the siren on or off.

public event Func<bool, Task>? CommandReceived

Event Type

Func<bool, Task>