class to control OLED and define buffer More...

#include <SSD1306_OLED_RDL.hpp>

Inheritance diagram for SSD1306_RDL:

[legend]

Public Member Functions
	SSD1306_RDL (int16_t oledwidth, int16_t oledheight)
	init the screen object

virtual void	drawPixel (int16_t x, int16_t y, uint8_t color) override
	Draws a Pixel to the screen overrides the graphics lib.

rdlib::Return_Codes_e	OLEDSetBufferPtr (uint8_t width, uint8_t height, std::span< uint8_t > buffer)
	sets the buffer pointer to the users screen data buffer

rdlib::Return_Codes_e	OLEDupdate (void)
	updates the buffer i.e. writes it to the screen

rdlib::Return_Codes_e	OLEDclearBuffer (void)
	clears the buffer memory i.e. does NOT write to the screen

void	OLEDBufferScreen (int16_t x, int16_t y, uint8_t w, uint8_t h, std::span< uint8_t > data)
	Draw the buffer directly to the screen.

void	OLEDFillScreen (uint8_t pixel, uint8_t mircodelay)
	Fill the screen NOT the buffer with a datapattern.

void	OLEDFillPage (uint8_t page_num, uint8_t pixels, uint8_t delay)
	Fill the chosen page(1-8) with a datapattern.

void	OLEDbegin ()
	begin Method initialise OLED

void	OLEDinit (void)
	Called from OLEDbegin carries out Power on sequence and register init.

void	OLEDPowerDown (void)
	Disables OLED Call when powering down.

void	OLEDEnable (uint8_t on)
	Turns On Display.

void	OLEDContrast (uint8_t OLEDcontrast)
	Adjusts contrast.

void	OLEDInvert (bool on)
	invert the display

void	OLEDStartScrollRight (uint8_t start, uint8_t stop)
	Scroll OLED data to the right.

void	OLEDStartScrollLeft (uint8_t start, uint8_t stop)
	Scroll OLED data to the left.

void	OLEDStartScrollDiagRight (uint8_t start, uint8_t stop)
	Scroll OLED data diagonally to the right.

void	OLEDStartScrollDiagLeft (uint8_t start, uint8_t stop)
	Scroll OLED data diagonally to the left.

void	OLEDStopScroll (void)
	Stop scroll mode.

rdlib::Return_Codes_e	OLED_I2C_ON (int I2C_device, int I2C_addr, int I2C_flags)
	Start I2C operations.

rdlib::Return_Codes_e	OLED_I2C_OFF (void)
	End I2C operations. This closes the I2C device.

int	OLEDCheckConnection (void)
	checks if OLED on I2C bus

int	OLEDI2CErrorGet (void)
	get I2C error Flag

uint16_t	OLEDI2CErrorTimeoutGet (void)
	Gets the I2C timeout, used in the event of an I2C write error.

void	OLEDI2CErrorTimeoutSet (uint16_t)
	Sets the I2C timeout, in the event of an I2C write error.

uint8_t	OLEDI2CErrorRetryNumGet (void)
	Gets the I2C error retry attempts, used in the event of an I2C write error.

void	OLEDI2CErrorRetryNumSet (uint8_t)
	Sets the I2C error retry attempts used in the event of an I2C write error.

Public Member Functions inherited from bicolor_graphics
	bicolor_graphics (int16_t w, int16_t h)
	init the Display Graphics class object

rdlib::Return_Codes_e	drawDotGrid (int16_t x, int16_t y, int16_t w, int16_t h, uint8_t DotGridGap, uint8_t color)
	Draws a grid of dots on the screen starting from the given coordinates. This function draws a grid of pixels with a specified gap between them. It checks that the provided coordinates and dimensions are within the screen bounds and adjusts them if necessary. It also validates The grid of dots gap value and defaults it to 2 if invalid.

void	drawLine (int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint8_t color)
	draws a line from (x0,y0) to (x1,y1).

rdlib::Return_Codes_e	drawFastVLine (int16_t x, int16_t y, int16_t h, uint8_t color)
	Draws a vertical line starting at (x,y) with height h.

rdlib::Return_Codes_e	drawFastHLine (int16_t x, int16_t y, int16_t w, uint8_t color)
	Draws a horizontal line starting at (x,y) with width w.

void	drawLineAngle (int16_t x, int16_t y, int angle, uint8_t start, uint8_t length, int offset, uint8_t color)
	Draws a line using an angle and length as parameters. This function draws a line starting from `(x, y)`, extending in the direction specified by `angle`, with a given `length`. The function also allows applying an `offset` to the angle before computing the line’s end coordinates.

void	drawRect (int16_t x, int16_t y, int16_t w, int16_t h, uint8_t color)
	draws rectangle at (x,y) where h is height and w is width of the rectangle.

