Class for SSD1306 display controller to be copypasted and adapted for other controllers. More...

#include <SSD1306.h>

Inherits LCD.

Public Member Functions
	SSD1306 (proto_t displayproto, PortName port, PinName CS, PinName reset, PinName DC, PinName WR, PinName RD, const char *name, unsigned int LCDSIZE_X=128, unsigned int LCDSIZE_Y=64)
	Create a PAR display interface.
	SSD1306 (proto_t displayproto, int Hz, PinName mosi, PinName miso, PinName sclk, PinName CS, PinName reset, PinName DC, const char *name, unsigned int LCDSIZE_X=128, unsigned int LCDSIZE_Y=64)
	Create an SPI display interface.
virtual void	set_contrast (int o)
	set the contrast of the screen
void	horizontal_scroll (int l_r, int s_page, int e_page, int speed)
	set automatc horizontal scroll mode
void	horiz_vert_scroll (int l_r, int s_page, int e_page, int v_off, int speed)
	automatic horizontal + vertical scroll mode
void	end_scroll (void)
	end scroll mode
virtual void	pixel (int x, int y, unsigned short color)
	Draw a pixel in the specified color.
virtual void	window (int x, int y, int w, int h)
	Set the window, which controls where items are written to the screen.
virtual unsigned short	pixelread (int x, int y)
	Read pixel color at location.
virtual void	window_pushpixel (unsigned short color)
	Push a single pixel into the window and increment position.
virtual void	window_pushpixel (unsigned short color, unsigned int count)
	Push some pixels of the same color into the window and increment position.
virtual void	window_pushpixelbuf (unsigned short *color, unsigned int lenght)
	Push array of pixel colors into the window and increment position.
virtual void	copy_to_lcd ()
	Framebuffer is used, it needs to be sent to LCD from time to time.
int	get_contrast (void)
	read the contrast level
void	invert (unsigned char o)
	display inverted colors
virtual void	cls ()
	clear the entire screen The inherited one sets windomax then fill with background color We override it to speedup
void	set_orientation (int o)
	Set the orientation of the screen x,y: 0,0 is always top left.
virtual void	BusEnable (bool enable)
	Set ChipSelect high or low.
int	sizeX ()
	get display X size in pixels (native, orientation independent)
int	sizeY ()
	get display Y size in pixels (native, orientation independent)
virtual void	WindowMax (void)
	Set window to max possible size May be overridden in a derived class.
virtual void	circle (int x, int y, int r, unsigned short color)
	draw a circle
virtual void	fillcircle (int x, int y, int r, unsigned short color)
	draw a filled circle
virtual void	line (int x0, int y0, int x1, int y1, unsigned short color)
	draw a 1 pixel line
void	hline (int x0, int x1, int y, unsigned short color)
	draw a horizontal line
void	vline (int y0, int y1, int x, unsigned short color)
	draw a vertical line
virtual void	rect (int x0, int y0, int x1, int y1, unsigned short color)
	draw a rect
virtual void	fillrect (int x0, int y0, int x1, int y1, unsigned short color)
	draw a filled rect
virtual void	locate (int x, int y)
	setup cursor position for text
virtual int	_putc (int value)
	put a char on the screen
virtual void	character (int x, int y, int c)
	draw a character on given position out of the active font to the TFT
void	Bitmap (int x, int y, int w, int h, unsigned char *bitmap)
	paint a bitmap on the TFT
void	Bitmap_BW (Bitmap_s bm, int x, int y)
	paint monochrome bitmap to screen
int	BMP_16 (int x, int y, const char *Name_BMP)
	paint a 16 bit BMP from filesytem on the TFT (slow)
void	set_font (unsigned char *f, unsigned char firstascii=32, unsigned char lastascii=127, bool proportional=true)
	select the font to use
virtual int	columns ()
	Get the number of columns based on the currently active font.
virtual int	rows ()
	Get the number of rows based on the currently active font.
int	width ()
	get the current oriented screen width in pixels
int	height ()
	get the current oriented screen height in pixels
void	set_width (int width)
	set the current oriented screen width in pixels
void	set_height (int height)
	set the current oriented screen height in pixels
void	set_auto_up (bool up)
	setup auto update of screen
bool	get_auto_up (void)
	get status of the auto update function
virtual bool	claim (FILE *stream)
	redirect output from a stream (stoud, sterr) to display
