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

Common base: entity identity and the owning client. More...

#include <entity_handles.hpp>

Inheritance diagram for esphome::api::Entity:
Inheritance graph
[legend]
Collaboration diagram for esphome::api::Entity:
Collaboration graph
[legend]

Public Member Functions

 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
 

Protected Attributes

Clientclient_
 
std::uint32_t key_
 
std::string object_id_
 
std::string name_
 

Detailed Description

Common base: entity identity and the owning client.

Constructor & Destructor Documentation

◆ Entity()

esphome::api::Entity::Entity ( Client client,
const std::uint32_t  key,
std::string  object_id,
std::string  name 
)
inline

Member Function Documentation

◆ key()

std::uint32_t esphome::api::Entity::key ( ) const
inlinenoexcept

◆ name()

const std::string & esphome::api::Entity::name ( ) const
inlinenoexcept

◆ object_id()

const std::string & esphome::api::Entity::object_id ( ) const
inlinenoexcept

Member Data Documentation

◆ client_

Client* esphome::api::Entity::client_
protected

◆ key_

std::uint32_t esphome::api::Entity::key_
protected

◆ name_

std::string esphome::api::Entity::name_
protected

◆ object_id_

std::string esphome::api::Entity::object_id_
protected

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