ESPHome  2024.6.1
Public Member Functions | Data Fields | Protected Attributes
esphome::ble_client::BLETextSensor Class Reference

#include <ble_text_sensor.h>

Inheritance diagram for esphome::ble_client::BLETextSensor:
esphome::text_sensor::TextSensor esphome::PollingComponent esphome::ble_client::BLEClientNode esphome::EntityBase esphome::EntityBase_DeviceClass esphome::Component esphome::ble_client::BLETextSensorNotifyTrigger

Public Member Functions

void loop () override
void update () override
void gattc_event_handler (esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if, esp_ble_gattc_cb_param_t *param) override
void dump_config () override
float get_setup_priority () const override
void set_service_uuid16 (uint16_t uuid)
void set_service_uuid32 (uint32_t uuid)
void set_service_uuid128 (uint8_t *uuid)
void set_char_uuid16 (uint16_t uuid)
void set_char_uuid32 (uint32_t uuid)
void set_char_uuid128 (uint8_t *uuid)
void set_descr_uuid16 (uint16_t uuid)
void set_descr_uuid32 (uint32_t uuid)
void set_descr_uuid128 (uint8_t *uuid)
void set_enable_notify (bool notify)
std::string parse_data (uint8_t *value, uint16_t value_len)
- Public Member Functions inherited from esphome::text_sensor::TextSensor
std::string get_state () const
 Getter-syntax for .state. More...
std::string get_raw_state () const
 Getter-syntax for .raw_state. More...
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. More...
void add_filters (const std::vector< Filter *> &filters)
 Add a list of vectors to the back of the filter chain. More...
void set_filters (const std::vector< Filter *> &filters)
 Clear the filters and replace them by filters. More...
void clear_filters ()
 Clear the entire filter chain. More...
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. More...
virtual std::string unique_id ()
 Override this method to set the unique ID of this sensor. More...
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. More...
void set_device_class (const char *device_class)
 Manually set the device class. More...
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms. More...
virtual void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object. More...
void call_setup () override
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor. More...
void start_poller ()
void stop_poller ()
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. More...
float get_actual_setup_priority () const
void set_setup_priority (float priority)
virtual float get_loop_priority () const
 priority of loop(). More...
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. More...
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. More...
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
- Public Member Functions inherited from esphome::ble_client::BLEClientNode
virtual void gap_event_handler (esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param)
void set_address (uint64_t address)
BLEClientparent ()
void set_ble_client_parent (BLEClient *parent)

Data Fields

uint16_t handle
- Data Fields inherited from esphome::text_sensor::TextSensor
std::string state
std::string raw_state
- Data Fields inherited from esphome::ble_client::BLEClientNode
espbt::ClientState node_state

Protected Attributes

bool notify_
espbt::ESPBTUUID service_uuid_
espbt::ESPBTUUID char_uuid_
espbt::ESPBTUUID descr_uuid_
- Protected Attributes inherited from esphome::text_sensor::TextSensor
CallbackManager< void(std::string)> raw_callback_
 Storage for raw state callbacks. More...
CallbackManager< void(std::string)> callback_
 Storage for filtered state callbacks. More...
Filterfilter_list_ {nullptr}
 Store all active filters. More...
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. More...
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
float setup_priority_override_ {NAN}
const char * component_source_ {nullptr}
- Protected Attributes inherited from esphome::ble_client::BLEClientNode
uint64_t address_

Additional Inherited Members

- Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t hash_base ()
 The hash_base() function has been deprecated. More...
void calc_object_id_ ()
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
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. More...
void set_interval (uint32_t interval, std::function< void()> &&f)
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
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. More...
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. More...
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
void set_timeout (uint32_t timeout, std::function< void()> &&f)
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...

Detailed Description

Definition at line 16 of file ble_text_sensor.h.

Member Function Documentation

◆ dump_config()

void esphome::ble_client::BLETextSensor::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 19 of file ble_text_sensor.cpp.

