|
| | TemplateAlarmControlPanel () |
| |
| void | dump_config () override |
| |
| void | setup () override |
| |
| void | loop () override |
| |
| uint32_t | get_supported_features () const override |
| |
| bool | get_requires_code () const override |
| |
| bool | get_requires_code_to_arm () const override |
| |
| bool | get_all_sensors_ready () |
| |
| void | set_restore_mode (TemplateAlarmControlPanelRestoreMode restore_mode) |
| |
| void | bypass_before_arming () |
| |
| void | init_sensors (size_t capacity) |
| | Initialize the sensors vector with the specified capacity.
|
| |
| void | add_sensor (binary_sensor::BinarySensor *sensor, uint16_t flags=0, AlarmSensorType type=ALARM_SENSOR_TYPE_DELAYED) |
| | Add a binary_sensor to the alarm_panel.
|
| |
| void | set_codes (std::initializer_list< const char * > codes) |
| | Set the codes (from initializer list).
|
| |
| void | set_codes (std::initializer_list< std::string > codes)=delete |
| |
| void | set_requires_code_to_arm (bool code_to_arm) |
| | set requires a code to arm
|
| |
| void | set_arming_away_time (uint32_t time) |
| | set the delay before arming away
|
| |
| void | set_arming_home_time (uint32_t time) |
| | set the delay before arming home
|
| |
| void | set_arming_night_time (uint32_t time) |
| | set the delay before arming night
|
| |
| void | set_pending_time (uint32_t time) |
| | set the delay before triggering
|
| |
| void | set_trigger_time (uint32_t time) |
| | set the delay before resetting after triggered
|
| |
| void | set_supports_arm_home (bool supports_arm_home) |
| |
| void | set_supports_arm_night (bool supports_arm_night) |
| |
| AlarmControlPanelCall | make_call () |
| | Make a AlarmControlPanelCall.
|
| |
| void | publish_state (AlarmControlPanelState state) |
| | Set the state of the alarm_control_panel.
|
| |
| void | add_on_state_callback (std::function< void()> &&callback) |
| | Add a callback for when the state of the alarm_control_panel changes.
|
| |
| void | add_on_cleared_callback (std::function< void()> &&callback) |
| | Add a callback for when the state of the alarm_control_panel clears from triggered.
|
| |
| void | add_on_chime_callback (std::function< void()> &&callback) |
| | Add a callback for when a chime zone goes from closed to open.
|
| |
| void | add_on_ready_callback (std::function< void()> &&callback) |
| | Add a callback for when a ready state changes.
|
| |
| void | arm_away (const char *code=nullptr) |
| | arm the alarm in away mode
|
| |
| void | arm_away (const optional< std::string > &code) |
| |
| void | arm_home (const char *code=nullptr) |
| | arm the alarm in home mode
|
| |
| void | arm_home (const optional< std::string > &code) |
| |
| void | arm_night (const char *code=nullptr) |
| | arm the alarm in night mode
|
| |
| void | arm_night (const optional< std::string > &code) |
| |
| void | arm_vacation (const char *code=nullptr) |
| | arm the alarm in vacation mode
|
| |
| void | arm_vacation (const optional< std::string > &code) |
| |
| void | arm_custom_bypass (const char *code=nullptr) |
| | arm the alarm in custom bypass mode
|
| |
| void | arm_custom_bypass (const optional< std::string > &code) |
| |
| void | disarm (const char *code=nullptr) |
| | disarm the alarm
|
| |
| void | disarm (const optional< std::string > &code) |
| |
| AlarmControlPanelState | get_state () const |
| | Get the state.
|
| |
| bool | is_state_armed (AlarmControlPanelState state) |
| |
| const StringRef & | get_name () const |
| |
| void | set_name (const char *name) |
| |
| void | set_name (const char *name, uint32_t object_id_hash) |
| | Set name with pre-computed object_id hash (avoids runtime hash calculation) Use hash=0 for dynamic names that need runtime calculation.
|
| |
| bool | has_own_name () const |
| |
| ESPDEPRECATED("object_id mangles names and all object_id methods are planned for removal " "(see https://github.com/esphome/backlog/issues/76). " "Now is the time to stop using object_id. If still needed, use get_object_id_to() " "which will remain available longer. get_object_id() will be removed in 2026.7.0", "2025.12.0") std uint32_t | get_object_id_hash () |
| |
| StringRef | get_object_id_to (std::span< char, OBJECT_ID_MAX_LEN > buf) const |
| | Get object_id with zero heap allocation For static case: returns StringRef to internal storage (buffer unused) For dynamic case: formats into buffer and returns StringRef to buffer.
|
| |
| size_t | write_object_id_to (char *buf, size_t buf_size) const |
| | Write object_id directly to buffer, returns length written (excluding null) Useful for building compound strings without intermediate buffer.
|
| |
| bool | is_internal () const |
| |
| void | set_internal (bool internal) |
| |
| bool | is_disabled_by_default () const |
| |
| void | set_disabled_by_default (bool disabled_by_default) |
| |
| EntityCategory | get_entity_category () const |
| |
| void | set_entity_category (EntityCategory entity_category) |
| |
| ESPDEPRECATED("Use get_icon_ref() instead for better performance (avoids string copy). Will be removed in ESPHome 2026.5.0", "2025.11.0") std void | set_icon (const char *icon) |
| |
| StringRef | get_icon_ref () const |
| |
| uint32_t | get_device_id () const |
| |
| void | set_device (Device *device) |
| |
| Device * | get_device () const |
| |
| bool | has_state () const |
| |
| void | set_has_state (bool state) |
| |
| | ESPDEPRECATED ("Use make_entity_preference<T>() instead, or preferences won't be migrated. " "See https://github.com/esphome/backlog/issues/85. Will be removed in 2027.1.0.", "2026.7.0") uint32_t get_preference_hash() |
| | Get a unique hash for storing preferences/settings for this entity.
|
| |
| template<typename T > |
| ESPPreferenceObject | make_entity_preference (uint32_t version=0) |
| | Create a preference object for storing this entity's state/settings.
|
| |
| virtual float | get_setup_priority () const |
| | priority of setup().
|
| |
| float | get_actual_setup_priority () const |
| |
| void | set_setup_priority (float priority) |
| |
| virtual float | get_loop_priority () const |
| | priority of loop().
|
| |
| void | call () |
| |
| virtual void | on_shutdown () |
| |
| virtual void | on_safe_shutdown () |
| |
| virtual bool | teardown () |
| | Called during teardown to allow component to gracefully finish operations.
|
| |
| virtual void | on_powerdown () |
| | Called after teardown is complete to power down hardware.
|
| |
| uint8_t | get_component_state () const |
| |
| void | reset_to_construction_state () |
| | Reset this component back to the construction state to allow setup to run again.
|
| |
| bool | is_in_loop_state () const |
| | Check if this component has completed setup and is in the loop state.
|
| |
| bool | is_idle () const |
| | Check if this component is idle.
|
| |
| virtual void | mark_failed () |
| | Mark this component as failed.
|
| |
| | ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message) |
| |
| void | mark_failed (const LogString *message) |
| |
| void | disable_loop () |
| | Disable this component's loop.
|
| |
| void | enable_loop () |
| | Enable this component's loop.
|
| |
| void | enable_loop_soon_any_context () |
| | Thread and ISR-safe version of enable_loop() that can be called from any context.
|
| |
| bool | is_failed () const |
| |
| bool | is_ready () const |
| |
| virtual bool | can_proceed () |
| |
| bool | status_has_warning () const |
| |
| bool | status_has_error () const |
| |
| void | status_set_warning (const char *message=nullptr) |
| |
| void | status_set_warning (const LogString *message) |
| |
| void | status_set_error () |
| |
| | ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message) |
| |
| void | status_set_error (const LogString *message) |
| |
| void | status_clear_warning () |
| |
| void | status_clear_error () |
| |
| void | status_momentary_warning (const char *name, uint32_t length=5000) |
| | Set warning status flag and automatically clear it after a timeout.
|
| |
| void | status_momentary_error (const char *name, uint32_t length=5000) |
| | Set error status flag and automatically clear it after a timeout.
|
| |
| bool | has_overridden_loop () const |
| |
| void | set_component_source (const LogString *source) |
| | Set where this component was loaded from for some debug messages.
|
| |
| const LogString * | get_component_log_str () const |
| | Get the integration where this component was declared as a LogString for logging.
|
| |
| bool | should_warn_of_blocking (uint32_t blocking_time) |
| |
|
| void | control (const alarm_control_panel::AlarmControlPanelCall &call) override |
| |
| bool | is_code_valid_ (optional< std::string > code) |
| |
| void | arm_ (optional< std::string > code, alarm_control_panel::AlarmControlPanelState state, uint32_t delay) |
| |
| void | arm_with_code_ (AlarmControlPanelCall &(AlarmControlPanelCall::*arm_method)(), const char *code) |
| |
| ESPPreferenceObject | make_entity_preference_ (size_t size, uint32_t version) |
| | Non-template helper for make_entity_preference() to avoid code bloat.
|
| |
| void | calc_object_id_ () |
| |
| virtual void | call_loop () |
| |
| virtual void | call_setup () |
| |
| virtual void | call_dump_config () |
| |
| void | set_component_state_ (uint8_t state) |
| | Helper to set component state (clears state bits and sets new state)
|
| |
| void | set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f) |
| | Set an interval function with a numeric ID (zero heap allocation).
|
| |
| void | set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f) |
| |
| void | set_interval (uint32_t interval, std::function< void()> &&f) |
| |
| bool | cancel_interval (uint32_t id) |
| |
| bool | cancel_interval (InternalSchedulerID id) |
| |
| ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std | ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const char *name |
| |
| | ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t id |
| |
| | ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t initial_wait_time |
| |
| ESPDEPRECATED("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const std | ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const char *name) |
| |
| | ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(uint32_t id) |
| |
| void | set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f) |
| | Set a timeout function with a numeric ID (zero heap allocation).
|
| |
| void | set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f) |
| |
| void | set_timeout (uint32_t timeout, std::function< void()> &&f) |
| |
| bool | cancel_timeout (uint32_t id) |
| |
| bool | cancel_timeout (InternalSchedulerID id) |
| |
| void | defer (std::function< void()> &&f) |
| | Defer a callback to the next loop() call.
|
| |
| void | defer (uint32_t id, std::function< void()> &&f) |
| | Defer a callback with a numeric ID (zero heap allocation)
|
| |
| bool | cancel_defer (uint32_t id) |
| |
|
| FixedVector< AlarmSensor > | sensors_ |
| |
| std::vector< uint8_t > | bypassed_sensor_indicies_ |
| |
| std::vector< SensorDataStore > | sensor_data_ |
| |
| uint8_t | next_store_index_ = 0 |
| |
| TemplateAlarmControlPanelRestoreMode | restore_mode_ {} |
| |
| uint32_t | arming_away_time_ |
| |
| uint32_t | arming_home_time_ {0} |
| |
| uint32_t | arming_night_time_ {0} |
| |
| uint32_t | pending_time_ |
| |
| uint32_t | trigger_time_ |
| |
| FixedVector< const char * > | codes_ |
| |
| bool | requires_code_to_arm_ = false |
| |
| bool | supports_arm_home_ = false |
| |
| bool | supports_arm_night_ = false |
| |
| bool | sensors_ready_ = false |
| |
| friend | AlarmControlPanelCall |
| |
| ESPPreferenceObject | pref_ |
| |
| AlarmControlPanelState | current_state_ |
| |
| AlarmControlPanelState | desired_state_ |
| |
| uint32_t | last_update_ |
| |
| LazyCallbackManager< void()> | state_callback_ {} |
| |
| LazyCallbackManager< void()> | cleared_callback_ {} |
| |
| LazyCallbackManager< void()> | chime_callback_ {} |
| |
| LazyCallbackManager< void()> | ready_callback_ {} |
| |
| StringRef | name_ |
| |
| const char * | icon_c_str_ {nullptr} |
| |
| uint32_t | object_id_hash_ {} |
| |
| Device * | device_ {} |
| |
| struct esphome::EntityBase::EntityFlags | flags_ |
| |
| ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi | set_interval )(const char *name, uint32_t interval, std::function< void()> &&f) |
| | Set an interval function with a unique name.
|
| |
| ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo | cancel_interval )(const char *name) |
| | Cancel an interval function.
|
| |
| ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t | initial_wait_time |
| |
| ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t | max_attempts |
| |
| ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> && | f |
| |
| ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> float | backoff_increase_factor = 1.0f) |
| |
| uint32_t | initial_wait_time |
| |
| uint32_t uint8_t | max_attempts |
| |
| uint32_t uint8_t std::function< RetryResult(uint8_t)> && | f |
| |
| uint32_t uint8_t std::function< RetryResult(uint8_t)> float | backoff_increase_factor = 1.0f) |
| |
| uint8_t | max_attempts |
| |
| uint8_t std::function< RetryResult(uint8_t)> && | f |
| |
| uint8_t std::function< RetryResult(uint8_t)> float | backoff_increase_factor = 1.0f) |
| |
| ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi | set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f) |
| | Set a timeout function with a unique name.
|
| |
| ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo | cancel_timeout )(const char *name) |
| | Cancel a timeout function.
|
| |
| ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi | defer )(const char *name, std::function< void()> &&f) |
| | Defer a callback to the next loop() call.
|
| |
| ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo | cancel_defer )(const char *name) |
| | Cancel a defer callback using the specified name, name must not be empty.
|
| |
| const LogString * | component_source_ {nullptr} |
| |
| uint16_t | warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS} |
| | Warn if blocked for this many ms (max 65.5s)
|
| |
| uint8_t | component_state_ {0x00} |
| | State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bits 5-7: Unused - reserved for future expansion.
|
| |
| volatile bool | pending_enable_loop_ {false} |
| | ISR-safe flag for enable_loop_soon_any_context.
|
| |
Public Member Functions inherited from esphome::alarm_control_panel::AlarmControlPanel
1.12.0