ESPHome  2024.8.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::esp32_ble_beacon::ESP32BLEBeacon Class Reference

#include <esp32_ble_beacon.h>

Inheritance diagram for esphome::esp32_ble_beacon::ESP32BLEBeacon:
esphome::Component esphome::esp32_ble::GAPEventHandler esphome::Parented< ESP32BLE >

Public Member Functions

 ESP32BLEBeacon (const std::array< uint8_t, 16 > &uuid)
 
void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void set_major (uint16_t major)
 
void set_minor (uint16_t minor)
 
void set_min_interval (uint16_t val)
 
void set_max_interval (uint16_t val)
 
void set_measured_power (int8_t val)
 
void set_tx_power (esp_power_level_t val)
 
void gap_event_handler (esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param) override
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. 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 () 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="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...
 
- Public Member Functions inherited from esphome::Parented< ESP32BLE >
 Parented ()
 
 Parented (ESP32BLE *parent)
 
ESP32BLE * get_parent () const
 Get the parent of this object. More...
 
void set_parent (ESP32BLE *parent)
 Set the parent of this object. More...
 

Protected Member Functions

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

std::array< uint8_t, 16 > uuid_
 
uint16_t major_ {}
 
uint16_t minor_ {}
 
uint16_t min_interval_ {}
 
uint16_t max_interval_ {}
 
int8_t measured_power_ {}
 
esp_power_level_t tx_power_ {}
 
esp_ble_adv_params_t ble_adv_params_
 
bool advertising_ {false}
 
- 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}
 
- Protected Attributes inherited from esphome::Parented< ESP32BLE >
ESP32BLE * parent_
 

Detailed Description

Definition at line 36 of file esp32_ble_beacon.h.

Constructor & Destructor Documentation

◆ ESP32BLEBeacon()

esphome::esp32_ble_beacon::ESP32BLEBeacon::ESP32BLEBeacon ( const std::array< uint8_t, 16 > &  uuid)
inlineexplicit

Definition at line 38 of file esp32_ble_beacon.h.

Member Function Documentation

◆ dump_config()

void esphome::esp32_ble_beacon::ESP32BLEBeacon::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 29 of file esp32_ble_beacon.cpp.

◆ gap_event_handler()

void esphome::esp32_ble_beacon::ESP32BLEBeacon::gap_event_handler ( esp_gap_ble_cb_event_t  event,
esp_ble_gap_cb_param_t *  param 
)
overridevirtual

Implements esphome::esp32_ble::GAPEventHandler.

Definition at line 90 of file esp32_ble_beacon.cpp.

◆ get_setup_priority()

float esphome::esp32_ble_beacon::ESP32BLEBeacon::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 47 of file esp32_ble_beacon.cpp.

◆ on_advertise_()

void esphome::esp32_ble_beacon::ESP32BLEBeacon::on_advertise_ ( )
protected

Definition at line 69 of file esp32_ble_beacon.cpp.

◆ set_major()

void esphome::esp32_ble_beacon::ESP32BLEBeacon::set_major ( uint16_t  major)
inline

Definition at line 44 of file esp32_ble_beacon.h.

◆ set_max_interval()

void esphome::esp32_ble_beacon::ESP32BLEBeacon::set_max_interval ( uint16_t  val)
inline

Definition at line 47 of file esp32_ble_beacon.h.

◆ set_measured_power()

void esphome::esp32_ble_beacon::ESP32BLEBeacon::set_measured_power ( int8_t  val)
inline

Definition at line 48 of file esp32_ble_beacon.h.

◆ set_min_interval()

void esphome::esp32_ble_beacon::ESP32BLEBeacon::set_min_interval ( uint16_t  val)
inline

Definition at line 46 of file esp32_ble_beacon.h.

◆ set_minor()

void esphome::esp32_ble_beacon::ESP32BLEBeacon::set_minor ( uint16_t  minor)
inline

Definition at line 45 of file esp32_ble_beacon.h.

◆ set_tx_power()

void esphome::esp32_ble_beacon::ESP32BLEBeacon::set_tx_power ( esp_power_level_t  val)
inline

Definition at line 49 of file esp32_ble_beacon.h.

◆ setup()

void esphome::esp32_ble_beacon::ESP32BLEBeacon::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 49 of file esp32_ble_beacon.cpp.

Field Documentation

◆ advertising_

bool esphome::esp32_ble_beacon::ESP32BLEBeacon::advertising_ {false}
protected

Definition at line 63 of file esp32_ble_beacon.h.

◆ ble_adv_params_

esp_ble_adv_params_t esphome::esp32_ble_beacon::ESP32BLEBeacon::ble_adv_params_
protected

Definition at line 62 of file esp32_ble_beacon.h.

◆ major_

uint16_t esphome::esp32_ble_beacon::ESP32BLEBeacon::major_ {}
protected

Definition at line 56 of file esp32_ble_beacon.h.

◆ max_interval_

uint16_t esphome::esp32_ble_beacon::ESP32BLEBeacon::max_interval_ {}
protected

Definition at line 59 of file esp32_ble_beacon.h.

◆ measured_power_

int8_t esphome::esp32_ble_beacon::ESP32BLEBeacon::measured_power_ {}
protected

Definition at line 60 of file esp32_ble_beacon.h.

◆ min_interval_

uint16_t esphome::esp32_ble_beacon::ESP32BLEBeacon::min_interval_ {}
protected

Definition at line 58 of file esp32_ble_beacon.h.

◆ minor_

uint16_t esphome::esp32_ble_beacon::ESP32BLEBeacon::minor_ {}
protected

Definition at line 57 of file esp32_ble_beacon.h.

◆ tx_power_

esp_power_level_t esphome::esp32_ble_beacon::ESP32BLEBeacon::tx_power_ {}
protected

Definition at line 61 of file esp32_ble_beacon.h.

◆ uuid_

std::array<uint8_t, 16> esphome::esp32_ble_beacon::ESP32BLEBeacon::uuid_
protected

Definition at line 55 of file esp32_ble_beacon.h.


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