#include <waveshare_epaper.h>

Inheritance diagram for esphome::waveshare_epaper::WaveshareEPaper13P3InK:

Public Member Functions
void	initialize () override

void	display () override

void	dump_config () override

void	deep_sleep () override

Public Member Functions inherited from esphome::waveshare_epaper::WaveshareEPaper
void	fill (Color color) override

display::DisplayType	get_display_type () override

Public Member Functions inherited from esphome::waveshare_epaper::WaveshareEPaperBase
void	set_dc_pin (GPIOPin *dc_pin)

float	get_setup_priority () const override

void	set_reset_pin (GPIOPin *reset)

void	set_busy_pin (GPIOPin *busy)

void	set_reset_duration (uint32_t reset_duration)

void	command (uint8_t value)

void	data (uint8_t value)

void	cmd_data (const uint8_t *data, size_t length)

void	update () override

void	setup () override

void	on_safe_shutdown () override

Public Member Functions inherited from esphome::display::DisplayBuffer
int	get_width () override
	Get the width of the image in pixels with rotation applied.

int	get_height () override
	Get the height of the image in pixels with rotation applied.

void	draw_pixel_at (int x, int y, Color color) override
	Set a single pixel at the specified coordinates to the given color.

Public Member Functions inherited from esphome::display::Display
void	clear ()
	Clear the entire screen by filling it with OFF pixels.

int	get_native_width ()
	Get the native (original) width of the display in pixels.

int	get_native_height ()
	Get the native (original) height of the display in pixels.

void	draw_pixel_at (int x, int y)
	Set a single pixel at the specified coordinates to default color.

virtual void	draw_pixels_at (int x_start, int y_start, int w, int h, const uint8_t *ptr, ColorOrder order, ColorBitness bitness, bool big_endian, int x_offset, int y_offset, int x_pad)
	Given an array of pixels encoded in the nominated format, draw these into the display's buffer.

void	draw_pixels_at (int x_start, int y_start, int w, int h, const uint8_t *ptr, ColorOrder order, ColorBitness bitness, bool big_endian)
	Convenience overload for base case where the pixels are packed into the buffer with no gaps (e.g. suits LVGL.)

void	line (int x1, int y1, int x2, int y2, Color color=COLOR_ON)
	Draw a straight line from the point [x1,y1] to [x2,y2] with the given color.

void	line_at_angle (int x, int y, int angle, int length, Color color=COLOR_ON)
	Draw a straight line at the given angle based on the origin [x, y] for a specified length with the given color.

void	line_at_angle (int x, int y, int angle, int start_radius, int stop_radius, Color color=COLOR_ON)
	Draw a straight line at the given angle based on the origin [x, y] from a specified start and stop radius with the given color.

void	horizontal_line (int x, int y, int width, Color color=COLOR_ON)
	Draw a horizontal line from the point [x,y] to [x+width,y] with the given color.

void	vertical_line (int x, int y, int height, Color color=COLOR_ON)
	Draw a vertical line from the point [x,y] to [x,y+width] with the given color.

void	rectangle (int x1, int y1, int width, int height, Color color=COLOR_ON)
	Draw the outline of a rectangle with the top left point at [x1,y1] and the bottom right point at [x1+width,y1+height].

void	filled_rectangle (int x1, int y1, int width, int height, Color color=COLOR_ON)
	Fill a rectangle with the top left point at [x1,y1] and the bottom right point at [x1+width,y1+height].

void	circle (int center_x, int center_xy, int radius, Color color=COLOR_ON)
	Draw the outline of a circle centered around [center_x,center_y] with the radius radius with the given color.

void	filled_circle (int center_x, int center_y, int radius, Color color=COLOR_ON)
	Fill a circle centered around [center_x,center_y] with the radius radius with the given color.

void	filled_ring (int center_x, int center_y, int radius1, int radius2, Color color=COLOR_ON)
	Fill a ring centered around [center_x,center_y] between two circles with the radius1 and radius2 with the given color.

void	filled_gauge (int center_x, int center_y, int radius1, int radius2, int progress, Color color=COLOR_ON)
	Fill a half-ring "gauge" centered around [center_x,center_y] between two circles with the radius1 and radius2 with he given color and filled up to 'progress' percent.

void	triangle (int x1, int y1, int x2, int y2, int x3, int y3, Color color=COLOR_ON)
	Draw the outline of a triangle contained between the points [x1,y1], [x2,y2] and [x3,y3] with the given color.

