#include <inkplate.h>

Inheritance diagram for esphome::inkplate::Inkplate:

Public Member Functions
void	set_greyscale (bool greyscale)

void	set_waveform (const std::array< uint8_t, GLUT_COUNT *GLUT_SIZE > &waveform, bool is_custom)

void	set_mirror_y (bool mirror_y)

void	set_mirror_x (bool mirror_x)

void	set_partial_updating (bool partial_updating)

void	set_full_update_every (uint32_t full_update_every)

void	set_model (InkplateModel model)

void	set_display_data_0_pin (InternalGPIOPin *data)

void	set_display_data_1_pin (InternalGPIOPin *data)

void	set_display_data_2_pin (InternalGPIOPin *data)

void	set_display_data_3_pin (InternalGPIOPin *data)

void	set_display_data_4_pin (InternalGPIOPin *data)

void	set_display_data_5_pin (InternalGPIOPin *data)

void	set_display_data_6_pin (InternalGPIOPin *data)

void	set_display_data_7_pin (InternalGPIOPin *data)

void	set_ckv_pin (GPIOPin *ckv)

void	set_cl_pin (InternalGPIOPin *cl)

void	set_gpio0_enable_pin (GPIOPin *gpio0_enable)

void	set_gmod_pin (GPIOPin *gmod)

void	set_le_pin (InternalGPIOPin *le)

void	set_oe_pin (GPIOPin *oe)

void	set_powerup_pin (GPIOPin *powerup)

void	set_sph_pin (GPIOPin *sph)

void	set_spv_pin (GPIOPin *spv)

void	set_vcom_pin (GPIOPin *vcom)

void	set_wakeup_pin (GPIOPin *wakeup)

float	get_setup_priority () const override

void	dump_config () override

void	display ()

void	clean ()

void	fill (Color color) override

void	update () override

void	setup () override

uint8_t	get_panel_state ()

bool	get_greyscale ()

bool	get_partial_updating ()

uint8_t	get_temperature ()

void	block_partial ()

display::DisplayType	get_display_type () 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 void	on_safe_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::i2c::I2CDevice
	I2CDevice ()=default
	we use the C++ default constructor

void	set_i2c_address (uint8_t address)
	We store the address of the device on the bus.

uint8_t	get_i2c_address () const
	Returns the I2C address of the object.

void	set_i2c_bus (I2CBus *bus)
	we store the pointer to the I2CBus to use

I2CRegister	reg (uint8_t a_register)
	calls the I2CRegister constructor

I2CRegister16	reg16 (uint16_t a_register)
	calls the I2CRegister16 constructor

ErrorCode	read (uint8_t *data, size_t len) const
	reads an array of bytes from the device using an I2CBus

ErrorCode	read_register (uint8_t a_register, uint8_t *data, size_t len)
	reads an array of bytes from a specific register in the I²C device

ErrorCode	read_register16 (uint16_t a_register, uint8_t *data, size_t len)
	reads an array of bytes from a specific register in the I²C device

ErrorCode	write (const uint8_t *data, size_t len) const
	writes an array of bytes to a device using an I2CBus

ErrorCode	write_read (const uint8_t write_data, size_t write_len, uint8_t read_data, size_t read_len) const
	writes an array of bytes to a device, then reads an array, as a single transaction

ErrorCode	write_register (uint8_t a_register, const uint8_t *data, size_t len) const
	writes an array of bytes to a specific register in the I²C device

ErrorCode	write_register16 (uint16_t a_register, const uint8_t *data, size_t len) const
	write an array of bytes to a specific register in the I²C device

bool	read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
	Compat APIs All methods below have been added for compatibility reasons.

bool	read_bytes_raw (uint8_t *data, uint8_t len) const

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)

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

bool	write_bytes (uint8_t a_register, const std::vector< uint8_t > &data) const

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

bool	write_byte (uint8_t a_register, uint8_t data) const

