#include <ble_presence_device.h>

Inheritance diagram for esphome::ble_presence::BLEPresenceDevice:

Public Member Functions
void	set_address (uint64_t address)

void	set_irk (uint8_t *irk)

void	set_service_uuid16 (uint16_t uuid)

void	set_service_uuid32 (uint32_t uuid)

void	set_service_uuid128 (uint8_t *uuid)

void	set_ibeacon_uuid (uint8_t *uuid)

void	set_ibeacon_major (uint16_t major)

void	set_ibeacon_minor (uint16_t minor)

void	set_minimum_rssi (int rssi)

void	set_timeout (uint32_t timeout)

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

void	loop () override

void	dump_config () override

float	get_setup_priority () const override

Public Member Functions inherited from esphome::binary_sensor::BinarySensorInitiallyOff
bool	has_state () const override

Public Member Functions inherited from esphome::binary_sensor::BinarySensor
	BinarySensor ()

void	add_on_state_callback (std::function< void(bool)> &&callback)
	Add a callback to be notified of state changes. More...

void	publish_state (bool state)
	Publish a new state to the front-end. More...

void	publish_initial_state (bool state)
	Publish the initial state, this will not make the callback manager send callbacks and is meant only for the initial state on boot. More...

void	add_filter (Filter *filter)

void	add_filters (const std::vector< Filter *> &filters)

void	set_publish_initial_state (bool publish_initial_state)

void	send_state_internal (bool state, bool is_initial)

virtual bool	is_status_binary_sensor () const

Public Member Functions inherited from esphome::EntityBase
const StringRef &	get_name () const

void	set_name (const char *name)

bool	has_own_name () const

std::string	get_object_id () const

void	set_object_id (const char *object_id)

uint32_t	get_object_id_hash ()

bool	is_internal () const

void	set_internal (bool internal)

bool	is_disabled_by_default () const

void	set_disabled_by_default (bool disabled_by_default)

EntityCategory	get_entity_category () const

void	set_entity_category (EntityCategory entity_category)

std::string	get_icon () const

void	set_icon (const char *icon)

Public Member Functions inherited from esphome::EntityBase_DeviceClass
std::string	get_device_class ()
	Get the device class, using the manual override if set. More...

void	set_device_class (const char *device_class)
	Manually set the device class. More...

Public Member Functions inherited from esphome::esp32_ble_tracker::ESPBTDeviceListener
virtual void	on_scan_end ()

virtual bool	parse_devices (esp_ble_gap_cb_param_t::ble_scan_result_evt_param *advertisements, size_t count)

virtual AdvertisementParserType	get_advertisement_parser_type ()

void	set_parent (ESP32BLETracker *parent)

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

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

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

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

uint32_t	get_component_state () const

virtual void	mark_failed ()
	Mark this component as failed. More...

bool	is_failed ()

bool	is_ready ()

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning (const char *message="unspecified")

void	status_set_error (const char *message="unspecified")

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

const char *	get_component_source () const
	Get the integration where this component was declared as a string. More...

Protected Types
enum	MatchType { MATCH_BY_MAC_ADDRESS, MATCH_BY_IRK, MATCH_BY_SERVICE_UUID, MATCH_BY_IBEACON_UUID }

Protected Member Functions
void	set_found_ (bool state)

bool	resolve_irk_ (uint64_t addr64, const uint8_t *irk)

Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t	hash_base ()
	The hash_base() function has been deprecated. More...

void	calc_object_id_ ()

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

virtual void	call_setup ()

virtual void	call_dump_config ()

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

void	set_interval (uint32_t interval, std::function< void()> &&f)

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

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. More...

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. More...

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

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

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

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

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

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

Protected Attributes
MatchType	match_by_

uint64_t	address_

uint8_t *	irk_

esp32_ble_tracker::ESPBTUUID	uuid_

esp32_ble_tracker::ESPBTUUID	ibeacon_uuid_

uint16_t	ibeacon_major_ {0}

uint16_t	ibeacon_minor_ {0}

int	minimum_rssi_ {0}

bool	check_ibeacon_major_ {false}

bool	check_ibeacon_minor_ {false}

bool	check_minimum_rssi_ {false}

