mirror of
https://github.com/esphome/esphome.git
synced 2026-02-25 04:45:29 -07:00
d4e978369a
This is so we can get the name of the device to use as part of the object id and to internally set the name for logging.
85 lines
2.4 KiB
C++
85 lines
2.4 KiB
C++
#include "esphome/core/entity_base.h"
|
|
#include "esphome/core/application.h"
|
|
#include "esphome/core/helpers.h"
|
|
|
|
namespace esphome {
|
|
|
|
static const char *const TAG = "entity_base";
|
|
|
|
// Entity Name
|
|
const StringRef &EntityBase::get_name() const { return this->name_; }
|
|
void EntityBase::set_name(const char *name) {
|
|
this->name_ = StringRef(name);
|
|
if (this->name_.empty()) {
|
|
#ifdef USE_DEVICES
|
|
if (this->device_ != nullptr) {
|
|
this->name_ = StringRef(this->device_->get_name());
|
|
} else
|
|
#endif
|
|
{
|
|
this->name_ = StringRef(App.get_friendly_name());
|
|
}
|
|
this->flags_.has_own_name = false;
|
|
} else {
|
|
this->flags_.has_own_name = true;
|
|
}
|
|
}
|
|
|
|
// Entity Icon
|
|
std::string EntityBase::get_icon() const {
|
|
if (this->icon_c_str_ == nullptr) {
|
|
return "";
|
|
}
|
|
return this->icon_c_str_;
|
|
}
|
|
void EntityBase::set_icon(const char *icon) { this->icon_c_str_ = icon; }
|
|
|
|
// Entity Object ID
|
|
std::string EntityBase::get_object_id() const {
|
|
std::string suffix = "";
|
|
#ifdef USE_DEVICES
|
|
if (this->device_ != nullptr) {
|
|
suffix = "@" + str_sanitize(str_snake_case(this->device_->get_name()));
|
|
}
|
|
#endif
|
|
// Check if `App.get_friendly_name()` is constant or dynamic.
|
|
if (!this->flags_.has_own_name && App.is_name_add_mac_suffix_enabled()) {
|
|
// `App.get_friendly_name()` is dynamic.
|
|
return str_sanitize(str_snake_case(App.get_friendly_name())) + suffix;
|
|
} else { // `App.get_friendly_name()` is constant.
|
|
if (this->object_id_c_str_ == nullptr) {
|
|
return suffix;
|
|
}
|
|
return this->object_id_c_str_ + suffix;
|
|
}
|
|
}
|
|
void EntityBase::set_object_id(const char *object_id) {
|
|
this->object_id_c_str_ = object_id;
|
|
this->calc_object_id_();
|
|
}
|
|
|
|
// Calculate Object ID Hash from Entity Name
|
|
void EntityBase::calc_object_id_() { this->object_id_hash_ = fnv1_hash(this->get_object_id()); }
|
|
|
|
uint32_t EntityBase::get_object_id_hash() { return this->object_id_hash_; }
|
|
|
|
std::string EntityBase_DeviceClass::get_device_class() {
|
|
if (this->device_class_ == nullptr) {
|
|
return "";
|
|
}
|
|
return this->device_class_;
|
|
}
|
|
|
|
void EntityBase_DeviceClass::set_device_class(const char *device_class) { this->device_class_ = device_class; }
|
|
|
|
std::string EntityBase_UnitOfMeasurement::get_unit_of_measurement() {
|
|
if (this->unit_of_measurement_ == nullptr)
|
|
return "";
|
|
return this->unit_of_measurement_;
|
|
}
|
|
void EntityBase_UnitOfMeasurement::set_unit_of_measurement(const char *unit_of_measurement) {
|
|
this->unit_of_measurement_ = unit_of_measurement;
|
|
}
|
|
|
|
} // namespace esphome
|