Class AmebaILI9341

AmebaILI9341 Class

Description

A class to use ILI9341 TFT SPI display driver on Ameba.

Syntax

class AmebaILI9341

Members

Public Constructors
AmebaILI9341::AmebaILI934	Constructs an AmebaILI9341 object
Public Methods
AmebaILI9341::begin	Initialize SPI, pin mapping and screen configuration
AmebaILI9341::setAddress	Initialize image size and position
AmebaILI9341::writecommand	SPI transfer a command
AmebaILI9341::writedata	SPI transfer a piece of data
AmebaILI9341::setRotation	Set screen orientation
AmebaILI9341::fillScreen	Fill the screen with a color
AmebaILI9341::clr	Clear screen
AmebaILI9341::fillScreen	Fill a rectangle shape with color and display on the screen.
AmebaILI9341::drawPixel	Draw a pixel by coordinates on the screen
AmebaILI9341::drawChar	Draw a character in the frame buffer but does not refresh.
AmebaILI9341::drawLine	Draw a line and display on the screen
AmebaILI9341::drawRectangle	Draw a rectangular shape and display on the screen.
AmebaILI9341::drawCircle	Draw a circle shape and display on the screen
AmebaILI9341::write	Display a character and display on the screen
AmebaILI9341::getWidth	Get the width of the image
AmebaILI9341::getHeight	Get the height of the image
AmebaILI9341::setCursor	Set the cursor to a specific position on the screen
AmebaILI9341::setForeground	Set foreground color
AmebaILI9341::setBackground	Set background color
AmebaILI9341::setFontSize	Set character font size
AmebaILI9341::reset	Reset the module

AmebaILI9341::AmebaILI9341

Description

The main class constructor when using AmebaILI9341 SPI display modules.

Syntax

AmebaILI9341(int csPin, int dcPin, int resetPin);

Parameters

csPin: the Chip Select pin

dcPin: the Data Command pin

resetPin: the Reset pin

Example Code

Example: LCD_Screen_ILI9341_TFT

Note

“AmebaILI9341.h” must be included to use the class function.

AmebaILI9341::begin

Description

Initialize hardware SPI, configure SPI DC and Reset pin mapping and SPI screen hardware module configuration including power control, memory access control, etc.

Syntax

void begin(void);

Example Code

Example: LCD_Screen_ILI9341_TFT

Note

“AmebaILI9341.h” must be included to use the class function. This method is required to run first before other operations on the display.

AmebaILI9341::setAddress

Description

Initialize image size and positioning on the display

Syntax

void setAddress(uint16_t x0, uint16_t y0, uint16_t x1, uint16_t y1);

Parameters

x0: leftmost coordinate of the image

y0: top coordinate of the image

x1: rightmost coordinate of the image

y1: bottom coordinate of the image

Example Code

NA

Note

Do not use this to set the cursor, use “setCursor” method instead. “AmebaILI9341.h” must be included to use the class function.

AmebaILI9341::writecommand

Description

Write a SPI command to the hardware peripheral

Syntax

void writecommand(uint8_t command);

Example Code

NA

Note

“AmebaILI9341.h” must be included to use the class function.

AmebaILI9341::writedata

Description

Write a SPI data to the hardware peripheral

Syntax

void writedata(uint8_t data);

Example Code

NA

Note

Only use this method to write 1 byte at a time. “AmebaILI9341.h” must be included to use the class function.

AmebaILI9341::setRotation

Description

Setting screen orientation, “0” for no rotation, “1” for 90 degrees rotation, “2” for 180 degrees rotation, “3” for 270 degrees rotation.

Syntax

void setRotation(uint8_t m);

Parameters

m: select desired screen orientation, expressing it as an integer. Defualt value is “0”.

Although “0” for no rotation, “1” for 90 degrees rotation, “2” for 180 degrees rotation, “3” for 270 degrees rotation, if m is more than 3, for example, m = 4 : there will be no rotation, m = 5 : 90 degrees rotation and so on. “AmebaILI9341.h” must be included to use the class function.

AmebaILI9341::fillScreen

Description

Fill the entire screen with a single color

Syntax

void fillScreen(uint16_t color);

Parameters

color: a 16-bit color, color definition (RGB565) can be found in AmebaILI9341.h

Returns

NA

Example Code

NA

Note

Refer to “AmebaILI9341.h” for available colors. “AmebaILI9341.h” must be included to use the class function.

AmebaILI9341::clr

Description

Clear the screen.

Syntax

void clr (void);

Parameters

NA

Returns

NA

Example Code

Example: LCD_Screen_ILI9341_TFT

Note

Background color can be changed by calling setBackground(). Refer to “AmebaILI9341.h” for available colors of setBackground() function input parameter. “AmebaILI9341.h” must be included to use the class function.

AmebaILI9341::fillRectangle

Description

Fill a rectangle shape with color and display on the screen.

Syntax

void fillRectangle(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color);

Parameters

x: leftmost coordinate of the rectangle shape

y: top coordinate of the rectangle shape

w: width of the rectangle shape

