ESPHome  2022.1.1
Public Member Functions | Static 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

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)
 
- 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 ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
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...
 

Static Protected Member Functions

static void gap_event_handler (esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param)
 
static void ble_core_task (void *params)
 
static void ble_setup ()
 

Protected Attributes

std::array< uint8_t, 16 > uuid_
 
uint16_t major_ {}
 
uint16_t minor_ {}
 
- 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

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

Detailed Description

Definition at line 35 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 37 of file esp32_ble_beacon.h.

Member Function Documentation

◆ ble_core_task()

void esphome::esp32_ble_beacon::ESP32BLEBeacon::ble_core_task ( void *  params)
staticprotected

Definition at line 61 of file esp32_ble_beacon.cpp.

◆ ble_setup()

void esphome::esp32_ble_beacon::ESP32BLEBeacon::ble_setup ( )
staticprotected

Definition at line 69 of file esp32_ble_beacon.cpp.

◆ dump_config()

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

Reimplemented from esphome::Component.

Definition at line 41 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 
)
staticprotected

Definition at line 138 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 60 of file esp32_ble_beacon.cpp.

◆ set_major()

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

Definition at line 43 of file esp32_ble_beacon.h.

◆ set_minor()

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

Definition at line 44 of file esp32_ble_beacon.h.

◆ setup()

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

Reimplemented from esphome::Component.

Definition at line 46 of file esp32_ble_beacon.cpp.

Field Documentation

◆ major_

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

Definition at line 52 of file esp32_ble_beacon.h.

◆ minor_

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

Definition at line 53 of file esp32_ble_beacon.h.

◆ uuid_

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

Definition at line 51 of file esp32_ble_beacon.h.


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