bool	found_ {false}

uint32_t	last_seen_ {}

uint32_t	timeout_ {}

Protected Attributes inherited from esphome::binary_sensor::BinarySensor
CallbackManager< void(bool)>	state_callback_ {}

Filter *	filter_list_ {nullptr}

bool	has_state_ {false}

bool	publish_initial_state_ {false}

Deduplicator< bool >	publish_dedup_

Protected Attributes inherited from esphome::EntityBase
StringRef	name_

const char *	object_id_c_str_ {nullptr}

const char *	icon_c_str_ {nullptr}

uint32_t	object_id_hash_

bool	has_own_name_ {false}

bool	internal_ {false}

bool	disabled_by_default_ {false}

EntityCategory	entity_category_ {ENTITY_CATEGORY_NONE}

Protected Attributes inherited from esphome::EntityBase_DeviceClass
const char *	device_class_ {nullptr}
	Device class override. More...

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

Protected Attributes inherited from esphome::Component
uint32_t	component_state_ {0x0000}
	State of this component. More...

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

Additional Inherited Members
Data Fields inherited from esphome::binary_sensor::BinarySensor
bool	state
	The current reported state of the binary sensor. More...

Detailed Description

Definition at line 22 of file ble_presence_device.h.

Member Enumeration Documentation

◆ MatchType

enum esphome::ble_presence::BLEPresenceDevice::MatchType

protected

Enumerator
MATCH_BY_MAC_ADDRESS
MATCH_BY_IRK
MATCH_BY_SERVICE_UUID
MATCH_BY_IBEACON_UUID

Definition at line 127 of file ble_presence_device.h.

Member Function Documentation

◆ dump_config()

void esphome::ble_presence::BLEPresenceDevice::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 11 of file ble_presence_device.cpp.

◆ get_setup_priority()

float esphome::ble_presence::BLEPresenceDevice::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 118 of file ble_presence_device.h.

◆ loop()

void esphome::ble_presence::BLEPresenceDevice::loop ( )

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 113 of file ble_presence_device.h.

◆ parse_device()

bool esphome::ble_presence::BLEPresenceDevice::parse_device ( const esp32_ble_tracker::ESPBTDevice & device )

inlineoverridevirtual

Implements esphome::esp32_ble_tracker::ESPBTDeviceListener.

Definition at line 63 of file ble_presence_device.h.

◆ resolve_irk_()

bool esphome::ble_presence::BLEPresenceDevice::resolve_irk_	(	uint64_t	addr64,
		const uint8_t *	irk
	)

inlineprotected

Definition at line 145 of file ble_presence_device.h.

◆ set_address()

void esphome::ble_presence::BLEPresenceDevice::set_address ( uint64_t address )

inline

Definition at line 26 of file ble_presence_device.h.

◆ set_found_()

void esphome::ble_presence::BLEPresenceDevice::set_found_ ( bool state )

inlineprotected

Definition at line 121 of file ble_presence_device.h.

◆ set_ibeacon_major()

void esphome::ble_presence::BLEPresenceDevice::set_ibeacon_major ( uint16_t major )

inline

Definition at line 50 of file ble_presence_device.h.

◆ set_ibeacon_minor()

void esphome::ble_presence::BLEPresenceDevice::set_ibeacon_minor ( uint16_t minor )

inline

Definition at line 54 of file ble_presence_device.h.

◆ set_ibeacon_uuid()

void esphome::ble_presence::BLEPresenceDevice::set_ibeacon_uuid ( uint8_t * uuid )

inline

Definition at line 46 of file ble_presence_device.h.

◆ set_irk()

void esphome::ble_presence::BLEPresenceDevice::set_irk ( uint8_t * irk )

inline

Definition at line 30 of file ble_presence_device.h.

◆ set_minimum_rssi()

void esphome::ble_presence::BLEPresenceDevice::set_minimum_rssi ( int rssi )

inline

Definition at line 58 of file ble_presence_device.h.

◆ set_service_uuid128()

void esphome::ble_presence::BLEPresenceDevice::set_service_uuid128 ( uint8_t * uuid )

inline

Definition at line 42 of file ble_presence_device.h.

