ESPHome  2024.12.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::sn74hc165::SN74HC165Component Class Reference

#include <sn74hc165.h>

Inheritance diagram for esphome::sn74hc165::SN74HC165Component:
esphome::Component

Public Member Functions

 SN74HC165Component ()=default
 
void setup () override
 
void loop () override
 
float get_setup_priority () const override
 
void dump_config () override
 
void set_data_pin (GPIOPin *pin)
 
void set_clock_pin (GPIOPin *pin)
 
void set_load_pin (GPIOPin *pin)
 
void set_clock_inhibit_pin (GPIOPin *pin)
 
void set_sr_count (uint8_t count)
 
- 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 Member Functions

bool digital_read_ (uint16_t pin)
 
void read_gpio_ ()
 
- 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

GPIOPindata_pin_
 
GPIOPinclock_pin_
 
GPIOPinload_pin_
 
GPIOPinclock_inhibit_pin_
 
uint8_t sr_count_
 
std::vector< bool > input_bits_
 
- 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}
 

Detailed Description

Definition at line 12 of file sn74hc165.h.

Constructor & Destructor Documentation

◆ SN74HC165Component()

esphome::sn74hc165::SN74HC165Component::SN74HC165Component ( )
default

Member Function Documentation

◆ digital_read_()

bool esphome::sn74hc165::SN74HC165Component::digital_read_ ( uint16_t  pin)
protected

Definition at line 32 of file sn74hc165.cpp.

◆ dump_config()

void esphome::sn74hc165::SN74HC165Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 30 of file sn74hc165.cpp.

◆ get_setup_priority()

float esphome::sn74hc165::SN74HC165Component::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 65 of file sn74hc165.cpp.

◆ loop()

void esphome::sn74hc165::SN74HC165Component::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 28 of file sn74hc165.cpp.

◆ read_gpio_()

void esphome::sn74hc165::SN74HC165Component::read_gpio_ ( )
protected

Definition at line 41 of file sn74hc165.cpp.

◆ set_clock_inhibit_pin()

void esphome::sn74hc165::SN74HC165Component::set_clock_inhibit_pin ( GPIOPin pin)
inline

Definition at line 24 of file sn74hc165.h.

◆ set_clock_pin()

void esphome::sn74hc165::SN74HC165Component::set_clock_pin ( GPIOPin pin)
inline

Definition at line 22 of file sn74hc165.h.

◆ set_data_pin()

void esphome::sn74hc165::SN74HC165Component::set_data_pin ( GPIOPin pin)
inline

Definition at line 21 of file sn74hc165.h.

◆ set_load_pin()

void esphome::sn74hc165::SN74HC165Component::set_load_pin ( GPIOPin pin)
inline

Definition at line 23 of file sn74hc165.h.

◆ set_sr_count()

void esphome::sn74hc165::SN74HC165Component::set_sr_count ( uint8_t  count)
inline

Definition at line 25 of file sn74hc165.h.

◆ setup()

void esphome::sn74hc165::SN74HC165Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 9 of file sn74hc165.cpp.

Field Documentation

◆ clock_inhibit_pin_

GPIOPin* esphome::sn74hc165::SN74HC165Component::clock_inhibit_pin_
protected

Definition at line 38 of file sn74hc165.h.

◆ clock_pin_

GPIOPin* esphome::sn74hc165::SN74HC165Component::clock_pin_
protected

Definition at line 36 of file sn74hc165.h.

◆ data_pin_

GPIOPin* esphome::sn74hc165::SN74HC165Component::data_pin_
protected

Definition at line 35 of file sn74hc165.h.

◆ input_bits_

std::vector<bool> esphome::sn74hc165::SN74HC165Component::input_bits_
protected

Definition at line 40 of file sn74hc165.h.

◆ load_pin_

GPIOPin* esphome::sn74hc165::SN74HC165Component::load_pin_
protected

Definition at line 37 of file sn74hc165.h.

◆ sr_count_

uint8_t esphome::sn74hc165::SN74HC165Component::sr_count_
protected

Definition at line 39 of file sn74hc165.h.


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