mirror of
https://github.com/esphome/esphome.git
synced 2024-12-02 19:54:14 +01:00
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>
73 lines
2.2 KiB
C++
73 lines
2.2 KiB
C++
#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"
|
|
|
|
namespace esphome {
|
|
namespace text_sensor {
|
|
|
|
#define LOG_TEXT_SENSOR(prefix, type, obj) \
|
|
if ((obj) != nullptr) { \
|
|
ESP_LOGCONFIG(TAG, "%s%s '%s'", prefix, LOG_STR_LITERAL(type), (obj)->get_name().c_str()); \
|
|
if (!(obj)->get_icon().empty()) { \
|
|
ESP_LOGCONFIG(TAG, "%s Icon: '%s'", prefix, (obj)->get_icon().c_str()); \
|
|
} \
|
|
if (!(obj)->unique_id().empty()) { \
|
|
ESP_LOGV(TAG, "%s Unique ID: '%s'", prefix, (obj)->unique_id().c_str()); \
|
|
} \
|
|
}
|
|
|
|
class TextSensor : public EntityBase {
|
|
public:
|
|
explicit TextSensor();
|
|
explicit TextSensor(const std::string &name);
|
|
|
|
/// Getter-syntax for .state.
|
|
std::string get_state() const;
|
|
/// Getter-syntax for .raw_state
|
|
std::string get_raw_state() const;
|
|
|
|
void publish_state(const std::string &state);
|
|
|
|
/// Add a filter to the filter chain. Will be appended to the back.
|
|
void add_filter(Filter *filter);
|
|
|
|
/// Add a list of vectors to the back of the filter chain.
|
|
void add_filters(const std::vector<Filter *> &filters);
|
|
|
|
/// Clear the filters and replace them by filters.
|
|
void set_filters(const std::vector<Filter *> &filters);
|
|
|
|
/// Clear the entire filter chain.
|
|
void clear_filters();
|
|
|
|
void add_on_state_callback(std::function<void(std::string)> callback);
|
|
/// Add a callback that will be called every time the sensor sends a raw value.
|
|
void add_on_raw_state_callback(std::function<void(std::string)> callback);
|
|
|
|
std::string state;
|
|
std::string raw_state;
|
|
|
|
// ========== INTERNAL METHODS ==========
|
|
// (In most use cases you won't need these)
|
|
virtual std::string unique_id();
|
|
|
|
bool has_state();
|
|
|
|
void internal_send_state_to_frontend(const std::string &state);
|
|
|
|
protected:
|
|
uint32_t hash_base() override;
|
|
|
|
CallbackManager<void(std::string)> raw_callback_; ///< Storage for raw state callbacks.
|
|
CallbackManager<void(std::string)> callback_; ///< Storage for filtered state callbacks.
|
|
|
|
Filter *filter_list_{nullptr}; ///< Store all active filters.
|
|
|
|
bool has_state_{false};
|
|
};
|
|
|
|
} // namespace text_sensor
|
|
} // namespace esphome
|