ESPHome 2026.11.0-dev
Loading...
Searching...
No Matches
esphome::bq25186::BQ25186TextSensor Class Referencefinal

A two-bit status field; first is the string table index of the field's value 0. More...

#include <bq25186_text_sensor.h>

Inheritance diagram for esphome::bq25186::BQ25186TextSensor:
esphome::text_sensor::TextSensor esphome::EntityBase

Public Member Functions

 BQ25186TextSensor (uint8_t reg, uint8_t shift, uint8_t first)
 
void on_status (const BQ25186StatusRegisters &status)
 
- Public Member Functions inherited from esphome::text_sensor::TextSensor
 TextSensor ()
 
 ~TextSensor ()=default
 
const std::string & get_state () const
 Getter-syntax for .state.
 
const std::string & get_raw_state () const
 Returns the raw (pre-filter) state.
 
void publish_state (const std::string &state)
 
void publish_state (const char *state)
 
void publish_state (const char *state, size_t len)
 
void add_filter (Filter *filter)
 Add a filter to the filter chain. Will be appended to the back.
 
void add_filters (std::initializer_list< Filter * > filters)
 Add a list of vectors to the back of the filter chain.
 
void set_filters (std::initializer_list< Filter * > filters)
 Clear the filters and replace them by filters.
 
void clear_filters ()
 Clear the entire filter chain.
 
template<typename F >
void add_on_state_callback (F &&callback)
 
template<typename F >
void add_on_raw_state_callback (F &&callback)
 Add a callback that will be called every time the sensor sends a raw value.
 
void internal_send_state_to_frontend (const std::string &state)
 
void internal_send_state_to_frontend (const char *state, size_t len)
 
- Public Member Functions inherited from esphome::EntityBase
const StringRef & get_name () const
 
bool has_own_name () const
 
uint32_t get_object_id_hash () const
 
StringRef get_object_id_to (std::span< char, OBJECT_ID_MAX_LEN > buf) const
 Get object_id with zero heap allocation For static case: returns StringRef to internal storage (buffer unused) For dynamic case: formats into buffer and returns StringRef to buffer.
 
size_t write_object_id_to (char *buf, size_t buf_size) const
 Write object_id directly to buffer, returns length written (excluding null) Useful for building compound strings without intermediate buffer.
 
bool is_internal () const
 
void set_internal (bool internal)
 
bool is_disabled_by_default () const
 
EntityCategory get_entity_category () const
 
const char * get_device_class_to (std::span< char, MAX_DEVICE_CLASS_LENGTH > buffer) const
 
StringRef get_unit_of_measurement_ref () const
 
const char * get_icon_to (std::span< char, MAX_ICON_LENGTH > buffer) const
 
uint32_t get_device_id () const
 
Device * get_device () const
 
bool has_state () const
 
void set_has_state (bool state)
 
 ESPDEPRECATED ("Use make_entity_preference<T>() instead, or preferences won't be migrated. " "See https://github.com/esphome/backlog/issues/85. Will be removed in 2027.1.0.", "2026.7.0") uint32_t get_preference_hash()
 Get a unique hash for storing preferences/settings for this entity.
 
template<typename T >
ESPPreferenceObject make_entity_preference (uint32_t version=0)
 Create a preference object for storing this entity's state/settings.
 

Protected Attributes

const uint8_t reg_
 
const uint8_t shift_
 
const uint8_t first_
 
uint8_t last_ {0xFF}
 
- Protected Attributes inherited from esphome::text_sensor::TextSensor
std::string raw_state_
 Backing storage for the raw (pre-filter) value. Only used when a filter is attached.
 
LazyCallbackManager< void(const std::string &)> raw_callback_
 Storage for raw state callbacks.
 
LazyCallbackManager< void(const std::string &)> callback_
 Storage for filtered state callbacks.
 
Filter * filter_list_ {nullptr}
 Store all active filters.
 
- Protected Attributes inherited from esphome::EntityBase
StringRef name_
 
uint32_t object_id_hash_ {}
 
Device * device_ {}
 
struct esphome::EntityBase::EntityFlags flags_
 
uint8_t device_class_idx_ {}
 
uint8_t uom_idx_ {}
 
uint8_t icon_idx_ {}
 

Additional Inherited Members

- Data Fields inherited from esphome::text_sensor::TextSensor
std::string state
 
- Protected Member Functions inherited from esphome::text_sensor::TextSensor
void notify_frontend_ ()
 Notify frontend that state has changed (assumes this->state is already set)
 
- Protected Member Functions inherited from esphome::EntityBase
friend void::setup ()
 
friend void::original_setup ()
 
void configure_entity_ (const char *name, uint32_t object_id_hash, uint32_t entity_fields)
 Combined entity setup from codegen: set name, object_id hash, entity string indices, and flags.
 
void set_device_ (Device *device)
 
ESPPreferenceObject make_entity_preference_ (size_t size, uint32_t version)
 Non-template helper for make_entity_preference() to avoid code bloat.
 
void calc_object_id_ ()
 

Detailed Description

A two-bit status field; first is the string table index of the field's value 0.

Definition at line 12 of file bq25186_text_sensor.h.

Constructor & Destructor Documentation

◆ BQ25186TextSensor()

esphome::bq25186::BQ25186TextSensor::BQ25186TextSensor ( uint8_t reg,
uint8_t shift,
uint8_t first )
inline

Definition at line 14 of file bq25186_text_sensor.h.

Member Function Documentation

◆ on_status()

void esphome::bq25186::BQ25186TextSensor::on_status ( const BQ25186StatusRegisters & status)

Definition at line 12 of file bq25186_text_sensor.cpp.

Field Documentation

◆ first_

const uint8_t esphome::bq25186::BQ25186TextSensor::first_
protected

Definition at line 20 of file bq25186_text_sensor.h.

◆ last_

uint8_t esphome::bq25186::BQ25186TextSensor::last_ {0xFF}
protected

Definition at line 21 of file bq25186_text_sensor.h.

◆ reg_

const uint8_t esphome::bq25186::BQ25186TextSensor::reg_
protected

Definition at line 18 of file bq25186_text_sensor.h.

◆ shift_

const uint8_t esphome::bq25186::BQ25186TextSensor::shift_
protected

Definition at line 19 of file bq25186_text_sensor.h.


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