void	fillRect (int16_t x, int16_t y, int16_t w, int16_t h, uint8_t color)
	fills a rectangle starting from coordinates (x,y) with width of w and height of h.

void	fillScreen (uint8_t color)
	Fills the whole screen with a given color.

void	drawCircle (int16_t x0, int16_t y0, int16_t r, uint8_t color)
	draws a circle where (x0,y0) are center coordinates an r is circle radius.

void	fillCircle (int16_t x0, int16_t y0, int16_t r, uint8_t color)
	fills a circle where (x0,y0) are center coordinates an r is circle radius.

void	drawEllipse (int16_t cx, int16_t cy, int16_t semiMajorAxis, int16_t semiMinorAxis, bool fill, uint8_t color)
	Draw an ellipse on the display. This function uses the midpoint ellipse algorithm to efficiently draw an ellipse centered at (cx, cy) with the given semi-major (horizontal) and semi-minor (vertical) axes.

void	drawTriangle (int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint8_t color)
	draws a triangle of coordinates (x0,y0), (x1,y1) and (x2,y2).

void	fillTriangle (int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint8_t color)
	Fills a triangle of coordinates (x0,y0), (x1,y1) and (x2,y2).

void	drawRoundRect (int16_t x0, int16_t y0, int16_t w, int16_t h, int16_t radius, uint8_t color)
	draws a rectangle with rounded edges

void	fillRoundRect (int16_t x0, int16_t y0, int16_t w, int16_t h, int16_t radius, uint8_t color)
	Fills a rectangle with rounded edges.

void	drawQuadrilateral (int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, int16_t x3, int16_t y3, uint8_t color)
	Draws a quadrilateral (four-sided polygon) by connecting four points with lines. This function draws a quadrilateral by drawing four lines between the given vertices. The lines are drawn in the order: (x0, y0) to (x1, y1), (x1, y1) to (x2, y2), (x2, y2) to (x3, y3), and finally (x3, y3) back to (x0, y0).

void	fillQuadrilateral (int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, int16_t x3, int16_t y3, uint8_t color, bool useTriangleSplit=true)
	Fills a quadrilateral with the specified color using triangles. This function fills a quadrilateral by dividing it into triangles and filling them individually. The quadrilateral is filled by calling the `fillTriangle` function three times with appropriate vertex coordinates. The `useTriangleSplit` parameter determines whether the quadrilateral is divided into two triangles or if only one triangle is used.

rdlib::Return_Codes_e	drawPolygon (int16_t x, int16_t y, uint8_t sides, int16_t diameter, float rotation, bool fill, uint8_t color)
	Draws a polygon with a specified number of sides, diameter, rotation, and color. This function draws a regular polygon by connecting points equally spaced around a circle, with each point having a distance defined by the diameter. The polygon is rotated by the given angle (in degrees) before being drawn. The number of sides is enforced to be at least 3.

void	drawArc (uint16_t cx, uint16_t cy, uint16_t radius, uint16_t thickness, float startAngle, float endAngle, uint8_t color)
	Draw an arc on the TFT display. This function draws an arc between two angles (start and end) on a circle with a given radius.

void	drawSimpleArc (int16_t cx, int16_t cy, int16_t radius, float startAngle, float endAngle, uint8_t color)
	Draw a simple arc of one pixel on the display( no offsets , thickness or maximum arc calculations) This function draws an arc between two angles (start and end) on a circle with a given radius.

float	getArcAngleMax () const
	Get the current maximum angle of the arc.

void	setArcAngleMax (float arcAngleMax)
	Set a new maximum angle for the arc.

int	getArcAngleOffset () const
	Get the current angle offset.

void	setArcAngleOffset (int arcAngleOffset)
	Set a new angle offset.

void	setCursor (int16_t x, int16_t y)
	set the cursor position

void	setRotation (displayBC_rotate_e m)
	Sets the _rotation of the display.

displayBC_rotate_e	getRotation ()
	Gets the _rotation of the display.

int16_t	height (void) const
	Gets the height of the display (per current _rotation)

int16_t	width (void) const
	Gets the width of the display (per current _rotation)

virtual size_t	write (uint8_t) override
	write method used in the print class when user calls print

rdlib::Return_Codes_e	writeChar (int16_t x, int16_t y, char value)
	Write 1 character on display.

rdlib::Return_Codes_e	writeCharString (int16_t x, int16_t y, char *text)
	Write Text character array on Display.

void	setTextWrap (bool w)
	turn on or off screen wrap of the text

void	setDrawBitmapAddr (bool mode)
	sets the data addressing mode in drawBitmap function.

rdlib::Return_Codes_e	drawBitmap (int16_t x, int16_t y, const std::span< const uint8_t > bitmap, int16_t w, int16_t h, uint8_t color, uint8_t bg)
	Draw a 1-bit color bitmap.

