471b82f727
* Renamed Nameable to EntityBase (cpp) * Renamed NAMEABLE_SCHEMA to ENTITY_BASE_SCHEMA (Python) * Renamed cg.Nameable to cg.EntityBase (Python) * Remove redundant use of CONF_NAME from esp32_touch * Remove redundant use of CONF_NAME from mcp3008 * Updated test * Moved EntityBase from Component.h and Component.cpp * Added icon property to EntityBase * Added CONF_ICON to ENTITY_BASE_SCHEMA and added setup_entity function to cpp_helpers * Added MQTT component getters for icon and disabled_by_default * Lint * Removed icon field from MQTT components * Code generation now uses setup_entity to setENTITY_BASE_SCHEMA fields * Removed unused import * Added cstdint include * Optimisation: don't set icon if it is empty * Remove icon from NumberTraits and SelectTraits * Removed unused import * Integration and Total Daily Energy sensors now inherit icons from their parents during code generation * Minor comment correction * Removed redundant icon-handling code from sensor, switch, and text_sensor * Update esphome/components/tsl2591/tsl2591.h Co-authored-by: Oxan van Leeuwen <oxan@oxanvanleeuwen.nl> * Added icon property to binary sensor, climate, cover, and fan component tests * Added icons for Binary Sensor, Climate, Cover, Fan, and Light to API * Consolidated EntityBase fields in MQTT components Co-authored-by: Oxan van Leeuwen <oxan@oxanvanleeuwen.nl>
51 lines
1.4 KiB
C++
51 lines
1.4 KiB
C++
#pragma once
|
|
|
|
#include <string>
|
|
#include <cstdint>
|
|
|
|
namespace esphome {
|
|
|
|
// The generic Entity base class that provides an interface common to all Entities.
|
|
class EntityBase {
|
|
public:
|
|
EntityBase() : EntityBase("") {}
|
|
explicit EntityBase(std::string name);
|
|
|
|
// Get/set the name of this Entity
|
|
const std::string &get_name() const;
|
|
void set_name(const std::string &name);
|
|
|
|
// Get the sanitized name of this Entity as an ID. Caching it internally.
|
|
const std::string &get_object_id();
|
|
|
|
// Get the unique Object ID of this Entity
|
|
uint32_t get_object_id_hash();
|
|
|
|
// Get/set whether this Entity should be hidden from outside of ESPHome
|
|
bool is_internal() const;
|
|
void set_internal(bool internal);
|
|
|
|
// Check if this object is declared to be disabled by default.
|
|
// That means that when the device gets added to Home Assistant (or other clients) it should
|
|
// not be added to the default view by default, and a user action is necessary to manually add it.
|
|
bool is_disabled_by_default() const;
|
|
void set_disabled_by_default(bool disabled_by_default);
|
|
|
|
// Get/set this entity's icon
|
|
const std::string &get_icon() const;
|
|
void set_icon(const std::string &name);
|
|
|
|
protected:
|
|
virtual uint32_t hash_base() = 0;
|
|
void calc_object_id_();
|
|
|
|
std::string name_;
|
|
std::string object_id_;
|
|
std::string icon_;
|
|
uint32_t object_id_hash_;
|
|
bool internal_{false};
|
|
bool disabled_by_default_{false};
|
|
};
|
|
|
|
} // namespace esphome
|