ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
esphome::ecocomfort2::Ecocomfort2Hub Class Reference

Hub component for Ecocomfort 2.0 VMC via BLE. More...

#include <ecocomfort2_hub.h>

Inheritance diagram for esphome::ecocomfort2::Ecocomfort2Hub:
esphome::ble_client::BLEClientNode esphome::PollingComponent esphome::Component

Protected Member Functions

void on_paired_ ()
 
void set_connected_ (bool connected)
 
void publish_unknown_ ()
 
bool read_char_ (uint16_t handle)
 
bool write_char_ (uint16_t handle, uint8_t *data, uint16_t len)
 
bool read_ok_ (const esp_ble_gattc_cb_param_t *param)
 
void on_oper_ (const uint8_t *data, uint16_t len)
 
void on_state_ (const uint8_t *data, uint16_t len)
 
void on_info_ (const uint8_t *data, uint16_t len)
 
void sync_clock_ ()
 
void read_settings_ ()
 
void request_settings_ (SettingsChar &settings)
 
bool settings_answer_current_ (SettingsChar &settings)
 
bool settings_known_ (const SettingsChar &settings)
 
void on_config_ (const uint8_t *data, uint16_t len)
 
void on_advanced_ (const uint8_t *data, uint16_t len)
 
void write_config_ (uint8_t index, uint8_t value, uint8_t stored)
 Write one C_CONFIGURATION byte, leaving the others as they are, and keep stored as its local copy.
 
void write_offsets_ (int16_t temperature, int16_t humidity)
 
bool write_settings_ (SettingsChar &settings, uint8_t *data, uint16_t len)
 
void publish_config_ ()
 
void publish_offsets_ ()
 
- Protected Member Functions inherited from esphome::Component
friend void::setup ()
 
friend void::original_setup ()
 
void set_component_source_ (uint8_t index)
 Set where this component was loaded from for some debug messages.
 
void call_dump_config_ ()
 
void enable_loop_slow_path_ ()
 
void set_component_state_ (uint8_t state)
 Helper to set component state (clears state bits and sets new state)
 
bool set_status_flag_ (uint8_t flag)
 Helper to set a status LED flag on both this component and the app.
 
bool set_error_flag_ (const LogString *message)
 Set the error flag and log it; true when it was not set before.
 
void set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a const char* name.
 
void set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a numeric ID (zero heap allocation).
 
void set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const char *name)
 Cancel an interval function.
 
bool cancel_interval (uint32_t id)
 
bool cancel_interval (InternalSchedulerID id)
 
void set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a const char* name.
 
void set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a numeric ID (zero heap allocation).
 
void set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const char *name)
 Cancel a timeout function.
 
bool cancel_timeout (uint32_t id)
 
bool cancel_timeout (InternalSchedulerID id)
 
void defer (const char *name, std::function< void()> &&f)
 Defer a callback to the next loop() call with a const char* name.
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
void defer (uint32_t id, std::function< void()> &&f)
 Defer a callback with a numeric ID (zero heap allocation)
 
bool cancel_defer (const char *name)
 Cancel a defer callback using the specified name, name must not be empty.
 
bool cancel_defer (uint32_t id)
 
void status_clear_warning_slow_path_ ()
 
void status_clear_error_slow_path_ ()
 

Protected Attributes

StaticVector< Ecocomfort2Client *, ECOCOMFORT2_CHILD_COUNT > children_
 
time::RealTimeClock * time_ {nullptr}
 
uint16_t char_handle_oper_ {0}
 
uint16_t char_handle_state_ {0}
 
uint16_t char_handle_info_ {0}
 
uint16_t char_handle_clock_ {0}
 
uint8_t mode_ {OPER_OFF}
 
uint8_t speed_ {SPEED_OFF}
 
number::Number * numbers_ [static_cast< uint8_t >(NumberSetting::NUMBER_SETTING_COUNT)] {}
 
switch_::Switch * switches_ [static_cast< uint8_t >(SwitchSetting::SWITCH_SETTING_COUNT)] {}
 
select::Select * selects_ [static_cast< uint8_t >(SelectSetting::SELECT_SETTING_COUNT)] {}
 
SettingsChar config_char_
 
SettingsChar advanced_char_
 
