ESPHome  2022.12.8
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
esphome::ble_client::BLESensor Class Reference

#include <ble_sensor.h>

Inheritance diagram for esphome::ble_client::BLESensor:
esphome::sensor::Sensor esphome::PollingComponent esphome::ble_client::BLEClientNode esphome::EntityBase esphome::Component esphome::ble_client::BLESensorNotifyTrigger

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_data_to_value (data_to_value_t &&lambda)
void set_enable_notify (bool notify)
- Public Member Functions inherited from esphome::sensor::Sensor
 Sensor ()
 Sensor (const std::string &name)
std::string get_unit_of_measurement ()
 Get the unit of measurement, using the manual override if set. More...
void set_unit_of_measurement (const std::string &unit_of_measurement)
 Manually set the unit of measurement. More...
int8_t get_accuracy_decimals ()
 Get the accuracy in decimals, using the manual override if set. More...
void set_accuracy_decimals (int8_t accuracy_decimals)
 Manually set the accuracy in decimals. More...
std::string get_device_class ()
 Get the device class, using the manual override if set. More...
void set_device_class (const std::string &device_class)
 Manually set the device class. More...
StateClass get_state_class ()
 Get the state class, using the manual override if set. More...
void set_state_class (StateClass state_class)
 Manually set the state class. More...
bool get_force_update () const
 Get whether force update mode is enabled. More...
void set_force_update (bool force_update)
 Set force update mode. More...
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...
float get_state () const
 Getter-syntax for .state. More...
float get_raw_state () const
 Getter-syntax for .raw_state. More...
void publish_state (float state)
 Publish a new state to the front-end. More...
void add_on_state_callback (std::function< void(float)> &&callback)
 Add a callback that will be called every time a filtered value arrives. More...
void add_on_raw_state_callback (std::function< void(float)> &&callback)
 Add a callback that will be called every time the sensor sends a raw value. More...
bool has_state () const
 Return whether this sensor has gotten a full state (that passed through all filters) yet. More...
virtual std::string unique_id ()
 A unique ID for this sensor, empty for no unique id. More...
void internal_send_state_to_frontend (float state)
- Public Member Functions inherited from esphome::EntityBase
 EntityBase ()
 EntityBase (std::string name)
const std::string & get_name () const
void set_name (const std::string &name)
const std::string & get_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)
const std::string & get_icon () const
void set_icon (const std::string &name)
- 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...
- 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 ()
virtual bool can_proceed ()
bool status_has_warning ()
bool status_has_error ()
void status_set_warning ()
void status_set_error ()
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::sensor::Sensor
float state
 This member variable stores the last state that has passed through all filters. More...
float raw_state
 This member variable stores the current raw state of the sensor, without any filters applied. More...
- Data Fields inherited from esphome::ble_client::BLEClientNode
espbt::ClientState node_state

Protected Member Functions

float parse_data_ (uint8_t *value, uint16_t value_len)
- Protected Member Functions inherited from esphome::sensor::Sensor
virtual std::string unit_of_measurement ()
 Override this to set the default unit of measurement. More...
virtual int8_t accuracy_decimals ()
 Override this to set the default accuracy in decimals. More...
virtual std::string device_class ()
 Override this to set the default device class. More...
virtual StateClass state_class ()
 Override this to set the default state class. More...
- 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()> &&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()> &&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...

Protected Attributes

optional< data_to_value_tdata_to_value_func_ {}
bool notify_
espbt::ESPBTUUID service_uuid_
espbt::ESPBTUUID char_uuid_
espbt::ESPBTUUID descr_uuid_
- Protected Attributes inherited from esphome::sensor::Sensor
CallbackManager< void(float)> raw_callback_
 Storage for raw state callbacks. More...
CallbackManager< void(float)> callback_
 Storage for filtered state callbacks. More...
bool has_state_ {false}
Filterfilter_list_ {nullptr}
 Store all active filters. More...
optional< std::string > unit_of_measurement_
 Unit of measurement override. More...
optional< int8_t > accuracy_decimals_
 Accuracy in decimals override. More...
optional< std::string > device_class_
 Device class override. More...
optional< StateClassstate_class_ {STATE_CLASS_NONE}
 State class override. More...
bool force_update_ {false}
 Force update mode. More...
- Protected Attributes inherited from esphome::EntityBase
std::string name_
std::string object_id_
std::string icon_
uint32_t object_id_hash_
bool internal_ {false}
bool disabled_by_default_ {false}
EntityCategory entity_category_ {ENTITY_CATEGORY_NONE}
- 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_

Detailed Description

Definition at line 20 of file ble_sensor.h.

Member Function Documentation

◆ dump_config()

void esphome::ble_client::BLESensor::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 16 of file ble_sensor.cpp.

◆ gattc_event_handler()

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

Implements esphome::ble_client::BLEClientNode.

Definition at line 26 of file ble_sensor.cpp.

◆ get_setup_priority()

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

Reimplemented from esphome::Component.

Definition at line 27 of file ble_sensor.h.

◆ loop()

void esphome::ble_client::BLESensor::loop ( )

Reimplemented from esphome::ble_client::BLEClientNode.

Definition at line 14 of file ble_sensor.cpp.

◆ parse_data_()

float esphome::ble_client::BLESensor::parse_data_ ( uint8_t *  value,
uint16_t  value_len 

Definition at line 106 of file ble_sensor.cpp.

◆ set_char_uuid128()

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

Definition at line 33 of file ble_sensor.h.

◆ set_char_uuid16()

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

Definition at line 31 of file ble_sensor.h.

◆ set_char_uuid32()

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

Definition at line 32 of file ble_sensor.h.

◆ set_data_to_value()

void esphome::ble_client::BLESensor::set_data_to_value ( data_to_value_t &&  lambda)

Definition at line 37 of file ble_sensor.h.

◆ set_descr_uuid128()

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

Definition at line 36 of file ble_sensor.h.

◆ set_descr_uuid16()

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

Definition at line 34 of file ble_sensor.h.

◆ set_descr_uuid32()

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

Definition at line 35 of file ble_sensor.h.

◆ set_enable_notify()

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

Definition at line 38 of file ble_sensor.h.

◆ set_service_uuid128()

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

Definition at line 30 of file ble_sensor.h.

◆ set_service_uuid16()

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

Definition at line 28 of file ble_sensor.h.

◆ set_service_uuid32()

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

Definition at line 29 of file ble_sensor.h.

◆ update()

void esphome::ble_client::BLESensor::update ( )

Implements esphome::PollingComponent.

Definition at line 115 of file ble_sensor.cpp.

Field Documentation

◆ char_uuid_

espbt::ESPBTUUID esphome::ble_client::BLESensor::char_uuid_

Definition at line 46 of file ble_sensor.h.

◆ data_to_value_func_

optional<data_to_value_t> esphome::ble_client::BLESensor::data_to_value_func_ {}

Definition at line 43 of file ble_sensor.h.

◆ descr_uuid_

espbt::ESPBTUUID esphome::ble_client::BLESensor::descr_uuid_

Definition at line 47 of file ble_sensor.h.

◆ handle

uint16_t esphome::ble_client::BLESensor::handle

Definition at line 39 of file ble_sensor.h.

◆ notify_

bool esphome::ble_client::BLESensor::notify_

Definition at line 44 of file ble_sensor.h.

◆ service_uuid_

espbt::ESPBTUUID esphome::ble_client::BLESensor::service_uuid_

Definition at line 45 of file ble_sensor.h.

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