Alarm Control Panel Entity

Incomplete

This entry is incomplete. Contribution welcome.

An alarm control panel entity controls an alarm. Derive a platform entity from homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Properties

tip

Properties should always only return information from memory and not do I/O (like network requests). Implement update() or async_update() to fetch data.

NameTypeDefaultDescription
statestringRequiredOne of the states listed in the states section.
code_formatstringNoneOne of the states listed in the code formats section.
changed_bystringNoneLast change triggered by.

States

ValueDescription
disarmedThe alarm is disarmed (off).
armed_homeThe alarm is armed in home mode.
armed_awayThe alarm is armed in away mode.
armed_nightThe alarm is armed in night mode.
armed_custom_bypass The alarm is armed in bypass mode.
pendingThe alarm is pending (towards triggered).
armingThe alarm is arming.
disarmingThe alarm is disarming.
triggeredThe alarm is triggered.

Code Formats

ValueDescription
NoneNo code required.
NumberCode is a number (Shows ten-key pad on frontend).
AnyCode is a string.

Methods

Alarm Disarm

Send disarm command.

class MyAlarm(AlarmControlPanelEntity):
# Implement one of these methods.
def alarm_disarm(self, code=None) -> None:
"""Send disarm command."""
async def async_alarm_disarm(self, code=None) -> None:
"""Send disarm command."""

Alarm Arm Home

Send arm home command.

class MyAlarm(AlarmControlPanelEntity):
# Implement one of these methods.
def alarm_arm_home(self, code=None) -> None:
"""Send arm home command."""
def async_alarm_arm_home(self, code=None) -> None:
"""Send arm home command."""

Alarm Arm Away

Send arm away command.

class MyAlarm(AlarmControlPanelEntity):
# Implement one of these methods.
def alarm_arm_away(self, code=None) -> None:
"""Send arm away command."""
def async_alarm_arm_away(self, code=None) -> None:
"""Send arm away command."""

Alarm Arm Night

Send arm night command.

class MyAlarm(AlarmControlPanelEntity):
# Implement one of these methods.
def alarm_arm_night(self, code=None) -> None:
"""Send arm night command."""
def async_alarm_arm_night(self, code=None) -> None:
"""Send arm night command."""

Alarm Trigger

Send alarm trigger command.

class MyAlarm(AlarmControlPanelEntity):
# Implement one of these methods.
def alarm_trigger(self, code=None) -> None:
"""Send alarm trigger command."""
def async_alarm_trigger(self, code=None) -> None:
"""Send alarm trigger command."""

Alarm Custom Bypass

Send arm custom bypass command.

class MyAlarm(AlarmControlPanelEntity):
# Implement one of these methods.
def alarm_arm_custom_bypass(self, code=None) -> None:
"""Send arm custom bypass command."""
def async_alarm_arm_custom_bypass(self, code=None) -> None:
"""Send arm custom bypass command."""
Last updated on