Public Member Functions inherited from display_Fonts
	display_Fonts ()
	init the OLED font class object constructor

rdlib::Return_Codes_e	setFont (display_Font_name_e)
	SetFont.

void	setInvertFont (bool invertStatus)
	setInvertFont

bool	getInvertFont (void)
	getInvertFont

Public Member Functions inherited from Print
int	getWriteError ()
	gets the error flag status, zero no error

void	clearWriteError ()
	clears the error flag by setting it to zero

virtual size_t	write (const uint8_t *buffer, size_t size)
	define in the sub class

size_t	write (const char *str)
	Writes a string to the output.

size_t	write (const char *buffer, size_t size)
	Writes a buffer of a specified size to the output.

virtual int	availableForWrite ()
	define in the sub class

size_t	print (const char[])
	print an array

size_t	print (char)
	print an character

size_t	print (int, int=RDL_DEC)
	print an integer of base number system

size_t	print (unsigned int, int=RDL_DEC)
	print an unsigned integer of base number system

size_t	print (long, int=RDL_DEC)
	print an long integer of base number system

size_t	print (unsigned long, int=RDL_DEC)
	print an unsigned long integer of base number system

size_t	print (double, int=2)
	print an double

size_t	print (const std::string &)
	print an C++ string object

size_t	println (const char[])
	Prints a character array followed by a newline.

size_t	println (char)
	print an character followed by new line

size_t	println (int, int=RDL_DEC)
	print an integer of base number system followed by new line

size_t	println (unsigned int, int=RDL_DEC)
	print an unsigned integer of base number system followed by new line

size_t	println (long, int=RDL_DEC)
	print an long integer of base number system followed by new line

size_t	println (unsigned long, int=RDL_DEC)
	print an unsigned long integer of base number system followed by new line

size_t	println (double, int=2)
	print an double

size_t	println (void)
	Goto to new line.

size_t	println (const std::string &s)
	print an C++ string object followed by new line

template<typename T >
size_t	print (const std::vector< T > &v, int format=defaultFormat< T >())
	Print a vector of any type.

template<typename T >
size_t	println (const std::vector< T > &vec, int format=defaultFormat< T >())
	Print a vector of elements followed by a newline.

template<typename T , size_t N>
size_t	print (const std::array< T, N > &arr, int format=defaultFormat< T >())
	Print a std::array of any type.

template<typename T , size_t N>
size_t	println (const std::array< T, N > &arr, int format=defaultFormat< T >())
	Print a std::array of elements followed by a newline.

Public Attributes
const uint8_t	SSD1306_ADDR = 0x3C

Private Member Functions
void	I2CWriteByte (uint8_t value=0x00, uint8_t DataOrCmd=SSD1306_COMMAND)
	Writes a byte to I2C address,command or data, used internally.

Private Attributes
int	_OLEDI2CAddress = SSD1306_ADDR

int	_OLEDI2CDevice = 1

int	_OLEDI2CFlags = 0

int	_OLEDI2CHandle = 0

uint16_t	_I2C_ErrorDelay = 100

uint8_t	_I2C_ErrorRetryNum = 3

int	_I2C_ErrorFlag = 0

uint8_t	_OLED_WIDTH =128

uint8_t	_OLED_HEIGHT =64

uint8_t	_OLED_PAGE_NUM =(_OLED_HEIGHT/8)

std::span< uint8_t >	_OLEDbuffer

Static Private Attributes
static constexpr uint8_t	SSD1306_SET_CONTRAST_CONTROL = 0x81

static constexpr uint8_t	SSD1306_DISPLAY_ALL_ON_RESUME = 0xA4

static constexpr uint8_t	SSD1306_DISPLAY_ALL_ON = 0xA5

static constexpr uint8_t	SSD1306_NORMAL_DISPLAY = 0xA6

static constexpr uint8_t	SSD1306_INVERT_DISPLAY = 0xA7

static constexpr uint8_t	SSD1306_DISPLAY_OFF = 0xAE

static constexpr uint8_t	SSD1306_DISPLAY_ON = 0xAF

static constexpr uint8_t	SSD1306_NOP = 0xE3

static constexpr uint8_t	SSD1306_RIGHT_HORIZONTAL_SCROLL = 0x26

static constexpr uint8_t	SSD1306_LEFT_HORIZONTAL_SCROLL = 0x27

static constexpr uint8_t	SSD1306_VERTICAL_AND_RIGHT_HORIZONTAL_SCROLL = 0x29

static constexpr uint8_t	SSD1306_VERTICAL_AND_LEFT_HORIZONTAL_SCROLL = 0x2A

static constexpr uint8_t	SSD1306_DEACTIVATE_SCROLL = 0x2E

static constexpr uint8_t	SSD1306_ACTIVATE_SCROLL = 0x2F