virtual void	foreground (uint16_t colour)
	set the foreground color
virtual void	background (uint16_t colour)
	set the background color
Protected Member Functions
void	init ()
	Init command sequence.
virtual void	mirrorXY (mirror_t mode)
	set mirror mode
void	wr_cmd8 (unsigned char cmd)
	Send 8bit command to display controller.
void	wr_data8 (unsigned char data)
	Send 8bit data to display controller.
void	wr_cmd16 (unsigned short cmd)
	Send 16bit command to display controller.
virtual void	wr_gram (unsigned short data, unsigned int count)
	Send same 16bit pixeldata to display controller multiple times.
virtual void	wr_grambuf (unsigned short *data, unsigned int lenght)
	Send array of pixeldata shorts to display controller.
void	hw_reset ()
	HW reset sequence (without display init commands)

Detailed Description

Class for SSD1306 display controller to be copypasted and adapted for other controllers.

Definition at line 10 of file SSD1306.h.

Constructor & Destructor Documentation

SSD1306	(	proto_t	displayproto,
		PortName	port,
		PinName	CS,
		PinName	reset,
		PinName	DC,
		PinName	WR,
		PinName	RD,
		const char *	name,
		unsigned int	LCDSIZE_X = `128`,
		unsigned int	LCDSIZE_Y = `64`
	)

Create a PAR display interface.

Parameters:

displayproto	only supports PAR_8
port	GPIO port name to use
CS	pin connected to CS of display
reset	pin connected to RESET of display
DC	pin connected to data/command of display
WR	pin connected to SDI of display
RD	pin connected to RS of display
name	The name used by the parent class to access the interface
LCDSIZE_X	x size in pixel - optional
LCDSIZE_Y	y size in pixel - optional

Definition at line 39 of file SSD1306.cpp.

SSD1306	(	proto_t	displayproto,
		int	Hz,
		PinName	mosi,
		PinName	miso,
		PinName	sclk,
		PinName	CS,
		PinName	reset,
		PinName	DC,
		const char *	name,
		unsigned int	LCDSIZE_X = `128`,
		unsigned int	LCDSIZE_Y = `64`
	)

Create an SPI display interface.

Parameters:

displayproto	SPI_8 or SPI_16
Hz	SPI speed in Hz
mosi	SPI pin
miso	SPI pin
sclk	SPI pin
CS	pin connected to CS of display
reset	pin connected to RESET of display
DC	pin connected to data/command of display
name	The name used by the parent class to access the interface
LCDSIZE_X	x size in pixel - optional
LCDSIZE_Y	y size in pixel - optional

Definition at line 49 of file SSD1306.cpp.

Member Function Documentation

int _putc ( int value ) [virtual, inherited]

put a char on the screen

Parameters:

value char to print

Returns:: printed char

Reimplemented from TextDisplay.

Definition at line 248 of file GraphicsDisplay.cpp.

void background ( uint16_t colour ) [virtual, inherited]

set the background color

Note:: this method may be overridden in a derived class.

Parameters:

color is color to use for background drawing.

Definition at line 61 of file TextDisplay.cpp.

void Bitmap	(	int	x,
		int	y,
		int	w,
		int	h,
		unsigned char *	bitmap
	)		`[inherited]`

paint a bitmap on the TFT

Parameters:

x,y	: upper left corner
w	width of bitmap
h	high of bitmap
*bitmap	pointer to the bitmap data

bitmap format: 16 bit R5 G6 B5

use Gimp to create / load , save as BMP, option 16 bit R5 G6 B5 use winhex to load this file and mark data stating at offset 0x46 to end use edit -> copy block -> C Source to export C array paste this array into your program

define the array as static const unsigned char to put it into flash memory cast the pointer to (unsigned char *) : tft.Bitmap(10,40,309,50,(unsigned char *)scala);

Definition at line 334 of file GraphicsDisplay.cpp.

void Bitmap_BW	(	Bitmap_s	bm,
		int	x,
		int	y
	)		`[inherited]`

paint monochrome bitmap to screen

Parameters:

bm	Bitmap in flash
x	x start
y	y start

Definition at line 309 of file GraphicsDisplay.cpp.

int BMP_16	(	int	x,
		int	y,
		const char *	Name_BMP
	)		`[inherited]`

paint a 16 bit BMP from filesytem on the TFT (slow)

Parameters:

x,y	: position of upper left corner
*Name_BMP	name of the BMP file with drive: "/local/test.bmp"

Returns:: 1 if bmp file was found and painted; 0 if bmp file was found not found; -1 if file is no bmp; -2 if bmp file is no 16 bit bmp; -3 if bmp file is to big for screen; -4 if buffer malloc go wrong

bitmap format: 16 bit R5 G6 B5

use Gimp to create / load , save as BMP, option 16 bit R5 G6 B5 copy to internal file system or SD card

Definition at line 360 of file GraphicsDisplay.cpp.

void BusEnable ( bool enable ) [virtual, inherited]

Set ChipSelect high or low.

Parameters:

enable 0/1

Reimplemented in UC1608.

Definition at line 121 of file LCD.cpp.

void character	(	int	x,
		int	y,
		int	c
	)		`[virtual, inherited]`

draw a character on given position out of the active font to the TFT

Parameters:

x	x-position of char (top left)
y	y-position
c	char to print

Implements TextDisplay.

Definition at line 262 of file GraphicsDisplay.cpp.

void circle	(	int	x,
		int	y,
		int	r,
		unsigned short	color
	)		`[virtual, inherited]`

draw a circle

Parameters:

x0,y0	center
r	radius
color	16 bit color *

Definition at line 58 of file GraphicsDisplay.cpp.

bool claim ( FILE * stream ) [virtual, inherited]

redirect output from a stream (stoud, sterr) to display

Parameters:

stream stream that shall be redirected to the TextDisplay

Note:: this method may be overridden in a derived class.

Returns:: true if the claim succeeded.

Definition at line 65 of file TextDisplay.cpp.

void cls ( void ) [virtual, inherited]

clear the entire screen The inherited one sets windomax then fill with background color We override it to speedup

Reimplemented from GraphicsDisplay.

Definition at line 294 of file LCD.cpp.

int columns ( ) [virtual, inherited]

Get the number of columns based on the currently active font.

Returns:: number of columns.

Note:: this method may be overridden in a derived class.

Implements TextDisplay.

Definition at line 226 of file GraphicsDisplay.cpp.

void copy_to_lcd ( void ) [virtual, inherited]

Framebuffer is used, it needs to be sent to LCD from time to time.

Implements GraphicsDisplay.

Definition at line 280 of file LCD.cpp.

void end_scroll ( void )

end scroll mode

Definition at line 175 of file SSD1306.cpp.

void fillcircle	(	int	x,
		int	y,
		int	r,
		unsigned short	color
	)		`[virtual, inherited]`

draw a filled circle

Parameters:

x0,y0	center
r	radius
color	16 bit color *

Definition at line 75 of file GraphicsDisplay.cpp.

void fillrect	(	int	x0,
		int	y0,
		int	x1,
		int	y1,
		unsigned short	color
	)		`[virtual, inherited]`

draw a filled rect

Parameters:

x0,y0	top left corner
x1,y1	down right corner
color	16 bit color

Definition at line 207 of file GraphicsDisplay.cpp.

void foreground ( uint16_t colour ) [virtual, inherited]

set the foreground color

Note:: this method may be overridden in a derived class.

Parameters:

color is color to use for foreground drawing.

Definition at line 57 of file TextDisplay.cpp.

bool get_auto_up ( void ) [inherited]

get status of the auto update function

Returns:: if auto update is on

Definition at line 456 of file GraphicsDisplay.cpp.

int get_contrast ( void ) [inherited]

read the contrast level

Definition at line 203 of file LCD.cpp.

int height ( ) [inherited]

get the current oriented screen height in pixels

Returns:: screen height in pixels.

Definition at line 54 of file GraphicsDisplay.cpp.

void hline	(	int	x0,
		int	x1,
		int	y,
		unsigned short	color
	)		`[inherited]`

draw a horizontal line

Parameters:

x0	horizontal start
x1	horizontal stop
y	vertical position
color	16 bit color

Definition at line 96 of file GraphicsDisplay.cpp.

void horiz_vert_scroll	(	int	l_r,
		int	s_page,
		int	e_page,
		int	v_off,
		int	speed
	)

automatic horizontal + vertical scroll mode

Parameters:

l_r	direction - left = 0, right = 1
s_page	start page
e_page	end page
v_off	vertical offset for scroll
speed	time between horizontal shift. 0 slow .. 7 fast

Definition at line 161 of file SSD1306.cpp.

