1
0
mirror of https://github.com/esphome/esphome.git synced 2025-09-02 11:22:24 +01:00
Files
esphome/esphome/components/text/text.h

52 lines
1.3 KiB
C++

#pragma once
#include "esphome/core/component.h"
#include "esphome/core/entity_base.h"
#include "esphome/core/helpers.h"
#include "text_call.h"
#include "text_traits.h"
namespace esphome {
namespace text {
#define LOG_TEXT(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()); \
} \
}
/** Base-class for all text inputs.
*
* A text input can use publish_state to send out a new value.
*/
class Text : public EntityBase {
public:
std::string state;
TextTraits traits;
void publish_state(const std::string &state);
/// Instantiate a TextCall object to modify this text component's state.
TextCall make_call() { return TextCall(this); }
void add_on_state_callback(std::function<void(std::string)> &&callback);
protected:
friend class TextCall;
/** Set the value of the text input, this is a virtual method that each text input integration must implement.
*
* This method is called by the TextCall.
*
* @param value The value as validated by the TextCall.
*/
virtual void control(const std::string &value) = 0;
CallbackManager<void(std::string)> state_callback_;
};
} // namespace text
} // namespace esphome