Table of Contents

Class SirenConfig

Namespace
HaMqttDiscoverable.Entities
Assembly
HaMqttDiscoverable.dll

Configuration for a Siren entity: an on/off alarm sounder, optionally with tones.

public sealed class SirenConfig : EntityConfig
Inheritance
SirenConfig
Inherited Members

Properties

AvailableTones

The tones this siren can play, shown in Home Assistant's UI. Selecting one doesn't change the MQTT payload sent unless you handle it yourself - see the Siren class remarks.

[JsonPropertyName("available_tones")]
public List<string>? AvailableTones { get; set; }

Property Value

List<string>

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

PayloadOff

The payload sent/expected to mean "off". Defaults to "OFF".

[JsonPropertyName("payload_off")]
public string PayloadOff { get; set; }

Property Value

string

PayloadOn

The payload sent/expected to mean "on". Defaults to "ON".

[JsonPropertyName("payload_on")]
public string PayloadOn { get; set; }

Property Value

string

StateOff

Overrides the state value meaning "off", if it differs from PayloadOff.

[JsonPropertyName("state_off")]
public string? StateOff { get; set; }

Property Value

string

StateOn

Overrides the state value meaning "on", if it differs from PayloadOn.

[JsonPropertyName("state_on")]
public string? StateOn { get; set; }

Property Value

string

SupportDuration

Whether Home Assistant should show a duration control. Defaults to true.

[JsonPropertyName("support_duration")]
public bool SupportDuration { get; set; }

Property Value

bool

SupportVolumeSet

Whether Home Assistant should show a volume control. Defaults to true.

[JsonPropertyName("support_volume_set")]
public bool SupportVolumeSet { get; set; }

Property Value

bool
Edit this page