#include <mcp23x17_base.h>

Inheritance diagram for esphome::mcp23x17_base::MCP23X17Base:

Public Member Functions
bool	digital_read_hw (uint8_t pin) override

void	digital_write_hw (uint8_t pin, bool value) override

bool	digital_read_cache (uint8_t pin) 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< 16 >
void	set_open_drain_ints (const bool value)

float	get_setup_priority () const override

void	loop () override

Public Member Functions inherited from esphome::Component
virtual void	setup ()
	Where the component's initialization should happen.

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().

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

bool	is_idle () const
	Check if this component is idle.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

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=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error (const char *message=nullptr)

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 LogString *source)
	Set where this component was loaded from for some debug messages.

const LogString *	get_component_log_str () const
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time)

Public Member Functions inherited from esphome::gpio_expander::CachedGpioExpander< uint8_t, N >
bool	digital_read (typename std::conditional<(N > 256), uint16_t, uint8_t >::type pin)
	Read the state of the given pin.

void	digital_write (typename std::conditional<(N > 256), uint16_t, uint8_t >::type pin, bool value)

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< 16 >
virtual bool	read_reg (uint8_t reg, uint8_t *value)=0

virtual bool	write_reg (uint8_t reg, uint8_t value)=0

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

void	set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

bool	cancel_interval (const char *name)

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.

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.

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

void	set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

bool	cancel_timeout (const char *name)

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call with a const char* name.

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Protected Member Functions inherited from esphome::gpio_expander::CachedGpioExpander< uint8_t, N >
virtual bool	digital_read_hw (typename std::conditional<(N > 256), uint16_t, uint8_t >::type pin)=0
	Read GPIO bank from hardware into internal state.

virtual bool	digital_read_cache (typename std::conditional<(N > 256), uint16_t, uint8_t >::type pin)=0
	Get cached pin value from internal state.

virtual void	digital_write_hw (typename std::conditional<(N > 256), uint16_t, uint8_t >::type pin, bool value)=0
	Write GPIO state to hardware.

void	reset_pin_cache_ ()
	Invalidate cache. This function should be called in component loop().

Protected Attributes
uint8_t	olat_a_ {0x00}

uint8_t	olat_b_ {0x00}

uint16_t	input_mask_ {0x00}
	State read in digital_read_hw.

Protected Attributes inherited from esphome::mcp23xxx_base::MCP23XXXBase< 16 >
bool	open_drain_ints_

Protected Attributes inherited from esphome::Component
const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bits 5-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

Protected Attributes inherited from esphome::gpio_expander::CachedGpioExpander< uint8_t, N >
uint8_t	read_cache_valid_ [BANKS]

Additional Inherited Members
Static Protected Attributes inherited from esphome::gpio_expander::CachedGpioExpander< uint8_t, N >
static constexpr uint16_t	BITS_PER_BYTE

static constexpr uint16_t	BANK_SIZE

static constexpr size_t	BANKS

static constexpr size_t	CACHE_SIZE_BYTES

Detailed Description

Definition at line 37 of file mcp23x17_base.h.

Member Function Documentation

◆ digital_read_cache()

bool esphome::mcp23x17_base::MCP23X17Base::digital_read_cache ( uint8_t pin )

override

Definition at line 33 of file mcp23x17_base.cpp.

◆ digital_read_hw()

bool esphome::mcp23x17_base::MCP23X17Base::digital_read_hw ( uint8_t pin )

override

Definition at line 10 of file mcp23x17_base.cpp.

◆ digital_write_hw()

void esphome::mcp23x17_base::MCP23X17Base::digital_write_hw	(	uint8_t	pin,
		bool	value )

override

Definition at line 28 of file mcp23x17_base.cpp.

◆ pin_interrupt_mode()

void esphome::mcp23x17_base::MCP23X17Base::pin_interrupt_mode	(	uint8_t	pin,
		mcp23xxx_base::MCP23XXXInterruptMode	interrupt_mode )

overridevirtual

Reimplemented from esphome::mcp23xxx_base::MCP23XXXBase< 16 >.

Definition at line 49 of file mcp23x17_base.cpp.

◆ pin_mode()

void esphome::mcp23x17_base::MCP23X17Base::pin_mode	(	uint8_t	pin,
		gpio::Flags	flags )

overridevirtual

Reimplemented from esphome::mcp23xxx_base::MCP23XXXBase< 16 >.

Definition at line 35 of file mcp23x17_base.cpp.

◆ update_reg()

void esphome::mcp23x17_base::MCP23X17Base::update_reg	(	uint8_t	pin,
		bool	pin_value,
		uint8_t	reg_a )

overrideprotectedvirtual

Implements esphome::mcp23xxx_base::MCP23XXXBase< 16 >.

Definition at line 75 of file mcp23x17_base.cpp.

Field Documentation

◆ input_mask_

uint16_t esphome::mcp23x17_base::MCP23X17Base::input_mask_ {0x00}

protected

State read in digital_read_hw.

Definition at line 53 of file mcp23x17_base.h.

◆ olat_a_

uint8_t esphome::mcp23x17_base::MCP23X17Base::olat_a_ {0x00}

protected

Definition at line 49 of file mcp23x17_base.h.

◆ olat_b_

uint8_t esphome::mcp23x17_base::MCP23X17Base::olat_b_ {0x00}

protected

Definition at line 50 of file mcp23x17_base.h.

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

esphome/components/mcp23x17_base/mcp23x17_base.h
esphome/components/mcp23x17_base/mcp23x17_base.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ digital_read_cache()

◆ digital_read_hw()

◆ digital_write_hw()

◆ pin_interrupt_mode()

◆ pin_mode()

◆ update_reg()

Field Documentation

◆ input_mask_

◆ olat_a_

◆ olat_b_