ESPHome  2024.10.3
Public Member Functions | Protected Attributes
esphome::qr_code::QrCode Class Reference

#include <qr_code.h>

Inheritance diagram for esphome::qr_code::QrCode:
esphome::Component

Public Member Functions

void draw (display::Display *buff, uint16_t x_offset, uint16_t y_offset, Color color, int scale)
 
void dump_config () override
 
void set_value (const std::string &value)
 
void set_ecc (qrcodegen_Ecc ecc)
 
void generate_qr_code ()
 
uint8_t get_size ()
 
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. More...
 
virtual void loop ()
 This method will be called repeatedly. More...
 
virtual float get_setup_priority () const
 priority of setup(). 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...
 

Protected Attributes

std::string value_
 
qrcodegen_Ecc ecc_
 
bool needs_update_ = true
 
uint8_t qr_ [qrcodegen_BUFFER_LEN_MAX]
 
- 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(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...
 

Detailed Description

Definition at line 16 of file qr_code.h.

Member Function Documentation

◆ draw()

void esphome::qr_code::QrCode::draw ( display::Display buff,
uint16_t  x_offset,
uint16_t  y_offset,
Color  color,
int  scale 
)

Definition at line 36 of file qr_code.cpp.

◆ dump_config()

void esphome::qr_code::QrCode::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 11 of file qr_code.cpp.

◆ generate_qr_code()

void esphome::qr_code::QrCode::generate_qr_code ( )

Definition at line 26 of file qr_code.cpp.

◆ get_size()

uint8_t esphome::qr_code::QrCode::get_size ( )

Definition at line 55 of file qr_code.cpp.

◆ set_ecc()

void esphome::qr_code::QrCode::set_ecc ( qrcodegen_Ecc  ecc)

Definition at line 21 of file qr_code.cpp.

◆ set_value()

void esphome::qr_code::QrCode::set_value ( const std::string &  value)

Definition at line 16 of file qr_code.cpp.

Field Documentation

◆ ecc_

qrcodegen_Ecc esphome::qr_code::QrCode::ecc_
protected

Definition at line 31 of file qr_code.h.

◆ needs_update_

bool esphome::qr_code::QrCode::needs_update_ = true
protected

Definition at line 32 of file qr_code.h.

◆ qr_

uint8_t esphome::qr_code::QrCode::qr_[qrcodegen_BUFFER_LEN_MAX]
protected

Definition at line 33 of file qr_code.h.

◆ value_

std::string esphome::qr_code::QrCode::value_
protected

Definition at line 30 of file qr_code.h.


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