EntityBase Refactor (#2418)

* 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>

esphome/components/text_sensor/__init__.py

@@ -3,21 +3,18 @@ import esphome.config_validation as cv
 from esphome import automation
 from esphome.components import mqtt
 from esphome.const import (
-    CONF_DISABLED_BY_DEFAULT,
     CONF_FILTERS,
-    CONF_ICON,
     CONF_ID,
-    CONF_INTERNAL,
     CONF_ON_VALUE,
     CONF_ON_RAW_VALUE,
     CONF_TRIGGER_ID,
     CONF_MQTT_ID,
-    CONF_NAME,
     CONF_STATE,
     CONF_FROM,
     CONF_TO,
 )
 from esphome.core import CORE, coroutine_with_priority
+from esphome.cpp_helpers import setup_entity
 from esphome.util import Registry
 
 
@@ -25,7 +22,7 @@ IS_PLATFORM_COMPONENT = True
 
 # pylint: disable=invalid-name
 text_sensor_ns = cg.esphome_ns.namespace("text_sensor")
-TextSensor = text_sensor_ns.class_("TextSensor", cg.Nameable)
+TextSensor = text_sensor_ns.class_("TextSensor", cg.EntityBase)
 TextSensorPtr = TextSensor.operator("ptr")
 
 TextSensorStateTrigger = text_sensor_ns.class_(
@@ -111,10 +108,9 @@ async def substitute_filter_to_code(config, filter_id):
 
 icon = cv.icon
 
-TEXT_SENSOR_SCHEMA = cv.NAMEABLE_SCHEMA.extend(cv.MQTT_COMPONENT_SCHEMA).extend(
+TEXT_SENSOR_SCHEMA = cv.ENTITY_BASE_SCHEMA.extend(cv.MQTT_COMPONENT_SCHEMA).extend(
     {
         cv.OnlyWith(CONF_MQTT_ID, "mqtt"): cv.declare_id(mqtt.MQTTTextSensor),
-        cv.Optional(CONF_ICON): icon,
         cv.Optional(CONF_FILTERS): validate_filters,
         cv.Optional(CONF_ON_VALUE): automation.validate_automation(
             {
@@ -137,12 +133,7 @@ async def build_filters(config):
 
 
 async def setup_text_sensor_core_(var, config):
-    cg.add(var.set_name(config[CONF_NAME]))
-    cg.add(var.set_disabled_by_default(config[CONF_DISABLED_BY_DEFAULT]))
-    if CONF_INTERNAL in config:
-        cg.add(var.set_internal(config[CONF_INTERNAL]))
-    if CONF_ICON in config:
-        cg.add(var.set_icon(config[CONF_ICON]))
+    await setup_entity(var, config)
 
     if config.get(CONF_FILTERS):  # must exist and not be empty
         filters = await build_filters(config[CONF_FILTERS])

esphome/components/text_sensor/text_sensor.cpp

@@ -7,7 +7,7 @@ namespace text_sensor {
 static const char *const TAG = "text_sensor";
 
 TextSensor::TextSensor() : TextSensor("") {}
-TextSensor::TextSensor(const std::string &name) : Nameable(name) {}
+TextSensor::TextSensor(const std::string &name) : EntityBase(name) {}
 
 void TextSensor::publish_state(const std::string &state) {
   this->raw_state = state;
@@ -68,14 +68,6 @@ void TextSensor::internal_send_state_to_frontend(const std::string &state) {
   this->callback_.call(state);
 }
 
-void TextSensor::set_icon(const std::string &icon) { this->icon_ = icon; }
-std::string TextSensor::get_icon() {
-  if (this->icon_.has_value())
-    return *this->icon_;
-  return this->icon();
-}
-std::string TextSensor::icon() { return ""; }
-
 std::string TextSensor::unique_id() { return ""; }
 bool TextSensor::has_state() { return this->has_state_; }
 uint32_t TextSensor::hash_base() { return 334300109UL; }

esphome/components/text_sensor/text_sensor.h

@@ -1,6 +1,7 @@
 #pragma once
 
 #include "esphome/core/component.h"
+#include "esphome/core/entity_base.h"
 #include "esphome/core/helpers.h"
 #include "esphome/components/text_sensor/filter.h"
 
@@ -18,7 +19,7 @@ namespace text_sensor {
     } \
   }
 
-class TextSensor : public Nameable {
+class TextSensor : public EntityBase {
  public:
   explicit TextSensor();
   explicit TextSensor(const std::string &name);
@@ -30,8 +31,6 @@ class TextSensor : public Nameable {
 
   void publish_state(const std::string &state);
 
-  void set_icon(const std::string &icon);
-
   /// Add a filter to the filter chain. Will be appended to the back.
   void add_filter(Filter *filter);
 
@@ -53,10 +52,6 @@ class TextSensor : public Nameable {
 
   // ========== INTERNAL METHODS ==========
   // (In most use cases you won't need these)
-  std::string get_icon();
-
-  virtual std::string icon();
-
   virtual std::string unique_id();
 
   bool has_state();
@@ -71,7 +66,6 @@ class TextSensor : public Nameable {
 
   Filter *filter_list_{nullptr};  ///< Store all active filters.
 
-  optional<std::string> icon_;
   bool has_state_{false};
 };