uint8_t config_bytes_ [5] {}
 
int16_t offsets_ [2] {}
 
- Protected Attributes inherited from esphome::ble_client::BLEClientNode
BLEClient * parent_
 
uint64_t address_
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- Protected Attributes inherited from esphome::Component
uint8_t component_source_index_ {0}
 Index into component source PROGMEM lookup table (0 = not set)
 
uint8_t warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
 Warn threshold in centiseconds (max 2550ms)
 
uint8_t component_state_ {0x00}
 State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.
 
volatile bool pending_enable_loop_ {false}
 ISR-safe flag for enable_loop_soon_any_context.
 
ComponentRuntimeStats runtime_stats_
 

Static Protected Attributes

static constexpr uint32_t AUTH_TIMEOUT_ID = 0
 
static constexpr uint32_t READBACK_TIMEOUT_ID = 1
 
static constexpr uint32_t AUTH_TIMEOUT_MS = 10000
 
static constexpr uint32_t READBACK_DELAY_MS = 300
 

Additional Inherited Members

- Public Member Functions inherited from esphome::ble_client::BLEClientNode
virtual void loop ()
 
void set_address (uint64_t address)
 
BLEClient * parent ()
 
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.
 
void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object.
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor.
 
void start_poller ()
 
void stop_poller ()
 
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen.
 
virtual void loop ()
 This method will be called repeatedly.
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
virtual bool teardown ()
 Called during teardown to allow component to gracefully finish operations.
 
virtual void on_powerdown ()
 Called last before a reboot or deep sleep to power down hardware.
 
uint8_t get_component_state () const
 
void reset_to_construction_state ()
 Reset this component back to the construction state to allow setup to run again.
 
bool is_in_loop_state () const
 Check if this component has completed setup and is in the loop state.
 
bool is_idle () const
 Check if this component is idle.
 
void mark_failed ()
 Mark this component as failed.
 
void mark_failed (const LogString *message)
 
bool ESPHOME_ALWAYS_INLINE setup_check (bool ok)
 Marks the component failed with message (default "Communication failed") unless ok; returns ok.
 
bool ESPHOME_ALWAYS_INLINE setup_check (bool ok, const LogString *message)
 
void disable_loop ()
 Disable this component's loop.
 
void enable_loop ()
 Enable this component's loop.
 
void enable_loop_soon_any_context ()
 Thread and ISR-safe version of enable_loop() that can be called from any context.
 
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 ()
 
void status_set_warning (const char *message)
 
void status_set_warning (const LogString *message)
 
bool status_comm_result (bool ok)
 Clears the warning when ok, else sets it with message (default "Communication failed"); returns ok.
 
bool status_comm_result (bool ok, const LogString *message)
 
void status_set_error ()
 
void status_set_error (const LogString *message)
 
void status_clear_warning ()
 
void status_clear_error ()
 
 ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name
 
void status_momentary_warning (uint32_t length=5000)
 Set warning status flag and clear it after length ms.
 
void status_momentary_warning (const LogString *message, uint32_t length=5000)
 
 ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name
 
void status_momentary_error (uint32_t length=5000)
 Set error status flag and clear it after length ms.
 
void status_momentary_error (const LogString *message, uint32_t length=5000)
 
bool has_overridden_loop () const
 
const LogString * get_component_log_str () const ESPHOME_ALWAYS_INLINE
 Get the integration where this component was declared as a LogString for logging.
 
bool should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)
 
- Data Fields inherited from esphome::ble_client::BLEClientNode
espbt::ESPBTClient * client
 
espbt::ClientState node_state
 
- Data Fields inherited from esphome::Component
uint32_t length = 5000)
 

Detailed Description

Hub component for Ecocomfort 2.0 VMC via BLE.

Definition at line 84 of file ecocomfort2_hub.h.

Member Function Documentation

◆ on_advanced_()

void esphome::ecocomfort2::Ecocomfort2Hub::on_advanced_ ( const uint8_t * data,
uint16_t len )
protected

Definition at line 444 of file ecocomfort2_hub.cpp.

◆ on_config_()

void esphome::ecocomfort2::Ecocomfort2Hub::on_config_ ( const uint8_t * data,
uint16_t len )
protected