static constexpr uint8_t	SSD1306_SET_VERTICAL_SCROLL_AREA = 0xA3

static constexpr uint8_t	SSD1306_SET_LOWER_COLUMN = 0x00

static constexpr uint8_t	SSD1306_SET_HIGHER_COLUMN = 0x10

static constexpr uint8_t	SSD1306_MEMORY_ADDR_MODE = 0x20

static constexpr uint8_t	SSD1306_SET_COLUMN_ADDR = 0x21

static constexpr uint8_t	SSD1306_SET_PAGE_ADDR = 0x22

static constexpr uint8_t	SSD1306_SET_START_LINE = 0x40

static constexpr uint8_t	SSD1306_SET_SEGMENT_REMAP = 0xA0

static constexpr uint8_t	SSD1306_SET_MULTIPLEX_RATIO = 0xA8

static constexpr uint8_t	SSD1306_COM_SCAN_DIR_INC = 0xC0

static constexpr uint8_t	SSD1306_COM_SCAN_DIR_DEC = 0xC8

static constexpr uint8_t	SSD1306_SET_DISPLAY_OFFSET = 0xD3

static constexpr uint8_t	SSD1306_SET_COM_PINS = 0xDA

static constexpr uint8_t	SSD1306_CHARGE_PUMP = 0x8D

static constexpr uint8_t	SSD1306_SET_DISPLAY_CLOCK_DIV_RATIO = 0xD5

static constexpr uint8_t	SSD1306_SET_PRECHARGE_PERIOD = 0xD9

static constexpr uint8_t	SSD1306_SET_VCOM_DESELECT = 0xDB

static constexpr uint8_t	SSD1306_COMMAND = 0x00

static constexpr uint8_t	SSD1306_DATA = 0xC0

static constexpr uint8_t	SSD1306_DATA_CONTINUE = 0x40

Additional Inherited Members
Public Types inherited from bicolor_graphics
enum	displayBC_rotate_e : uint8_t { BC_Degrees_0 = 0 , BC_Degrees_90 = 1 , BC_Degrees_180 = 2 , BC_Degrees_270 = 3 }

enum	pixel_color_e : uint8_t { WHITE = 0 , BLACK = 1 , INVERSE = 2 }

Public Types inherited from Print
enum	BaseNum : uint8_t { RDL_DEC = 10 , RDL_HEX = 16 , RDL_OCT = 8 , RDL_BIN = 2 }

Protected Member Functions inherited from Print
void	setWriteError (int err=0)

Protected Attributes inherited from bicolor_graphics
displayBC_rotate_e	_display_rotate = BC_Degrees_0

const int16_t	WIDTH

const int16_t	HEIGHT

int16_t	_width

int16_t	_height

int16_t	_cursor_x

int16_t	_cursor_y

float	_arcAngleMax = 360.0f

int	_arcAngleOffset = 0

bool	_textwrap = true

Protected Attributes inherited from display_Fonts
std::span< const uint8_t >	_FontSelect = pFontDefault

uint8_t	_Font_X_Size = 0x08

uint8_t	_Font_Y_Size = 0x08

uint8_t	_FontOffset = 0x20

uint8_t	_FontNumChars = 0x5F

Detailed Description

class to control OLED and define buffer

Constructor & Destructor Documentation

◆ SSD1306_RDL()

SSD1306_RDL::SSD1306_RDL	(	int16_t	oledwidth,
		int16_t	oledheight
	)

init the screen object

Parameters

oledwidth	width of OLED in pixels
oledheight	height of OLED in pixels

Member Function Documentation

◆ drawPixel()

void SSD1306_RDL::drawPixel	(	int16_t	x,
		int16_t	y,
		uint8_t	color
	)

overridevirtual

Draws a Pixel to the screen overrides the graphics lib.

Parameters

x	x axis position
y	y axis position
color	color of pixel.

Implements bicolor_graphics.

◆ I2CWriteByte()

void SSD1306_RDL::I2CWriteByte	(	uint8_t	value = `0x00`,
		uint8_t	cmd = `SSD1306_COMMAND`
	)

private

Writes a byte to I2C address,command or data, used internally.

Parameters

value	write the value to be written
cmd	command or data

Note: isDebugEnabled() ,will output data on I2C failures.

◆ OLED_I2C_OFF()

rdlib::Return_Codes_e SSD1306_RDL::OLED_I2C_OFF ( void )

End I2C operations. This closes the I2C device.

Returns

in event of any error

rdlib::Success everything worked
rdlib::I2CcloseFail cannot close I2c bus device

◆ OLED_I2C_ON()

rdlib::Return_Codes_e SSD1306_RDL::OLED_I2C_ON	(	int	I2C_device,
		int	I2C_addr,
		int	I2C_flags
	)

