esphome::api::InfraredEntity Class Reference

Handle to a Infrared entity. More...

#include <entity_handles.hpp>

Inheritance diagram for esphome::api::InfraredEntity:

Collaboration diagram for esphome::api::InfraredEntity:

Public Member Functions
std::optional< InfraredInfo >	info () const
std::uint32_t	capabilities () const
std::uint32_t	receiver_frequency () const
Public Member Functions inherited from esphome::api::TypedEntity< InfraredEntity >
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 Infrared entity.

Member Function Documentation

capabilities()

std::uint32_t esphome::api::InfraredEntity::capabilities ( ) const

inline

info()

std::optional< InfraredInfo > esphome::api::InfraredEntity::info ( ) const

inline

receiver_frequency()

std::uint32_t esphome::api::InfraredEntity::receiver_frequency ( ) const

inline

type()

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

inlinestaticconstexpr

---

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

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