Class AlarmControlPanelConfig

Namespace

HaMqttDiscoverable.Entities

Assembly

HaMqttDiscoverable.dll

Configuration for an AlarmControlPanel entity.

public sealed class AlarmControlPanelConfig : EntityConfig

Inheritance

object

EntityConfig

AlarmControlPanelConfig

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

Code

A code Home Assistant's UI requires the user to enter to arm/disarm/trigger the panel. Not validated by this library - HA enforces it client-side.

[JsonPropertyName("code")]
public string? Code { get; set; }

Property Value

string

CodeArmRequired

Whether a code is required to arm the panel. Defaults to true.

[JsonPropertyName("code_arm_required")]
public bool CodeArmRequired { get; set; }

Property Value

bool

CodeDisarmRequired

Whether a code is required to disarm the panel. Defaults to true.

[JsonPropertyName("code_disarm_required")]
public bool CodeDisarmRequired { get; set; }

Property Value

bool

CodeTriggerRequired

Whether a code is required to trigger the panel. Defaults to true.

[JsonPropertyName("code_trigger_required")]
public bool CodeTriggerRequired { get; set; }

Property Value

bool

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

PayloadArmAway

The payload sent to arm-away. Defaults to "ARM_AWAY".

[JsonPropertyName("payload_arm_away")]
public string PayloadArmAway { get; set; }

Property Value

string

PayloadArmCustomBypass

The payload sent to arm with custom bypass. Defaults to "ARM_CUSTOM_BYPASS".

[JsonPropertyName("payload_arm_custom_bypass")]
public string PayloadArmCustomBypass { get; set; }

Property Value

string

PayloadArmHome

The payload sent to arm-home. Defaults to "ARM_HOME".

[JsonPropertyName("payload_arm_home")]
public string PayloadArmHome { get; set; }

Property Value

string

PayloadArmNight

The payload sent to arm-night. Defaults to "ARM_NIGHT".

[JsonPropertyName("payload_arm_night")]
public string PayloadArmNight { get; set; }

Property Value

string

PayloadArmVacation

The payload sent to arm-vacation. Defaults to "ARM_VACATION".

[JsonPropertyName("payload_arm_vacation")]
public string PayloadArmVacation { get; set; }

Property Value

string

PayloadDisarm

The payload sent to disarm. Defaults to "DISARM".

[JsonPropertyName("payload_disarm")]
public string PayloadDisarm { get; set; }

Property Value

string

PayloadTrigger

The payload sent to trigger the alarm. Defaults to "TRIGGER".

[JsonPropertyName("payload_trigger")]
public string PayloadTrigger { get; set; }

Property Value

string

SupportedFeatures

Restricts which actions Home Assistant exposes, as a subset of "arm_home", "arm_away", "arm_night", "arm_vacation", "arm_custom_bypass", "trigger". Defaults to all of them.

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

Property Value

List<string>