esphome-api-client 0.5.0
Modern C++17 client for the ESPHome native API (plaintext + Noise)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
esphome::api::TypedEntity< Derived > Class Template Reference

Adds the shared EntityInfo accessors, reading from Derived::info(). More...

#include <entity_handles.hpp>

Inheritance diagram for esphome::api::TypedEntity< Derived >:
Inheritance graph
[legend]
Collaboration diagram for esphome::api::TypedEntity< Derived >:
Collaboration graph
[legend]

Public Member Functions

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
 

Additional Inherited Members

- Protected Attributes inherited from esphome::api::Entity
Clientclient_
 
std::uint32_t key_
 
std::string object_id_
 
std::string name_
 

Detailed Description

template<class Derived>
class esphome::api::TypedEntity< Derived >

Adds the shared EntityInfo accessors, reading from Derived::info().

Member Function Documentation

◆ device_id()

template<class Derived >
std::uint32_t esphome::api::TypedEntity< Derived >::device_id ( ) const
inline

◆ disabled_by_default()

template<class Derived >
bool esphome::api::TypedEntity< Derived >::disabled_by_default ( ) const
inline

◆ Entity()

template<class Derived >
esphome::api::Entity::Entity ( Client client,
const std::uint32_t  key,
std::string  object_id,
std::string  name 
)
inline

◆ entity_category()

template<class Derived >
EntityCategory esphome::api::TypedEntity< Derived >::entity_category ( ) const
inline

◆ icon()

template<class Derived >
std::string esphome::api::TypedEntity< Derived >::icon ( ) const
inline

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