#include <ble_nus.h>

Inheritance diagram for esphome::ble_nus::BLENUS:

Public Member Functions
void	setup () override

void	dump_config () override

void	loop () override

size_t	write_array (const uint8_t *data, size_t len)

void	set_expose_log (bool expose_log)

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)

virtual float	get_loop_priority () const
	priority of loop().

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.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *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 (const char *message=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error (const char *message=nullptr)

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 LogString *source)
	Set where this component was loaded from for some debug messages.

const LogString *	get_component_log_str () const
	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)

Protected Attributes inherited from esphome::Component
const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

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 Bits 5-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

Additional Inherited Members
Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

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 interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

bool	cancel_interval (const char *name)

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.

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.

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

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 timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

bool	cancel_timeout (const char *name)

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

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.

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Detailed Description

Definition at line 10 of file ble_nus.h.

Member Function Documentation

◆ connected()

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

staticprotected

Definition at line 30 of file ble_nus.cpp.

◆ disconnected()

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

staticprotected

Definition at line 36 of file ble_nus.cpp.

◆ dump_config()

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

overridevirtual

Reimplemented from esphome::Component.

Definition at line 101 of file ble_nus.cpp.

◆ loop()

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

overridevirtual

Reimplemented from esphome::Component.

Definition at line 112 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 67 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 49 of file ble_nus.cpp.

◆ set_expose_log()

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

inline

Definition at line 22 of file ble_nus.h.

◆ setup()

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

overridevirtual

Reimplemented from esphome::Component.

Definition at line 71 of file ble_nus.cpp.

◆ tx_callback()

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

staticprotected

Definition at line 44 of file ble_nus.cpp.

◆ write_array()

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

Definition at line 23 of file ble_nus.cpp.

Field Documentation

◆ conn_

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

protected

Definition at line 31 of file ble_nus.h.

◆ expose_log_

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

protected

Definition at line 32 of file ble_nus.h.

◆ tx_status_

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

protected

Definition at line 33 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

◆ connected()

◆ disconnected()

◆ dump_config()

◆ loop()

◆ rx_callback()

◆ send_enabled_callback()

◆ set_expose_log()

◆ setup()

◆ tx_callback()

◆ write_array()

Field Documentation

◆ conn_

◆ expose_log_

◆ tx_status_