void	filled_triangle (int x1, int y1, int x2, int y2, int x3, int y3, Color color=COLOR_ON)
	Fill a triangle contained between the points [x1,y1], [x2,y2] and [x3,y3] with the given color.

void	get_regular_polygon_vertex (int vertex_id, int vertex_x, int vertex_y, int center_x, int center_y, int radius, int edges, RegularPolygonVariation variation=VARIATION_POINTY_TOP, float rotation_degrees=ROTATION_0_DEGREES)
	Get the specified vertex (x,y) coordinates for the regular polygon inscribed in the circle centered on [center_x,center_y] with the given radius.

void	regular_polygon (int x, int y, int radius, int edges, RegularPolygonVariation variation=VARIATION_POINTY_TOP, float rotation_degrees=ROTATION_0_DEGREES, Color color=COLOR_ON, RegularPolygonDrawing drawing=DRAWING_OUTLINE)
	Draw the outline of a regular polygon inscribed in the circle centered on [x,y] with the given radius and color.

void	regular_polygon (int x, int y, int radius, int edges, RegularPolygonVariation variation, Color color, RegularPolygonDrawing drawing=DRAWING_OUTLINE)

void	regular_polygon (int x, int y, int radius, int edges, Color color, RegularPolygonDrawing drawing=DRAWING_OUTLINE)

void	filled_regular_polygon (int x, int y, int radius, int edges, RegularPolygonVariation variation=VARIATION_POINTY_TOP, float rotation_degrees=ROTATION_0_DEGREES, Color color=COLOR_ON)
	Fill a regular polygon inscribed in the circle centered on [x,y] with the given radius and color.

void	filled_regular_polygon (int x, int y, int radius, int edges, RegularPolygonVariation variation, Color color)

void	filled_regular_polygon (int x, int y, int radius, int edges, Color color)

void	print (int x, int y, BaseFont font, Color color, TextAlign align, const char text, Color background=COLOR_OFF)
	Print `text` with the anchor point at [x,y] with `font`.

void	print (int x, int y, BaseFont font, Color color, const char text, Color background=COLOR_OFF)
	Print `text` with the top left at [x,y] with `font`.

void	print (int x, int y, BaseFont font, TextAlign align, const char text)
	Print `text` with the anchor point at [x,y] with `font`.

void	print (int x, int y, BaseFont font, const char text)
	Print `text` with the top left at [x,y] with `font`.

