template_alarm_control_panel.h

Go to the documentation of this file.

#pragma once
 
#include <cinttypes>
#include <cstring>
#include <vector>
 
#include "esphome/core/automation.h"
#include "esphome/core/component.h"
#include "esphome/core/defines.h"
#include "esphome/core/helpers.h"
 
#include "esphome/components/alarm_control_panel/alarm_control_panel.h"
 
#ifdef USE_BINARY_SENSOR
#include "esphome/components/binary_sensor/binary_sensor.h"
#endif
 
namespace esphome::template_ {
 
#ifdef USE_BINARY_SENSOR
enum BinarySensorFlags : uint8_t {
  BINARY_SENSOR_MODE_NORMAL = 1 << 0,
  BINARY_SENSOR_MODE_BYPASS_ARMED_HOME = 1 << 1,
  BINARY_SENSOR_MODE_BYPASS_ARMED_NIGHT = 1 << 2,
  BINARY_SENSOR_MODE_CHIME = 1 << 3,
  BINARY_SENSOR_MODE_BYPASS_AUTO = 1 << 4,
};
 
enum AlarmSensorType : uint8_t {
  ALARM_SENSOR_TYPE_DELAYED = 0,
  ALARM_SENSOR_TYPE_INSTANT,
  ALARM_SENSOR_TYPE_DELAYED_FOLLOWER,
  ALARM_SENSOR_TYPE_INSTANT_ALWAYS,
};
 
#endif
 
enum TemplateAlarmControlPanelRestoreMode {
  ALARM_CONTROL_PANEL_ALWAYS_DISARMED,
  ALARM_CONTROL_PANEL_RESTORE_DEFAULT_DISARMED,
};
 
#ifdef USE_BINARY_SENSOR
struct SensorInfo {
  uint8_t flags;
  AlarmSensorType type;
  bool chime_active;
  bool auto_bypassed;
};
 
struct AlarmSensor {
  binary_sensor::BinarySensor *sensor;
  SensorInfo info;
};
#endif
 
class TemplateAlarmControlPanel final : public alarm_control_panel::AlarmControlPanel, public Component {
 public:
  TemplateAlarmControlPanel();
  void dump_config() override;
  void setup() override;
  void loop() override;
  uint32_t get_supported_features() const override;
  bool get_requires_code() const override { return !this->codes_.empty(); }
  bool get_requires_code_to_arm() const override { return this->requires_code_to_arm_; }
  bool get_all_sensors_ready() { return this->sensors_ready_; };
  void set_restore_mode(TemplateAlarmControlPanelRestoreMode restore_mode) { this->restore_mode_ = restore_mode; }
  // Remove before 2026.10.0
  ESPDEPRECATED("bypass_before_arming() is deprecated and will be removed in 2026.10.0", "2026.4.0")
  void bypass_before_arming() { this->auto_bypass_sensors_(); }
 
#ifdef USE_BINARY_SENSOR
  void init_sensors(size_t capacity) { this->sensors_.init(capacity); }
 
  void add_sensor(binary_sensor::BinarySensor *sensor, uint8_t flags = 0,
                  AlarmSensorType type = ALARM_SENSOR_TYPE_DELAYED);
#endif
 
  void set_codes(std::initializer_list<const char *> codes) { this->codes_ = codes; }
 
  // Deleted overload to catch incorrect std::string usage at compile time
  void set_codes(std::initializer_list<std::string> codes) = delete;
 
  void set_requires_code_to_arm(bool code_to_arm) { this->requires_code_to_arm_ = code_to_arm; }
 
  void set_arming_away_time(uint32_t time) { this->arming_away_time_ = time; }
 
  void set_arming_home_time(uint32_t time) { this->arming_home_time_ = time; }
 
  void set_arming_night_time(uint32_t time) { this->arming_night_time_ = time; }
 
  void set_pending_time(uint32_t time) { this->pending_time_ = time; }
 
  void set_trigger_time(uint32_t time) { this->trigger_time_ = time; }
 
  void set_supports_arm_home(bool supports_arm_home) { supports_arm_home_ = supports_arm_home; }
 
  void set_supports_arm_night(bool supports_arm_night) { supports_arm_night_ = supports_arm_night; }
 
 protected:
  void control(const alarm_control_panel::AlarmControlPanelCall &call) override;
#ifdef USE_BINARY_SENSOR
  // List of binary sensors with their alarm-specific info
  FixedVector<AlarmSensor> sensors_;
#endif
  TemplateAlarmControlPanelRestoreMode restore_mode_{};
 
  // the arming away delay
  uint32_t arming_away_time_;
  // the arming home delay
  uint32_t arming_home_time_{0};
  // the arming night delay
  uint32_t arming_night_time_{0};
  // the trigger delay
  uint32_t pending_time_;
  // the time in trigger
  uint32_t trigger_time_;
  // a list of codes (const char* pointers to string literals in flash)
  FixedVector<const char *> codes_;
  // requires a code to arm
  bool requires_code_to_arm_ = false;
  bool supports_arm_home_ = false;
  bool supports_arm_night_ = false;
  bool sensors_ready_ = false;
  // check if the code is valid
  bool is_code_valid_(optional<std::string> code);
 
  void arm_(optional<std::string> code, alarm_control_panel::AlarmControlPanelState state, uint32_t delay);
  void auto_bypass_sensors_();
  void clear_auto_bypassed_sensors_();
};
 
}  // namespace esphome::template_