#include <bluetooth_proxy.h>

Inheritance diagram for esphome::bluetooth_proxy::BluetoothProxy:

Public Member Functions
	BluetoothProxy ()

bool	parse_device (const esp32_ble_tracker::ESPBTDevice &device) override

bool	parse_devices (const esp32_ble::BLEScanResult *scan_results, size_t count) override

void	dump_config () override

void	setup () override

void	loop () override

esp32_ble_tracker::AdvertisementParserType	get_advertisement_parser_type () override

void	register_connection (BluetoothConnection *connection)

void	bluetooth_device_request (const api::BluetoothDeviceRequest &msg)

void	bluetooth_gatt_read (const api::BluetoothGATTReadRequest &msg)

void	bluetooth_gatt_write (const api::BluetoothGATTWriteRequest &msg)

void	bluetooth_gatt_read_descriptor (const api::BluetoothGATTReadDescriptorRequest &msg)

void	bluetooth_gatt_write_descriptor (const api::BluetoothGATTWriteDescriptorRequest &msg)

void	bluetooth_gatt_send_services (const api::BluetoothGATTGetServicesRequest &msg)

void	bluetooth_gatt_notify (const api::BluetoothGATTNotifyRequest &msg)

void	bluetooth_set_connection_params (const api::BluetoothSetConnectionParamsRequest &msg)

void	subscribe_api_connection (api::APIConnection *api_connection, uint32_t flags)

void	unsubscribe_api_connection (api::APIConnection *api_connection)

api::APIConnection *	get_api_connection ()

void	send_device_connection (uint64_t address, bool connected, uint16_t mtu=0, esp_err_t error=ESP_OK)

void	send_connections_free ()

void	send_connections_free (api::APIConnection *api_connection)

void	send_gatt_services_done (uint64_t address)

void	send_gatt_error (uint64_t address, uint16_t handle, esp_err_t error)

void	send_device_pairing (uint64_t address, bool paired, esp_err_t error=ESP_OK)

void	send_device_unpairing (uint64_t address, bool success, esp_err_t error=ESP_OK)

void	send_device_clear_cache (uint64_t address, bool success, esp_err_t error=ESP_OK)

void	bluetooth_scanner_set_mode (bool active)

void	set_active (bool active)

bool	has_active ()

void	on_scanner_state (esp32_ble_tracker::ScannerState state) override
	BLEScannerStateListener interface.

uint32_t	get_legacy_version () const

uint32_t	get_feature_flags () const

void	get_bluetooth_mac_address_pretty (std::span< char, 18 > output)

Public Member Functions inherited from esphome::esp32_ble_tracker::ESPBTDeviceListener
bool	parse_device (const ble_device_base::ESPBTDevice &device) override

virtual bool	parse_devices (const BLEScanResult *scan_results, size_t count)

void	set_parent (ESP32BLETracker *parent)

Public Member Functions inherited from esphome::ble_device_base::ESPBTDeviceListener
virtual	~ESPBTDeviceListener ()=default

virtual void	on_scan_end ()
	Called at the end of each scan duration period.

Public Member Functions inherited from esphome::esp32_ble_tracker::BLEScannerStateListener
Public Member Functions inherited from esphome::Component
virtual float	get_setup_priority () const
	priority of setup().

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

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

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)

Static Public Member Functions
static void	uint64_to_bd_addr (uint64_t address, esp_bd_addr_t bd_addr)

Protected Member Functions
void	send_bluetooth_scanner_state_ (esp32_ble_tracker::ScannerState state)

void	flush_pending_advertisements_ ()
	Caller must ensure api_connection_ is non-null and API server is connected.

void	log_advertisement_flush_ ()

BluetoothConnection *	get_connection_ (uint64_t address, bool reserve)

void	log_connection_request_ignored_ (BluetoothConnection *connection, espbt::ClientState state)

void	log_connection_info_ (BluetoothConnection connection, const char message)

void	log_not_connected_gatt_ (const char action, const char type)

void	handle_gatt_not_connected_ (uint64_t address, uint16_t handle, const char action, const char type)

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.

virtual void	call_setup ()

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.

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
api::APIConnection *	api_connection_ {nullptr}

std::array< BluetoothConnection *, BLUETOOTH_PROXY_MAX_CONNECTIONS >	connections_ {}

api::BluetoothLERawAdvertisementsResponse	response_

uint32_t	last_advertisement_flush_time_ {0}

api::BluetoothConnectionsFreeResponse	connections_free_response_

bool	active_

uint8_t	connection_count_ {0}

bool	configured_scan_active_ {false}

Protected Attributes inherited from esphome::esp32_ble_tracker::ESPBTDeviceListener
ESP32BLETracker *	parent_ {nullptr}

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_

Detailed Description

Definition at line 56 of file bluetooth_proxy.h.

Constructor & Destructor Documentation

◆ BluetoothProxy()

esphome::bluetooth_proxy::BluetoothProxy::BluetoothProxy ( )

Definition at line 24 of file bluetooth_proxy.cpp.

Member Function Documentation

◆ bluetooth_device_request()

void esphome::bluetooth_proxy::BluetoothProxy::bluetooth_device_request ( const api::BluetoothDeviceRequest & msg )

Definition at line 169 of file bluetooth_proxy.cpp.

◆ bluetooth_gatt_notify()

void esphome::bluetooth_proxy::BluetoothProxy::bluetooth_gatt_notify ( const api::BluetoothGATTNotifyRequest & msg )

Definition at line 341 of file bluetooth_proxy.cpp.

◆ bluetooth_gatt_read()

void esphome::bluetooth_proxy::BluetoothProxy::bluetooth_gatt_read ( const api::BluetoothGATTReadRequest & msg )

Definition at line 274 of file bluetooth_proxy.cpp.

◆ bluetooth_gatt_read_descriptor()

void esphome::bluetooth_proxy::BluetoothProxy::bluetooth_gatt_read_descriptor ( const api::BluetoothGATTReadDescriptorRequest & msg )

Definition at line 300 of file bluetooth_proxy.cpp.

◆ bluetooth_gatt_send_services()

void esphome::bluetooth_proxy::BluetoothProxy::bluetooth_gatt_send_services ( const api::BluetoothGATTGetServicesRequest & msg )

Definition at line 326 of file bluetooth_proxy.cpp.

◆ bluetooth_gatt_write()

void esphome::bluetooth_proxy::BluetoothProxy::bluetooth_gatt_write ( const api::BluetoothGATTWriteRequest & msg )

Definition at line 287 of file bluetooth_proxy.cpp.

◆ bluetooth_gatt_write_descriptor()

void esphome::bluetooth_proxy::BluetoothProxy::bluetooth_gatt_write_descriptor ( const api::BluetoothGATTWriteDescriptorRequest & msg )

Definition at line 313 of file bluetooth_proxy.cpp.

◆ bluetooth_scanner_set_mode()

void esphome::bluetooth_proxy::BluetoothProxy::bluetooth_scanner_set_mode ( bool active )

Definition at line 469 of file bluetooth_proxy.cpp.

◆ bluetooth_set_connection_params()

void esphome::bluetooth_proxy::BluetoothProxy::bluetooth_set_connection_params ( const api::BluetoothSetConnectionParamsRequest & msg )

Definition at line 354 of file bluetooth_proxy.cpp.

◆ dump_config()

void esphome::bluetooth_proxy::BluetoothProxy::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 116 of file bluetooth_proxy.cpp.

◆ flush_pending_advertisements_()

void esphome::bluetooth_proxy::BluetoothProxy::flush_pending_advertisements_ ( )

inlineprotected

Caller must ensure api_connection_ is non-null and API server is connected.

Definition at line 157 of file bluetooth_proxy.h.

◆ get_advertisement_parser_type()

esp32_ble_tracker::AdvertisementParserType esphome::bluetooth_proxy::BluetoothProxy::get_advertisement_parser_type ( )

overridevirtual

Reimplemented from esphome::esp32_ble_tracker::ESPBTDeviceListener.

Definition at line 143 of file bluetooth_proxy.cpp.

◆ get_api_connection()

api::APIConnection * esphome::bluetooth_proxy::BluetoothProxy::get_api_connection ( )

inline

Definition at line 93 of file bluetooth_proxy.h.

◆ get_bluetooth_mac_address_pretty()

void esphome::bluetooth_proxy::BluetoothProxy::get_bluetooth_mac_address_pretty ( std::span< char, 18 > output )

inline

Definition at line 144 of file bluetooth_proxy.h.

◆ get_connection_()

BluetoothConnection * esphome::bluetooth_proxy::BluetoothProxy::get_connection_	(	uint64_t	address,
		bool	reserve )

protected

Definition at line 147 of file bluetooth_proxy.cpp.

◆ get_feature_flags()

uint32_t esphome::bluetooth_proxy::BluetoothProxy::get_feature_flags ( ) const

inline

Definition at line 128 of file bluetooth_proxy.h.

◆ get_legacy_version()

uint32_t esphome::bluetooth_proxy::BluetoothProxy::get_legacy_version ( ) const

inline

Definition at line 121 of file bluetooth_proxy.h.

◆ handle_gatt_not_connected_()

void esphome::bluetooth_proxy::BluetoothProxy::handle_gatt_not_connected_	(	uint64_t	address,
		uint16_t	handle,
		const char *	action,
		const char *	type )

protected

Definition at line 66 of file bluetooth_proxy.cpp.

◆ has_active()

bool esphome::bluetooth_proxy::BluetoothProxy::has_active ( )

inline

Definition at line 116 of file bluetooth_proxy.h.

◆ log_advertisement_flush_()

void esphome::bluetooth_proxy::BluetoothProxy::log_advertisement_flush_ ( )

protected

Definition at line 112 of file bluetooth_proxy.cpp.

◆ log_connection_info_()

void esphome::bluetooth_proxy::BluetoothProxy::log_connection_info_	(	BluetoothConnection *	connection,
		const char *	message )

protected

Definition at line 58 of file bluetooth_proxy.cpp.

◆ log_connection_request_ignored_()

void esphome::bluetooth_proxy::BluetoothProxy::log_connection_request_ignored_	(	BluetoothConnection *	connection,
		espbt::ClientState	state )

protected

Definition at line 53 of file bluetooth_proxy.cpp.

◆ log_not_connected_gatt_()

void esphome::bluetooth_proxy::BluetoothProxy::log_not_connected_gatt_	(	const char *	action,
		const char *	type )

protected

Definition at line 62 of file bluetooth_proxy.cpp.

◆ loop()

void esphome::bluetooth_proxy::BluetoothProxy::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 124 of file bluetooth_proxy.cpp.

◆ on_scanner_state()

void esphome::bluetooth_proxy::BluetoothProxy::on_scanner_state ( esp32_ble_tracker::ScannerState state )

overridevirtual

BLEScannerStateListener interface.

Implements esphome::esp32_ble_tracker::BLEScannerStateListener.

Definition at line 36 of file bluetooth_proxy.cpp.

◆ parse_device()

bool esphome::bluetooth_proxy::BluetoothProxy::parse_device ( const esp32_ble_tracker::ESPBTDevice & device )

overridevirtual

Implements esphome::ble_device_base::ESPBTDeviceListener.

Definition at line 73 of file bluetooth_proxy.cpp.

◆ parse_devices()

bool esphome::bluetooth_proxy::BluetoothProxy::parse_devices	(	const esp32_ble::BLEScanResult *	scan_results,
		size_t	count )

override

Definition at line 80 of file bluetooth_proxy.cpp.

◆ register_connection()

void esphome::bluetooth_proxy::BluetoothProxy::register_connection ( BluetoothConnection * connection )

inline

Definition at line 72 of file bluetooth_proxy.h.

◆ send_bluetooth_scanner_state_()

void esphome::bluetooth_proxy::BluetoothProxy::send_bluetooth_scanner_state_ ( esp32_ble_tracker::ScannerState state )

protected

Definition at line 42 of file bluetooth_proxy.cpp.

◆ send_connections_free() [1/2]

void esphome::bluetooth_proxy::BluetoothProxy::send_connections_free ( )

Definition at line 419 of file bluetooth_proxy.cpp.

◆ send_connections_free() [2/2]

void esphome::bluetooth_proxy::BluetoothProxy::send_connections_free ( api::APIConnection * api_connection )

Definition at line 425 of file bluetooth_proxy.cpp.

◆ send_device_clear_cache()

void esphome::bluetooth_proxy::BluetoothProxy::send_device_clear_cache	(	uint64_t	address,
		bool	success,
		esp_err_t	error = ESP_OK )

◆ send_device_connection()

void esphome::bluetooth_proxy::BluetoothProxy::send_device_connection	(	uint64_t	address,
		bool	connected,
		uint16_t	mtu = 0,
		esp_err_t	error = ESP_OK )

Definition at line 409 of file bluetooth_proxy.cpp.

◆ send_device_pairing()

void esphome::bluetooth_proxy::BluetoothProxy::send_device_pairing	(	uint64_t	address,
		bool	paired,
		esp_err_t	error = ESP_OK )

Definition at line 447 of file bluetooth_proxy.cpp.

◆ send_device_unpairing()

void esphome::bluetooth_proxy::BluetoothProxy::send_device_unpairing	(	uint64_t	address,
		bool	success,
		esp_err_t	error = ESP_OK )

Definition at line 458 of file bluetooth_proxy.cpp.

◆ send_gatt_error()

void esphome::bluetooth_proxy::BluetoothProxy::send_gatt_error	(	uint64_t	address,
		uint16_t	handle,
		esp_err_t	error )

Definition at line 437 of file bluetooth_proxy.cpp.

◆ send_gatt_services_done()

void esphome::bluetooth_proxy::BluetoothProxy::send_gatt_services_done ( uint64_t address )

Definition at line 429 of file bluetooth_proxy.cpp.

◆ set_active()

void esphome::bluetooth_proxy::BluetoothProxy::set_active ( bool active )

inline

Definition at line 115 of file bluetooth_proxy.h.

◆ setup()

void esphome::bluetooth_proxy::BluetoothProxy::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 26 of file bluetooth_proxy.cpp.

◆ subscribe_api_connection()

void esphome::bluetooth_proxy::BluetoothProxy::subscribe_api_connection	(	api::APIConnection *	api_connection,
		uint32_t	flags )

Definition at line 381 of file bluetooth_proxy.cpp.

◆ uint64_to_bd_addr()

static void esphome::bluetooth_proxy::BluetoothProxy::uint64_to_bd_addr	(	uint64_t	address,
		esp_bd_addr_t	bd_addr )

inlinestatic

Definition at line 106 of file bluetooth_proxy.h.

◆ unsubscribe_api_connection()

void esphome::bluetooth_proxy::BluetoothProxy::unsubscribe_api_connection ( api::APIConnection * api_connection )

Definition at line 400 of file bluetooth_proxy.cpp.

Field Documentation

◆ active_

bool esphome::bluetooth_proxy::BluetoothProxy::active_

protected

Definition at line 191 of file bluetooth_proxy.h.

◆ api_connection_

api::APIConnection* esphome::bluetooth_proxy::BluetoothProxy::api_connection_ {nullptr}

protected

Definition at line 176 of file bluetooth_proxy.h.

◆ configured_scan_active_

bool esphome::bluetooth_proxy::BluetoothProxy::configured_scan_active_ {false}

protected

Definition at line 193 of file bluetooth_proxy.h.

◆ connection_count_

uint8_t esphome::bluetooth_proxy::BluetoothProxy::connection_count_ {0}

protected

Definition at line 192 of file bluetooth_proxy.h.

◆ connections_

std::array<BluetoothConnection *, BLUETOOTH_PROXY_MAX_CONNECTIONS> esphome::bluetooth_proxy::BluetoothProxy::connections_ {}

protected

Definition at line 179 of file bluetooth_proxy.h.

◆ connections_free_response_

api::BluetoothConnectionsFreeResponse esphome::bluetooth_proxy::BluetoothProxy::connections_free_response_

protected

Definition at line 188 of file bluetooth_proxy.h.

◆ last_advertisement_flush_time_

uint32_t esphome::bluetooth_proxy::BluetoothProxy::last_advertisement_flush_time_ {0}

protected

Definition at line 185 of file bluetooth_proxy.h.

◆ response_

api::BluetoothLERawAdvertisementsResponse esphome::bluetooth_proxy::BluetoothProxy::response_

protected

Definition at line 182 of file bluetooth_proxy.h.

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

esphome/components/bluetooth_proxy/bluetooth_proxy.h
esphome/components/bluetooth_proxy/bluetooth_proxy.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BluetoothProxy()

Member Function Documentation

◆ bluetooth_device_request()

◆ bluetooth_gatt_notify()

◆ bluetooth_gatt_read()

◆ bluetooth_gatt_read_descriptor()

◆ bluetooth_gatt_send_services()

◆ bluetooth_gatt_write()

◆ bluetooth_gatt_write_descriptor()

◆ bluetooth_scanner_set_mode()

◆ bluetooth_set_connection_params()

◆ dump_config()

◆ flush_pending_advertisements_()

◆ get_advertisement_parser_type()

◆ get_api_connection()

◆ get_bluetooth_mac_address_pretty()

◆ get_connection_()

◆ get_feature_flags()

◆ get_legacy_version()

◆ handle_gatt_not_connected_()

◆ has_active()

◆ log_advertisement_flush_()

◆ log_connection_info_()

◆ log_connection_request_ignored_()

◆ log_not_connected_gatt_()

◆ loop()

◆ on_scanner_state()

◆ parse_device()

◆ parse_devices()

◆ register_connection()

◆ send_bluetooth_scanner_state_()

◆ send_connections_free() [1/2]

◆ send_connections_free() [2/2]

◆ send_device_clear_cache()

◆ send_device_connection()

◆ send_device_pairing()

◆ send_device_unpairing()

◆ send_gatt_error()

◆ send_gatt_services_done()

◆ set_active()

◆ setup()

◆ subscribe_api_connection()

◆ uint64_to_bd_addr()

◆ unsubscribe_api_connection()

Field Documentation

◆ active_

◆ api_connection_

◆ configured_scan_active_

◆ connection_count_

◆ connections_

◆ connections_free_response_

◆ last_advertisement_flush_time_

◆ response_