Display control class, based on GraphicsDisplay and TextDisplay. More...

#include <SPI_TFT_ILI9341.h>

Inherits GraphicsDisplay.

Public Member Functions
	SPI_TFT_ILI9341 (PinName mosi, PinName miso, PinName sclk, PinName cs, PinName reset, PinName dc, const char *name="TFT")
	Create a SPI_TFT object connected to SPI and three pins.
virtual int	width ()
	Get the width of the screen in pixel.
virtual int	height ()
	Get the height of the screen in pixel.
virtual void	pixel (int x, int y, int colour)
	Draw a pixel at x,y with color.
void	circle (int x, int y, int r, int colour)
	draw a circle
void	fillcircle (int x, int y, int r, int colour)
	draw a filled circle
void	line (int x0, int y0, int x1, int y1, int colour)
	draw a 1 pixel line
void	rect (int x0, int y0, int x1, int y1, int colour)
	draw a rect
void	fillrect (int x0, int y0, int x1, int y1, int colour)
	draw a filled rect
virtual void	locate (int x, int y)
	setup cursor position
virtual void	cls (void)
	Fill the screen with _backgroun color.
virtual int	columns (void)
	calculate the max number of char in a line
virtual int	rows (void)
	calculate the max number of columns
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 (unsigned int x, unsigned int y, unsigned int w, unsigned int h, unsigned char *bitmap)
	paint a bitmap on the TFT
int	BMP_16 (unsigned int x, unsigned int y, const char *Name_BMP)
	paint a 16 bit BMP from filesytem on the TFT (slow)
void	set_font (unsigned char *f)
	select the font to use
void	set_orientation (unsigned int o)
	Set the orientation of the screen x,y: 0,0 is always top left.
int	Read_ID (void)
	read out the manufacturer ID of the LCD can used for checking the connection to the display
virtual bool	claim (FILE *stream)
	redirect output from a stream (stoud, sterr) to display
Protected Member Functions
void	WindowMax (void)
	Set draw window region to whole screen.
void	hline (int x0, int x1, int y, int colour)
	draw a horizontal line
void	vline (int y0, int y1, int x, int colour)
	draw a vertical line
virtual void	window (unsigned int x, unsigned int y, unsigned int w, unsigned int h)
	Set draw window region.
void	tft_reset ()
	Init the ILI9341 controller.
void	wr_dat (unsigned char value)
	Write data to the LCD controller.
void	wr_cmd (unsigned char value)
	Write a command the LCD controller.
char	rd_byte (unsigned char cmd)
	Start data sequence to the LCD controller.
virtual void	f_write (int data)
	Write a value to the to a LCD register.

Detailed Description

Display control class, based on GraphicsDisplay and TextDisplay.

Example:

 #include "stdio.h"
 #include "mbed.h"
 #include "SPI_TFT_ILI9341.h"
 #include "string"
 #include "Arial12x12.h"
 #include "Arial24x23.h"
 


 // the TFT is connected to SPI pin 5-7 and IO's 8-10
 SPI_TFT_ILI9341 TFT(p5, p6, p7, p8, p9, p10,"TFT"); // mosi, miso, sclk, cs, reset, dc
 If your display need a signal for switch the backlight use a aditional IO pin in your program 

 int main() {
     TFT.claim(stdout);      // send stdout to the TFT display 
     //TFT.claim(stderr);      // send stderr to the TFT display

     TFT.background(Black);    // set background to black
     TFT.foreground(White);    // set chars to white
     TFT.cls();                // clear the screen
     TFT.set_font((unsigned char*) Arial12x12);  // select the font
     
     TFT.set_orientation(0);
     printf("  Hello Mbed 0");
     TFT.set_font((unsigned char*) Arial24x23);  // select font 2
     TFT.locate(48,115);
     TFT.printf("Bigger Font");
  }

Definition at line 80 of file SPI_TFT_ILI9341.h.

Constructor & Destructor Documentation

SPI_TFT_ILI9341	(	PinName	mosi,
		PinName	miso,
		PinName	sclk,
		PinName	cs,
		PinName	reset,
		PinName	dc,
		const char *	name = `"TFT"`
	)

Create a SPI_TFT object connected to SPI and three pins.

Parameters:

mosi	pin connected to SDO of display
miso	pin connected to SDI of display
sclk	pin connected to RS of display
cs	pin connected to CS of display
reset	pin connected to RESET of display
dc	pin connected to WR of display the IM pins have to be set to 1110 (3-0)

Definition at line 35 of file SPI_TFT_ILI9341.cpp.

Member Function Documentation

int _putc ( int value ) [virtual]

put a char on the screen

Parameters:

value char to print

Returns:: printed char

Definition at line 590 of file SPI_TFT_ILI9341.cpp.

void Bitmap	(	unsigned int	x,
		unsigned int	y,
		unsigned int	w,
		unsigned int	h,
		unsigned char *	bitmap
	)

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 672 of file SPI_TFT_ILI9341.cpp.

int BMP_16	(	unsigned int	x,
		unsigned int	y,
		const char *	Name_BMP
	)

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 719 of file SPI_TFT_ILI9341.cpp.

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

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

Definition at line 605 of file SPI_TFT_ILI9341.cpp.

void circle	(	int	x,
		int	y,
		int	r,
		int	colour
	)

draw a circle

Parameters:

