ESPHome  2024.3.1
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::mcp23s17::MCP23S17 Class Reference

#include <mcp23s17.h>

Inheritance diagram for esphome::mcp23s17::MCP23S17:
esphome::mcp23x17_base::MCP23X17Base esphome::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_LEADING, spi::DATA_RATE_8MHZ > esphome::mcp23xxx_base::MCP23XXXBase esphome::spi::SPIClient esphome::Component

Public Member Functions

 MCP23S17 ()=default
 
void setup () override
 
void dump_config () override
 
void set_device_address (uint8_t device_addr)
 
- Public Member Functions inherited from esphome::mcp23x17_base::MCP23X17Base
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 loop ()
 This method will be called repeatedly. More...
 
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 ()
 
bool is_ready ()
 
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...
 
- Public Member Functions inherited from esphome::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_LEADING, spi::DATA_RATE_8MHZ >
 SPIDevice ()
 
 SPIDevice (SPIComponent *parent, GPIOPin *cs_pin)
 
void spi_setup () override
 
void spi_teardown () override
 
void set_spi_parent (SPIComponent *parent)
 
void set_cs_pin (GPIOPin *cs)
 
void set_data_rate (uint32_t data_rate)
 
void set_bit_order (SPIBitOrder order)
 
void set_mode (SPIMode mode)
 
uint8_t read_byte ()
 
void read_array (uint8_t *data, size_t length)
 
void write (uint16_t data, size_t num_bits)
 Write a single data item, up to 32 bits. More...
 
void write_cmd_addr_data (size_t cmd_bits, uint32_t cmd, size_t addr_bits, uint32_t address, const uint8_t *data, size_t length, uint8_t bus_width=1)
 
void write_byte (uint8_t data)
 
void transfer_array (uint8_t *data, size_t length)
 Write the array data, replace with received data. More...
 
void transfer_array (std::array< uint8_t, N > &data)
 
uint8_t transfer_byte (uint8_t data)
 
void write_byte16 (uint16_t data)
 Write 16 bit data. More...
 
void write_array16 (const uint16_t *data, size_t length)
 Write an array of data as 16 bit values, byte-swapping if required. More...
 
void enable ()
 
void disable ()
 
void write_array (const uint8_t *data, size_t length)
 
void write_array (const std::array< uint8_t, N > &data)
 
void write_array (const std::vector< uint8_t > &data)
 
- Public Member Functions inherited from esphome::spi::SPIClient
 SPIClient (SPIBitOrder bit_order, SPIMode mode, uint32_t data_rate)
 
bool spi_is_ready ()
 

Protected Member Functions

bool read_reg (uint8_t reg, uint8_t *value) override
 
bool write_reg (uint8_t reg, uint8_t value) override
 
- Protected Member Functions inherited from esphome::mcp23x17_base::MCP23X17Base
void update_reg (uint8_t pin, bool pin_value, uint8_t reg_a) override
 
- 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 device_opcode_ = 0x40
 
- Protected Attributes inherited from esphome::mcp23x17_base::MCP23X17Base
uint8_t olat_a_ {0x00}
 
uint8_t olat_b_ {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}
 
- Protected Attributes inherited from esphome::spi::SPIClient
SPIBitOrder bit_order_ {BIT_ORDER_MSB_FIRST}
 
SPIMode mode_ {MODE0}
 
uint32_t data_rate_ {1000000}
 
SPIComponentparent_ {nullptr}
 
GPIOPincs_ {nullptr}
 
SPIDelegatedelegate_ {SPIDelegate::NULL_DELEGATE}
 

Detailed Description

Definition at line 11 of file mcp23s17.h.

Constructor & Destructor Documentation

◆ MCP23S17()

esphome::mcp23s17::MCP23S17::MCP23S17 ( )
default

Member Function Documentation

◆ dump_config()

void esphome::mcp23s17::MCP23S17::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 44 of file mcp23s17.cpp.

◆ read_reg()

bool esphome::mcp23s17::MCP23S17::read_reg ( uint8_t  reg,
uint8_t *  value 
)
overrideprotectedvirtual

Reimplemented from esphome::mcp23xxx_base::MCP23XXXBase.

Definition at line 49 of file mcp23s17.cpp.

◆ set_device_address()

void esphome::mcp23s17::MCP23S17::set_device_address ( uint8_t  device_addr)

Definition at line 9 of file mcp23s17.cpp.

◆ setup()

void esphome::mcp23s17::MCP23S17::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 15 of file mcp23s17.cpp.

◆ write_reg()

bool esphome::mcp23s17::MCP23S17::write_reg ( uint8_t  reg,
uint8_t  value 
)
overrideprotectedvirtual

Reimplemented from esphome::mcp23xxx_base::MCP23XXXBase.

Definition at line 58 of file mcp23s17.cpp.

Field Documentation

◆ device_opcode_

uint8_t esphome::mcp23s17::MCP23S17::device_opcode_ = 0x40
protected

Definition at line 25 of file mcp23s17.h.


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