esphome::alarm_control_panel Namespace Reference

Data Structures
class	AlarmControlPanel
class	AlarmControlPanelCall
class	AlarmControlPanelCondition
class	ArmAwayAction
class	ArmHomeAction
class	ArmNightAction
class	DisarmAction
class	PendingAction
struct	StateAnyForwarder
	Callback forwarder that triggers an Automation<> on any state change. More...
struct	StateEnterForwarder
	Callback forwarder that triggers an Automation<> only when the alarm enters a specific state. More...
class	TriggeredAction

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
	PROGMEM_STRING_TABLE (AlarmControlPanelStateStrings, "DISARMED", "ARMED_HOME", "ARMED_AWAY", "ARMED_NIGHT", "ARMED_VACATION", "ARMED_CUSTOM_BYPASS", "PENDING", "ARMING", "DISARMING", "TRIGGERED", "UNKNOWN")
const LogString *	alarm_control_panel_state_to_string (AlarmControlPanelState state)
	Returns a string representation of the state.

Enumeration Type Documentation

AlarmControlPanelFeature

enum esphome::alarm_control_panel::AlarmControlPanelFeature : uint8_t

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 12 of file alarm_control_panel.h.

AlarmControlPanelState

enum esphome::alarm_control_panel::AlarmControlPanelState : uint8_t

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 8 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

state

The AlarmControlPanelState.

Definition at line 10 of file alarm_control_panel_state.cpp.

PROGMEM_STRING_TABLE()

esphome::alarm_control_panel::PROGMEM_STRING_TABLE	(	AlarmControlPanelStateStrings	,
		"DISARMED"	,
		"ARMED_HOME"	,
		"ARMED_AWAY"	,
		"ARMED_NIGHT"	,
		"ARMED_VACATION"	,
		"ARMED_CUSTOM_BYPASS"	,
		"PENDING"	,
		"ARMING"	,
		"DISARMING"	,
		"TRIGGERED"	,
		"UNKNOWN"	)