void	printf (int x, int y, BaseFont font, Color color, Color background, TextAlign align, const char format,...) __attribute__((format(printf
	Evaluate the printf-format `format` and print the result with the anchor point at [x,y] with `font`.

void void	printf (int x, int y, BaseFont font, Color color, TextAlign align, const char format,...) __attribute__((format(printf
	Evaluate the printf-format `format` and print the result with the anchor point at [x,y] with `font`.

void void void	printf (int x, int y, BaseFont font, Color color, const char format,...) __attribute__((format(printf
	Evaluate the printf-format `format` and print the result with the top left at [x,y] with `font`.

void void void void	printf (int x, int y, BaseFont font, TextAlign align, const char format,...) __attribute__((format(printf
	Evaluate the printf-format `format` and print the result with the anchor point at [x,y] with `font`.

void void void void void	printf (int x, int y, BaseFont font, const char format,...) __attribute__((format(printf
	Evaluate the printf-format `format` and print the result with the top left at [x,y] with `font`.

void void void void void void	strftime (int x, int y, BaseFont font, Color color, Color background, TextAlign align, const char format, ESPTime time) __attribute__((format(strftime
	Evaluate the strftime-format `format` and print the result with the anchor point at [x,y] with `font`.

void void void void void void void	strftime (int x, int y, BaseFont font, Color color, TextAlign align, const char format, ESPTime time) __attribute__((format(strftime
	Evaluate the strftime-format `format` and print the result with the anchor point at [x,y] with `font`.

void void void void void void void void	strftime (int x, int y, BaseFont font, Color color, const char format, ESPTime time) __attribute__((format(strftime
	Evaluate the strftime-format `format` and print the result with the top left at [x,y] with `font`.

void void void void void void void void void	strftime (int x, int y, BaseFont font, TextAlign align, const char format, ESPTime time) __attribute__((format(strftime
	Evaluate the strftime-format `format` and print the result with the anchor point at [x,y] with `font`.

void void void void void void void void void void	strftime (int x, int y, BaseFont font, const char format, ESPTime time) __attribute__((format(strftime
	Evaluate the strftime-format `format` and print the result with the top left at [x,y] with `font`.

void void void void void void void void void void void	image (int x, int y, BaseImage *image, Color color_on=COLOR_ON, Color color_off=COLOR_OFF)
	Draw the `image` with the top-left corner at [x,y] to the screen.

void	image (int x, int y, BaseImage *image, ImageAlign align, Color color_on=COLOR_ON, Color color_off=COLOR_OFF)
	Draw the `image` at [x,y] to the screen.

void	graph (int x, int y, graph::Graph *graph, Color color_on=COLOR_ON)
	Draw the `graph` with the top-left corner at [x,y] to the screen.

void	legend (int x, int y, graph::Graph *graph, Color color_on=COLOR_ON)
	Draw the `legend` for graph with the top-left corner at [x,y] to the screen.

void	qr_code (int x, int y, qr_code::QrCode *qr_code, Color color_on=COLOR_ON, int scale=1)
	Draw the `qr_code` with the top-left corner at [x,y] to the screen.

void	menu (int x, int y, graphical_display_menu::GraphicalDisplayMenu *menu, int width, int height)

void	get_text_bounds (int x, int y, const char text, BaseFont font, TextAlign align, int x1, int y1, int width, int height)
	Get the text bounds of the given string.

void	set_writer (display_writer_t &&writer)
	Internal method to set the display writer lambda.

void	show_page (DisplayPage *page)

void	show_next_page ()

void	show_prev_page ()

void	set_pages (std::vector< DisplayPage * > pages)

const DisplayPage *	get_active_page () const

void	add_on_page_change_trigger (DisplayOnPageChangeTrigger *t)

void	set_rotation (DisplayRotation rotation)
	Internal method to set the display rotation with.

void	set_auto_clear (bool auto_clear_enabled)

DisplayRotation	get_rotation () const

void	start_clipping (Rect rect)
	Set the clipping rectangle for further drawing.

void	start_clipping (int16_t left, int16_t top, int16_t right, int16_t bottom)

void	extend_clipping (Rect rect)
	Add a rectangular region to the invalidation region.

void	extend_clipping (int16_t left, int16_t top, int16_t right, int16_t bottom)

void	shrink_clipping (Rect rect)
	substract a rectangular region to the invalidation region

void	shrink_clipping (uint16_t left, uint16_t top, uint16_t right, uint16_t bottom)

void	end_clipping ()
	Reset the invalidation region.

Rect	get_clipping () const
	Get the current the clipping rectangle.

bool	is_clipping () const

bool	clip (int x, int y)
	Check if pixel is within region of display.

void	test_card ()

void	show_test_card ()

Public Member Functions inherited from esphome::PollingComponent
	PollingComponent ()

	PollingComponent (uint32_t update_interval)
	Initialize this polling component with the given update interval in ms.

virtual void	set_update_interval (uint32_t update_interval)
	Manually set the update interval in ms for this polling object.

void	call_setup () override

virtual uint32_t	get_update_interval () const
	Get the update interval in ms of this sensor.

void	start_poller ()

void	stop_poller ()

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

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop().

void	call ()

virtual void	on_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

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=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error (const char *message=nullptr)

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 LogString *source)
	Set where this component was loaded from for some debug messages.

const LogString *	get_component_log_str () const
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time)

Public Member Functions inherited from esphome::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_LEADING, spi::DATA_RATE_2MHZ >
	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.

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.

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.

void	write_array16 (const uint16_t *data, size_t length)
	Write an array of data as 16 bit values, byte-swapping if required.

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

void	set_release_device (bool release)

void	set_write_only (bool write_only)

Protected Member Functions
int	get_width_internal () override

int	get_height_internal () override

uint32_t	idle_timeout_ () override

Protected Member Functions inherited from esphome::waveshare_epaper::WaveshareEPaper
void	draw_absolute_pixel_internal (int x, int y, Color color) override

uint32_t	get_buffer_length_ () override

Protected Member Functions inherited from esphome::waveshare_epaper::WaveshareEPaperBase
bool	wait_until_idle_ ()

void	setup_pins_ ()

void	reset_ ()

virtual int	get_width_controller ()

void	start_command_ ()

void	end_command_ ()

void	start_data_ ()

void	end_data_ ()

Protected Member Functions inherited from esphome::display::DisplayBuffer
void	init_internal_ (uint32_t buffer_length)

Protected Member Functions inherited from esphome::display::Display
bool	clamp_x_ (int x, int w, int &min_x, int &max_x)

bool	clamp_y_ (int y, int h, int &min_y, int &max_y)

void	vprintf_ (int x, int y, BaseFont font, Color color, Color background, TextAlign align, const char format, va_list arg)

void	do_update_ ()

void	clear_clipping_ ()

void	filled_flat_side_triangle_ (int x1, int y1, int x2, int y2, int x3, int y3, Color color)
	This method fills a triangle using only integer variables by using a modified bresenham algorithm.

void	sort_triangle_points_by_y_ (int x1, int y1, int x2, int y2, int x3, int y3)

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_dump_config ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

void	set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

bool	cancel_interval (const char *name)

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.

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.

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

void	set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

bool	cancel_timeout (const char *name)

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call with a const char* name.

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Additional Inherited Members
Protected Attributes inherited from esphome::waveshare_epaper::WaveshareEPaperBase
uint32_t	reset_duration_ {200}

GPIOPin *	reset_pin_ {nullptr}

GPIOPin *	dc_pin_

GPIOPin *	busy_pin_ {nullptr}

Protected Attributes inherited from esphome::display::DisplayBuffer
uint8_t *	buffer_ {nullptr}

Protected Attributes inherited from esphome::display::Display
DisplayRotation	rotation_ {DISPLAY_ROTATION_0_DEGREES}

optional< display_writer_t >	writer_ {}

DisplayPage *	page_ {nullptr}

DisplayPage *	previous_page_ {nullptr}

std::vector< DisplayOnPageChangeTrigger * >	on_page_change_triggers_

bool	auto_clear_enabled_ {true}

std::vector< Rect >	clipping_rectangle_

bool	show_test_card_ {false}

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

Protected Attributes inherited from esphome::Component
const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bits 5-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

Protected Attributes inherited from esphome::spi::SPIClient
SPIBitOrder	bit_order_ {BIT_ORDER_MSB_FIRST}

SPIMode	mode_ {MODE0}

uint32_t	data_rate_ {1000000}

SPIComponent *	parent_ {nullptr}

GPIOPin *	cs_ {nullptr}

bool	release_device_ {false}

bool	write_only_ {false}

SPIDelegate *	delegate_ {SPIDelegate::NULL_DELEGATE}

Detailed Description

Definition at line 1080 of file waveshare_epaper.h.

Member Function Documentation

◆ deep_sleep()

void esphome::waveshare_epaper::WaveshareEPaper13P3InK::deep_sleep ( )

inlineoverridevirtual

Implements esphome::waveshare_epaper::WaveshareEPaperBase.

Definition at line 1088 of file waveshare_epaper.h.

◆ display()

void HOT esphome::waveshare_epaper::WaveshareEPaper13P3InK::display ( )

overridevirtual

Implements esphome::waveshare_epaper::WaveshareEPaperBase.

Definition at line 4728 of file waveshare_epaper.cpp.

◆ dump_config()

void esphome::waveshare_epaper::WaveshareEPaper13P3InK::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 4744 of file waveshare_epaper.cpp.

◆ get_height_internal()

int esphome::waveshare_epaper::WaveshareEPaper13P3InK::get_height_internal ( )

overrideprotectedvirtual

Implements esphome::display::Display.

Definition at line 4742 of file waveshare_epaper.cpp.

◆ get_width_internal()

int esphome::waveshare_epaper::WaveshareEPaper13P3InK::get_width_internal ( )

overrideprotectedvirtual

Implements esphome::display::Display.

Definition at line 4741 of file waveshare_epaper.cpp.

◆ idle_timeout_()

uint32_t esphome::waveshare_epaper::WaveshareEPaper13P3InK::idle_timeout_ ( )

overrideprotectedvirtual

Reimplemented from esphome::waveshare_epaper::WaveshareEPaperBase.

Definition at line 4743 of file waveshare_epaper.cpp.

◆ initialize()

void esphome::waveshare_epaper::WaveshareEPaper13P3InK::initialize ( )

overridevirtual

Implements esphome::waveshare_epaper::WaveshareEPaperBase.

Definition at line 4678 of file waveshare_epaper.cpp.

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

esphome/components/waveshare_epaper/waveshare_epaper.h
esphome/components/waveshare_epaper/waveshare_epaper.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ deep_sleep()

◆ display()

◆ dump_config()

◆ get_height_internal()

◆ get_width_internal()

◆ idle_timeout_()

◆ initialize()