Definition at line 429 of file ecocomfort2_hub.cpp.

◆ on_info_()

void esphome::ecocomfort2::Ecocomfort2Hub::on_info_ ( const uint8_t * data,
uint16_t len )
protected

Definition at line 314 of file ecocomfort2_hub.cpp.

◆ on_oper_()

void esphome::ecocomfort2::Ecocomfort2Hub::on_oper_ ( const uint8_t * data,
uint16_t len )
protected

Definition at line 274 of file ecocomfort2_hub.cpp.

◆ on_paired_()

void esphome::ecocomfort2::Ecocomfort2Hub::on_paired_ ( )
protected

Definition at line 238 of file ecocomfort2_hub.cpp.

◆ on_state_()

void esphome::ecocomfort2::Ecocomfort2Hub::on_state_ ( const uint8_t * data,
uint16_t len )
protected

Definition at line 292 of file ecocomfort2_hub.cpp.

◆ publish_config_()

void esphome::ecocomfort2::Ecocomfort2Hub::publish_config_ ( )
protected

Definition at line 478 of file ecocomfort2_hub.cpp.

◆ publish_offsets_()

void esphome::ecocomfort2::Ecocomfort2Hub::publish_offsets_ ( )
protected

Definition at line 503 of file ecocomfort2_hub.cpp.

◆ publish_unknown_()

void esphome::ecocomfort2::Ecocomfort2Hub::publish_unknown_ ( )
protected

Definition at line 261 of file ecocomfort2_hub.cpp.

◆ read_char_()

bool esphome::ecocomfort2::Ecocomfort2Hub::read_char_ ( uint16_t handle)
protected

Definition at line 51 of file ecocomfort2_hub.cpp.

◆ read_ok_()

bool esphome::ecocomfort2::Ecocomfort2Hub::read_ok_ ( const esp_ble_gattc_cb_param_t * param)
protected

Definition at line 208 of file ecocomfort2_hub.cpp.

◆ read_settings_()

void esphome::ecocomfort2::Ecocomfort2Hub::read_settings_ ( )
protected

Definition at line 405 of file ecocomfort2_hub.cpp.

◆ request_settings_()

void esphome::ecocomfort2::Ecocomfort2Hub::request_settings_ ( SettingsChar & settings)
protected

Definition at line 384 of file ecocomfort2_hub.cpp.

◆ set_connected_()

void esphome::ecocomfort2::Ecocomfort2Hub::set_connected_ ( bool connected)
protected

Definition at line 254 of file ecocomfort2_hub.cpp.

◆ settings_answer_current_()

bool esphome::ecocomfort2::Ecocomfort2Hub::settings_answer_current_ ( SettingsChar & settings)
protected

Definition at line 396 of file ecocomfort2_hub.cpp.

◆ settings_known_()

bool esphome::ecocomfort2::Ecocomfort2Hub::settings_known_ ( const SettingsChar & settings)
protected

Definition at line 420 of file ecocomfort2_hub.cpp.

◆ sync_clock_()

void esphome::ecocomfort2::Ecocomfort2Hub::sync_clock_ ( )
protected

Definition at line 330 of file ecocomfort2_hub.cpp.

◆ write_char_()

bool esphome::ecocomfort2::Ecocomfort2Hub::write_char_ ( uint16_t handle,
uint8_t * data,
uint16_t len )
protected

Definition at line 41 of file ecocomfort2_hub.cpp.

◆ write_config_()

void esphome::ecocomfort2::Ecocomfort2Hub::write_config_ ( uint8_t index,
uint8_t value,
uint8_t stored )
protected

Write one C_CONFIGURATION byte, leaving the others as they are, and keep stored as its local copy.

Definition at line 525 of file ecocomfort2_hub.cpp.

◆ write_offsets_()

void esphome::ecocomfort2::Ecocomfort2Hub::write_offsets_ ( int16_t temperature,
int16_t humidity )
protected

Definition at line 537 of file ecocomfort2_hub.cpp.

◆ write_settings_()

bool esphome::ecocomfort2::Ecocomfort2Hub::write_settings_ ( SettingsChar & settings,
uint8_t * data,
uint16_t len )
protected

Definition at line 513 of file ecocomfort2_hub.cpp.

