#include <lcd_display.h>

Inheritance diagram for esphome::lcd_base::LCDDisplay:

Public Member Functions
void	set_dimensions (uint8_t columns, uint8_t rows)

void	set_user_defined_char (uint8_t pos, const std::vector< uint8_t > &data)

void	setup () override

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, 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, 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...

void	start_poller ()

void	stop_poller ()

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly. More...

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

void	mark_failed (const char *message)

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="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...

Protected Member Functions
virtual bool	is_four_bit_mode ()=0

virtual void	write_n_bits (uint8_t value, uint8_t n)=0

virtual void	send (uint8_t value, bool rs)=0

void	command_ (uint8_t value)

virtual void	call_writer ()=0

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(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	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}

std::string	error_message_ {}

Detailed Description

Definition at line 14 of file lcd_display.h.

Member Function Documentation

◆ call_writer()

virtual void esphome::lcd_base::LCDDisplay::call_writer ( )

protectedpure virtual

Implemented in esphome::lcd_gpio::GPIOLCDDisplay, and esphome::lcd_pcf8574::PCF8574LCDDisplay.

◆ clear()

void esphome::lcd_base::LCDDisplay::clear ( )

Definition at line 157 of file lcd_display.cpp.

◆ command_()

void esphome::lcd_base::LCDDisplay::command_ ( uint8_t value )

protected

Definition at line 119 of file lcd_display.cpp.

◆ display()

void HOT esphome::lcd_base::LCDDisplay::display ( )

Definition at line 91 of file lcd_display.cpp.

◆ get_setup_priority()

float esphome::lcd_base::LCDDisplay::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 90 of file lcd_display.cpp.

◆ is_four_bit_mode()

virtual bool esphome::lcd_base::LCDDisplay::is_four_bit_mode ( )

protectedpure virtual

Implemented in esphome::lcd_gpio::GPIOLCDDisplay, and esphome::lcd_pcf8574::PCF8574LCDDisplay.

◆ loadchar()

void esphome::lcd_base::LCDDisplay::loadchar	(	uint8_t	location,
		uint8_t	charmap[]
	)

Load custom char to given location.

Definition at line 168 of file lcd_display.cpp.

◆ print() [1/4]

void esphome::lcd_base::LCDDisplay::print	(	uint8_t	column,
		uint8_t	row,
		const char *	str
	)

Print the given text at the specified column and row.

Definition at line 120 of file lcd_display.cpp.

◆ print() [2/4]

void esphome::lcd_base::LCDDisplay::print	(	uint8_t	column,
		uint8_t	row,
		const std::string &	str
	)

Print the given string at the specified column and row.

Definition at line 136 of file lcd_display.cpp.

◆ print() [3/4]

void esphome::lcd_base::LCDDisplay::print ( const char * str )

Print the given text at column=0 and row=0.

Definition at line 137 of file lcd_display.cpp.

◆ print() [4/4]

void esphome::lcd_base::LCDDisplay::print ( const std::string & str )

Print the given string at column=0 and row=0.

Definition at line 138 of file lcd_display.cpp.

◆ printf() [1/2]

void esphome::lcd_base::LCDDisplay::printf	(	uint8_t	column,
		uint8_t	row,
		const char *	format,
			...
	)

Evaluate the printf-format and print the text at the specified column and row.

Definition at line 139 of file lcd_display.cpp.

◆ printf() [2/2]

void esphome::lcd_base::LCDDisplay::printf	(	const char *	format,
			...
	)

Evaluate the printf-format and print the text at column=0 and row=0.

Definition at line 148 of file lcd_display.cpp.

◆ send()

virtual void esphome::lcd_base::LCDDisplay::send	(	uint8_t	value,
		bool	rs
	)

protectedpure virtual

Implemented in esphome::lcd_gpio::GPIOLCDDisplay, and esphome::lcd_pcf8574::PCF8574LCDDisplay.

◆ set_dimensions()

void esphome::lcd_base::LCDDisplay::set_dimensions	(	uint8_t	columns,
		uint8_t	rows
	)

inline

Definition at line 16 of file lcd_display.h.

◆ set_user_defined_char()

void esphome::lcd_base::LCDDisplay::set_user_defined_char	(	uint8_t	pos,
		const std::vector< uint8_t > &	data
	)

inline

Definition at line 21 of file lcd_display.h.

◆ setup()

void esphome::lcd_base::LCDDisplay::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::lcd_pcf8574::PCF8574LCDDisplay, and esphome::lcd_gpio::GPIOLCDDisplay.

Definition at line 32 of file lcd_display.cpp.

◆ strftime() [1/2]

void esphome::lcd_base::LCDDisplay::strftime	(	uint8_t	column,
		uint8_t	row,
		const char *	format,
		ESPTime	time
	)

Evaluate the strftime-format and print the text at the specified column and row.

Definition at line 161 of file lcd_display.cpp.

◆ strftime() [2/2]

void esphome::lcd_base::LCDDisplay::strftime	(	const char *	format,
		ESPTime	time
	)

Evaluate the strftime-format and print the text at column=0 and row=0.

Definition at line 167 of file lcd_display.cpp.

◆ update()

void esphome::lcd_base::LCDDisplay::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 114 of file lcd_display.cpp.

◆ write_n_bits()

virtual void esphome::lcd_base::LCDDisplay::write_n_bits	(	uint8_t	value,
		uint8_t	n
	)

protectedpure virtual

Implemented in esphome::lcd_gpio::GPIOLCDDisplay, and esphome::lcd_pcf8574::PCF8574LCDDisplay.

Field Documentation

◆ buffer_

uint8_t* esphome::lcd_base::LCDDisplay::buffer_ {nullptr}

protected

Definition at line 61 of file lcd_display.h.

◆ columns_

uint8_t esphome::lcd_base::LCDDisplay::columns_

protected

Definition at line 59 of file lcd_display.h.

◆ rows_

uint8_t esphome::lcd_base::LCDDisplay::rows_

protected

Definition at line 60 of file lcd_display.h.

◆ user_defined_chars_

std::map<uint8_t, std::vector<uint8_t> > esphome::lcd_base::LCDDisplay::user_defined_chars_

protected

Definition at line 62 of file lcd_display.h.

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

/opt/build/esphome/esphome/components/lcd_base/lcd_display.h
/opt/build/esphome/esphome/components/lcd_base/lcd_display.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ call_writer()

◆ clear()

◆ command_()

◆ display()

◆ get_setup_priority()

◆ is_four_bit_mode()

◆ loadchar()

◆ print() [1/4]

◆ print() [2/4]

◆ print() [3/4]

◆ print() [4/4]

◆ printf() [1/2]

◆ printf() [2/2]

◆ send()

◆ set_dimensions()

◆ set_user_defined_char()

◆ setup()

◆ strftime() [1/2]

◆ strftime() [2/2]

◆ update()

◆ write_n_bits()

Field Documentation

◆ buffer_

◆ columns_

◆ rows_

◆ user_defined_chars_