Start I2C operations.

Parameters

I2C_device	An I2C device number.
I2C_addr	The address of a device on the I2C bus. PCF8574 default is 0x3C
I2C_flags	Flags which modify an I2C open command. None are currently defined.

Returns

rdlib::Success everything worked
rdlib::I2CbeginFail Cannot open I2C device

◆ OLEDBufferScreen()

void SSD1306_RDL::OLEDBufferScreen	(	int16_t	x,
		int16_t	y,
		uint8_t	w,
		uint8_t	h,
		std::span< uint8_t >	data
	)

Draw the buffer directly to the screen.

Parameters

x	x axis offset
y	y axis offset
w	width
h	height
data	the span of the buffer data

Note: Called by OLEDupdate internally

◆ OLEDCheckConnection()

int SSD1306_RDL::OLEDCheckConnection ( void )

checks if OLED on I2C bus

Returns: lg Error codes, LG_OKAY 0x00 = Success

Note: Error codes are here https://abyz.me.uk/lg/lgpio.html

◆ OLEDclearBuffer()

rdlib::Return_Codes_e SSD1306_RDL::OLEDclearBuffer ( void )

clears the buffer memory i.e. does NOT write to the screen

Returns

Success
BufferEmpty is buffer empty object

◆ OLEDContrast()

void SSD1306_RDL::OLEDContrast ( uint8_t contrast )

Adjusts contrast.

Parameters

contrast 0x00 to 0xFF , default 0x80

◆ OLEDEnable()

void SSD1306_RDL::OLEDEnable ( uint8_t bits )

Turns On Display.

Parameters

bits	1 on , 0 off

◆ OLEDFillPage()

void SSD1306_RDL::OLEDFillPage	(	uint8_t	page_num,
		uint8_t	dataPattern,
		uint8_t	mydelay
	)

Fill the chosen page(1-8) with a datapattern.

Parameters

page_num	chosen page (1-8)
dataPattern	can be set to 0 to FF (not buffer)
mydelay	optional delay in milliseconds can be set to zero normally.

◆ OLEDFillScreen()

void SSD1306_RDL::OLEDFillScreen	(	uint8_t	dataPattern,
		uint8_t	delay
	)

Fill the screen NOT the buffer with a datapattern.

Parameters

dataPattern	can be set to zero to clear screen (not buffer) range 0x00 to 0ff
delay	in milliseconds can be set to zero normally.

◆ OLEDI2CErrorGet()

int SSD1306_RDL::OLEDI2CErrorGet ( void )

get I2C error Flag

Returns: See Error Codes at bottom of https://abyz.me.uk/lg/lgpio.html

◆ OLEDI2CErrorRetryNumGet()

uint8_t SSD1306_RDL::OLEDI2CErrorRetryNumGet ( void )

Gets the I2C error retry attempts, used in the event of an I2C write error.

Number of times to retry in event of an error

Returns: _I2C_ErrorRetryNum

◆ OLEDI2CErrorRetryNumSet()

void SSD1306_RDL::OLEDI2CErrorRetryNumSet ( uint8_t AttemptCount )

Sets the I2C error retry attempts used in the event of an I2C write error.

Number of times to retry in event of an error

Parameters

AttemptCount I2C retry attempts

◆ OLEDI2CErrorTimeoutGet()

uint16_t SSD1306_RDL::OLEDI2CErrorTimeoutGet ( void )

Gets the I2C timeout, used in the event of an I2C write error.

Delay between retry attempts in event of an error , mS

Returns: I2C timeout delay in mS, _I2C_ErrorDelay

◆ OLEDI2CErrorTimeoutSet()

void SSD1306_RDL::OLEDI2CErrorTimeoutSet ( uint16_t newTimeout )

Sets the I2C timeout, in the event of an I2C write error.

Parameters

newTimeout I2C timeout delay in mS

Delay between retry attempts in event of an error , mS

◆ OLEDinit()

void SSD1306_RDL::OLEDinit ( void )

Called from OLEDbegin carries out Power on sequence and register init.

< Initialisation delay in mS

◆ OLEDInvert()

void SSD1306_RDL::OLEDInvert ( bool value )

invert the display

Parameters

value true invert , false normal

◆ OLEDSetBufferPtr()

rdlib::Return_Codes_e SSD1306_RDL::OLEDSetBufferPtr	(	uint8_t	width,
		uint8_t	height,
		std::span< uint8_t >	buffer
	)

sets the buffer pointer to the users screen data buffer

Parameters

width	width of buffer in pixels
height	height of buffer in pixels
buffer	the buffer span

Returns

Will return rdlib::Return_Codes_e enum

◆ OLEDStartScrollDiagLeft()

void SSD1306_RDL::OLEDStartScrollDiagLeft	(	uint8_t	start,
		uint8_t	stop
	)