h: height of the rectangle shape

color: the color of the rectangle shape

Returns

NA

Example Code

Example: LCD_Screen_ILI9341_TFT

Note

Refer to “AmebaILI9341.h” for available colors. “AmebaILI9341.h” must be included to use the class function.

AmebaILI9341::drawPixel

Description

Draw a single pixel by coordinates on the screen.

Syntax

void drawPixel(int16_t x, int16_t y, uint16_t color);

Parameters

x: leftmost coordinate of the pixel

y: top coordinate of the pixel

color: the color of the pixel

Returns

NA

Example Code

NA

Note

Refer to “AmebaILI9341.h” for available colors. “AmebaILI9341.h” must be included to use the class function.

AmebaILI9341::drawChar

Description

Draw a character in the frame buffer but does not refresh.

Syntax

void AmebaILI9341::drawChar(unsigned char c);
void AmebaILI9341::drawChar(int16_t x, int16_t y, unsigned char c, uint16_t _fontcolor, uint16_t _background, uint8_t _fontsize);

Parameters

x: leftmost coordinate of the character

y: top coordinate of the character

c: a character

_fontcolor: character font color

_background: character background color

_fontsize: character font size

Returns

NA

Example Code

NA

Note

This method only stores the string of character in a buffer frame. The Print/Println method have to be called in order to display a string of character on the serial monitor. Refer to “AmebaILI9341.h” for available colors. “AmebaILI9341.h” must be included to use the class function.

AmebaILI9341::drawLine

Description

Draw a line and display on the screen.

Syntax

void drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t color);
void drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1);

Parameters

x0: leftmost coordinate of the line

y0: top coordinate of the line

x1: leftmost coordinate of the line

y1: top coordinate of the line

color: the color of the line

Returns

NA

Example Code

NA

Note

Refer to “AmebaILI9341.h” for available colors. “AmebaILI9341.h” must be included to use the class function.

AmebaILI9341::drawRectangle

Description

Draw a rectangular shape and display on the screen.

Syntax

void drawRectangle(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color);
void drawRectangle(int16_t x, int16_t y, int16_t w, int16_t h);

Parameters

x: leftmost coordinate of the rectangular shape

y: top coordinate of the rectangular shape

w: width of the rectangular shape

h: height of the rectangular shape

color: the color of the rectangular shape outline

Returns

NA

Example Code

NA

Note

Refer to AmebaILI9341.h for available colors. “AmebaILI9341.h” must be included to use the class function.

AmebaILI9341::drawCircle

Description

Draw a circle shape and display on the screen.

Syntax

void drawCircle(int16_t x0, int16_t y0, int16_t r, uint16_t color);
void drawCircle(int16_t x0, int16_t y0, int16_t r);

Parameters

x0: leftmost coordinate of the circle shape

y0: top coordinate of the circle shape

r: radius of the circle shape

color: the color of the circle shape outline

Returns

NA

Example Code

NA

Note

Refer to AmebaILI9341.h for available colors. “AmebaILI9341.h” must be included to use the class function.

AmebaILI9341::write

Description

Display a character and display on the screen.

Syntax

virtual size_t write(uint8_t);

Parameters

c: a character to be written on the screen

Returns

This function returns the number of bytes written.

Example Code

NA

Note

This an inherited method from Print class and is seldom used. “AmebaILI9341.h” must be included to use the class function.

AmebaILI9341::getWidth

Description

Get the width of the image.

Syntax

int16_t getWidth(void);

Parameters

NA

Returns

This function returns the width of the image.

Example Code

NA

Note

The width is defined in” AmebaILI9341.h”. “AmebaILI9341.h” must be included to use the class function.

AmebaILI9341::getHeight

Description

Get the height of the image.

Syntax

int16_t getHeight(void);

Parameters

NA

Returns

This function returns the height of the image.

Example Code

NA

Note

The height is defined in” AmebaILI9341.h”. “AmebaILI9341.h” must be included to use the class function.

AmebaILI9341::setCursor

Description

Set the cursor to a specific position on the screen.

Syntax

void setCursor(int16_t x, int16_t y);

Parameters

x: coordinate on the x-axis

y: coordinate on the y-axis

Returns

NA

Example Code

Example: LCD_Screen_ILI9341_TFT

Note

“AmebaILI9341.h” must be included to use the class function.

AmebaILI9341::setForeground

Description

Set foreground color.

Syntax

void setForeground(uint16_t color);

Parameters

color: desired colors for foreground

Returns

NA

Example Code

Example: LCD_Screen_ILI9341_TFT

Note

testText() function, to set foreground colors for different font sizes. Refer to AmebaILI9341.h for available colors. “AmebaILI9341.h” must be included to use the class function.

void setBackground(uint16_t color);

Refer to AmebaILI9341.h for available colors. “AmebaILI9341.h” must be included to use the class function.

void AmebaILI9341::setFontSize(uint8_t size)

“AmebaILI9341.h” must be included to use the class function.

void reset(void);

“AmebaILI9341.h” must be included to use the class function.