esphome::api::ButtonEntity Class Reference

Handle to a Button entity. More...

#include <entity_handles.hpp>

Inheritance diagram for esphome::api::ButtonEntity:

Collaboration diagram for esphome::api::ButtonEntity:

Public Member Functions
std::optional< ButtonInfo >	info () const
std::string	device_class () const
void	command (ButtonCommand c) const
	Send a fully-specified command (its key is set automatically).
void	press () const
Public Member Functions inherited from esphome::api::TypedEntity< ButtonEntity >
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 Button entity.

Member Function Documentation

command()

void esphome::api::ButtonEntity::command ( ButtonCommand  c ) const

inline

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

device_class()

std::string esphome::api::ButtonEntity::device_class ( ) const

inline

info()

std::optional< ButtonInfo > esphome::api::ButtonEntity::info ( ) const

inline

press()

void esphome::api::ButtonEntity::press ( ) const

inline

type()

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

inlinestaticconstexpr

---

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

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