ESPHome  2024.12.2
Public Member Functions | Protected Attributes
esphome::wiegand::Wiegand Class Reference

#include <wiegand.h>

Inheritance diagram for esphome::wiegand::Wiegand:
esphome::key_provider::KeyProvider esphome::Component

Public Member Functions

float get_setup_priority () const override
 
void setup () override
 
void loop () override
 
void dump_config () override
 
void set_d0_pin (InternalGPIOPin *pin)
 
void set_d1_pin (InternalGPIOPin *pin)
 
void register_tag_trigger (WiegandTagTrigger *trig)
 
void register_raw_trigger (WiegandRawTrigger *trig)
 
void register_key_trigger (WiegandKeyTrigger *trig)
 
- Public Member Functions inherited from esphome::key_provider::KeyProvider
void add_on_key_callback (std::function< void(uint8_t)> &&callback)
 
- Public Member Functions inherited from esphome::Component
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

InternalGPIOPind0_pin_
 
InternalGPIOPind1_pin_
 
WiegandStore store_ {}
 
std::vector< WiegandTagTrigger * > tag_triggers_
 
std::vector< WiegandRawTrigger * > raw_triggers_
 
std::vector< WiegandKeyTrigger * > key_triggers_
 
- Protected Attributes inherited from esphome::key_provider::KeyProvider
CallbackManager< void(uint8_t)> key_callback_ {}
 
- 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::key_provider::KeyProvider
void send_key_ (uint8_t key)
 
- 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 31 of file wiegand.h.

Member Function Documentation

◆ dump_config()

void esphome::wiegand::Wiegand::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 120 of file wiegand.cpp.

◆ get_setup_priority()

float esphome::wiegand::Wiegand::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 33 of file wiegand.h.

◆ loop()

void esphome::wiegand::Wiegand::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 58 of file wiegand.cpp.

◆ register_key_trigger()

void esphome::wiegand::Wiegand::register_key_trigger ( WiegandKeyTrigger trig)
inline

Definition at line 42 of file wiegand.h.

◆ register_raw_trigger()

void esphome::wiegand::Wiegand::register_raw_trigger ( WiegandRawTrigger trig)
inline

Definition at line 41 of file wiegand.h.

◆ register_tag_trigger()

void esphome::wiegand::Wiegand::register_tag_trigger ( WiegandTagTrigger trig)
inline

Definition at line 40 of file wiegand.h.

◆ set_d0_pin()

void esphome::wiegand::Wiegand::set_d0_pin ( InternalGPIOPin pin)
inline

Definition at line 38 of file wiegand.h.

◆ set_d1_pin()

void esphome::wiegand::Wiegand::set_d1_pin ( InternalGPIOPin pin)
inline

Definition at line 39 of file wiegand.h.

◆ setup()

void esphome::wiegand::Wiegand::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 29 of file wiegand.cpp.

Field Documentation

◆ d0_pin_

InternalGPIOPin* esphome::wiegand::Wiegand::d0_pin_
protected

Definition at line 45 of file wiegand.h.

◆ d1_pin_

InternalGPIOPin* esphome::wiegand::Wiegand::d1_pin_
protected

Definition at line 46 of file wiegand.h.

◆ key_triggers_

std::vector<WiegandKeyTrigger *> esphome::wiegand::Wiegand::key_triggers_
protected

Definition at line 50 of file wiegand.h.

◆ raw_triggers_

std::vector<WiegandRawTrigger *> esphome::wiegand::Wiegand::raw_triggers_
protected

Definition at line 49 of file wiegand.h.

◆ store_

WiegandStore esphome::wiegand::Wiegand::store_ {}
protected

Definition at line 47 of file wiegand.h.

◆ tag_triggers_

std::vector<WiegandTagTrigger *> esphome::wiegand::Wiegand::tag_triggers_
protected

Definition at line 48 of file wiegand.h.


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