ESPHome  2022.6.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::pcf8574::PCF8574Component Class Reference

#include <pcf8574.h>

Inheritance diagram for esphome::pcf8574::PCF8574Component:
esphome::Component esphome::i2c::I2CDevice

Public Member Functions

 PCF8574Component ()=default
 
void set_pcf8575 (bool pcf8575)
 
void setup () override
 Check i2c availability and setup masks. More...
 
bool digital_read (uint8_t pin)
 Helper function to read the value of a pin. More...
 
void digital_write (uint8_t pin, bool value)
 Helper function to write the value of a pin. More...
 
void pin_mode (uint8_t pin, gpio::Flags flags)
 Helper function to set the pin mode of a pin. More...
 
float get_setup_priority () const override
 
void dump_config () 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 ()
 
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...
 
- Public Member Functions inherited from esphome::i2c::I2CDevice
 I2CDevice ()=default
 
void set_i2c_address (uint8_t address)
 
void set_i2c_bus (I2CBus *bus)
 
I2CRegister reg (uint8_t a_register)
 
ErrorCode read (uint8_t *data, size_t len)
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len, bool stop=true)
 
ErrorCode write (const uint8_t *data, uint8_t len, bool stop=true)
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 
bool read_bytes_raw (uint8_t *data, uint8_t len)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes (uint8_t a_register)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes_raw ()
 
bool read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)
 
bool read_byte (uint8_t a_register, uint8_t *data, bool stop=true)
 
optional< uint8_t > read_byte (uint8_t a_register)
 
bool read_byte_16 (uint8_t a_register, uint16_t *data)
 
bool write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len, bool stop=true)
 
bool write_bytes (uint8_t a_register, const std::vector< uint8_t > &data)
 
template<size_t N>
bool write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)
 
bool write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len)
 
bool write_byte (uint8_t a_register, uint8_t data, bool stop=true)
 
bool write_byte_16 (uint8_t a_register, uint16_t data)
 

Protected Member Functions

bool read_gpio_ ()
 
bool write_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()> &&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

uint16_t mode_mask_ {0x00}
 Mask for the pin mode - 1 means output, 0 means input. More...
 
uint16_t output_mask_ {0x00}
 The mask to write as output state - 1 means HIGH, 0 means LOW. More...
 
uint16_t input_mask_ {0x00}
 The state read in read_gpio_ - 1 means HIGH, 0 means LOW. More...
 
bool pcf8575_
 TRUE->16-channel PCF8575, FALSE->8-channel PCF8574. More...
 
- 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::i2c::I2CDevice
uint8_t address_ {0x00}
 
I2CBusbus_ {nullptr}
 

Detailed Description

Definition at line 10 of file pcf8574.h.

Constructor & Destructor Documentation

◆ PCF8574Component()

esphome::pcf8574::PCF8574Component::PCF8574Component ( )
default

Member Function Documentation

◆ digital_read()

bool esphome::pcf8574::PCF8574Component::digital_read ( uint8_t  pin)

Helper function to read the value of a pin.

Definition at line 28 of file pcf8574.cpp.

◆ digital_write()

void esphome::pcf8574::PCF8574Component::digital_write ( uint8_t  pin,
bool  value 
)

Helper function to write the value of a pin.

Definition at line 32 of file pcf8574.cpp.

◆ dump_config()

void esphome::pcf8574::PCF8574Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 20 of file pcf8574.cpp.

◆ get_setup_priority()

float esphome::pcf8574::PCF8574Component::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 93 of file pcf8574.cpp.

◆ pin_mode()

void esphome::pcf8574::PCF8574Component::pin_mode ( uint8_t  pin,
gpio::Flags  flags 
)

Helper function to set the pin mode of a pin.

Definition at line 41 of file pcf8574.cpp.

◆ read_gpio_()

bool esphome::pcf8574::PCF8574Component::read_gpio_ ( )
protected

Definition at line 52 of file pcf8574.cpp.

◆ set_pcf8575()

void esphome::pcf8574::PCF8574Component::set_pcf8575 ( bool  pcf8575)
inline

Definition at line 14 of file pcf8574.h.

◆ setup()

void esphome::pcf8574::PCF8574Component::setup ( )
overridevirtual

Check i2c availability and setup masks.

Reimplemented from esphome::Component.

Definition at line 9 of file pcf8574.cpp.

◆ write_gpio_()

bool esphome::pcf8574::PCF8574Component::write_gpio_ ( )
protected

Definition at line 72 of file pcf8574.cpp.

Field Documentation

◆ input_mask_

uint16_t esphome::pcf8574::PCF8574Component::input_mask_ {0x00}
protected

The state read in read_gpio_ - 1 means HIGH, 0 means LOW.

Definition at line 39 of file pcf8574.h.

◆ mode_mask_

uint16_t esphome::pcf8574::PCF8574Component::mode_mask_ {0x00}
protected

Mask for the pin mode - 1 means output, 0 means input.

Definition at line 35 of file pcf8574.h.

◆ output_mask_

uint16_t esphome::pcf8574::PCF8574Component::output_mask_ {0x00}
protected

The mask to write as output state - 1 means HIGH, 0 means LOW.

Definition at line 37 of file pcf8574.h.

◆ pcf8575_

bool esphome::pcf8574::PCF8574Component::pcf8575_
protected

TRUE->16-channel PCF8575, FALSE->8-channel PCF8574.

Definition at line 40 of file pcf8574.h.


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