ESPHome  2022.11.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::lcd_pcf8574::PCF8574LCDDisplay Class Reference

#include <pcf8574_display.h>

Inheritance diagram for esphome::lcd_pcf8574::PCF8574LCDDisplay:
esphome::lcd_base::LCDDisplay esphome::i2c::I2CDevice esphome::PollingComponent esphome::Component

Public Member Functions

void set_writer (std::function< void(PCF8574LCDDisplay &)> &&writer)
 
void setup () override
 
void dump_config () override
 
void backlight ()
 
void no_backlight ()
 
- Public Member Functions inherited from esphome::lcd_base::LCDDisplay
void set_dimensions (uint8_t columns, uint8_t rows)
 
void set_user_defined_char (uint8_t pos, const std::vector< uint8_t > &data)
 
float get_setup_priority () const override
 
void update () override
 
void display ()
 
void clear ()
 
void print (uint8_t column, uint8_t row, const char *str)
 Print the given text at the specified column and row. More...
 
void print (uint8_t column, uint8_t row, const std::string &str)
 Print the given string at the specified column and row. More...
 
void print (const char *str)
 Print the given text at column=0 and row=0. More...
 
void print (const std::string &str)
 Print the given string at column=0 and row=0. More...
 
void printf (uint8_t column, uint8_t row, const char *format,...) __attribute__((format(printf
 Evaluate the printf-format and print the text at the specified column and row. More...
 
void void printf (const char *format,...) __attribute__((format(printf
 Evaluate the printf-format and print the text at column=0 and row=0. More...
 
void void void strftime (uint8_t column, uint8_t row, const char *format, time::ESPTime time) __attribute__((format(strftime
 Evaluate the strftime-format and print the text at the specified column and row. More...
 
void void void void strftime (const char *format, time::ESPTime time) __attribute__((format(strftime
 Evaluate the strftime-format and print the text at column=0 and row=0. More...
 
void void void void void loadchar (uint8_t location, uint8_t charmap[])
 Load custom char to given location. More...
 
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms. More...
 
virtual void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object. More...
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor. More...
 
- 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 is_four_bit_mode () override
 
void write_n_bits (uint8_t value, uint8_t n) override
 
void send (uint8_t value, bool rs) override
 
void call_writer () override
 
- Protected Member Functions inherited from esphome::lcd_base::LCDDisplay
void command_ (uint8_t value)
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
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

uint8_t backlight_value_
 
std::function< void(PCF8574LCDDisplay &)> writer_
 
- Protected Attributes inherited from esphome::lcd_base::LCDDisplay
uint8_t columns_
 
uint8_t rows_
 
uint8_t * buffer_ {nullptr}
 
std::map< uint8_t, std::vector< uint8_t > > user_defined_chars_
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- 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_display.h.

Member Function Documentation

◆ backlight()

void esphome::lcd_pcf8574::PCF8574LCDDisplay::backlight ( )

Definition at line 49 of file pcf8574_display.cpp.

◆ call_writer()

void esphome::lcd_pcf8574::PCF8574LCDDisplay::call_writer ( )
inlineoverrideprotectedvirtual

Implements esphome::lcd_base::LCDDisplay.

Definition at line 23 of file pcf8574_display.h.

◆ dump_config()

void esphome::lcd_pcf8574::PCF8574LCDDisplay::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 23 of file pcf8574_display.cpp.

◆ is_four_bit_mode()

bool esphome::lcd_pcf8574::PCF8574LCDDisplay::is_four_bit_mode ( )
inlineoverrideprotectedvirtual

Implements esphome::lcd_base::LCDDisplay.

Definition at line 19 of file pcf8574_display.h.

◆ no_backlight()

void esphome::lcd_pcf8574::PCF8574LCDDisplay::no_backlight ( )

Definition at line 53 of file pcf8574_display.cpp.

◆ send()

void esphome::lcd_pcf8574::PCF8574LCDDisplay::send ( uint8_t  value,
bool  rs 
)
overrideprotectedvirtual

Implements esphome::lcd_base::LCDDisplay.

Definition at line 45 of file pcf8574_display.cpp.

◆ set_writer()

void esphome::lcd_pcf8574::PCF8574LCDDisplay::set_writer ( std::function< void(PCF8574LCDDisplay &)> &&  writer)
inline

Definition at line 12 of file pcf8574_display.h.

◆ setup()

void esphome::lcd_pcf8574::PCF8574LCDDisplay::setup ( )
overridevirtual

Reimplemented from esphome::lcd_base::LCDDisplay.

Definition at line 13 of file pcf8574_display.cpp.

◆ write_n_bits()

void esphome::lcd_pcf8574::PCF8574LCDDisplay::write_n_bits ( uint8_t  value,
uint8_t  n 
)
overrideprotectedvirtual

Implements esphome::lcd_base::LCDDisplay.

Definition at line 32 of file pcf8574_display.cpp.

Field Documentation

◆ backlight_value_

uint8_t esphome::lcd_pcf8574::PCF8574LCDDisplay::backlight_value_
protected

Definition at line 26 of file pcf8574_display.h.

◆ writer_

std::function<void(PCF8574LCDDisplay &)> esphome::lcd_pcf8574::PCF8574LCDDisplay::writer_
protected

Definition at line 27 of file pcf8574_display.h.


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