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

#include <ecocomfort2_hub.h>

Inheritance diagram for esphome::ecocomfort2::Ecocomfort2Hub:

Public Member Functions
void	setup () override

void	update () override

void	dump_config () override

float	get_setup_priority () const 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	gap_event_handler (esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param) override

void	register_child (Ecocomfort2Client *obj)

void	set_temperature_sensor (sensor::Sensor *s)

void	set_humidity_sensor (sensor::Sensor *s)

void	set_voc_sensor (sensor::Sensor *s)

void	set_direction_sensor (sensor::Sensor *s)

void	set_connected_binary_sensor (binary_sensor::BinarySensor *s)

void	set_boost_binary_sensor (binary_sensor::BinarySensor *s)

void	set_firmware_text_sensor (text_sensor::TextSensor *s)

void	set_time (time::RealTimeClock *time)
	Keeps the unit's clock in step with this time source while connected.

bool	is_ready () const
	True once the link is established and paired.

void	write_oper (uint8_t mode, uint8_t speed)
	Write C_OPER (mode byte, speed/flags byte) and read it back shortly after.

uint8_t	get_mode () const
	Raw C_OPER values from the last readback.

uint8_t	get_speed () const

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	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 after teardown is complete 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)

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)

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)

Protected Member Functions
void	on_paired_ ()

void	set_connected_ (bool connected)

void	publish_unknown_ ()

void	read_char_ (uint16_t handle)

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_ ()

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_

sensor::Sensor *	temperature_sensor_ {nullptr}

sensor::Sensor *	humidity_sensor_ {nullptr}

sensor::Sensor *	voc_sensor_ {nullptr}

sensor::Sensor *	direction_sensor_ {nullptr}

binary_sensor::BinarySensor *	connected_binary_sensor_ {nullptr}

binary_sensor::BinarySensor *	boost_binary_sensor_ {nullptr}

text_sensor::TextSensor *	firmware_text_sensor_ {nullptr}

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}

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
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 47 of file ecocomfort2_hub.h.

Member Function Documentation

◆ dump_config()

void esphome::ecocomfort2::Ecocomfort2Hub::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 42 of file ecocomfort2_hub.cpp.

◆ gap_event_handler()

void esphome::ecocomfort2::Ecocomfort2Hub::gap_event_handler	(	esp_gap_ble_cb_event_t	event,
		esp_ble_gap_cb_param_t *	param )

overridevirtual

Reimplemented from esphome::ble_client::BLEClientNode.

Definition at line 162 of file ecocomfort2_hub.cpp.

◆ gattc_event_handler()

void esphome::ecocomfort2::Ecocomfort2Hub::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 66 of file ecocomfort2_hub.cpp.

◆ get_mode()

uint8_t esphome::ecocomfort2::Ecocomfort2Hub::get_mode ( ) const

inline

Raw C_OPER values from the last readback.

Definition at line 86 of file ecocomfort2_hub.h.

◆ get_setup_priority()

float esphome::ecocomfort2::Ecocomfort2Hub::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 52 of file ecocomfort2_hub.h.

◆ get_speed()

uint8_t esphome::ecocomfort2::Ecocomfort2Hub::get_speed ( ) const

inline

Definition at line 87 of file ecocomfort2_hub.h.

◆ is_ready()

bool esphome::ecocomfort2::Ecocomfort2Hub::is_ready ( ) const

inline

True once the link is established and paired.

Definition at line 80 of file ecocomfort2_hub.h.

◆ on_info_()

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

protected

Definition at line 260 of file ecocomfort2_hub.cpp.

◆ on_oper_()

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

protected

Definition at line 215 of file ecocomfort2_hub.cpp.

◆ on_paired_()

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

protected

Definition at line 177 of file ecocomfort2_hub.cpp.

◆ on_state_()

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

protected

Definition at line 233 of file ecocomfort2_hub.cpp.

◆ publish_unknown_()

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

protected

Definition at line 201 of file ecocomfort2_hub.cpp.

◆ read_char_()

void esphome::ecocomfort2::Ecocomfort2Hub::read_char_ ( uint16_t handle )

protected

Definition at line 34 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 147 of file ecocomfort2_hub.cpp.

◆ register_child()

void esphome::ecocomfort2::Ecocomfort2Hub::register_child ( Ecocomfort2Client * obj )

Definition at line 317 of file ecocomfort2_hub.cpp.

◆ set_boost_binary_sensor()

void esphome::ecocomfort2::Ecocomfort2Hub::set_boost_binary_sensor ( binary_sensor::BinarySensor * s )

inline

Definition at line 69 of file ecocomfort2_hub.h.

◆ set_connected_()

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

protected

Definition at line 193 of file ecocomfort2_hub.cpp.

◆ set_connected_binary_sensor()

void esphome::ecocomfort2::Ecocomfort2Hub::set_connected_binary_sensor ( binary_sensor::BinarySensor * s )

inline

Definition at line 68 of file ecocomfort2_hub.h.

◆ set_direction_sensor()

void esphome::ecocomfort2::Ecocomfort2Hub::set_direction_sensor ( sensor::Sensor * s )

inline

Definition at line 65 of file ecocomfort2_hub.h.

◆ set_firmware_text_sensor()

void esphome::ecocomfort2::Ecocomfort2Hub::set_firmware_text_sensor ( text_sensor::TextSensor * s )

inline

Definition at line 72 of file ecocomfort2_hub.h.

◆ set_humidity_sensor()

void esphome::ecocomfort2::Ecocomfort2Hub::set_humidity_sensor ( sensor::Sensor * s )

inline

Definition at line 63 of file ecocomfort2_hub.h.

◆ set_temperature_sensor()

void esphome::ecocomfort2::Ecocomfort2Hub::set_temperature_sensor ( sensor::Sensor * s )

inline

Definition at line 62 of file ecocomfort2_hub.h.

◆ set_time()

void esphome::ecocomfort2::Ecocomfort2Hub::set_time ( time::RealTimeClock * time )

inline

Keeps the unit's clock in step with this time source while connected.

Definition at line 76 of file ecocomfort2_hub.h.

◆ set_voc_sensor()

void esphome::ecocomfort2::Ecocomfort2Hub::set_voc_sensor ( sensor::Sensor * s )

inline

Definition at line 64 of file ecocomfort2_hub.h.

◆ setup()

void esphome::ecocomfort2::Ecocomfort2Hub::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 12 of file ecocomfort2_hub.cpp.

◆ sync_clock_()

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

protected

Definition at line 277 of file ecocomfort2_hub.cpp.

◆ update()

void esphome::ecocomfort2::Ecocomfort2Hub::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 24 of file ecocomfort2_hub.cpp.

◆ write_oper()

void esphome::ecocomfort2::Ecocomfort2Hub::write_oper	(	uint8_t	mode,
		uint8_t	speed )

Write C_OPER (mode byte, speed/flags byte) and read it back shortly after.

Definition at line 299 of file ecocomfort2_hub.cpp.

Field Documentation

◆ AUTH_TIMEOUT_ID

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

staticconstexprprotected

Definition at line 90 of file ecocomfort2_hub.h.

◆ AUTH_TIMEOUT_MS

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

staticconstexprprotected

Definition at line 92 of file ecocomfort2_hub.h.

◆ boost_binary_sensor_

binary_sensor::BinarySensor* esphome::ecocomfort2::Ecocomfort2Hub::boost_binary_sensor_ {nullptr}

protected

Definition at line 118 of file ecocomfort2_hub.h.

◆ char_handle_clock_

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

protected

Definition at line 129 of file ecocomfort2_hub.h.

◆ char_handle_info_

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

protected

Definition at line 128 of file ecocomfort2_hub.h.

◆ char_handle_oper_

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

protected

Definition at line 126 of file ecocomfort2_hub.h.

◆ char_handle_state_

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

protected

Definition at line 127 of file ecocomfort2_hub.h.

◆ children_

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

protected

Definition at line 108 of file ecocomfort2_hub.h.

◆ connected_binary_sensor_

binary_sensor::BinarySensor* esphome::ecocomfort2::Ecocomfort2Hub::connected_binary_sensor_ {nullptr}

protected

Definition at line 117 of file ecocomfort2_hub.h.

◆ direction_sensor_

sensor::Sensor* esphome::ecocomfort2::Ecocomfort2Hub::direction_sensor_ {nullptr}

protected

Definition at line 114 of file ecocomfort2_hub.h.

◆ firmware_text_sensor_

text_sensor::TextSensor* esphome::ecocomfort2::Ecocomfort2Hub::firmware_text_sensor_ {nullptr}

protected

Definition at line 121 of file ecocomfort2_hub.h.

◆ humidity_sensor_

sensor::Sensor* esphome::ecocomfort2::Ecocomfort2Hub::humidity_sensor_ {nullptr}

protected

Definition at line 112 of file ecocomfort2_hub.h.

◆ mode_

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

protected

Definition at line 130 of file ecocomfort2_hub.h.

◆ READBACK_DELAY_MS

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

staticconstexprprotected

Definition at line 93 of file ecocomfort2_hub.h.

◆ READBACK_TIMEOUT_ID

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

staticconstexprprotected

Definition at line 91 of file ecocomfort2_hub.h.

◆ speed_

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

protected

Definition at line 131 of file ecocomfort2_hub.h.

◆ temperature_sensor_

sensor::Sensor* esphome::ecocomfort2::Ecocomfort2Hub::temperature_sensor_ {nullptr}

protected

Definition at line 111 of file ecocomfort2_hub.h.

◆ time_

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

protected

Definition at line 124 of file ecocomfort2_hub.h.

◆ voc_sensor_

sensor::Sensor* esphome::ecocomfort2::Ecocomfort2Hub::voc_sensor_ {nullptr}

protected

Definition at line 113 of file ecocomfort2_hub.h.

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

esphome/components/ecocomfort2/ecocomfort2_hub.h
esphome/components/ecocomfort2/ecocomfort2_hub.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ dump_config()

◆ gap_event_handler()

◆ gattc_event_handler()

◆ get_mode()

◆ get_setup_priority()

◆ get_speed()

◆ is_ready()

◆ on_info_()

◆ on_oper_()

◆ on_paired_()

◆ on_state_()

◆ publish_unknown_()

◆ read_char_()

◆ read_ok_()

◆ register_child()

◆ set_boost_binary_sensor()

◆ set_connected_()

◆ set_connected_binary_sensor()

◆ set_direction_sensor()

◆ set_firmware_text_sensor()

◆ set_humidity_sensor()

◆ set_temperature_sensor()

◆ set_time()

◆ set_voc_sensor()

◆ setup()

◆ sync_clock_()

◆ update()

◆ write_oper()

Field Documentation

◆ AUTH_TIMEOUT_ID

◆ AUTH_TIMEOUT_MS

◆ boost_binary_sensor_

◆ char_handle_clock_

◆ char_handle_info_

◆ char_handle_oper_

◆ char_handle_state_

◆ children_

◆ connected_binary_sensor_

◆ direction_sensor_

◆ firmware_text_sensor_

◆ humidity_sensor_

◆ mode_

◆ READBACK_DELAY_MS

◆ READBACK_TIMEOUT_ID

◆ speed_

◆ temperature_sensor_

◆ time_

◆ voc_sensor_