bool	write_byte_16 (uint8_t a_register, uint16_t data) const

	ESPDEPRECATED ("The stop argument is no longer used. This will be removed from ESPHome 2026.3.0", "2025.9.0") ErrorCode read_register(uint8_t a_register

	ESPDEPRECATED ("The stop argument is no longer used. This will be removed from ESPHome 2026.3.0", "2025.9.0") ErrorCode read_register16(uint16_t a_register

	ESPDEPRECATED ("The stop argument is no longer used; use write_read() for consecutive write and read. This will be " "removed from ESPHome 2026.3.0", "2025.9.0") ErrorCode write(const uint8_t *data

	ESPDEPRECATED ("The stop argument is no longer used; use write_read() for consecutive write and read. This will be " "removed from ESPHome 2026.3.0", "2025.9.0") ErrorCode write_register(uint8_t a_register

	ESPDEPRECATED ("The stop argument is no longer used; use write_read() for consecutive write and read. This will be " "removed from ESPHome 2026.3.0", "2025.9.0") ErrorCode write_register16(uint16_t a_register

Protected Member Functions
void	draw_absolute_pixel_internal (int x, int y, Color color) override

void	display1b_ ()

void	display3b_ ()

void	initialize_ ()
	Allocate buffers.

bool	partial_update_ ()

void	clean_fast_ (uint8_t c, uint8_t rep)

void	hscan_start_ (uint32_t d)

void	vscan_end_ ()

void	vscan_start_ ()

void	eink_off_ ()

void	eink_on_ ()

bool	read_power_status_ ()

void	setup_pins_ ()

void	pins_z_state_ ()

void	pins_as_outputs_ ()

int	get_width_internal () override

int	get_height_internal () override

size_t	get_buffer_length_ ()

int	get_data_pin_mask_ ()

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.

Protected Attributes
bool	panel_on_ {false}

uint8_t	temperature_

uint8_t *	partial_buffer_ {nullptr}

uint8_t *	partial_buffer_2_ {nullptr}

uint32_t *	glut_ {nullptr}

uint32_t *	glut2_ {nullptr}

uint32_t	pin_lut_ [256]

uint32_t	full_update_every_

uint32_t	partial_updates_ {0}

bool	block_partial_ {true}

bool	greyscale_

bool	mirror_y_ {false}

bool	mirror_x_ {false}

bool	partial_updating_

bool	custom_waveform_ {false}

uint8_t	waveform_ [GLUT_COUNT][GLUT_SIZE]

InkplateModel	model_

InternalGPIOPin *	display_data_0_pin_

InternalGPIOPin *	display_data_1_pin_

InternalGPIOPin *	display_data_2_pin_

InternalGPIOPin *	display_data_3_pin_

InternalGPIOPin *	display_data_4_pin_

InternalGPIOPin *	display_data_5_pin_

InternalGPIOPin *	display_data_6_pin_

InternalGPIOPin *	display_data_7_pin_

GPIOPin *	ckv_pin_

InternalGPIOPin *	cl_pin_

GPIOPin *	gpio0_enable_pin_

GPIOPin *	gmod_pin_

InternalGPIOPin *	le_pin_

GPIOPin *	oe_pin_

GPIOPin *	powerup_pin_

GPIOPin *	sph_pin_

GPIOPin *	spv_pin_

GPIOPin *	vcom_pin_

GPIOPin *	wakeup_pin_

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::i2c::I2CDevice
uint8_t	address_ {0x00}
	store the address of the device on the bus

I2CBus *	bus_ {nullptr}
	pointer to I2CBus instance

Additional Inherited Members
Data Fields inherited from esphome::i2c::I2CDevice
uint8_t *	data

uint8_t size_t	len

uint8_t size_t bool	stop

size_t	len

size_t bool stop	const { return this->write(data, len)

const uint8_t *	data

const uint8_t size_t	len

const uint8_t size_t bool stop	const

Detailed Description

Definition at line 35 of file inkplate.h.

Member Function Documentation

◆ block_partial()

void esphome::inkplate::Inkplate::block_partial ( )

inline

Definition at line 97 of file inkplate.h.

◆ clean()

void esphome::inkplate::Inkplate::clean ( )

Definition at line 705 of file inkplate.cpp.

◆ clean_fast_()

void esphome::inkplate::Inkplate::clean_fast_	(	uint8_t	c,
		uint8_t	rep )

protected

Definition at line 719 of file inkplate.cpp.

◆ display()

void esphome::inkplate::Inkplate::display ( )

Definition at line 307 of file inkplate.cpp.

◆ display1b_()

void esphome::inkplate::Inkplate::display1b_ ( )

protected

Definition at line 323 of file inkplate.cpp.

◆ display3b_()

void esphome::inkplate::Inkplate::display3b_ ( )

protected

Definition at line 490 of file inkplate.cpp.

◆ draw_absolute_pixel_internal()

void HOT esphome::inkplate::Inkplate::draw_absolute_pixel_internal	(	int	x,
		int	y,
		Color	color )

overrideprotectedvirtual

Implements esphome::display::DisplayBuffer.

Definition at line 149 of file inkplate.cpp.

◆ dump_config()

void esphome::inkplate::Inkplate::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 181 of file inkplate.cpp.

◆ eink_off_()

void esphome::inkplate::Inkplate::eink_off_ ( )

protected

Definition at line 213 of file inkplate.cpp.

◆ eink_on_()

void esphome::inkplate::Inkplate::eink_on_ ( )

protected

Definition at line 241 of file inkplate.cpp.

◆ fill()

void esphome::inkplate::Inkplate::fill ( Color color )

overridevirtual

Reimplemented from esphome::display::Display.

Definition at line 292 of file inkplate.cpp.

◆ get_buffer_length_()

size_t esphome::inkplate::Inkplate::get_buffer_length_ ( )

protected

Definition at line 131 of file inkplate.cpp.

◆ get_data_pin_mask_()

int esphome::inkplate::Inkplate::get_data_pin_mask_ ( )

inlineprotected

Definition at line 155 of file inkplate.h.

◆ get_display_type()

display::DisplayType esphome::inkplate::Inkplate::get_display_type ( )

inlineoverridevirtual

Implements esphome::display::Display.

Definition at line 99 of file inkplate.h.

◆ get_greyscale()

bool esphome::inkplate::Inkplate::get_greyscale ( )

inline

Definition at line 93 of file inkplate.h.

◆ get_height_internal()

int esphome::inkplate::Inkplate::get_height_internal ( )

inlineoverrideprotectedvirtual

Implements esphome::display::Display.

Definition at line 138 of file inkplate.h.

◆ get_panel_state()

uint8_t esphome::inkplate::Inkplate::get_panel_state ( )

inline

Definition at line 92 of file inkplate.h.

◆ get_partial_updating()

bool esphome::inkplate::Inkplate::get_partial_updating ( )

inline

Definition at line 94 of file inkplate.h.

◆ get_setup_priority()

float esphome::inkplate::Inkplate::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 129 of file inkplate.cpp.

◆ get_temperature()

uint8_t esphome::inkplate::Inkplate::get_temperature ( )

inline

Definition at line 95 of file inkplate.h.

◆ get_width_internal()

int esphome::inkplate::Inkplate::get_width_internal ( )

inlineoverrideprotectedvirtual

Implements esphome::display::Display.

Definition at line 123 of file inkplate.h.

◆ hscan_start_()

void esphome::inkplate::Inkplate::hscan_start_ ( uint32_t d )

protected

Definition at line 689 of file inkplate.cpp.

◆ initialize_()

void esphome::inkplate::Inkplate::initialize_ ( )

protected

Allocate buffers.

May be called after setup to re-initialise if e.g. greyscale is changed.

Definition at line 59 of file inkplate.cpp.

◆ partial_update_()

bool esphome::inkplate::Inkplate::partial_update_ ( )

protected

Definition at line 603 of file inkplate.cpp.

◆ pins_as_outputs_()

void esphome::inkplate::Inkplate::pins_as_outputs_ ( )

protected

Definition at line 784 of file inkplate.cpp.

◆ pins_z_state_()

void esphome::inkplate::Inkplate::pins_z_state_ ( )

protected

Definition at line 764 of file inkplate.cpp.

◆ read_power_status_()

bool esphome::inkplate::Inkplate::read_power_status_ ( )

protected

Definition at line 283 of file inkplate.cpp.

◆ set_ckv_pin()

void esphome::inkplate::Inkplate::set_ckv_pin ( GPIOPin * ckv )

inline

Definition at line 68 of file inkplate.h.

◆ set_cl_pin()

void esphome::inkplate::Inkplate::set_cl_pin ( InternalGPIOPin * cl )

inline

Definition at line 69 of file inkplate.h.

◆ set_display_data_0_pin()

void esphome::inkplate::Inkplate::set_display_data_0_pin ( InternalGPIOPin * data )

inline

Definition at line 59 of file inkplate.h.

◆ set_display_data_1_pin()

void esphome::inkplate::Inkplate::set_display_data_1_pin ( InternalGPIOPin * data )

inline

Definition at line 60 of file inkplate.h.

◆ set_display_data_2_pin()

void esphome::inkplate::Inkplate::set_display_data_2_pin ( InternalGPIOPin * data )

inline

Definition at line 61 of file inkplate.h.

◆ set_display_data_3_pin()

void esphome::inkplate::Inkplate::set_display_data_3_pin ( InternalGPIOPin * data )

inline

Definition at line 62 of file inkplate.h.

◆ set_display_data_4_pin()

void esphome::inkplate::Inkplate::set_display_data_4_pin ( InternalGPIOPin * data )

inline

Definition at line 63 of file inkplate.h.

◆ set_display_data_5_pin()

void esphome::inkplate::Inkplate::set_display_data_5_pin ( InternalGPIOPin * data )

inline

Definition at line 64 of file inkplate.h.

◆ set_display_data_6_pin()

void esphome::inkplate::Inkplate::set_display_data_6_pin ( InternalGPIOPin * data )

inline

Definition at line 65 of file inkplate.h.

◆ set_display_data_7_pin()

void esphome::inkplate::Inkplate::set_display_data_7_pin ( InternalGPIOPin * data )

inline

Definition at line 66 of file inkplate.h.

◆ set_full_update_every()

void esphome::inkplate::Inkplate::set_full_update_every ( uint32_t full_update_every )

inline

Definition at line 55 of file inkplate.h.

◆ set_gmod_pin()

void esphome::inkplate::Inkplate::set_gmod_pin ( GPIOPin * gmod )

inline

Definition at line 71 of file inkplate.h.

◆ set_gpio0_enable_pin()

void esphome::inkplate::Inkplate::set_gpio0_enable_pin ( GPIOPin * gpio0_enable )

inline

Definition at line 70 of file inkplate.h.

◆ set_greyscale()

void esphome::inkplate::Inkplate::set_greyscale ( bool greyscale )

inline

Definition at line 37 of file inkplate.h.

◆ set_le_pin()

void esphome::inkplate::Inkplate::set_le_pin ( InternalGPIOPin * le )

inline

Definition at line 72 of file inkplate.h.

◆ set_mirror_x()

void esphome::inkplate::Inkplate::set_mirror_x ( bool mirror_x )

inline

Definition at line 52 of file inkplate.h.

◆ set_mirror_y()

void esphome::inkplate::Inkplate::set_mirror_y ( bool mirror_y )

inline

Definition at line 51 of file inkplate.h.

◆ set_model()

void esphome::inkplate::Inkplate::set_model ( InkplateModel model )

inline

Definition at line 57 of file inkplate.h.

◆ set_oe_pin()

void esphome::inkplate::Inkplate::set_oe_pin ( GPIOPin * oe )

inline

Definition at line 73 of file inkplate.h.

◆ set_partial_updating()

void esphome::inkplate::Inkplate::set_partial_updating ( bool partial_updating )

inline

Definition at line 54 of file inkplate.h.

◆ set_powerup_pin()

void esphome::inkplate::Inkplate::set_powerup_pin ( GPIOPin * powerup )

inline

Definition at line 74 of file inkplate.h.

◆ set_sph_pin()

void esphome::inkplate::Inkplate::set_sph_pin ( GPIOPin * sph )

inline

Definition at line 75 of file inkplate.h.

◆ set_spv_pin()

void esphome::inkplate::Inkplate::set_spv_pin ( GPIOPin * spv )

inline

Definition at line 76 of file inkplate.h.

◆ set_vcom_pin()

void esphome::inkplate::Inkplate::set_vcom_pin ( GPIOPin * vcom )

inline

Definition at line 77 of file inkplate.h.

◆ set_wakeup_pin()

void esphome::inkplate::Inkplate::set_wakeup_pin ( GPIOPin * wakeup )

inline

Definition at line 78 of file inkplate.h.

◆ set_waveform()

void esphome::inkplate::Inkplate::set_waveform	(	const std::array< uint8_t, GLUT_COUNT *GLUT_SIZE > &	waveform,
		bool	is_custom )

inline

Definition at line 44 of file inkplate.h.

◆ setup()

void esphome::inkplate::Inkplate::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 13 of file inkplate.cpp.

◆ setup_pins_()

void esphome::inkplate::Inkplate::setup_pins_ ( )

protected

◆ update()

void esphome::inkplate::Inkplate::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 139 of file inkplate.cpp.

◆ vscan_end_()

void esphome::inkplate::Inkplate::vscan_end_ ( )

protected

Definition at line 698 of file inkplate.cpp.

◆ vscan_start_()

void esphome::inkplate::Inkplate::vscan_start_ ( )

protected

Definition at line 665 of file inkplate.cpp.

Field Documentation

◆ block_partial_

bool esphome::inkplate::Inkplate::block_partial_ {true}

protected

Definition at line 181 of file inkplate.h.

◆ ckv_pin_

GPIOPin* esphome::inkplate::Inkplate::ckv_pin_

protected

Definition at line 200 of file inkplate.h.

◆ cl_pin_

InternalGPIOPin* esphome::inkplate::Inkplate::cl_pin_

protected

Definition at line 201 of file inkplate.h.

◆ custom_waveform_

bool esphome::inkplate::Inkplate::custom_waveform_ {false}

protected

Definition at line 186 of file inkplate.h.

◆ display_data_0_pin_

InternalGPIOPin* esphome::inkplate::Inkplate::display_data_0_pin_

protected

Definition at line 191 of file inkplate.h.

◆ display_data_1_pin_

InternalGPIOPin* esphome::inkplate::Inkplate::display_data_1_pin_

protected

Definition at line 192 of file inkplate.h.

◆ display_data_2_pin_

InternalGPIOPin* esphome::inkplate::Inkplate::display_data_2_pin_

protected

Definition at line 193 of file inkplate.h.

◆ display_data_3_pin_

InternalGPIOPin* esphome::inkplate::Inkplate::display_data_3_pin_

protected

Definition at line 194 of file inkplate.h.

◆ display_data_4_pin_

InternalGPIOPin* esphome::inkplate::Inkplate::display_data_4_pin_

protected

Definition at line 195 of file inkplate.h.

◆ display_data_5_pin_

InternalGPIOPin* esphome::inkplate::Inkplate::display_data_5_pin_

protected

Definition at line 196 of file inkplate.h.

◆ display_data_6_pin_

InternalGPIOPin* esphome::inkplate::Inkplate::display_data_6_pin_

protected

Definition at line 197 of file inkplate.h.

◆ display_data_7_pin_

InternalGPIOPin* esphome::inkplate::Inkplate::display_data_7_pin_

protected

Definition at line 198 of file inkplate.h.

◆ full_update_every_

uint32_t esphome::inkplate::Inkplate::full_update_every_

protected

Definition at line 178 of file inkplate.h.

◆ glut2_

uint32_t* esphome::inkplate::Inkplate::glut2_ {nullptr}

protected

Definition at line 175 of file inkplate.h.

◆ glut_

uint32_t* esphome::inkplate::Inkplate::glut_ {nullptr}

protected

Definition at line 174 of file inkplate.h.

◆ gmod_pin_

GPIOPin* esphome::inkplate::Inkplate::gmod_pin_

protected

Definition at line 203 of file inkplate.h.

◆ gpio0_enable_pin_

GPIOPin* esphome::inkplate::Inkplate::gpio0_enable_pin_

protected

Definition at line 202 of file inkplate.h.

◆ greyscale_

bool esphome::inkplate::Inkplate::greyscale_

protected

Definition at line 182 of file inkplate.h.

◆ le_pin_

InternalGPIOPin* esphome::inkplate::Inkplate::le_pin_

protected

Definition at line 204 of file inkplate.h.

◆ mirror_x_

bool esphome::inkplate::Inkplate::mirror_x_ {false}

protected

Definition at line 184 of file inkplate.h.

◆ mirror_y_

bool esphome::inkplate::Inkplate::mirror_y_ {false}

protected

Definition at line 183 of file inkplate.h.

◆ model_

InkplateModel esphome::inkplate::Inkplate::model_

protected

Definition at line 189 of file inkplate.h.

◆ oe_pin_

GPIOPin* esphome::inkplate::Inkplate::oe_pin_

protected

Definition at line 205 of file inkplate.h.

◆ panel_on_

bool esphome::inkplate::Inkplate::panel_on_ {false}

protected

Definition at line 168 of file inkplate.h.

◆ partial_buffer_

uint8_t* esphome::inkplate::Inkplate::partial_buffer_ {nullptr}

protected

Definition at line 171 of file inkplate.h.

◆ partial_buffer_2_

uint8_t* esphome::inkplate::Inkplate::partial_buffer_2_ {nullptr}

protected

Definition at line 172 of file inkplate.h.

◆ partial_updates_

uint32_t esphome::inkplate::Inkplate::partial_updates_ {0}

protected

Definition at line 179 of file inkplate.h.

◆ partial_updating_

bool esphome::inkplate::Inkplate::partial_updating_

protected

Definition at line 185 of file inkplate.h.

◆ pin_lut_

uint32_t esphome::inkplate::Inkplate::pin_lut_[256]

protected

Definition at line 176 of file inkplate.h.

◆ powerup_pin_

GPIOPin* esphome::inkplate::Inkplate::powerup_pin_

protected

Definition at line 206 of file inkplate.h.

◆ sph_pin_

GPIOPin* esphome::inkplate::Inkplate::sph_pin_

protected

Definition at line 207 of file inkplate.h.

◆ spv_pin_

GPIOPin* esphome::inkplate::Inkplate::spv_pin_

protected

Definition at line 208 of file inkplate.h.

◆ temperature_

uint8_t esphome::inkplate::Inkplate::temperature_

protected

Definition at line 169 of file inkplate.h.

◆ vcom_pin_

GPIOPin* esphome::inkplate::Inkplate::vcom_pin_

protected

Definition at line 209 of file inkplate.h.

◆ wakeup_pin_

GPIOPin* esphome::inkplate::Inkplate::wakeup_pin_

protected

Definition at line 210 of file inkplate.h.

◆ waveform_

uint8_t esphome::inkplate::Inkplate::waveform_[GLUT_COUNT][GLUT_SIZE]

protected

Definition at line 187 of file inkplate.h.

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

esphome/components/inkplate/inkplate.h
esphome/components/inkplate/inkplate.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ block_partial()

◆ clean()

◆ clean_fast_()

◆ display()

◆ display1b_()

◆ display3b_()

◆ draw_absolute_pixel_internal()

◆ dump_config()

◆ eink_off_()

◆ eink_on_()

◆ fill()

◆ get_buffer_length_()

◆ get_data_pin_mask_()

◆ get_display_type()

◆ get_greyscale()

◆ get_height_internal()

◆ get_panel_state()

◆ get_partial_updating()

◆ get_setup_priority()

◆ get_temperature()

◆ get_width_internal()

◆ hscan_start_()

◆ initialize_()

◆ partial_update_()

◆ pins_as_outputs_()

◆ pins_z_state_()

◆ read_power_status_()

◆ set_ckv_pin()

◆ set_cl_pin()

◆ set_display_data_0_pin()

◆ set_display_data_1_pin()

◆ set_display_data_2_pin()

◆ set_display_data_3_pin()

◆ set_display_data_4_pin()

◆ set_display_data_5_pin()

◆ set_display_data_6_pin()

◆ set_display_data_7_pin()

◆ set_full_update_every()

◆ set_gmod_pin()

◆ set_gpio0_enable_pin()

◆ set_greyscale()

◆ set_le_pin()

◆ set_mirror_x()

◆ set_mirror_y()

◆ set_model()

◆ set_oe_pin()

◆ set_partial_updating()

◆ set_powerup_pin()

◆ set_sph_pin()

◆ set_spv_pin()

◆ set_vcom_pin()

◆ set_wakeup_pin()

◆ set_waveform()

◆ setup()

◆ setup_pins_()

◆ update()

◆ vscan_end_()

◆ vscan_start_()

Field Documentation

◆ block_partial_

◆ ckv_pin_

◆ cl_pin_

◆ custom_waveform_

◆ display_data_0_pin_

◆ display_data_1_pin_

◆ display_data_2_pin_

◆ display_data_3_pin_

◆ display_data_4_pin_

◆ display_data_5_pin_

◆ display_data_6_pin_

◆ display_data_7_pin_

◆ full_update_every_

◆ glut2_

◆ glut_