ESPHome  2024.2.1
Data Structures | Public Member Functions | Protected Member Functions | Protected Attributes
esphome::airthings_wave_base::AirthingsWaveBase Class Referenceabstract

#include <airthings_wave_base.h>

Inheritance diagram for esphome::airthings_wave_base::AirthingsWaveBase:
esphome::PollingComponent esphome::ble_client::BLEClientNode esphome::Component esphome::airthings_wave_mini::AirthingsWaveMini esphome::airthings_wave_plus::AirthingsWavePlus

Data Structures

struct  AccessControlPointResponse
 

Public Member Functions

 AirthingsWaveBase ()=default
 
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 set_temperature (sensor::Sensor *temperature)
 
void set_humidity (sensor::Sensor *humidity)
 
void set_pressure (sensor::Sensor *pressure)
 
void set_tvoc (sensor::Sensor *tvoc)
 
void set_battery_voltage (sensor::Sensor *voltage)
 
void set_battery_update_interval (uint32_t interval)
 
- 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...
 
virtual void loop ()
 This method will be called repeatedly. More...
 
virtual void dump_config ()
 
virtual float get_setup_priority () const
 priority of setup(). 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 ()
 
bool is_ready ()
 
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)
 
virtual void loop ()
 
void set_address (uint64_t address)
 
BLEClientparent ()
 
void set_ble_client_parent (BLEClient *parent)
 

Protected Member Functions

bool is_valid_voc_value_ (uint16_t voc)
 
bool request_read_values_ ()
 
virtual void read_sensors (uint8_t *raw_value, uint16_t value_len)=0
 
void response_pending_ ()
 
void response_received_ ()
 
void set_response_timeout_ ()
 
bool request_battery_ ()
 
void read_battery_ (uint8_t *raw_value, uint16_t value_len)
 
- 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::Sensortemperature_sensor_ {nullptr}
 
sensor::Sensorhumidity_sensor_ {nullptr}
 
sensor::Sensorpressure_sensor_ {nullptr}
 
sensor::Sensortvoc_sensor_ {nullptr}
 
sensor::Sensorbattery_voltage_ {nullptr}
 
uint16_t handle_
 
espbt::ESPBTUUID service_uuid_
 
espbt::ESPBTUUID sensors_data_characteristic_uuid_
 
uint16_t acp_handle_ {0}
 
uint16_t cccd_handle_ {0}
 
espbt::ESPBTUUID access_control_point_characteristic_uuid_
 
uint8_t responses_pending_ {0}
 
bool read_battery_next_update_ {false}
 
uint32_t battery_update_interval_ {}
 
- 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
BLEClientparent_
 
uint64_t address_
 

Additional Inherited Members

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

Detailed Description

Definition at line 25 of file airthings_wave_base.h.

Constructor & Destructor Documentation

◆ AirthingsWaveBase()

esphome::airthings_wave_base::AirthingsWaveBase::AirthingsWaveBase ( )
default

Member Function Documentation

◆ gattc_event_handler()

void esphome::airthings_wave_base::AirthingsWaveBase::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 13 of file airthings_wave_base.cpp.

◆ is_valid_voc_value_()

bool esphome::airthings_wave_base::AirthingsWaveBase::is_valid_voc_value_ ( uint16_t  voc)
protected

Definition at line 79 of file airthings_wave_base.cpp.

◆ read_battery_()

void esphome::airthings_wave_base::AirthingsWaveBase::read_battery_ ( uint8_t *  raw_value,
uint16_t  value_len 
)
protected

Definition at line 164 of file airthings_wave_base.cpp.

◆ read_sensors()

virtual void esphome::airthings_wave_base::AirthingsWaveBase::read_sensors ( uint8_t *  raw_value,
uint16_t  value_len 
)
protectedpure virtual

◆ request_battery_()

bool esphome::airthings_wave_base::AirthingsWaveBase::request_battery_ ( )
protected

Definition at line 114 of file airthings_wave_base.cpp.

◆ request_read_values_()

bool esphome::airthings_wave_base::AirthingsWaveBase::request_read_values_ ( )
protected

Definition at line 93 of file airthings_wave_base.cpp.

◆ response_pending_()

void esphome::airthings_wave_base::AirthingsWaveBase::response_pending_ ( )
protected

Definition at line 187 of file airthings_wave_base.cpp.

◆ response_received_()

void esphome::airthings_wave_base::AirthingsWaveBase::response_received_ ( )
protected

Definition at line 192 of file airthings_wave_base.cpp.

◆ set_battery_update_interval()

void esphome::airthings_wave_base::AirthingsWaveBase::set_battery_update_interval ( uint32_t  interval)
inline

Definition at line 42 of file airthings_wave_base.h.

◆ set_battery_voltage()

void esphome::airthings_wave_base::AirthingsWaveBase::set_battery_voltage ( sensor::Sensor voltage)
inline

Definition at line 38 of file airthings_wave_base.h.

◆ set_humidity()

void esphome::airthings_wave_base::AirthingsWaveBase::set_humidity ( sensor::Sensor humidity)
inline

Definition at line 35 of file airthings_wave_base.h.

◆ set_pressure()

void esphome::airthings_wave_base::AirthingsWaveBase::set_pressure ( sensor::Sensor pressure)
inline

Definition at line 36 of file airthings_wave_base.h.

◆ set_response_timeout_()

void esphome::airthings_wave_base::AirthingsWaveBase::set_response_timeout_ ( )
protected

Definition at line 201 of file airthings_wave_base.cpp.

◆ set_temperature()

void esphome::airthings_wave_base::AirthingsWaveBase::set_temperature ( sensor::Sensor temperature)
inline

Definition at line 34 of file airthings_wave_base.h.

◆ set_tvoc()

void esphome::airthings_wave_base::AirthingsWaveBase::set_tvoc ( sensor::Sensor tvoc)
inline

Definition at line 37 of file airthings_wave_base.h.

◆ update()

void esphome::airthings_wave_base::AirthingsWaveBase::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 81 of file airthings_wave_base.cpp.

Field Documentation

◆ access_control_point_characteristic_uuid_

espbt::ESPBTUUID esphome::airthings_wave_base::AirthingsWaveBase::access_control_point_characteristic_uuid_
protected

Definition at line 62 of file airthings_wave_base.h.

◆ acp_handle_

uint16_t esphome::airthings_wave_base::AirthingsWaveBase::acp_handle_ {0}
protected

Definition at line 60 of file airthings_wave_base.h.

◆ battery_update_interval_

uint32_t esphome::airthings_wave_base::AirthingsWaveBase::battery_update_interval_ {}
protected

Definition at line 74 of file airthings_wave_base.h.

◆ battery_voltage_

sensor::Sensor* esphome::airthings_wave_base::AirthingsWaveBase::battery_voltage_ {nullptr}
protected

Definition at line 54 of file airthings_wave_base.h.

◆ cccd_handle_

uint16_t esphome::airthings_wave_base::AirthingsWaveBase::cccd_handle_ {0}
protected

Definition at line 61 of file airthings_wave_base.h.

◆ handle_

uint16_t esphome::airthings_wave_base::AirthingsWaveBase::handle_
protected

Definition at line 56 of file airthings_wave_base.h.

◆ humidity_sensor_

sensor::Sensor* esphome::airthings_wave_base::AirthingsWaveBase::humidity_sensor_ {nullptr}
protected

Definition at line 51 of file airthings_wave_base.h.

◆ pressure_sensor_

sensor::Sensor* esphome::airthings_wave_base::AirthingsWaveBase::pressure_sensor_ {nullptr}
protected

Definition at line 52 of file airthings_wave_base.h.

◆ read_battery_next_update_

bool esphome::airthings_wave_base::AirthingsWaveBase::read_battery_next_update_ {false}
protected

Definition at line 71 of file airthings_wave_base.h.

◆ responses_pending_

uint8_t esphome::airthings_wave_base::AirthingsWaveBase::responses_pending_ {0}
protected

Definition at line 64 of file airthings_wave_base.h.

◆ sensors_data_characteristic_uuid_

espbt::ESPBTUUID esphome::airthings_wave_base::AirthingsWaveBase::sensors_data_characteristic_uuid_
protected

Definition at line 58 of file airthings_wave_base.h.

◆ service_uuid_

espbt::ESPBTUUID esphome::airthings_wave_base::AirthingsWaveBase::service_uuid_
protected

Definition at line 57 of file airthings_wave_base.h.

◆ temperature_sensor_

sensor::Sensor* esphome::airthings_wave_base::AirthingsWaveBase::temperature_sensor_ {nullptr}
protected

Definition at line 50 of file airthings_wave_base.h.

◆ tvoc_sensor_

sensor::Sensor* esphome::airthings_wave_base::AirthingsWaveBase::tvoc_sensor_ {nullptr}
protected

Definition at line 53 of file airthings_wave_base.h.


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