esphome::api::AlarmControlPanelEntity Class Reference

Handle to a AlarmControlPanel entity. More...

#include <entity_handles.hpp>

Inheritance diagram for esphome::api::AlarmControlPanelEntity:

Collaboration diagram for esphome::api::AlarmControlPanelEntity:

Public Member Functions
std::optional< AlarmControlPanelInfo >	info () const
std::optional< AlarmControlPanelStatus >	state () const
std::uint32_t	supported_features () const
bool	requires_code () const
bool	requires_code_to_arm () const
void	command (AlarmControlPanelCommand c) const
	Send a fully-specified command (its key is set automatically).
void	disarm (const std::string &code={}) const
void	arm_away (const std::string &code={}) const
void	arm_home (const std::string &code={}) const
Public Member Functions inherited from esphome::api::TypedEntity< AlarmControlPanelEntity >
std::string	icon () const
bool	disabled_by_default () const
EntityCategory	entity_category () const
std::uint32_t	device_id () const
	Entity (Client &client, const std::uint32_t key, std::string object_id, std::string name)
Public Member Functions inherited from esphome::api::Entity
	Entity (Client &client, const std::uint32_t key, std::string object_id, std::string name)
std::uint32_t	key () const noexcept
const std::string &	object_id () const noexcept
const std::string &	name () const noexcept

Static Public Member Functions
static constexpr EntityType	type ()

Additional Inherited Members
Protected Attributes inherited from esphome::api::Entity
Client *	client_
std::uint32_t	key_
std::string	object_id_
std::string	name_

Detailed Description

Handle to a AlarmControlPanel entity.

Member Function Documentation

arm_away()

void esphome::api::AlarmControlPanelEntity::arm_away ( const std::string &  code = {} ) const

inline

arm_home()

void esphome::api::AlarmControlPanelEntity::arm_home ( const std::string &  code = {} ) const

inline

command()

void esphome::api::AlarmControlPanelEntity::command ( AlarmControlPanelCommand  c ) const

inline

Send a fully-specified command (its key is set automatically).

disarm()

void esphome::api::AlarmControlPanelEntity::disarm ( const std::string &  code = {} ) const

inline

info()

std::optional< AlarmControlPanelInfo > esphome::api::AlarmControlPanelEntity::info ( ) const

inline

requires_code()

bool esphome::api::AlarmControlPanelEntity::requires_code ( ) const

inline

requires_code_to_arm()

bool esphome::api::AlarmControlPanelEntity::requires_code_to_arm ( ) const

inline

state()

std::optional< AlarmControlPanelStatus > esphome::api::AlarmControlPanelEntity::state ( ) const

inline

supported_features()

std::uint32_t esphome::api::AlarmControlPanelEntity::supported_features ( ) const

inline

type()

static constexpr EntityType esphome::api::AlarmControlPanelEntity::type ( )

inlinestaticconstexpr

---

The documentation for this class was generated from the following file:

• include/esphome/api/model/entity_handles.hpp