void horizontal_scroll	(	int	l_r,
		int	s_page,
		int	e_page,
		int	speed
	)

set automatc horizontal scroll mode

Parameters:

l_r	direction - left = 0, right = 1
s_page	start page
e_page	end page
speed	time between horizontal shift. 0 slow .. 7 fast

Definition at line 148 of file SSD1306.cpp.

void hw_reset ( ) [protected, inherited]

HW reset sequence (without display init commands)

Definition at line 117 of file LCD.cpp.

void init ( ) [protected]

Init command sequence.

Definition at line 60 of file SSD1306.cpp.

void invert ( unsigned char o ) [inherited]

display inverted colors

Parameters:

o	= 0 normal, 1 invert

Definition at line 190 of file LCD.cpp.

void line	(	int	x0,
		int	y0,
		int	x1,
		int	y1,
		unsigned short	color
	)		`[virtual, inherited]`

draw a 1 pixel line

Parameters:

x0,y0	start point
x1,y1	stop point
color	16 bit color

Definition at line 114 of file GraphicsDisplay.cpp.

void locate	(	int	x,
		int	y
	)		`[virtual, inherited]`

setup cursor position for text

Parameters:

x	x-position (top left)
y	y-position

Reimplemented from TextDisplay.

Definition at line 221 of file GraphicsDisplay.cpp.

void mirrorXY ( mirror_t mode ) [protected, virtual]

set mirror mode

Note:: here overriding the LCD class default one because of not standard commands

Parameters:

mode	NONE, X, Y, XY

Reimplemented from LCD.

Definition at line 112 of file SSD1306.cpp.

void pixel	(	int	x,
		int	y,
		unsigned short	color
	)		`[virtual, inherited]`

Draw a pixel in the specified color.

Parameters:

x	is the horizontal offset to this pixel.
y	is the vertical offset to this pixel.
color	defines the color for the pixel.

Implements GraphicsDisplay.

Definition at line 262 of file LCD.cpp.

unsigned short pixelread	(	int	x,
		int	y
	)		`[virtual, inherited]`

Read pixel color at location.

Parameters:

x	is the horizontal offset to this pixel.
y	is the vertical offset to this pixel.

Returns:: 16bit color, 0000=Black(pixel set), FFFF=White(pixel clear).

Definition at line 271 of file LCD.cpp.

void rect	(	int	x0,
		int	y0,
		int	x1,
		int	y1,
		unsigned short	color
	)		`[virtual, inherited]`

draw a rect

Parameters:

x0,y0	top left corner
x1,y1	down right corner
color	16 bit color *

Definition at line 185 of file GraphicsDisplay.cpp.

int rows ( ) [virtual, inherited]

Get the number of rows based on the currently active font.

Returns:: number of rows.

Note:: this method may be overridden in a derived class.

Implements TextDisplay.

Definition at line 230 of file GraphicsDisplay.cpp.

void set_auto_up ( bool up ) [inherited]

setup auto update of screen

Parameters:

up	1 = on , 0 = off if switched off the program has to call copy_to_lcd() to update screen from framebuffer

Definition at line 451 of file GraphicsDisplay.cpp.

void set_contrast ( int o ) [virtual]

set the contrast of the screen

Note:: here overrided because of not standard value range

Parameters:

o	contrast 0-255

Reimplemented from LCD.

Definition at line 131 of file SSD1306.cpp.

void set_font	(	unsigned char *	f,
		unsigned char	firstascii = `32`,
		unsigned char	lastascii = `127`,
		bool	proportional = `true`
	)		`[inherited]`

select the font to use

Parameters:

f	pointer to font array
firstascii	first ascii code present in font array, default 32 (space)
lastascii	last ascii code present in font array, default 127 (DEL)
proportional	enable/disable variable font width (default enabled)

font array can created with GLCD Font Creator from http://www.mikroe.com you have to add 4 parameter at the beginning of the font array to use:

the number of byte / char (not used in this revision, set to whatever)
the vertial size in pixel
the horizontal size in pixel
the number of byte per vertical line (not used in this revision, set to whatever) you also have to change the array to cont unsigned char[] and __align(2)

Definition at line 234 of file GraphicsDisplay.cpp.

void set_height ( int height ) [inherited]

set the current oriented screen height in pixels

Parameters:

height screen height in pixels.

Definition at line 46 of file GraphicsDisplay.cpp.