◆ gattc_event_handler()

void esphome::ble_client::BLETextSensor::gattc_event_handler ( esp_gattc_cb_event_t  event,
esp_gatt_if_t  gattc_if,
esp_ble_gattc_cb_param_t *  param 

Reimplemented from esphome::ble_client::BLEClientNode.

Definition at line 29 of file ble_text_sensor.cpp.

◆ get_setup_priority()

float esphome::ble_client::BLETextSensor::get_setup_priority ( ) const

Reimplemented from esphome::Component.

Definition at line 23 of file ble_text_sensor.h.

◆ loop()

void esphome::ble_client::BLETextSensor::loop ( )

Reimplemented from esphome::ble_client::BLEClientNode.

Definition at line 17 of file ble_text_sensor.cpp.

◆ parse_data()

std::string esphome::ble_client::BLETextSensor::parse_data ( uint8_t *  value,
uint16_t  value_len 

Definition at line 107 of file ble_text_sensor.cpp.

◆ set_char_uuid128()

void esphome::ble_client::BLETextSensor::set_char_uuid128 ( uint8_t *  uuid)

Definition at line 29 of file ble_text_sensor.h.

◆ set_char_uuid16()

void esphome::ble_client::BLETextSensor::set_char_uuid16 ( uint16_t  uuid)

Definition at line 27 of file ble_text_sensor.h.

◆ set_char_uuid32()

void esphome::ble_client::BLETextSensor::set_char_uuid32 ( uint32_t  uuid)

Definition at line 28 of file ble_text_sensor.h.

◆ set_descr_uuid128()

void esphome::ble_client::BLETextSensor::set_descr_uuid128 ( uint8_t *  uuid)

Definition at line 32 of file ble_text_sensor.h.

◆ set_descr_uuid16()

void esphome::ble_client::BLETextSensor::set_descr_uuid16 ( uint16_t  uuid)

Definition at line 30 of file ble_text_sensor.h.

◆ set_descr_uuid32()

void esphome::ble_client::BLETextSensor::set_descr_uuid32 ( uint32_t  uuid)

Definition at line 31 of file ble_text_sensor.h.

◆ set_enable_notify()

void esphome::ble_client::BLETextSensor::set_enable_notify ( bool  notify)

Definition at line 33 of file ble_text_sensor.h.

◆ set_service_uuid128()

void esphome::ble_client::BLETextSensor::set_service_uuid128 ( uint8_t *  uuid)

Definition at line 26 of file ble_text_sensor.h.

◆ set_service_uuid16()

void esphome::ble_client::BLETextSensor::set_service_uuid16 ( uint16_t  uuid)

Definition at line 24 of file ble_text_sensor.h.

◆ set_service_uuid32()

void esphome::ble_client::BLETextSensor::set_service_uuid32 ( uint32_t  uuid)

Definition at line 25 of file ble_text_sensor.h.

◆ update()

void esphome::ble_client::BLETextSensor::update ( )

Implements esphome::PollingComponent.

Definition at line 112 of file ble_text_sensor.cpp.

Field Documentation

◆ char_uuid_

espbt::ESPBTUUID esphome::ble_client::BLETextSensor::char_uuid_

Definition at line 40 of file ble_text_sensor.h.

◆ descr_uuid_

espbt::ESPBTUUID esphome::ble_client::BLETextSensor::descr_uuid_

Definition at line 41 of file ble_text_sensor.h.

◆ handle

uint16_t esphome::ble_client::BLETextSensor::handle

Definition at line 35 of file ble_text_sensor.h.

◆ notify_

bool esphome::ble_client::BLETextSensor::notify_

Definition at line 38 of file ble_text_sensor.h.

◆ service_uuid_

espbt::ESPBTUUID esphome::ble_client::BLETextSensor::service_uuid_

Definition at line 39 of file ble_text_sensor.h.

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