#include "esphome/core/entity_base.h" #include "esphome/core/application.h" #include "esphome/core/helpers.h" #include "esphome/core/progmem.h" #include "esphome/core/string_ref.h" namespace esphome { static const char *const TAG = "entity_base"; // Entity Name const StringRef &EntityBase::get_name() const { return this->name_; } void EntityBase::configure_entity_(const char *name, uint32_t object_id_hash, uint32_t entity_strings_packed) { this->name_ = StringRef(name); if (this->name_.empty()) { #ifdef USE_DEVICES if (this->device_ != nullptr) { this->name_ = StringRef(this->device_->get_name()); } else #endif { // Bug-for-bug compatibility with OLD behavior: // - With MAC suffix: OLD code used App.get_friendly_name() directly (no fallback) // - Without MAC suffix: OLD code used pre-computed object_id with fallback to device name const auto &friendly = App.get_friendly_name(); if (App.is_name_add_mac_suffix_enabled()) { // MAC suffix enabled - use friendly_name directly (even if empty) for compatibility this->name_ = friendly; } else { // No MAC suffix - fallback to device name if friendly_name is empty this->name_ = !friendly.empty() ? friendly : App.get_name(); } } this->flags_.has_own_name = false; // Dynamic name - must calculate hash at runtime this->calc_object_id_(); } else { this->flags_.has_own_name = true; // Static name - use pre-computed hash if provided if (object_id_hash != 0) { this->object_id_hash_ = object_id_hash; } else { this->calc_object_id_(); } } // Unpack entity string table indices. // Packed: [23..16] icon | [15..8] UoM | [7..0] device_class (each 8 bits) #ifdef USE_ENTITY_DEVICE_CLASS this->device_class_idx_ = entity_strings_packed & 0xFF; #endif #ifdef USE_ENTITY_UNIT_OF_MEASUREMENT this->uom_idx_ = (entity_strings_packed >> 8) & 0xFF; #endif #ifdef USE_ENTITY_ICON this->icon_idx_ = (entity_strings_packed >> 16) & 0xFF; #endif } // Weak default lookup functions — overridden by generated code in main.cpp __attribute__((weak)) const char *entity_device_class_lookup(uint8_t) { return ""; } __attribute__((weak)) const char *entity_uom_lookup(uint8_t) { return ""; } __attribute__((weak)) const char *entity_icon_lookup(uint8_t) { return ""; } // Entity device class — buffer-based API for PROGMEM safety on ESP8266 const char *EntityBase::get_device_class_to([[maybe_unused]] std::span buffer) const { #ifdef USE_ENTITY_DEVICE_CLASS const uint8_t idx = this->device_class_idx_; #else const uint8_t idx = 0; #endif #ifdef USE_ESP8266 if (idx == 0) return ""; const char *dc = entity_device_class_lookup(idx); ESPHOME_strncpy_P(buffer.data(), dc, buffer.size() - 1); buffer[buffer.size() - 1] = '\0'; return buffer.data(); #else return entity_device_class_lookup(idx); #endif } #ifndef USE_ESP8266 // Deprecated device class accessors — not available on ESP8266 (rodata is RAM) StringRef EntityBase::get_device_class_ref() const { #ifdef USE_ENTITY_DEVICE_CLASS return StringRef(entity_device_class_lookup(this->device_class_idx_)); #else return StringRef(entity_device_class_lookup(0)); #endif } std::string EntityBase::get_device_class() const { #ifdef USE_ENTITY_DEVICE_CLASS return std::string(entity_device_class_lookup(this->device_class_idx_)); #else return std::string(entity_device_class_lookup(0)); #endif } #endif // !USE_ESP8266 // Entity unit of measurement (from index) StringRef EntityBase::get_unit_of_measurement_ref() const { #ifdef USE_ENTITY_UNIT_OF_MEASUREMENT return StringRef(entity_uom_lookup(this->uom_idx_)); #else return StringRef(entity_uom_lookup(0)); #endif } std::string EntityBase::get_unit_of_measurement() const { return std::string(this->get_unit_of_measurement_ref().c_str()); } // Entity icon — buffer-based API for PROGMEM safety on ESP8266 const char *EntityBase::get_icon_to([[maybe_unused]] std::span buffer) const { #ifdef USE_ENTITY_ICON const uint8_t idx = this->icon_idx_; #else const uint8_t idx = 0; #endif #ifdef USE_ESP8266 if (idx == 0) return ""; const char *icon = entity_icon_lookup(idx); ESPHOME_strncpy_P(buffer.data(), icon, buffer.size() - 1); buffer[buffer.size() - 1] = '\0'; return buffer.data(); #else return entity_icon_lookup(idx); #endif } #ifndef USE_ESP8266 // Deprecated icon accessors — not available on ESP8266 (rodata is RAM) StringRef EntityBase::get_icon_ref() const { #ifdef USE_ENTITY_ICON return StringRef(entity_icon_lookup(this->icon_idx_)); #else return StringRef(entity_icon_lookup(0)); #endif } std::string EntityBase::get_icon() const { #ifdef USE_ENTITY_ICON return std::string(entity_icon_lookup(this->icon_idx_)); #else return std::string(entity_icon_lookup(0)); #endif } #endif // !USE_ESP8266 // Entity Object ID - computed on-demand from name std::string EntityBase::get_object_id() const { char buf[OBJECT_ID_MAX_LEN]; size_t len = this->write_object_id_to(buf, sizeof(buf)); return std::string(buf, len); } // Calculate Object ID Hash directly from name using snake_case + sanitize void EntityBase::calc_object_id_() { this->object_id_hash_ = fnv1_hash_object_id(this->name_.c_str(), this->name_.size()); } size_t EntityBase::write_object_id_to(char *buf, size_t buf_size) const { size_t len = std::min(this->name_.size(), buf_size - 1); for (size_t i = 0; i < len; i++) { buf[i] = to_sanitized_char(to_snake_case_char(this->name_[i])); } buf[len] = '\0'; return len; } StringRef EntityBase::get_object_id_to(std::span buf) const { size_t len = this->write_object_id_to(buf.data(), buf.size()); return StringRef(buf.data(), len); } uint32_t EntityBase::get_object_id_hash() { return this->object_id_hash_; } // Migrate preference data from old_key to new_key if they differ. // This helper is exposed so callers with custom key computation (like TextPrefs) // can use it for manual migration. See: https://github.com/esphome/backlog/issues/85 // // FUTURE IMPLEMENTATION: // This will require raw load/save methods on ESPPreferenceObject that take uint8_t* and size. // void EntityBase::migrate_entity_preference_(size_t size, uint32_t old_key, uint32_t new_key) { // if (old_key == new_key) // return; // auto old_pref = global_preferences->make_preference(size, old_key); // auto new_pref = global_preferences->make_preference(size, new_key); // SmallBufferWithHeapFallback<64> buffer(size); // if (old_pref.load(buffer.data(), size)) { // new_pref.save(buffer.data(), size); // } // } ESPPreferenceObject EntityBase::make_entity_preference_(size_t size, uint32_t version) { // This helper centralizes preference creation to enable fixing hash collisions. // See: https://github.com/esphome/backlog/issues/85 // // COLLISION PROBLEM: get_preference_hash() uses fnv1_hash on sanitized object_id. // Multiple entity names can sanitize to the same object_id: // - "Living Room" and "living_room" both become "living_room" // - UTF-8 names like "温度" and "湿度" both become "__" (underscores) // This causes entities to overwrite each other's stored preferences. // // FUTURE MIGRATION: When implementing get_preference_hash_v2() that hashes // the original entity name (not sanitized object_id): // // uint32_t old_key = this->get_preference_hash() ^ version; // uint32_t new_key = this->get_preference_hash_v2() ^ version; // this->migrate_entity_preference_(size, old_key, new_key); // return global_preferences->make_preference(size, new_key); // #pragma GCC diagnostic push #pragma GCC diagnostic ignored "-Wdeprecated-declarations" uint32_t key = this->get_preference_hash() ^ version; #pragma GCC diagnostic pop return global_preferences->make_preference(size, key); } #ifdef USE_ENTITY_ICON void log_entity_icon(const char *tag, const char *prefix, const EntityBase &obj) { char icon_buf[MAX_ICON_LENGTH]; const char *icon = obj.get_icon_to(icon_buf); if (icon[0] != '\0') { ESP_LOGCONFIG(tag, "%s Icon: '%s'", prefix, icon); } } #endif void log_entity_device_class(const char *tag, const char *prefix, const EntityBase &obj) { char dc_buf[MAX_DEVICE_CLASS_LENGTH]; const char *dc = obj.get_device_class_to(dc_buf); if (dc[0] != '\0') { ESP_LOGCONFIG(tag, "%s Device Class: '%s'", prefix, dc); } } void log_entity_unit_of_measurement(const char *tag, const char *prefix, const EntityBase &obj) { if (!obj.get_unit_of_measurement_ref().empty()) { ESP_LOGCONFIG(tag, "%s Unit of Measurement: '%s'", prefix, obj.get_unit_of_measurement_ref().c_str()); } } } // namespace esphome