ESPHome  2024.11.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::alpha3::Alpha3 Class Reference

#include <alpha3.h>

Inheritance diagram for esphome::alpha3::Alpha3:
esphome::ble_client::BLEClientNode esphome::PollingComponent esphome::Component

Public Member Functions

void setup () 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_flow_sensor (sensor::Sensor *sensor)
 
void set_head_sensor (sensor::Sensor *sensor)
 
void set_power_sensor (sensor::Sensor *sensor)
 
void set_current_sensor (sensor::Sensor *sensor)
 
void set_speed_sensor (sensor::Sensor *sensor)
 
void set_voltage_sensor (sensor::Sensor *sensor)
 
- 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)
 
virtual void loop ()
 
void set_address (uint64_t address)
 
BLEClientparent ()
 
void set_ble_client_parent (BLEClient *parent)
 
- 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 loop ()
 This method will be called repeatedly. 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...
 

Protected Member Functions

void extract_publish_sensor_value_ (const uint8_t *response, int16_t length, int16_t response_offset, int16_t value_offset, sensor::Sensor *sensor, float factor)
 
void handle_geni_response_ (const uint8_t *response, uint16_t length)
 
void send_request_ (uint8_t *request, size_t len)
 
bool is_current_response_type_ (const uint8_t *response_type)
 
- 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...
 

Protected Attributes

sensor::Sensorflow_sensor_ {nullptr}
 
sensor::Sensorhead_sensor_ {nullptr}
 
sensor::Sensorpower_sensor_ {nullptr}
 
sensor::Sensorcurrent_sensor_ {nullptr}
 
sensor::Sensorspeed_sensor_ {nullptr}
 
sensor::Sensorvoltage_sensor_ {nullptr}
 
uint16_t geni_handle_
 
int16_t response_length_
 
int16_t response_offset_
 
uint8_t response_type_ [GENI_RESPONSE_TYPE_LENGTH]
 
uint8_t buffer_ [4]
 
- Protected Attributes inherited from esphome::ble_client::BLEClientNode
BLEClientparent_
 
uint64_t address_
 
- 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}
 

Additional Inherited Members

- Data Fields inherited from esphome::ble_client::BLEClientNode
espbt::ESPBTClientclient
 
espbt::ClientState node_state
 

Detailed Description

Definition at line 37 of file alpha3.h.

Member Function Documentation

◆ dump_config()

void esphome::alpha3::Alpha3::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 13 of file alpha3.cpp.

◆ extract_publish_sensor_value_()

void esphome::alpha3::Alpha3::extract_publish_sensor_value_ ( const uint8_t *  response,
int16_t  length,
int16_t  response_offset,
int16_t  value_offset,
sensor::Sensor sensor,
float  factor 
)
protected

Definition at line 25 of file alpha3.cpp.

◆ gattc_event_handler()

void esphome::alpha3::Alpha3::gattc_event_handler ( esp_gattc_cb_event_t  event,
esp_gatt_if_t  gattc_if,
esp_ble_gattc_cb_param_t *  param 
)
overridevirtual

Reimplemented from esphome::ble_client::BLEClientNode.

Definition at line 97 of file alpha3.cpp.

◆ get_setup_priority()

float esphome::alpha3::Alpha3::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 44 of file alpha3.h.

◆ handle_geni_response_()

void esphome::alpha3::Alpha3::handle_geni_response_ ( const uint8_t *  response,
uint16_t  length 
)
protected

Definition at line 57 of file alpha3.cpp.

◆ is_current_response_type_()

bool esphome::alpha3::Alpha3::is_current_response_type_ ( const uint8_t *  response_type)
protected

Definition at line 53 of file alpha3.cpp.

◆ send_request_()

void esphome::alpha3::Alpha3::send_request_ ( uint8_t *  request,
size_t  len 
)
protected

Definition at line 162 of file alpha3.cpp.

◆ set_current_sensor()

void esphome::alpha3::Alpha3::set_current_sensor ( sensor::Sensor sensor)
inline

Definition at line 48 of file alpha3.h.

◆ set_flow_sensor()

void esphome::alpha3::Alpha3::set_flow_sensor ( sensor::Sensor sensor)
inline

Definition at line 45 of file alpha3.h.

◆ set_head_sensor()

void esphome::alpha3::Alpha3::set_head_sensor ( sensor::Sensor sensor)
inline

Definition at line 46 of file alpha3.h.

◆ set_power_sensor()

void esphome::alpha3::Alpha3::set_power_sensor ( sensor::Sensor sensor)
inline

Definition at line 47 of file alpha3.h.

◆ set_speed_sensor()

void esphome::alpha3::Alpha3::set_speed_sensor ( sensor::Sensor sensor)
inline

Definition at line 49 of file alpha3.h.

◆ set_voltage_sensor()

void esphome::alpha3::Alpha3::set_voltage_sensor ( sensor::Sensor sensor)
inline

Definition at line 50 of file alpha3.h.

◆ setup()

void esphome::alpha3::Alpha3::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 23 of file alpha3.cpp.

◆ update()

void esphome::alpha3::Alpha3::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 170 of file alpha3.cpp.

Field Documentation

◆ buffer_

uint8_t esphome::alpha3::Alpha3::buffer_[4]
protected

Definition at line 63 of file alpha3.h.

◆ current_sensor_

sensor::Sensor* esphome::alpha3::Alpha3::current_sensor_ {nullptr}
protected

Definition at line 56 of file alpha3.h.

◆ flow_sensor_

sensor::Sensor* esphome::alpha3::Alpha3::flow_sensor_ {nullptr}
protected

Definition at line 53 of file alpha3.h.

◆ geni_handle_

uint16_t esphome::alpha3::Alpha3::geni_handle_
protected

Definition at line 59 of file alpha3.h.

◆ head_sensor_

sensor::Sensor* esphome::alpha3::Alpha3::head_sensor_ {nullptr}
protected

Definition at line 54 of file alpha3.h.

◆ power_sensor_

sensor::Sensor* esphome::alpha3::Alpha3::power_sensor_ {nullptr}
protected

Definition at line 55 of file alpha3.h.

◆ response_length_

int16_t esphome::alpha3::Alpha3::response_length_
protected

Definition at line 60 of file alpha3.h.

◆ response_offset_

int16_t esphome::alpha3::Alpha3::response_offset_
protected

Definition at line 61 of file alpha3.h.

◆ response_type_

uint8_t esphome::alpha3::Alpha3::response_type_[GENI_RESPONSE_TYPE_LENGTH]
protected

Definition at line 62 of file alpha3.h.

◆ speed_sensor_

sensor::Sensor* esphome::alpha3::Alpha3::speed_sensor_ {nullptr}
protected

Definition at line 57 of file alpha3.h.

◆ voltage_sensor_

sensor::Sensor* esphome::alpha3::Alpha3::voltage_sensor_ {nullptr}
protected

Definition at line 58 of file alpha3.h.


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