ESPHome  2024.11.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::mcp23x08_base::MCP23X08Base Class Reference

#include <mcp23x08_base.h>

Inheritance diagram for esphome::mcp23x08_base::MCP23X08Base:
esphome::mcp23xxx_base::MCP23XXXBase esphome::Component esphome::mcp23008::MCP23008 esphome::mcp23s08::MCP23S08

Public Member Functions

bool digital_read (uint8_t pin) override
 
void digital_write (uint8_t pin, bool value) override
 
void pin_mode (uint8_t pin, gpio::Flags flags) override
 
void pin_interrupt_mode (uint8_t pin, mcp23xxx_base::MCP23XXXInterruptMode interrupt_mode) override
 
- Public Member Functions inherited from esphome::mcp23xxx_base::MCP23XXXBase
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 () 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

void update_reg (uint8_t pin, bool pin_value, uint8_t reg_a) override
 
- Protected Member Functions inherited from esphome::mcp23xxx_base::MCP23XXXBase
virtual bool read_reg (uint8_t reg, uint8_t *value)
 
virtual bool write_reg (uint8_t reg, uint8_t value)
 
- 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

uint8_t olat_ {0x00}
 
- Protected Attributes inherited from esphome::mcp23xxx_base::MCP23XXXBase
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 25 of file mcp23x08_base.h.

Member Function Documentation

◆ digital_read()

bool esphome::mcp23x08_base::MCP23X08Base::digital_read ( uint8_t  pin)
overridevirtual

Reimplemented from esphome::mcp23xxx_base::MCP23XXXBase.

Definition at line 9 of file mcp23x08_base.cpp.

◆ digital_write()

void esphome::mcp23x08_base::MCP23X08Base::digital_write ( uint8_t  pin,
bool  value 
)
overridevirtual

Reimplemented from esphome::mcp23xxx_base::MCP23XXXBase.

Definition at line 17 of file mcp23x08_base.cpp.

◆ pin_interrupt_mode()

void esphome::mcp23x08_base::MCP23X08Base::pin_interrupt_mode ( uint8_t  pin,
mcp23xxx_base::MCP23XXXInterruptMode  interrupt_mode 
)
overridevirtual

Reimplemented from esphome::mcp23xxx_base::MCP23XXXBase.

Definition at line 35 of file mcp23x08_base.cpp.

◆ pin_mode()

void esphome::mcp23x08_base::MCP23X08Base::pin_mode ( uint8_t  pin,
gpio::Flags  flags 
)
overridevirtual

Reimplemented from esphome::mcp23xxx_base::MCP23XXXBase.

Definition at line 22 of file mcp23x08_base.cpp.

◆ update_reg()

void esphome::mcp23x08_base::MCP23X08Base::update_reg ( uint8_t  pin,
bool  pin_value,
uint8_t  reg_a 
)
overrideprotectedvirtual

Reimplemented from esphome::mcp23xxx_base::MCP23XXXBase.

Definition at line 61 of file mcp23x08_base.cpp.

Field Documentation

◆ olat_

uint8_t esphome::mcp23x08_base::MCP23X08Base::olat_ {0x00}
protected

Definition at line 35 of file mcp23x08_base.h.


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