Field Documentation

◆ advanced_char_

SettingsChar esphome::ecocomfort2::Ecocomfort2Hub::advanced_char_
protected

Definition at line 208 of file ecocomfort2_hub.h.

◆ AUTH_TIMEOUT_ID

uint32_t esphome::ecocomfort2::Ecocomfort2Hub::AUTH_TIMEOUT_ID = 0
staticconstexprprotected

Definition at line 153 of file ecocomfort2_hub.h.

◆ AUTH_TIMEOUT_MS

uint32_t esphome::ecocomfort2::Ecocomfort2Hub::AUTH_TIMEOUT_MS = 10000
staticconstexprprotected

Definition at line 155 of file ecocomfort2_hub.h.

◆ char_handle_clock_

uint16_t esphome::ecocomfort2::Ecocomfort2Hub::char_handle_clock_ {0}
protected

Definition at line 194 of file ecocomfort2_hub.h.

◆ char_handle_info_

uint16_t esphome::ecocomfort2::Ecocomfort2Hub::char_handle_info_ {0}
protected

Definition at line 193 of file ecocomfort2_hub.h.

◆ char_handle_oper_

uint16_t esphome::ecocomfort2::Ecocomfort2Hub::char_handle_oper_ {0}
protected

Definition at line 191 of file ecocomfort2_hub.h.

◆ char_handle_state_

uint16_t esphome::ecocomfort2::Ecocomfort2Hub::char_handle_state_ {0}
protected

Definition at line 192 of file ecocomfort2_hub.h.

◆ children_

StaticVector<Ecocomfort2Client *, ECOCOMFORT2_CHILD_COUNT> esphome::ecocomfort2::Ecocomfort2Hub::children_
protected

Definition at line 186 of file ecocomfort2_hub.h.

◆ config_bytes_

uint8_t esphome::ecocomfort2::Ecocomfort2Hub::config_bytes_[5] {}
protected

Definition at line 210 of file ecocomfort2_hub.h.

◆ config_char_

SettingsChar esphome::ecocomfort2::Ecocomfort2Hub::config_char_
protected

Definition at line 207 of file ecocomfort2_hub.h.

◆ mode_

uint8_t esphome::ecocomfort2::Ecocomfort2Hub::mode_ {OPER_OFF}
protected

Definition at line 195 of file ecocomfort2_hub.h.

◆ numbers_

number::Number* esphome::ecocomfort2::Ecocomfort2Hub::numbers_[static_cast< uint8_t >(NumberSetting::NUMBER_SETTING_COUNT)] {}
protected

Definition at line 199 of file ecocomfort2_hub.h.

◆ offsets_

int16_t esphome::ecocomfort2::Ecocomfort2Hub::offsets_[2] {}
protected

Definition at line 212 of file ecocomfort2_hub.h.

◆ READBACK_DELAY_MS

uint32_t esphome::ecocomfort2::Ecocomfort2Hub::READBACK_DELAY_MS = 300
staticconstexprprotected

Definition at line 156 of file ecocomfort2_hub.h.

◆ READBACK_TIMEOUT_ID

uint32_t esphome::ecocomfort2::Ecocomfort2Hub::READBACK_TIMEOUT_ID = 1
staticconstexprprotected

Definition at line 154 of file ecocomfort2_hub.h.

◆ selects_

select::Select* esphome::ecocomfort2::Ecocomfort2Hub::selects_[static_cast< uint8_t >(SelectSetting::SELECT_SETTING_COUNT)] {}
protected

Definition at line 205 of file ecocomfort2_hub.h.

◆ speed_

uint8_t esphome::ecocomfort2::Ecocomfort2Hub::speed_ {SPEED_OFF}
protected

Definition at line 196 of file ecocomfort2_hub.h.

◆ switches_

switch_::Switch* esphome::ecocomfort2::Ecocomfort2Hub::switches_[static_cast< uint8_t >(SwitchSetting::SWITCH_SETTING_COUNT)] {}
protected

Definition at line 202 of file ecocomfort2_hub.h.

◆ time_

time::RealTimeClock* esphome::ecocomfort2::Ecocomfort2Hub::time_ {nullptr}
protected

Definition at line 189 of file ecocomfort2_hub.h.


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