void set_orientation ( int o ) [inherited]

Set the orientation of the screen x,y: 0,0 is always top left.

Parameters:

o	direction to use the screen (0-3) 0 = -90° 1 = default 0° 2 = +90° 3 = +180°

Definition at line 130 of file LCD.cpp.

void set_width ( int width ) [inherited]

set the current oriented screen width in pixels

Parameters:

width screen width in pixels.

Definition at line 42 of file GraphicsDisplay.cpp.

int sizeX ( ) [inherited]

get display X size in pixels (native, orientation independent)

Returns:: X size in pixels

Definition at line 308 of file LCD.cpp.

int sizeY ( ) [inherited]

get display Y size in pixels (native, orientation independent)

Returns:: Y size in pixels

Definition at line 312 of file LCD.cpp.

void vline	(	int	y0,
		int	y1,
		int	x,
		unsigned short	color
	)		`[inherited]`

draw a vertical line

Parameters:

x	horizontal position
y0	vertical start
y1	vertical stop
color	16 bit color

Definition at line 105 of file GraphicsDisplay.cpp.

int width ( ) [inherited]

get the current oriented screen width in pixels

Returns:: screen width in pixels.

Definition at line 50 of file GraphicsDisplay.cpp.

void window	(	int	x,
		int	y,
		int	w,
		int	h
	)		`[virtual, inherited]`

Set the window, which controls where items are written to the screen.

When something hits the window width, it wraps back to the left side and down a row. If the initial write is outside the window, it will be captured into the window when it crosses a boundary.

Parameters:

x	is the left edge in pixels.
y	is the top edge in pixels.
w	is the window width in pixels.
h	is the window height in pixels.

Implements GraphicsDisplay.

Definition at line 207 of file LCD.cpp.

void window_pushpixel ( unsigned short color ) [virtual, inherited]

Push a single pixel into the window and increment position.

You must first call window() then push pixels in loop.

Parameters:

color is the pixel color.

Implements GraphicsDisplay.

Definition at line 217 of file LCD.cpp.

void window_pushpixel	(	unsigned short	color,
		unsigned int	count
	)		`[virtual, inherited]`

Push some pixels of the same color into the window and increment position.

You must first call window() then push pixels.

Parameters:

color	is the pixel color.
count,:	how many

Implements GraphicsDisplay.

Definition at line 228 of file LCD.cpp.

void window_pushpixelbuf	(	unsigned short *	color,
		unsigned int	lenght
	)		`[virtual, inherited]`

Push array of pixel colors into the window and increment position.

You must first call window() then push pixels.

Parameters:

color is the pixel color.

Implements GraphicsDisplay.

Definition at line 245 of file LCD.cpp.

void WindowMax ( void ) [virtual, inherited]

Set window to max possible size May be overridden in a derived class.

Definition at line 38 of file GraphicsDisplay.cpp.

void wr_cmd16 ( unsigned short cmd ) [protected, inherited]

Send 16bit command to display controller.

Parameters:

cmd,: halfword to send

Definition at line 105 of file LCD.cpp.

void wr_cmd8 ( unsigned char cmd ) [protected, inherited]

Send 8bit command to display controller.

Parameters:

cmd,: byte to send

Note:: if protocol is SPI16, it will insert NOP cmd before, so if cmd is a 2byte cmd, the second cmd will be broken. Use wr_cmd16 for 2bytes cmds

Definition at line 96 of file LCD.cpp.

void wr_data8 ( unsigned char data ) [protected, inherited]

Send 8bit data to display controller.

Parameters:

data,: byte to send

Definition at line 101 of file LCD.cpp.

void wr_gram	(	unsigned short	data,
		unsigned int	count
	)		`[protected, virtual, inherited]`

Send same 16bit pixeldata to display controller multiple times.

Parameters:

data,:	halfword to send
count,:	how many

Definition at line 109 of file LCD.cpp.

void wr_grambuf	(	unsigned short *	data,
		unsigned int	lenght
	)		`[protected, virtual, inherited]`

Send array of pixeldata shorts to display controller.

Parameters:

data,:	unsigned short pixeldata array
lenght,:	lenght (in shorts)

Definition at line 113 of file LCD.cpp.

Type:	Library
Created:	06 May 2015
Imports:	7
Forks:	0
Commits:	23
Dependents:	0
Dependencies:	0
Followers:	1

SSD1306 Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

SSD1306 Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning