#include <ble_nus.h>

Inheritance diagram for esphome::ble_nus::BLENUS:

Public Member Functions
void	setup () override

void	dump_config () override

void	loop () override

void	write_array (const uint8_t *data, size_t len) override

bool	peek_byte (uint8_t *data) override

bool	read_array (uint8_t *data, size_t len) override

size_t	available () override

uart::UARTFlushResult	flush () override

void	check_logger_conflict () override

void	set_expose_log (bool expose_log)

void	on_log (uint8_t level, const char tag, const char message, size_t message_len)

Public Member Functions inherited from esphome::uart::UARTComponent
void	write_array (const std::vector< uint8_t > &data)

void	write_byte (uint8_t data)

void	write_str (const char *str)

bool	read_byte (uint8_t *data)

virtual bool	is_connected ()

virtual void	set_flush_timeout (uint32_t flush_timeout_ms)

void	set_tx_pin (InternalGPIOPin *tx_pin)

void	set_rx_pin (InternalGPIOPin *rx_pin)

void	set_flow_control_pin (InternalGPIOPin *flow_control_pin)

void	set_rx_buffer_size (size_t rx_buffer_size)

size_t	get_rx_buffer_size ()

virtual void	set_rx_full_threshold (size_t rx_full_threshold)

void	set_rx_full_threshold_ms (uint8_t time)

size_t	get_rx_full_threshold ()

virtual void	set_rx_timeout (size_t rx_timeout)

size_t	get_rx_timeout ()

void	set_stop_bits (uint8_t stop_bits)

uint8_t	get_stop_bits () const

void	set_data_bits (uint8_t data_bits)

uint8_t	get_data_bits () const

void	set_parity (UARTParityOptions parity)

UARTParityOptions	get_parity () const

void	set_baud_rate (uint32_t baud_rate)

uint32_t	get_baud_rate () const

virtual void	load_settings (bool dump_config)
	Load the UART settings.

virtual void	load_settings ()
	Load the UART settings.

template<typename F >
void	add_debug_callback (F &&callback)

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.

	ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message)

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

	ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message)

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)

Static Protected Member Functions
static void	send_enabled_callback (bt_nus_send_status status)

static void	tx_callback (bt_conn *conn)

static void	rx_callback (bt_conn conn, const uint8_t data, uint16_t len)

static void	connected (bt_conn *conn, uint8_t err)

static void	disconnected (bt_conn *conn, uint8_t reason)

Protected Attributes
std::atomic< bt_conn * >	conn_ = nullptr

bool	expose_log_ = false

atomic_t	tx_status_ = ATOMIC_INIT(TX_DISABLED)

std::atomic< bool >	connected_ {}

uint8_t	peek_buffer_ {0}

bool	has_peek_ {false}

Protected Attributes inherited from esphome::uart::UARTComponent
InternalGPIOPin *	tx_pin_ {}

InternalGPIOPin *	rx_pin_ {}

InternalGPIOPin *	flow_control_pin_ {}

size_t	rx_buffer_size_ {}

size_t	rx_full_threshold_ {RX_FULL_THRESHOLD_UNSET}

size_t	rx_timeout_ {0}

uint32_t	baud_rate_ {0}

uint8_t	stop_bits_ {0}

uint8_t	data_bits_ {0}

UARTParityOptions	parity_ {UART_CONFIG_PARITY_NONE}

CallbackManager< void(UARTDirection, uint8_t)>	debug_callback_ {}

Protected Attributes inherited from esphome::Component
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi	set_interval )(const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo	cancel_interval )(const char *name)
	Cancel an interval function.

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t	initial_wait_time

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t	max_attempts

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> &&	f

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

uint32_t	initial_wait_time

uint32_t uint8_t	max_attempts

uint32_t uint8_t std::function< RetryResult(uint8_t)> &&	f

uint32_t uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

uint8_t	max_attempts

uint8_t std::function< RetryResult(uint8_t)> &&	f

uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi	set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo	cancel_timeout )(const char *name)
	Cancel a timeout function.

ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi	defer )(const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo	cancel_defer )(const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

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_

Additional Inherited Members
Static Public Attributes inherited from esphome::uart::UARTComponent
static constexpr size_t	RX_FULL_THRESHOLD_UNSET = 0

Protected Member Functions inherited from esphome::uart::UARTComponent
bool	check_read_timeout_ (size_t len=1)

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

bool	cancel_interval (InternalSchedulerID id)

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const char *name

	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t id

	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t initial_wait_time

ESPDEPRECATED("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const std	ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const char *name)

	ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(uint32_t id)

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

bool	cancel_timeout (InternalSchedulerID id)

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

void	status_clear_warning_slow_path_ ()

void	status_clear_error_slow_path_ ()

Detailed Description

Definition at line 14 of file ble_nus.h.

Member Function Documentation

◆ available()

size_t esphome::ble_nus::BLENUS::available ( )

overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 96 of file ble_nus.cpp.

◆ check_logger_conflict()

void esphome::ble_nus::BLENUS::check_logger_conflict ( )

inlineoverridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 30 of file ble_nus.h.

◆ connected()

void esphome::ble_nus::BLENUS::connected	(	bt_conn *	conn,
		uint8_t	err )

staticprotected

Definition at line 119 of file ble_nus.cpp.

◆ disconnected()

void esphome::ble_nus::BLENUS::disconnected	(	bt_conn *	conn,
		uint8_t	reason )

staticprotected

Definition at line 126 of file ble_nus.cpp.

◆ dump_config()

void esphome::ble_nus::BLENUS::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 206 of file ble_nus.cpp.

◆ flush()

uart::UARTFlushResult esphome::ble_nus::BLENUS::flush ( )

overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 106 of file ble_nus.cpp.

◆ loop()

void esphome::ble_nus::BLENUS::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 220 of file ble_nus.cpp.

◆ on_log()

void esphome::ble_nus::BLENUS::on_log	(	uint8_t	level,
		const char *	tag,
		const char *	message,
		size_t	message_len )

Definition at line 197 of file ble_nus.cpp.

◆ peek_byte()

bool esphome::ble_nus::BLENUS::peek_byte ( uint8_t * data )

overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 40 of file ble_nus.cpp.

◆ read_array()

bool esphome::ble_nus::BLENUS::read_array	(	uint8_t *	data,
		size_t	len )

overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 59 of file ble_nus.cpp.

◆ rx_callback()

void esphome::ble_nus::BLENUS::rx_callback	(	bt_conn *	conn,
		const uint8_t *	data,
		uint16_t	len )

staticprotected

Definition at line 157 of file ble_nus.cpp.

◆ send_enabled_callback()

void esphome::ble_nus::BLENUS::send_enabled_callback ( bt_nus_send_status status )

staticprotected

Definition at line 140 of file ble_nus.cpp.

◆ set_expose_log()

void esphome::ble_nus::BLENUS::set_expose_log ( bool expose_log )

inline

Definition at line 31 of file ble_nus.h.

◆ setup()

void esphome::ble_nus::BLENUS::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 166 of file ble_nus.cpp.

◆ tx_callback()

void esphome::ble_nus::BLENUS::tx_callback ( bt_conn * conn )

staticprotected

Definition at line 135 of file ble_nus.cpp.

◆ write_array()

void esphome::ble_nus::BLENUS::write_array	(	const uint8_t *	data,
		size_t	len )

overridevirtual

Implements esphome::uart::UARTComponent.

Definition at line 24 of file ble_nus.cpp.

Field Documentation

◆ conn_

std::atomic<bt_conn *> esphome::ble_nus::BLENUS::conn_ = nullptr

protected

Definition at line 43 of file ble_nus.h.

◆ connected_

std::atomic<bool> esphome::ble_nus::BLENUS::connected_ {}

protected

Definition at line 46 of file ble_nus.h.

◆ expose_log_

bool esphome::ble_nus::BLENUS::expose_log_ = false

protected

Definition at line 44 of file ble_nus.h.

◆ has_peek_

bool esphome::ble_nus::BLENUS::has_peek_ {false}

protected

Definition at line 50 of file ble_nus.h.

◆ peek_buffer_

uint8_t esphome::ble_nus::BLENUS::peek_buffer_ {0}

protected

Definition at line 49 of file ble_nus.h.

◆ tx_status_

atomic_t esphome::ble_nus::BLENUS::tx_status_ = ATOMIC_INIT(TX_DISABLED)

protected

Definition at line 45 of file ble_nus.h.

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

esphome/components/ble_nus/ble_nus.h
esphome/components/ble_nus/ble_nus.cpp

Public Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ available()

◆ check_logger_conflict()

◆ connected()

◆ disconnected()

◆ dump_config()

◆ flush()

◆ loop()

◆ on_log()

◆ peek_byte()

◆ read_array()

◆ rx_callback()

◆ send_enabled_callback()

◆ set_expose_log()

◆ setup()

◆ tx_callback()

◆ write_array()

Field Documentation

◆ conn_

◆ connected_

◆ expose_log_

◆ has_peek_

◆ peek_buffer_

◆ tx_status_