ESPHome  2024.6.1
Data Structures | Enumerations | Functions
esphome::alarm_control_panel Namespace Reference

Data Structures

class  AlarmControlPanel
 
class  AlarmControlPanelCall
 
class  AlarmControlPanelCondition
 
class  ArmAwayAction
 
class  ArmedAwayTrigger
 
class  ArmedHomeTrigger
 
class  ArmedNightTrigger
 
class  ArmHomeAction
 
class  ArmingTrigger
 
class  ArmNightAction
 
class  ChimeTrigger
 
class  ClearedTrigger
 
class  DisarmAction
 
class  DisarmedTrigger
 
class  PendingAction
 
class  PendingTrigger
 
class  ReadyTrigger
 
class  StateTrigger
 
class  TriggeredAction
 
class  TriggeredTrigger
 

Enumerations

enum  AlarmControlPanelFeature : uint8_t {
  ACP_FEAT_ARM_HOME = 1 << 0, ACP_FEAT_ARM_AWAY = 1 << 1, ACP_FEAT_ARM_NIGHT = 1 << 2, ACP_FEAT_TRIGGER = 1 << 3,
  ACP_FEAT_ARM_CUSTOM_BYPASS = 1 << 4, ACP_FEAT_ARM_VACATION = 1 << 5
}
 
enum  AlarmControlPanelState : uint8_t {
  ACP_STATE_DISARMED = 0, ACP_STATE_ARMED_HOME = 1, ACP_STATE_ARMED_AWAY = 2, ACP_STATE_ARMED_NIGHT = 3,
  ACP_STATE_ARMED_VACATION = 4, ACP_STATE_ARMED_CUSTOM_BYPASS = 5, ACP_STATE_PENDING = 6, ACP_STATE_ARMING = 7,
  ACP_STATE_DISARMING = 8, ACP_STATE_TRIGGERED = 9
}
 

Functions

const LogString * alarm_control_panel_state_to_string (AlarmControlPanelState state)
 Returns a string representation of the state. More...
 

Enumeration Type Documentation

◆ AlarmControlPanelFeature

Enumerator
ACP_FEAT_ARM_HOME 
ACP_FEAT_ARM_AWAY 
ACP_FEAT_ARM_NIGHT 
ACP_FEAT_TRIGGER 
ACP_FEAT_ARM_CUSTOM_BYPASS 
ACP_FEAT_ARM_VACATION 

Definition at line 15 of file alarm_control_panel.h.

◆ AlarmControlPanelState

Enumerator
ACP_STATE_DISARMED 
ACP_STATE_ARMED_HOME 
ACP_STATE_ARMED_AWAY 
ACP_STATE_ARMED_NIGHT 
ACP_STATE_ARMED_VACATION 
ACP_STATE_ARMED_CUSTOM_BYPASS 
ACP_STATE_PENDING 
ACP_STATE_ARMING 
ACP_STATE_DISARMING 
ACP_STATE_TRIGGERED 

Definition at line 9 of file alarm_control_panel_state.h.

Function Documentation

◆ alarm_control_panel_state_to_string()

const LogString * esphome::alarm_control_panel::alarm_control_panel_state_to_string ( AlarmControlPanelState  state)

Returns a string representation of the state.

Parameters
stateThe AlarmControlPanelState.

Definition at line 6 of file alarm_control_panel_state.cpp.