ESPHome  2022.1.1
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::lcd_gpio::GPIOLCDDisplay Class Reference

#include <gpio_lcd_display.h>

Inheritance diagram for esphome::lcd_gpio::GPIOLCDDisplay:
esphome::lcd_base::LCDDisplay esphome::PollingComponent esphome::Component

Public Member Functions

void set_writer (std::function< void(GPIOLCDDisplay &)> &&writer)
 
void setup () override
 
void set_data_pins (GPIOPin *d0, GPIOPin *d1, GPIOPin *d2, GPIOPin *d3)
 
void set_data_pins (GPIOPin *d0, GPIOPin *d1, GPIOPin *d2, GPIOPin *d3, GPIOPin *d4, GPIOPin *d5, GPIOPin *d6, GPIOPin *d7)
 
void set_enable_pin (GPIOPin *enable)
 
void set_rs_pin (GPIOPin *rs)
 
void set_rw_pin (GPIOPin *rw)
 
void dump_config () override
 
- Public Member Functions inherited from esphome::lcd_base::LCDDisplay
void set_dimensions (uint8_t columns, uint8_t rows)
 
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...
 
- 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...
 

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

GPIOPinrs_pin_ {nullptr}
 
GPIOPinrw_pin_ {nullptr}
 
GPIOPinenable_pin_ {nullptr}
 
GPIOPindata_pins_ [8] {nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr}
 
std::function< void(GPIOLCDDisplay &)> writer_
 
- Protected Attributes inherited from esphome::lcd_base::LCDDisplay
uint8_t columns_
 
uint8_t rows_
 
uint8_t * buffer_ {nullptr}
 
- 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
 

Detailed Description

Definition at line 9 of file gpio_lcd_display.h.

Member Function Documentation

◆ call_writer()

void esphome::lcd_gpio::GPIOLCDDisplay::call_writer ( )
inlineoverrideprotectedvirtual

Implements esphome::lcd_base::LCDDisplay.

Definition at line 40 of file gpio_lcd_display.h.

◆ dump_config()

void esphome::lcd_gpio::GPIOLCDDisplay::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 26 of file gpio_lcd_display.cpp.

◆ is_four_bit_mode()

bool esphome::lcd_gpio::GPIOLCDDisplay::is_four_bit_mode ( )
inlineoverrideprotectedvirtual

Implements esphome::lcd_base::LCDDisplay.

Definition at line 36 of file gpio_lcd_display.h.

◆ send()

void esphome::lcd_gpio::GPIOLCDDisplay::send ( uint8_t  value,
bool  rs 
)
overrideprotectedvirtual

Implements esphome::lcd_base::LCDDisplay.

Definition at line 54 of file gpio_lcd_display.cpp.

◆ set_data_pins() [1/2]

void esphome::lcd_gpio::GPIOLCDDisplay::set_data_pins ( GPIOPin d0,
GPIOPin d1,
GPIOPin d2,
GPIOPin d3 
)
inline

Definition at line 13 of file gpio_lcd_display.h.

◆ set_data_pins() [2/2]

void esphome::lcd_gpio::GPIOLCDDisplay::set_data_pins ( GPIOPin d0,
GPIOPin d1,
GPIOPin d2,
GPIOPin d3,
GPIOPin d4,
GPIOPin d5,
GPIOPin d6,
GPIOPin d7 
)
inline

Definition at line 19 of file gpio_lcd_display.h.

◆ set_enable_pin()

void esphome::lcd_gpio::GPIOLCDDisplay::set_enable_pin ( GPIOPin enable)
inline

Definition at line 30 of file gpio_lcd_display.h.

◆ set_rs_pin()

void esphome::lcd_gpio::GPIOLCDDisplay::set_rs_pin ( GPIOPin rs)
inline

Definition at line 31 of file gpio_lcd_display.h.

◆ set_rw_pin()

void esphome::lcd_gpio::GPIOLCDDisplay::set_rw_pin ( GPIOPin rw)
inline

Definition at line 32 of file gpio_lcd_display.h.

◆ set_writer()

void esphome::lcd_gpio::GPIOLCDDisplay::set_writer ( std::function< void(GPIOLCDDisplay &)> &&  writer)
inline

Definition at line 11 of file gpio_lcd_display.h.

◆ setup()

void esphome::lcd_gpio::GPIOLCDDisplay::setup ( )
overridevirtual

Reimplemented from esphome::lcd_base::LCDDisplay.

Definition at line 9 of file gpio_lcd_display.cpp.

◆ write_n_bits()

void esphome::lcd_gpio::GPIOLCDDisplay::write_n_bits ( uint8_t  value,
uint8_t  n 
)
overrideprotectedvirtual

Implements esphome::lcd_base::LCDDisplay.

Definition at line 45 of file gpio_lcd_display.cpp.

Field Documentation

◆ data_pins_

GPIOPin* esphome::lcd_gpio::GPIOLCDDisplay::data_pins_[8] {nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr}
protected

Definition at line 45 of file gpio_lcd_display.h.

◆ enable_pin_

GPIOPin* esphome::lcd_gpio::GPIOLCDDisplay::enable_pin_ {nullptr}
protected

Definition at line 44 of file gpio_lcd_display.h.

◆ rs_pin_

GPIOPin* esphome::lcd_gpio::GPIOLCDDisplay::rs_pin_ {nullptr}
protected

Definition at line 42 of file gpio_lcd_display.h.

◆ rw_pin_

GPIOPin* esphome::lcd_gpio::GPIOLCDDisplay::rw_pin_ {nullptr}
protected

Definition at line 43 of file gpio_lcd_display.h.

◆ writer_

std::function<void(GPIOLCDDisplay &)> esphome::lcd_gpio::GPIOLCDDisplay::writer_
protected

Definition at line 46 of file gpio_lcd_display.h.


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