x0,y0	center
r	radius
color	16 bit color *

Definition at line 365 of file SPI_TFT_ILI9341.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

Definition at line 65 of file TextDisplay.cpp.

void cls ( void ) [virtual]

Fill the screen with _backgroun color.

Definition at line 358 of file SPI_TFT_ILI9341.cpp.

int columns ( void ) [virtual]

calculate the max number of char in a line

Returns:: max columns depends on actual font size

Definition at line 576 of file SPI_TFT_ILI9341.cpp.

void f_write ( int data ) [protected, virtual]

Write a value to the to a LCD register.

Parameters:

reg	register to be written
val	data to be written Read a LCD register
reg	register to be read

Returns:: value of the register fast SPI write function for optimized versions

Parameters:

data	data written to SPI

Definition at line 72 of file SPI_TFT_ILI9341_NUCLEO.cpp.

void fillcircle	(	int	x,
		int	y,
		int	r,
		int	colour
	)

draw a filled circle

Parameters:

x0,y0	center
r	radius
color	16 bit color *

Definition at line 384 of file SPI_TFT_ILI9341.cpp.

void fillrect	(	int	x0,
		int	y0,
		int	x1,
		int	y1,
		int	colour
	)

draw a filled rect

Parameters:

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

Definition at line 542 of file SPI_TFT_ILI9341.cpp.

int height ( ) [virtual]

Get the height of the screen in pixel.

Returns:: height of screen in pixel

Definition at line 53 of file SPI_TFT_ILI9341.cpp.

void hline	(	int	x0,
		int	x1,
		int	y,
		int	colour
	)		`[protected]`

draw a horizontal line

Parameters:

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

Definition at line 400 of file SPI_TFT_ILI9341.cpp.

void line	(	int	x0,
		int	y0,
		int	x1,
		int	y1,
		int	colour
	)

draw a 1 pixel line

Parameters:

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

Definition at line 450 of file SPI_TFT_ILI9341.cpp.

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

setup cursor position

Parameters:

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

Definition at line 568 of file SPI_TFT_ILI9341.cpp.

void pixel	(	int	x,
		int	y,
		int	colour
	)		`[virtual]`

Draw a pixel at x,y with color.

Parameters:

x	horizontal position
y	vertical position
color	16 bit pixel color

Definition at line 310 of file SPI_TFT_ILI9341.cpp.

char rd_byte ( unsigned char cmd ) [protected]

Start data sequence to the LCD controller.

Stop of data writing to the LCD controller write data to the LCD controller

Parameters:

data	to be written * Read byte from the LCD controller
cmd	comand to controller

Returns:: data from LCD controller

Definition at line 104 of file SPI_TFT_ILI9341.cpp.

int Read_ID ( void )

read out the manufacturer ID of the LCD can used for checking the connection to the display

Returns:: ID

Definition at line 141 of file SPI_TFT_ILI9341.cpp.

void rect	(	int	x0,
		int	y0,
		int	x1,
		int	y1,
		int	colour
	)

draw a rect

Parameters:

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

Definition at line 522 of file SPI_TFT_ILI9341.cpp.

int rows ( void ) [virtual]

calculate the max number of columns

Returns:: max column depends on actual font size

Definition at line 583 of file SPI_TFT_ILI9341.cpp.

void set_font ( unsigned char * f )

select the font to use

Parameters:

f	pointer to font array

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
the vertial size in pixel
the horizontal size in pixel
the number of byte per vertical line you also have to change the array to char[]

Definition at line 665 of file SPI_TFT_ILI9341.cpp.

void set_orientation ( unsigned int o )

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

Parameters:

o	direction to use the screen (0-3)

Definition at line 60 of file SPI_TFT_ILI9341.cpp.

void tft_reset ( ) [protected]

Init the ILI9341 controller.

Definition at line 153 of file SPI_TFT_ILI9341.cpp.

void vline	(	int	y0,
		int	y1,
		int	x,
		int	colour
	)		`[protected]`

draw a vertical line

Parameters:

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

Definition at line 425 of file SPI_TFT_ILI9341.cpp.

int width ( ) [virtual]

Get the width of the screen in pixel.

Returns:: width of screen in pixel

Definition at line 46 of file SPI_TFT_ILI9341.cpp.

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

Set draw window region.

Parameters:

x	horizontal position
y	vertical position
w	window width in pixel
h	window height in pixels

Definition at line 333 of file SPI_TFT_ILI9341.cpp.

void WindowMax ( void ) [protected]

Set draw window region to whole screen.

Definition at line 351 of file SPI_TFT_ILI9341.cpp.

void wr_cmd ( unsigned char value ) [protected]

Write a command the LCD controller.

Parameters:

cmd,: command to be written

Definition at line 85 of file SPI_TFT_ILI9341.cpp.

void wr_dat ( unsigned char value ) [protected]

Write data to the LCD controller.

Parameters:

dat	data written to LCD controller

Definition at line 95 of file SPI_TFT_ILI9341.cpp.

Type:	Library
Created:	12 Jun 2013
Imports:	4328
Forks:	12
Commits:	14
Dependents:	51
Dependencies:	0
Followers:	206
Issues:	6

SPI_TFT_ILI9341 Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Components

Important Information for this Arm website

SPI_TFT_ILI9341 Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Components

Important Information for this Arm website

Access Warning