#include <st7567_base.h>

Inheritance diagram for esphome::st7567_base::ST7567:

Public Member Functions
void	setup () override

void	update () override

void	set_reset_pin (GPIOPin *reset_pin)

void	init_mirror_x (bool mirror_x)

void	init_mirror_y (bool mirror_y)

void	init_invert_colors (bool invert_colors)

void	set_invert_colors (bool invert_colors)

void	set_contrast (uint8_t val)

void	set_brightness (uint8_t val)

void	set_all_pixels_on (bool enable)

void	set_scroll (uint8_t line)

bool	is_on ()

void	turn_on ()

void	turn_off ()

void	request_refresh ()

float	get_setup_priority () const override

void	fill (Color color) override

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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]. More...

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]. More...

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

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

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

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

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

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

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

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

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

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`. More...

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`. More...

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

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

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`. More...

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`. More...

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`. More...

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`. More...

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`. More...

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`. More...

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`. More...

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`. More...

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`. More...

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`. More...

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

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

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

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

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

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

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

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

void	set_auto_clear (bool auto_clear_enabled)

DisplayRotation	get_rotation () const

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

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

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

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

void	end_clipping ()
	Reset the invalidation region. More...

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

bool	is_clipping () const

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

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

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 void	command (uint8_t value)=0

virtual void	write_display_data ()=0

void	init_reset_ ()

void	display_init_ ()

void	display_init_registers_ ()

void	display_sw_refresh_ ()

void	draw_absolute_pixel_internal (int x, int y, Color color) override

int	get_height_internal () override

int	get_width_internal () override

size_t	get_buffer_length_ ()

int	get_offset_x_ ()

const char *	model_str_ ()

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

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_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
GPIOPin *	reset_pin_ {nullptr}

bool	is_on_ {false}

uint8_t	contrast_ {27}

uint8_t	brightness_ {5}

bool	mirror_x_ {true}

bool	mirror_y_ {true}

bool	invert_colors_ {false}

bool	all_pixels_on_ {false}

uint8_t	start_line_ {0}

bool	refresh_requested_ {false}

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
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 37 of file st7567_base.h.

Member Function Documentation

◆ command()

virtual void esphome::st7567_base::ST7567::command ( uint8_t value )

protectedpure virtual

Implemented in esphome::st7567_spi::SPIST7567, and esphome::st7567_i2c::I2CST7567.

◆ display_init_()

void esphome::st7567_base::ST7567::display_init_ ( )

protected

Definition at line 15 of file st7567_base.cpp.

◆ display_init_registers_()

void esphome::st7567_base::ST7567::display_init_registers_ ( )

protected

Definition at line 23 of file st7567_base.cpp.

◆ display_sw_refresh_()

void esphome::st7567_base::ST7567::display_sw_refresh_ ( )

protected

Definition at line 44 of file st7567_base.cpp.

◆ draw_absolute_pixel_internal()

void HOT esphome::st7567_base::ST7567::draw_absolute_pixel_internal	(	int	x,
		int	y,
		Color	color
	)

overrideprotectedvirtual

Implements esphome::display::DisplayBuffer.

Definition at line 120 of file st7567_base.cpp.

◆ fill()

void esphome::st7567_base::ST7567::fill ( Color color )

overridevirtual

Reimplemented from esphome::display::Display.

Definition at line 134 of file st7567_base.cpp.

◆ get_buffer_length_()

size_t esphome::st7567_base::ST7567::get_buffer_length_ ( )

protected

Definition at line 116 of file st7567_base.cpp.

◆ get_display_type()

display::DisplayType esphome::st7567_base::ST7567::get_display_type ( )

inlineoverridevirtual

Implements esphome::display::Display.

Definition at line 64 of file st7567_base.h.

◆ get_height_internal()

int esphome::st7567_base::ST7567::get_height_internal ( )

overrideprotectedvirtual

Implements esphome::display::Display.

Definition at line 113 of file st7567_base.cpp.

◆ get_offset_x_()

int esphome::st7567_base::ST7567::get_offset_x_ ( )

inlineprotected

Definition at line 81 of file st7567_base.h.

◆ get_setup_priority()

float esphome::st7567_base::ST7567::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 61 of file st7567_base.h.

◆ get_width_internal()

int esphome::st7567_base::ST7567::get_width_internal ( )

overrideprotectedvirtual

Implements esphome::display::Display.

Definition at line 111 of file st7567_base.cpp.

◆ init_invert_colors()

void esphome::st7567_base::ST7567::init_invert_colors ( bool invert_colors )

inline

Definition at line 46 of file st7567_base.h.

◆ init_mirror_x()

void esphome::st7567_base::ST7567::init_mirror_x ( bool mirror_x )

inline

Definition at line 44 of file st7567_base.h.

◆ init_mirror_y()

void esphome::st7567_base::ST7567::init_mirror_y ( bool mirror_y )

inline

Definition at line 45 of file st7567_base.h.

◆ init_reset_()

void esphome::st7567_base::ST7567::init_reset_ ( )

protected

Definition at line 136 of file st7567_base.cpp.

◆ is_on()

bool esphome::st7567_base::ST7567::is_on ( )

Definition at line 97 of file st7567_base.cpp.

◆ model_str_()

const char * esphome::st7567_base::ST7567::model_str_ ( )

protected

Definition at line 149 of file st7567_base.cpp.

◆ request_refresh()

void esphome::st7567_base::ST7567::request_refresh ( )

Definition at line 50 of file st7567_base.cpp.

◆ set_all_pixels_on()

void esphome::st7567_base::ST7567::set_all_pixels_on ( bool enable )

Definition at line 64 of file st7567_base.cpp.

◆ set_brightness()

void esphome::st7567_base::ST7567::set_brightness ( uint8_t val )

Definition at line 86 of file st7567_base.cpp.

◆ set_contrast()

void esphome::st7567_base::ST7567::set_contrast ( uint8_t val )

Definition at line 74 of file st7567_base.cpp.

◆ set_invert_colors()

void esphome::st7567_base::ST7567::set_invert_colors ( bool invert_colors )

Definition at line 69 of file st7567_base.cpp.

◆ set_reset_pin()

void esphome::st7567_base::ST7567::set_reset_pin ( GPIOPin * reset_pin )

inline

Definition at line 43 of file st7567_base.h.

◆ set_scroll()

void esphome::st7567_base::ST7567::set_scroll ( uint8_t line )

Definition at line 109 of file st7567_base.cpp.

◆ setup()

void esphome::st7567_base::ST7567::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Reimplemented in esphome::st7567_spi::SPIST7567, and esphome::st7567_i2c::I2CST7567.

Definition at line 10 of file st7567_base.cpp.

◆ turn_off()

void esphome::st7567_base::ST7567::turn_off ( )

Definition at line 104 of file st7567_base.cpp.

◆ turn_on()

void esphome::st7567_base::ST7567::turn_on ( )

Definition at line 99 of file st7567_base.cpp.

◆ update()

void esphome::st7567_base::ST7567::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 55 of file st7567_base.cpp.

◆ write_display_data()

virtual void esphome::st7567_base::ST7567::write_display_data ( )

protectedpure virtual

Implemented in esphome::st7567_spi::SPIST7567, and esphome::st7567_i2c::I2CST7567.

Field Documentation

◆ all_pixels_on_

bool esphome::st7567_base::ST7567::all_pixels_on_ {false}

protected

Definition at line 94 of file st7567_base.h.

◆ brightness_

uint8_t esphome::st7567_base::ST7567::brightness_ {5}

protected

Definition at line 90 of file st7567_base.h.

◆ contrast_

uint8_t esphome::st7567_base::ST7567::contrast_ {27}

protected

Definition at line 89 of file st7567_base.h.

◆ invert_colors_

bool esphome::st7567_base::ST7567::invert_colors_ {false}

protected

Definition at line 93 of file st7567_base.h.

◆ is_on_

bool esphome::st7567_base::ST7567::is_on_ {false}

protected

Definition at line 86 of file st7567_base.h.

◆ mirror_x_

bool esphome::st7567_base::ST7567::mirror_x_ {true}

protected

Definition at line 91 of file st7567_base.h.

◆ mirror_y_

bool esphome::st7567_base::ST7567::mirror_y_ {true}

protected

Definition at line 92 of file st7567_base.h.

◆ refresh_requested_

bool esphome::st7567_base::ST7567::refresh_requested_ {false}

protected

Definition at line 96 of file st7567_base.h.

◆ reset_pin_

GPIOPin* esphome::st7567_base::ST7567::reset_pin_ {nullptr}

protected

Definition at line 85 of file st7567_base.h.

◆ start_line_

uint8_t esphome::st7567_base::ST7567::start_line_ {0}

protected

Definition at line 95 of file st7567_base.h.

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

/opt/build/esphome/esphome/components/st7567_base/st7567_base.h
/opt/build/esphome/esphome/components/st7567_base/st7567_base.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ command()

◆ display_init_()

◆ display_init_registers_()

◆ display_sw_refresh_()

◆ draw_absolute_pixel_internal()

◆ fill()

◆ get_buffer_length_()

◆ get_display_type()

◆ get_height_internal()

◆ get_offset_x_()

◆ get_setup_priority()

◆ get_width_internal()

◆ init_invert_colors()

◆ init_mirror_x()

◆ init_mirror_y()

◆ init_reset_()

◆ is_on()

◆ model_str_()

◆ request_refresh()

◆ set_all_pixels_on()

◆ set_brightness()

◆ set_contrast()

◆ set_invert_colors()

◆ set_reset_pin()

◆ set_scroll()

◆ setup()

◆ turn_off()

◆ turn_on()

◆ update()

◆ write_display_data()

Field Documentation

◆ all_pixels_on_

◆ brightness_

◆ contrast_

◆ invert_colors_

◆ is_on_

◆ mirror_x_

◆ mirror_y_

◆ refresh_requested_

◆ reset_pin_

◆ start_line_