Scroll OLED data diagonally to the left.

Parameters

start	start position
stop	stop position

◆ OLEDStartScrollDiagRight()

void SSD1306_RDL::OLEDStartScrollDiagRight	(	uint8_t	start,
		uint8_t	stop
	)

Scroll OLED data diagonally to the right.

Parameters

start	start position
stop	stop position

◆ OLEDStartScrollLeft()

void SSD1306_RDL::OLEDStartScrollLeft	(	uint8_t	start,
		uint8_t	stop
	)

Scroll OLED data to the left.

Parameters

start	start position
stop	stop position

◆ OLEDStartScrollRight()

void SSD1306_RDL::OLEDStartScrollRight	(	uint8_t	start,
		uint8_t	stop
	)

Scroll OLED data to the right.

Parameters

start	start position
stop	stop position

◆ OLEDupdate()

rdlib::Return_Codes_e SSD1306_RDL::OLEDupdate ( void )

updates the buffer i.e. writes it to the screen

Returns

Success
BufferEmpty if buffer is empty object

Member Data Documentation

◆ _I2C_ErrorDelay

uint16_t SSD1306_RDL::_I2C_ErrorDelay = 100

private

I2C delay(in between retry attempts) in event of error in mS

◆ _I2C_ErrorFlag

int SSD1306_RDL::_I2C_ErrorFlag = 0

private

In event of I2C error holds code

◆ _I2C_ErrorRetryNum

uint8_t SSD1306_RDL::_I2C_ErrorRetryNum = 3

private

In event of I2C error number of retry attempts

◆ _OLED_HEIGHT

uint8_t SSD1306_RDL::_OLED_HEIGHT =64

private

Height of OLED Screen in pixels

◆ _OLED_PAGE_NUM

uint8_t SSD1306_RDL::_OLED_PAGE_NUM =(_OLED_HEIGHT/8)

private

Number of byte size pages OLED screen is divided into

◆ _OLED_WIDTH

uint8_t SSD1306_RDL::_OLED_WIDTH =128

private

Width of OLED Screen in pixels

◆ _OLEDbuffer

std::span<uint8_t> SSD1306_RDL::_OLEDbuffer

private

span to buffer which holds screen data

◆ _OLEDI2CAddress

int SSD1306_RDL::_OLEDI2CAddress = SSD1306_ADDR

private

I2C address for I2C module PCF8574 backpack on OLED

◆ _OLEDI2CDevice

int SSD1306_RDL::_OLEDI2CDevice = 1

private

An I2C device number.

◆ _OLEDI2CFlags

int SSD1306_RDL::_OLEDI2CFlags = 0

private

Flags which modify an I2C open command. None are currently defined.

◆ _OLEDI2CHandle

int SSD1306_RDL::_OLEDI2CHandle = 0

private

A number referencing an object opened by one of lgI2cOpen

◆ SSD1306_ACTIVATE_SCROLL

constexpr uint8_t SSD1306_RDL::SSD1306_ACTIVATE_SCROLL = 0x2F

staticconstexprprivate

Activate scroll command

◆ SSD1306_ADDR

const uint8_t SSD1306_RDL::SSD1306_ADDR = 0x3C

I2C address, alt 0x3D

◆ SSD1306_CHARGE_PUMP

constexpr uint8_t SSD1306_RDL::SSD1306_CHARGE_PUMP = 0x8D

staticconstexprprivate

Charge pump setting

◆ SSD1306_COM_SCAN_DIR_DEC

constexpr uint8_t SSD1306_RDL::SSD1306_COM_SCAN_DIR_DEC = 0xC8

staticconstexprprivate

Set COM Output Scan Direction, remapped mode

◆ SSD1306_COM_SCAN_DIR_INC

constexpr uint8_t SSD1306_RDL::SSD1306_COM_SCAN_DIR_INC = 0xC0

staticconstexprprivate

Set COM Output Scan Direction, normal mode

◆ SSD1306_COMMAND

constexpr uint8_t SSD1306_RDL::SSD1306_COMMAND = 0x00

staticconstexprprivate

Command byte code

◆ SSD1306_DATA

constexpr uint8_t SSD1306_RDL::SSD1306_DATA = 0xC0

staticconstexprprivate

data byte code with continuation bit set

◆ SSD1306_DATA_CONTINUE

constexpr uint8_t SSD1306_RDL::SSD1306_DATA_CONTINUE = 0x40

staticconstexprprivate

data byte code with continuation bit clear

◆ SSD1306_DEACTIVATE_SCROLL

constexpr uint8_t SSD1306_RDL::SSD1306_DEACTIVATE_SCROLL = 0x2E

staticconstexprprivate

Deactivate scroll command

◆ SSD1306_DISPLAY_ALL_ON

constexpr uint8_t SSD1306_RDL::SSD1306_DISPLAY_ALL_ON = 0xA5

staticconstexprprivate

Entire Display ON ignore RAM

◆ SSD1306_DISPLAY_ALL_ON_RESUME

constexpr uint8_t SSD1306_RDL::SSD1306_DISPLAY_ALL_ON_RESUME = 0xA4

staticconstexprprivate

Entire Display ON follow RAM

◆ SSD1306_DISPLAY_OFF

constexpr uint8_t SSD1306_RDL::SSD1306_DISPLAY_OFF = 0xAE

staticconstexprprivate

Display Off, Sleep mode

◆ SSD1306_DISPLAY_ON

constexpr uint8_t SSD1306_RDL::SSD1306_DISPLAY_ON = 0xAF

staticconstexprprivate

Display ON in normal mode

◆ SSD1306_INVERT_DISPLAY

constexpr uint8_t SSD1306_RDL::SSD1306_INVERT_DISPLAY = 0xA7

staticconstexprprivate

Set Inverted Display

◆ SSD1306_LEFT_HORIZONTAL_SCROLL

constexpr uint8_t SSD1306_RDL::SSD1306_LEFT_HORIZONTAL_SCROLL = 0x27

staticconstexprprivate

Left horizontal scroll command

◆ SSD1306_MEMORY_ADDR_MODE

constexpr uint8_t SSD1306_RDL::SSD1306_MEMORY_ADDR_MODE = 0x20

staticconstexprprivate

Set Memory Addressing Mode 00b, Horizontal Addressing Mode

◆ SSD1306_NOP

constexpr uint8_t SSD1306_RDL::SSD1306_NOP = 0xE3

staticconstexprprivate

Command for no operation

◆ SSD1306_NORMAL_DISPLAY

constexpr uint8_t SSD1306_RDL::SSD1306_NORMAL_DISPLAY = 0xA6

staticconstexprprivate

Set Normal Display

◆ SSD1306_RIGHT_HORIZONTAL_SCROLL

constexpr uint8_t SSD1306_RDL::SSD1306_RIGHT_HORIZONTAL_SCROLL = 0x26

staticconstexprprivate

Right horizontal scroll command

◆ SSD1306_SET_COLUMN_ADDR

constexpr uint8_t SSD1306_RDL::SSD1306_SET_COLUMN_ADDR = 0x21

staticconstexprprivate

Set Column Address

◆ SSD1306_SET_COM_PINS

constexpr uint8_t SSD1306_RDL::SSD1306_SET_COM_PINS = 0xDA

staticconstexprprivate

Set COM Pins Hardware Configuration

◆ SSD1306_SET_CONTRAST_CONTROL

constexpr uint8_t SSD1306_RDL::SSD1306_SET_CONTRAST_CONTROL = 0x81

staticconstexprprivate

Set Contrast Control

◆ SSD1306_SET_DISPLAY_CLOCK_DIV_RATIO

constexpr uint8_t SSD1306_RDL::SSD1306_SET_DISPLAY_CLOCK_DIV_RATIO = 0xD5

staticconstexprprivate

Set Display Clock Divider - Oscillator Frequency

◆ SSD1306_SET_DISPLAY_OFFSET

constexpr uint8_t SSD1306_RDL::SSD1306_SET_DISPLAY_OFFSET = 0xD3

staticconstexprprivate

Set Display Offset , set vertical shift

◆ SSD1306_SET_HIGHER_COLUMN

constexpr uint8_t SSD1306_RDL::SSD1306_SET_HIGHER_COLUMN = 0x10

staticconstexprprivate

Higher Col Start Addr : Page Addressing mode

◆ SSD1306_SET_LOWER_COLUMN

constexpr uint8_t SSD1306_RDL::SSD1306_SET_LOWER_COLUMN = 0x00

staticconstexprprivate

Lower Col Start Addr : Page Addressing mode

◆ SSD1306_SET_MULTIPLEX_RATIO

constexpr uint8_t SSD1306_RDL::SSD1306_SET_MULTIPLEX_RATIO = 0xA8

staticconstexprprivate

Set Multiplex Ratio

◆ SSD1306_SET_PAGE_ADDR

constexpr uint8_t SSD1306_RDL::SSD1306_SET_PAGE_ADDR = 0x22

staticconstexprprivate

Set Page Address

◆ SSD1306_SET_PRECHARGE_PERIOD

constexpr uint8_t SSD1306_RDL::SSD1306_SET_PRECHARGE_PERIOD = 0xD9

staticconstexprprivate

Set Pre-charge Period

◆ SSD1306_SET_SEGMENT_REMAP

constexpr uint8_t SSD1306_RDL::SSD1306_SET_SEGMENT_REMAP = 0xA0

staticconstexprprivate

Set Segment Re-map to SEG0

◆ SSD1306_SET_START_LINE

constexpr uint8_t SSD1306_RDL::SSD1306_SET_START_LINE = 0x40

staticconstexprprivate

Set display RAM display start line register from 0

◆ SSD1306_SET_VCOM_DESELECT

constexpr uint8_t SSD1306_RDL::SSD1306_SET_VCOM_DESELECT = 0xDB

staticconstexprprivate

Set VCOMH Deselect level

◆ SSD1306_SET_VERTICAL_SCROLL_AREA

constexpr uint8_t SSD1306_RDL::SSD1306_SET_VERTICAL_SCROLL_AREA = 0xA3

staticconstexprprivate

Set vertical scroll area command

◆ SSD1306_VERTICAL_AND_LEFT_HORIZONTAL_SCROLL

constexpr uint8_t SSD1306_RDL::SSD1306_VERTICAL_AND_LEFT_HORIZONTAL_SCROLL = 0x2A

staticconstexprprivate

Vertical and left horizontal scroll command

◆ SSD1306_VERTICAL_AND_RIGHT_HORIZONTAL_SCROLL

constexpr uint8_t SSD1306_RDL::SSD1306_VERTICAL_AND_RIGHT_HORIZONTAL_SCROLL = 0x29

staticconstexprprivate

Vertical and right horizontal scroll command

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

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SSD1306_RDL()

Member Function Documentation

◆ drawPixel()

◆ I2CWriteByte()

◆ OLED_I2C_OFF()

◆ OLED_I2C_ON()

◆ OLEDBufferScreen()

◆ OLEDCheckConnection()

◆ OLEDclearBuffer()

◆ OLEDContrast()

◆ OLEDEnable()

◆ OLEDFillPage()

◆ OLEDFillScreen()

◆ OLEDI2CErrorGet()

◆ OLEDI2CErrorRetryNumGet()

◆ OLEDI2CErrorRetryNumSet()

◆ OLEDI2CErrorTimeoutGet()

◆ OLEDI2CErrorTimeoutSet()

◆ OLEDinit()

◆ OLEDInvert()

◆ OLEDSetBufferPtr()

◆ OLEDStartScrollDiagLeft()

◆ OLEDStartScrollDiagRight()

◆ OLEDStartScrollLeft()

◆ OLEDStartScrollRight()

◆ OLEDupdate()

Member Data Documentation

◆ _I2C_ErrorDelay

◆ _I2C_ErrorFlag

◆ _I2C_ErrorRetryNum

◆ _OLED_HEIGHT

◆ _OLED_PAGE_NUM

◆ _OLED_WIDTH

◆ _OLEDbuffer

◆ _OLEDI2CAddress

◆ _OLEDI2CDevice

◆ _OLEDI2CFlags

◆ _OLEDI2CHandle

◆ SSD1306_ACTIVATE_SCROLL

◆ SSD1306_ADDR

◆ SSD1306_CHARGE_PUMP

◆ SSD1306_COM_SCAN_DIR_DEC

◆ SSD1306_COM_SCAN_DIR_INC

◆ SSD1306_COMMAND

◆ SSD1306_DATA

◆ SSD1306_DATA_CONTINUE

◆ SSD1306_DEACTIVATE_SCROLL

◆ SSD1306_DISPLAY_ALL_ON

◆ SSD1306_DISPLAY_ALL_ON_RESUME

◆ SSD1306_DISPLAY_OFF

◆ SSD1306_DISPLAY_ON

◆ SSD1306_INVERT_DISPLAY

◆ SSD1306_LEFT_HORIZONTAL_SCROLL

◆ SSD1306_MEMORY_ADDR_MODE

◆ SSD1306_NOP

◆ SSD1306_NORMAL_DISPLAY

◆ SSD1306_RIGHT_HORIZONTAL_SCROLL

◆ SSD1306_SET_COLUMN_ADDR

◆ SSD1306_SET_COM_PINS

◆ SSD1306_SET_CONTRAST_CONTROL

◆ SSD1306_SET_DISPLAY_CLOCK_DIV_RATIO

◆ SSD1306_SET_DISPLAY_OFFSET

◆ SSD1306_SET_HIGHER_COLUMN

◆ SSD1306_SET_LOWER_COLUMN

◆ SSD1306_SET_MULTIPLEX_RATIO

◆ SSD1306_SET_PAGE_ADDR

◆ SSD1306_SET_PRECHARGE_PERIOD

◆ SSD1306_SET_SEGMENT_REMAP

◆ SSD1306_SET_START_LINE

◆ SSD1306_SET_VCOM_DESELECT

◆ SSD1306_SET_VERTICAL_SCROLL_AREA

◆ SSD1306_VERTICAL_AND_LEFT_HORIZONTAL_SCROLL