ESPHome 2025.5.0
Loading...
Searching...
No Matches
esphome::mqtt_subscribe::MQTTSubscribeTextSensor Class Reference

#include <mqtt_subscribe_text_sensor.h>

Inheritance diagram for esphome::mqtt_subscribe::MQTTSubscribeTextSensor:
esphome::text_sensor::TextSensor esphome::Component esphome::EntityBase esphome::EntityBase_DeviceClass

Public Member Functions

void set_parent (mqtt::MQTTClientComponent *parent)
 
void set_topic (const std::string &topic)
 
void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void set_qos (uint8_t qos)
 
- Public Member Functions inherited from esphome::text_sensor::TextSensor
std::string get_state () const
 Getter-syntax for .state.
 
std::string get_raw_state () const
 Getter-syntax for .raw_state.
 
void publish_state (const std::string &state)
 
void add_filter (Filter *filter)
 Add a filter to the filter chain. Will be appended to the back.
 
void add_filters (const std::vector< Filter * > &filters)
 Add a list of vectors to the back of the filter chain.
 
void set_filters (const std::vector< Filter * > &filters)
 Clear the filters and replace them by filters.
 
void clear_filters ()
 Clear the entire filter chain.
 
void add_on_state_callback (std::function< void(std::string)> callback)
 
void add_on_raw_state_callback (std::function< void(std::string)> callback)
 Add a callback that will be called every time the sensor sends a raw value.
 
virtual std::string unique_id ()
 Override this method to set the unique ID of this sensor.
 
bool has_state ()
 
void internal_send_state_to_frontend (const std::string &state)
 
- Public Member Functions inherited from esphome::EntityBase
const StringRefget_name () const
 
void set_name (const char *name)
 
bool has_own_name () const
 
std::string get_object_id () const
 
void set_object_id (const char *object_id)
 
uint32_t get_object_id_hash ()
 
bool is_internal () const
 
void set_internal (bool internal)
 
bool is_disabled_by_default () const
 
void set_disabled_by_default (bool disabled_by_default)
 
EntityCategory get_entity_category () const
 
void set_entity_category (EntityCategory entity_category)
 
std::string get_icon () const
 
void set_icon (const char *icon)
 
- Public Member Functions inherited from esphome::EntityBase_DeviceClass
std::string get_device_class ()
 Get the device class, using the manual override if set.
 
void set_device_class (const char *device_class)
 Manually set the device class.
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly.
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop().
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed.
 
void mark_failed (const char *message)
 
bool is_failed () const
 
bool is_ready () const
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning (const char *message="unspecified")
 
void status_set_error (const char *message="unspecified")
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages.
 
const char * get_component_source () const
 Get the integration where this component was declared as a string.
 
bool should_warn_of_blocking (uint32_t blocking_time)
 

Protected Attributes

mqtt::MQTTClientComponentparent_
 
std::string topic_
 
uint8_t qos_ {}
 
- Protected Attributes inherited from esphome::text_sensor::TextSensor
CallbackManager< void(std::string)> raw_callback_
 Storage for raw state callbacks.
 
CallbackManager< void(std::string)> callback_
 Storage for filtered state callbacks.
 
Filterfilter_list_ {nullptr}
 Store all active filters.
 
bool has_state_ {false}
 
- Protected Attributes inherited from esphome::EntityBase
StringRef name_
 
const char * object_id_c_str_ {nullptr}
 
const char * icon_c_str_ {nullptr}
 
uint32_t object_id_hash_
 
bool has_own_name_ {false}
 
bool internal_ {false}
 
bool disabled_by_default_ {false}
 
EntityCategory entity_category_ {ENTITY_CATEGORY_NONE}
 
- Protected Attributes inherited from esphome::EntityBase_DeviceClass
const char * device_class_ {nullptr}
 Device class override.
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component.
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 
uint32_t warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
 
std::string error_message_ {}
 

Additional Inherited Members

- Data Fields inherited from esphome::text_sensor::TextSensor
std::string state
 
std::string raw_state
 
- Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t hash_base ()
 The hash_base() function has been deprecated.
 
void calc_object_id_ ()
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name.
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function.
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name.
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function.
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name.
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function.
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty.
 

Detailed Description

Definition at line 14 of file mqtt_subscribe_text_sensor.h.

Member Function Documentation

◆ dump_config()

void esphome::mqtt_subscribe::MQTTSubscribeTextSensor::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 20 of file mqtt_subscribe_text_sensor.cpp.

◆ get_setup_priority()

float esphome::mqtt_subscribe::MQTTSubscribeTextSensor::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 18 of file mqtt_subscribe_text_sensor.cpp.

◆ set_parent()

void esphome::mqtt_subscribe::MQTTSubscribeTextSensor::set_parent ( mqtt::MQTTClientComponent * parent)
inline

Definition at line 16 of file mqtt_subscribe_text_sensor.h.

◆ set_qos()

void esphome::mqtt_subscribe::MQTTSubscribeTextSensor::set_qos ( uint8_t qos)

Definition at line 19 of file mqtt_subscribe_text_sensor.cpp.

◆ set_topic()

void esphome::mqtt_subscribe::MQTTSubscribeTextSensor::set_topic ( const std::string & topic)
inline

Definition at line 17 of file mqtt_subscribe_text_sensor.h.

◆ setup()

void esphome::mqtt_subscribe::MQTTSubscribeTextSensor::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 13 of file mqtt_subscribe_text_sensor.cpp.

Field Documentation

◆ parent_

mqtt::MQTTClientComponent* esphome::mqtt_subscribe::MQTTSubscribeTextSensor::parent_
protected

Definition at line 24 of file mqtt_subscribe_text_sensor.h.

◆ qos_

uint8_t esphome::mqtt_subscribe::MQTTSubscribeTextSensor::qos_ {}
protected

Definition at line 26 of file mqtt_subscribe_text_sensor.h.

◆ topic_

std::string esphome::mqtt_subscribe::MQTTSubscribeTextSensor::topic_
protected

Definition at line 25 of file mqtt_subscribe_text_sensor.h.


The documentation for this class was generated from the following files: