#include <ble_binary_output.h>

Inheritance diagram for esphome::ble_client::BLEBinaryOutput:

Public Member Functions
void	dump_config () override

void	loop () override

void	set_service_uuid16 (uint16_t uuid)

void	set_service_uuid32 (uint32_t uuid)

void	set_service_uuid128 (uint8_t *uuid)

void	set_char_uuid16 (uint16_t uuid)

void	set_char_uuid32 (uint32_t uuid)

void	set_char_uuid128 (uint8_t *uuid)

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	set_require_response (bool response)

Public Member Functions inherited from esphome::output::BinaryOutput
void	set_inverted (bool inverted)
	Set the inversion state of this binary output.

void	set_power_supply (power_supply::PowerSupply *power_supply)
	Use this to connect up a power supply to this output.

virtual void	set_state (bool state)
	Enable or disable this binary output.

virtual void	turn_on ()
	Enable this binary output.

virtual void	turn_off ()
	Disable this binary output.

bool	is_inverted () const
	Return whether this binary output is inverted.

Public Member Functions inherited from esphome::ble_client::BLEClientNode
virtual void	gap_event_handler (esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param)

void	set_address (uint64_t address)

BLEClient *	parent ()

void	set_ble_client_parent (BLEClient *parent)

Public Member Functions inherited from esphome::Component
virtual void	setup ()
	Where the component's initialization should happen.

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)

Protected Member Functions
void	write_state (bool state) override

Protected Member Functions inherited from esphome::output::BinaryOutput
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.

Protected Attributes
bool	require_response_

espbt::ESPBTUUID	service_uuid_

espbt::ESPBTUUID	char_uuid_

uint16_t	char_handle_ {}

esp_gatt_char_prop_t	char_props_ {}

esp_gatt_write_type_t	write_type_ {}

Protected Attributes inherited from esphome::output::BinaryOutput
bool	inverted_ {false}

power_supply::PowerSupplyRequester	power_ {}

Protected Attributes inherited from esphome::ble_client::BLEClientNode
BLEClient *	parent_

uint64_t	address_

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
Data Fields inherited from esphome::ble_client::BLEClientNode
espbt::ESPBTClient *	client

espbt::ClientState	node_state

Detailed Description

Definition at line 15 of file ble_binary_output.h.

Member Function Documentation

◆ dump_config()

void esphome::ble_client::BLEBinaryOutput::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 11 of file ble_binary_output.cpp.

◆ gattc_event_handler()

void esphome::ble_client::BLEBinaryOutput::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 22 of file ble_binary_output.cpp.

◆ loop()

void esphome::ble_client::BLEBinaryOutput::loop ( )

inlineoverridevirtual

Reimplemented from esphome::ble_client::BLEClientNode.

Definition at line 18 of file ble_binary_output.h.

◆ set_char_uuid128()

void esphome::ble_client::BLEBinaryOutput::set_char_uuid128 ( uint8_t * uuid )

inline

Definition at line 24 of file ble_binary_output.h.

◆ set_char_uuid16()

void esphome::ble_client::BLEBinaryOutput::set_char_uuid16 ( uint16_t uuid )

inline

Definition at line 22 of file ble_binary_output.h.

◆ set_char_uuid32()

void esphome::ble_client::BLEBinaryOutput::set_char_uuid32 ( uint32_t uuid )

inline

Definition at line 23 of file ble_binary_output.h.

◆ set_require_response()

void esphome::ble_client::BLEBinaryOutput::set_require_response ( bool response )

inline

Definition at line 27 of file ble_binary_output.h.

◆ set_service_uuid128()

void esphome::ble_client::BLEBinaryOutput::set_service_uuid128 ( uint8_t * uuid )

inline

Definition at line 21 of file ble_binary_output.h.

◆ set_service_uuid16()

void esphome::ble_client::BLEBinaryOutput::set_service_uuid16 ( uint16_t uuid )

inline

Definition at line 19 of file ble_binary_output.h.

◆ set_service_uuid32()

void esphome::ble_client::BLEBinaryOutput::set_service_uuid32 ( uint32_t uuid )

inline

Definition at line 20 of file ble_binary_output.h.

◆ write_state()

void esphome::ble_client::BLEBinaryOutput::write_state ( bool state )

overrideprotectedvirtual

Implements esphome::output::BinaryOutput.

Definition at line 63 of file ble_binary_output.cpp.

Field Documentation

◆ char_handle_

uint16_t esphome::ble_client::BLEBinaryOutput::char_handle_ {}

protected

Definition at line 34 of file ble_binary_output.h.

◆ char_props_

esp_gatt_char_prop_t esphome::ble_client::BLEBinaryOutput::char_props_ {}

protected

Definition at line 35 of file ble_binary_output.h.

◆ char_uuid_

espbt::ESPBTUUID esphome::ble_client::BLEBinaryOutput::char_uuid_

protected

Definition at line 33 of file ble_binary_output.h.

◆ require_response_

bool esphome::ble_client::BLEBinaryOutput::require_response_

protected

Definition at line 31 of file ble_binary_output.h.

◆ service_uuid_

espbt::ESPBTUUID esphome::ble_client::BLEBinaryOutput::service_uuid_

protected

Definition at line 32 of file ble_binary_output.h.

◆ write_type_

esp_gatt_write_type_t esphome::ble_client::BLEBinaryOutput::write_type_ {}

protected

Definition at line 36 of file ble_binary_output.h.

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

esphome/components/ble_client/output/ble_binary_output.h
esphome/components/ble_client/output/ble_binary_output.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ dump_config()

◆ gattc_event_handler()

◆ loop()

◆ set_char_uuid128()

◆ set_char_uuid16()

◆ set_char_uuid32()

◆ set_require_response()

◆ set_service_uuid128()

◆ set_service_uuid16()

◆ set_service_uuid32()

◆ write_state()

Field Documentation

◆ char_handle_

◆ char_props_

◆ char_uuid_

◆ require_response_

◆ service_uuid_

◆ write_type_