ESPHome  2022.6.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::mcp23xxx_base::MCP23XXXBase Class Reference

#include <mcp23xxx_base.h>

Inheritance diagram for esphome::mcp23xxx_base::MCP23XXXBase:
esphome::Component esphome::mcp23x08_base::MCP23X08Base esphome::mcp23x17_base::MCP23X17Base esphome::mcp23008::MCP23008 esphome::mcp23s08::MCP23S08 esphome::mcp23017::MCP23017 esphome::mcp23s17::MCP23S17

Public Member Functions

virtual bool digital_read (uint8_t pin)
 
virtual void digital_write (uint8_t pin, bool value)
 
virtual void pin_mode (uint8_t pin, gpio::Flags flags)
 
virtual void pin_interrupt_mode (uint8_t pin, MCP23XXXInterruptMode interrupt_mode)
 
void set_open_drain_ints (const bool value)
 
float get_setup_priority () const override
 
- 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 void dump_config ()
 
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...
 

Protected Member Functions

virtual bool read_reg (uint8_t reg, uint8_t *value)
 
virtual bool write_reg (uint8_t reg, uint8_t value)
 
virtual void update_reg (uint8_t pin, bool pin_value, uint8_t reg_a)
 
- 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...
 

Protected Attributes

bool open_drain_ints_
 
- 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 11 of file mcp23xxx_base.h.

Member Function Documentation

◆ digital_read()

virtual bool esphome::mcp23xxx_base::MCP23XXXBase::digital_read ( uint8_t  pin)
virtual

◆ digital_write()

virtual void esphome::mcp23xxx_base::MCP23XXXBase::digital_write ( uint8_t  pin,
bool  value 
)
virtual

◆ get_setup_priority()

float esphome::mcp23xxx_base::MCP23XXXBase::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 7 of file mcp23xxx_base.cpp.

◆ pin_interrupt_mode()

virtual void esphome::mcp23xxx_base::MCP23XXXBase::pin_interrupt_mode ( uint8_t  pin,
MCP23XXXInterruptMode  interrupt_mode 
)
virtual

◆ pin_mode()

virtual void esphome::mcp23xxx_base::MCP23XXXBase::pin_mode ( uint8_t  pin,
gpio::Flags  flags 
)
virtual

◆ read_reg()

virtual bool esphome::mcp23xxx_base::MCP23XXXBase::read_reg ( uint8_t  reg,
uint8_t *  value 
)
protectedvirtual

◆ set_open_drain_ints()

void esphome::mcp23xxx_base::MCP23XXXBase::set_open_drain_ints ( const bool  value)
inline

Definition at line 18 of file mcp23xxx_base.h.

◆ update_reg()

virtual void esphome::mcp23xxx_base::MCP23XXXBase::update_reg ( uint8_t  pin,
bool  pin_value,
uint8_t  reg_a 
)
protectedvirtual

◆ write_reg()

virtual bool esphome::mcp23xxx_base::MCP23XXXBase::write_reg ( uint8_t  reg,
uint8_t  value 
)
protectedvirtual

Field Documentation

◆ open_drain_ints_

bool esphome::mcp23xxx_base::MCP23XXXBase::open_drain_ints_
protected

Definition at line 29 of file mcp23xxx_base.h.


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