◆ set_service_uuid16()

void esphome::ble_presence::BLEPresenceDevice::set_service_uuid16 ( uint16_t uuid )

inline

Definition at line 34 of file ble_presence_device.h.

◆ set_service_uuid32()

void esphome::ble_presence::BLEPresenceDevice::set_service_uuid32 ( uint32_t uuid )

inline

Definition at line 38 of file ble_presence_device.h.

◆ set_timeout()

void esphome::ble_presence::BLEPresenceDevice::set_timeout ( uint32_t timeout )

inline

Definition at line 62 of file ble_presence_device.h.

Field Documentation

◆ address_

uint64_t esphome::ble_presence::BLEPresenceDevice::address_

protected

Definition at line 130 of file ble_presence_device.h.

◆ check_ibeacon_major_

bool esphome::ble_presence::BLEPresenceDevice::check_ibeacon_major_ {false}

protected

Definition at line 141 of file ble_presence_device.h.

◆ check_ibeacon_minor_

bool esphome::ble_presence::BLEPresenceDevice::check_ibeacon_minor_ {false}

protected

Definition at line 142 of file ble_presence_device.h.

◆ check_minimum_rssi_

bool esphome::ble_presence::BLEPresenceDevice::check_minimum_rssi_ {false}

protected

Definition at line 143 of file ble_presence_device.h.

◆ found_

bool esphome::ble_presence::BLEPresenceDevice::found_ {false}

protected

Definition at line 182 of file ble_presence_device.h.

◆ ibeacon_major_

uint16_t esphome::ble_presence::BLEPresenceDevice::ibeacon_major_ {0}

protected

Definition at line 136 of file ble_presence_device.h.

◆ ibeacon_minor_

uint16_t esphome::ble_presence::BLEPresenceDevice::ibeacon_minor_ {0}

protected

Definition at line 137 of file ble_presence_device.h.

◆ ibeacon_uuid_

esp32_ble_tracker::ESPBTUUID esphome::ble_presence::BLEPresenceDevice::ibeacon_uuid_

protected

Definition at line 135 of file ble_presence_device.h.

◆ irk_

uint8_t* esphome::ble_presence::BLEPresenceDevice::irk_

protected

Definition at line 131 of file ble_presence_device.h.

◆ last_seen_

uint32_t esphome::ble_presence::BLEPresenceDevice::last_seen_ {}

protected

Definition at line 183 of file ble_presence_device.h.

◆ match_by_

MatchType esphome::ble_presence::BLEPresenceDevice::match_by_

protected

Definition at line 128 of file ble_presence_device.h.

◆ minimum_rssi_

int esphome::ble_presence::BLEPresenceDevice::minimum_rssi_ {0}

protected

Definition at line 139 of file ble_presence_device.h.

◆ timeout_

uint32_t esphome::ble_presence::BLEPresenceDevice::timeout_ {}

protected

Definition at line 184 of file ble_presence_device.h.

◆ uuid_

esp32_ble_tracker::ESPBTUUID esphome::ble_presence::BLEPresenceDevice::uuid_

protected

Definition at line 133 of file ble_presence_device.h.

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

/opt/build/esphome/esphome/components/ble_presence/ble_presence_device.h
/opt/build/esphome/esphome/components/ble_presence/ble_presence_device.cpp

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ MatchType

Member Function Documentation

◆ dump_config()

◆ get_setup_priority()

◆ loop()

◆ parse_device()

◆ resolve_irk_()

◆ set_address()

◆ set_found_()

◆ set_ibeacon_major()

◆ set_ibeacon_minor()

◆ set_ibeacon_uuid()

◆ set_irk()

◆ set_minimum_rssi()

◆ set_service_uuid128()

◆ set_service_uuid16()

◆ set_service_uuid32()

◆ set_timeout()

Field Documentation

◆ address_

◆ check_ibeacon_major_

◆ check_ibeacon_minor_

◆ check_minimum_rssi_

◆ found_

◆ ibeacon_major_

◆ ibeacon_minor_

◆ ibeacon_uuid_

◆ irk_

◆ last_seen_

◆ match_by_

◆ minimum_rssi_

◆ timeout_

◆ uuid_