Class to control GC9A01 TFT basic functionality. More...

#include <GC9A01_TFT_LCD_RDL.hpp>

Inheritance diagram for GC9A01_TFT:

[legend]

Classes
struct	MADCTL_FLAGS_t
	MADCTL bit flags for register GC9A01_MADCTL (0x36). More...

Public Types
enum class	PowerState_e : uint8_t { NormalIdleOff , NormalIdleOn , PartialIdleOff , PartialIdleOn , SleepNormalIdleOff , SleepNormalIdleOn , SleepPartialIdleOff , SleepPartialIdleOn }
	GC9A01 power states based on the power control flow chart. These states combine the modes: Normal/Partial, Idle ON/OFF, and Sleep IN/OUT. They are listed from highest to lowest power consumption. Power states are based on the power control flow chart in the datasheet. FIG 89 5.10.2. Power Flow Chart. More...

Public Types inherited from color16_graphics
enum	pixel_color565_e : uint16_t { RDLC_BLACK = 0x0000 , RDLC_BLUE = 0x001F , RDLC_RED = 0xF800 , RDLC_GREEN = 0x07E0 , RDLC_CYAN = 0x07FF , RDLC_MAGENTA = 0xF81F , RDLC_YELLOW = 0xFFE0 , RDLC_WHITE = 0xFFFF , RDLC_TAN = 0xED01 , RDLC_GREY = 0x9CD1 , RDLC_BROWN = 0x6201 , RDLC_DGREEN = 0x01C0 , RDLC_ORANGE = 0xFC00 , RDLC_NAVY = 0x000F , RDLC_DCYAN = 0x03EF , RDLC_MAROON = 0x7800 , RDLC_PURPLE = 0x780F , RDLC_OLIVE = 0x7BE0 , RDLC_LGREY = 0xC618 , RDLC_DGREY = 0x7BEF , RDLC_GYELLOW = 0xAFE5 , RDLC_PINK = 0xFC18 , RDLC_LBLUE = 0x7E5F , RDLC_BEIGE = 0xB5D2 }
	16-bit color definitions (RGB565 format). More...

enum	display_rotate_e : uint8_t { Degrees_0 = 0 , Degrees_90 , Degrees_180 , Degrees_270 }

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

Public Member Functions
	GC9A01_TFT ()
	Constructor for class GC9A01_TFT.

virtual void	setAddrWindow (uint16_t, uint16_t, uint16_t, uint16_t) override
	SPI displays set an address window rectangle for blitting pixels.

void	TFTSetupGPIO (int8_t, int8_t, int8_t, int8_t, int8_t)
	sets up TFT GPIO for software SPI

void	TFTSetupGPIO (int8_t, int8_t)
	sets up TFT GPIO for Hardware SPi

void	TFTInitScreenSize (uint16_t w, uint16_t h)
	initialise the variables that define the size of the screen

rdlib::Return_Codes_e	TFTInitSPI (uint16_t CommDelay, int gpioDev)
	intialise PCBtype and SPI, Software SPI

rdlib::Return_Codes_e	TFTInitSPI (int device, int channel, int speed, int flags, int gpioDev)
	intialise SPI, Hardware SPI

rdlib::Return_Codes_e	TFTPowerDown (void)
	Call when powering down TFT.

uint16_t	HighFreqDelayGet (void)
	Freq delay used in SW SPI getter, uS delay used in SW SPI method.

void	HighFreqDelaySet (uint16_t)
	Freq delay used in SW SPI setter, uS delay used in SW SPI method.

rdlib::Return_Codes_e	TFTResetPin (void)
	Method for Hardware Reset pin control.

void	TFTsetRotation (display_rotate_e r)
	: change rotation of display.

void	TFTchangeInvertMode (bool m)
	Toggle the invert mode.

void	TFTsetPowerMode (PowerState_e m)
	Set the power mode of the display.

void	TFTenableDisplay (bool m)
	enable /disable display mode

void	TFTsetBrightness (uint8_t level)
	Set display brightness (0–255).

void	TFTsetScrollArea (uint16_t topFixed, uint16_t scrollArea, uint16_t bottomFixed)
	This method defines the Vertical Scrolling Area of the display where:

void	TFTsetScrollStart (uint16_t vsp)
	This method is used together with the setScrollDefinition.

void	TFTScrollModeLeave (void)
	Scroll Mode can be left ,by the Normal Display Mode ON cmd.

Public Member Functions inherited from color16_graphics
	color16_graphics ()
	Construct a new graphics class object.

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

void	setCursor (int16_t x, int16_t y)
	Set the Cursor Position on screen.

void	drawPixel (uint16_t, uint16_t, uint16_t)
	Draw a pixel to screen.

rdlib::Return_Codes_e	drawDotGrid (int16_t x, int16_t y, int16_t w, int16_t h, uint8_t DotGridGap, uint16_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, uint16_t color)
	draws a line from (x0,y0) to (x1,y1).

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

rdlib::Return_Codes_e	drawFastHLine (uint16_t x, uint16_t y, uint16_t w, uint16_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, uint16_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	drawRectWH (uint16_t x, uint16_t y, uint16_t w, uint16_t h, uint16_t color)
	draws rectangle at (x,y) where h is height and w is width of the rectangle.

rdlib::Return_Codes_e	fillRectangle (uint16_t, uint16_t, uint16_t, uint16_t, uint16_t)
	fills a rectangle starting from coordinates (x,y) with width of w and height of h.

void	fillRect (uint16_t x, uint16_t y, uint16_t w, uint16_t h, uint16_t color)
	fills a rectangle at (x,y) where h is height and w is width of the rectangle.

void	drawRoundRect (uint16_t x, uint16_t y, uint16_t w, uint16_t h, uint16_t r, uint16_t color)
	draws a rectangle with rounded edges

void	fillRoundRect (uint16_t x, uint16_t y, uint16_t w, uint16_t h, uint16_t r, uint16_t color)
	Fills a rectangle with rounded edges.

void	drawCircle (int16_t x0, int16_t y0, int16_t r, uint16_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, uint16_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, uint16_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, uint16_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, uint16_t color)
	Fills a triangle of coordinates (x0,y0), (x1,y1) and (x2,y2).

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, uint16_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, uint16_t color)
	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, uint16_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	drawSimpleArc (int16_t cx, int16_t cy, int16_t radius, float startAngle, float endAngle, uint16_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.

void	drawArc (uint16_t cx, uint16_t cy, uint16_t radius, uint16_t thickness, float startAngle, float endAngle, uint16_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.

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.

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 (fonts 1-6)

void	setTextColor (uint16_t c, uint16_t bg)
	Set text color foreground and background.

void	setTextColor (uint16_t c)
	Set text color foreground.

void	setTextCharPixelOrBuffer (bool mode)
	Set the text rendering mode to either buffered or pixel-by-pixel.

bool	getTextCharPixelOrBuffer () const
	Get the current text rendering mode.

rdlib::Return_Codes_e	drawIcon (uint16_t x, uint16_t y, uint16_t w, uint16_t color, uint16_t bgcolor, const std::span< const uint8_t > data)
	Draws an custom Icon of X by 8 size to screen , where X = 0 to 127.

rdlib::Return_Codes_e	drawBitmap (uint16_t x, uint16_t y, uint16_t w, uint16_t h, uint16_t color, uint16_t bgcolor, const std::span< const uint8_t > data)
	: Draws an bi-color bitmap to screen

rdlib::Return_Codes_e	drawBitmap24 (uint16_t x, uint16_t y, const std::span< const uint8_t > data, uint16_t w, uint16_t h)
	Draws an 24 bit color bitmap to screen from a data array.

rdlib::Return_Codes_e	drawBitmap16 (uint16_t x, uint16_t y, const std::span< const uint8_t > data, uint16_t w, uint16_t h)
	: Draws an 16 bit color bitmap to screen from a data array

rdlib::Return_Codes_e	drawSprite (uint16_t x, uint16_t y, const std::span< const uint8_t > data, uint16_t w, uint16_t h, uint16_t backgroundColor, bool printBg=false)
	: Draws an 16 bit color sprite bitmap to screen with transparent background

int16_t	Color565 (int16_t, int16_t, int16_t)
	: Convert: 24-bit color to 565 16-bit color

int	getDisplaySPIBlockSize () const
	Gets the maximum SPI transaction block size.

void	setDisplaySPIBlockSize (int size)
	Sets the maximum SPI transaction block size.

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
display_rotate_e	displayRotate = Degrees_0

Private Member Functions
rdlib::Return_Codes_e	TFTDataCommandPin (void)
	: Method for Data or Command pin setup

rdlib::Return_Codes_e	TFTClock_Data_ChipSelect_Pins (void)
	: Method for Clock, data and chip select pin setup routine for software SPI.

void	TFTSetupResetPin (int8_t rst)
	sets up TFT GPIO reset pin

rdlib::Return_Codes_e	TFTGC9A01Initialize (void)
	init routine for GC9A01 controller

void	cmdInitSequence (void)
	Command Initialization sequence for GC9A01 display.

Private Attributes
PowerState_e	_currentPowerState = PowerState_e::NormalIdleOff

bool	_displayOn = false

const uint16_t	_sleepDelay = 120

uint8_t	_colstart = 0

uint8_t	_rowstart = 0

uint16_t	_widthStartTFT = 240

uint16_t	_heightStartTFT = 240

int	_spiDev = 0

int	_spiChan = 0

int	_spiBaud = 50000

int	_spiFlags = 0

bool	_resetPinOn = true

Static Private Attributes
static constexpr uint8_t	GC9A01_SWRESET = 0x01

static constexpr uint8_t	GC9A01_RDDID = 0x04

static constexpr uint8_t	GC9A01_RDDST = 0x09

static constexpr uint8_t	GC9A01_SLPIN = 0x10

static constexpr uint8_t	GC9A01_SLPOUT = 0x11

static constexpr uint8_t	GC9A01_PTLON = 0x12

static constexpr uint8_t	GC9A01_NORON = 0x13

static constexpr uint8_t	GC9A01_DISPOFF = 0x28

static constexpr uint8_t	GC9A01_DISPON = 0x29

static constexpr uint8_t	GC9A01_IDLEOFF = 0x38

static constexpr uint8_t	GC9A01_IDLEON = 0x39

static constexpr uint8_t	GC9A01_INVOFF = 0x20

static constexpr uint8_t	GC9A01_INVON = 0x21

static constexpr uint8_t	GC9A01_CASET = 0x2A

static constexpr uint8_t	GC9A01_RASET = 0x2B

static constexpr uint8_t	GC9A01_RAMWR = 0x2C

static constexpr uint8_t	GC9A01_PTLAR = 0x30

static constexpr uint8_t	GC9A01_VSCRDEF = 0x33

static constexpr uint8_t	GC9A01_TEOFF = 0x34

static constexpr uint8_t	GC9A01_TEON = 0x35

static constexpr uint8_t	GC9A01_MADCTL = 0x36

static constexpr uint8_t	GC9A01_VSCRSADD = 0x37

static constexpr uint8_t	GC9A01_COLMOD = 0x3A

static constexpr uint8_t	GC9A01_CONTINUE = 0x3C

static constexpr uint8_t	GC9A01_TEARSET = 0x44

static constexpr uint8_t	GC9A01_GETLINE = 0x45

static constexpr uint8_t	GC9A01_SETBRIGHT = 0x51

static constexpr uint8_t	GC9A01_SETCTRL = 0x53

static constexpr uint8_t	GC9A01_TEWC = 0xBA

static constexpr uint8_t	GC9A01_BLANK_PORCH_CTRL = 0xB5

static constexpr uint8_t	GC9A01_FUNCTION_CTRL = 0xB6

static constexpr uint8_t	GC9A01_POWER1 = 0xC1

static constexpr uint8_t	GC9A01_POWER2 = 0xC3

static constexpr uint8_t	GC9A01_POWER3 = 0xC4

static constexpr uint8_t	GC9A01_POWER4 = 0xC9

static constexpr uint8_t	GC9A01_POWER7 = 0xA7

static constexpr uint8_t	GC9A01_RDID1 = 0xDA

static constexpr uint8_t	GC9A01_RDID2 = 0xDB

static constexpr uint8_t	GC9A01_RDID3 = 0xDC

static constexpr uint8_t	GC9A01_FRAMERATE = 0xE8

static constexpr uint8_t	GC9A01_SPI2DATA = 0xE9

static constexpr uint8_t	GC9A01_INREGEN2 = 0xEF

static constexpr uint8_t	GC9A01_GAMMA1 = 0xF0

static constexpr uint8_t	GC9A01_GAMMA2 = 0xF1

static constexpr uint8_t	GC9A01_GAMMA3 = 0xF2

static constexpr uint8_t	GC9A01_GAMMA4 = 0xF3

static constexpr uint8_t	GC9A01_IFACE = 0xF6

static constexpr uint8_t	GC9A01_INREGEN1 = 0xFE

Additional Inherited Members
Protected Member Functions inherited from color16_graphics
void	pushColor (uint16_t color)
	pushColor

void	writeCommand (uint8_t)
	: Write an SPI command to

void	writeData (uint8_t)
	Write an SPI data byte to device.

void	spiWrite (uint8_t)
	Write byte to SPI.

void	spiWriteDataBuffer (uint8_t *spidata, int len)
	Write a buffer to SPI, both Software and hardware SPI supported.

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

Protected Attributes inherited from color16_graphics
bool	_textwrap = true

uint16_t	_textcolor = 0xFFFF

uint16_t	_textbgcolor = 0x0000

int16_t	_cursorX = 0

int16_t	_cursorY = 0

uint16_t	_width

uint16_t	_height

uint8_t	_XStart = 0

uint8_t	_YStart = 0

float	_arcAngleMax = 360.0f

int	_arcAngleOffset = 0

int8_t	_Display_DC

int8_t	_Display_RST

int8_t	_Display_CS

int8_t	_Display_SCLK

int8_t	_Display_SDATA

int8_t	_Display_MISO

int	_DeviceNumGpioChip = 0

int	_GpioHandle = 0

bool	_hardwareSPI =true

uint16_t	_HighFreqDelay = 0

int	_spiHandle = 0

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 GC9A01 TFT basic functionality.

Member Enumeration Documentation

◆ PowerState_e

enum class GC9A01_TFT::PowerState_e : uint8_t

strong

GC9A01 power states based on the power control flow chart. These states combine the modes: Normal/Partial, Idle ON/OFF, and Sleep IN/OUT. They are listed from highest to lowest power consumption. Power states are based on the power control flow chart in the datasheet. FIG 89 5.10.2. Power Flow Chart.

Enumerator
NormalIdleOff	SLPOUT + NORON + IDMOFF
NormalIdleOn	SLPOUT + NORON + IDMON
PartialIdleOff	SLPOUT + PLTON + IDMOFF
PartialIdleOn	SLPOUT + PLTON + IDMON
SleepNormalIdleOff	SLPIN + NORON + IDMOFF
SleepNormalIdleOn	SLPIN + NORON + IDMON
SleepPartialIdleOff	SLPIN + PLTON + IDMOFF
SleepPartialIdleOn	SLPIN + PLTON + IDMON

Member Function Documentation

◆ HighFreqDelayGet()

uint16_t GC9A01_TFT::HighFreqDelayGet ( void )

Freq delay used in SW SPI getter, uS delay used in SW SPI method.

Returns: The GPIO communications delay in uS

◆ HighFreqDelaySet()

void GC9A01_TFT::HighFreqDelaySet ( uint16_t CommDelay )

Freq delay used in SW SPI setter, uS delay used in SW SPI method.

Parameters

CommDelay The GPIO communications delay in uS

◆ setAddrWindow()

void GC9A01_TFT::setAddrWindow	(	uint16_t	x1,
		uint16_t	y1,
		uint16_t	w,
		uint16_t	h
	)

overridevirtual

SPI displays set an address window rectangle for blitting pixels.

Parameters

x1	Top left corner x coordinate
y1	Top left corner y coordinate
w	Width of window
h	Height of window

Note: https://en.wikipedia.org/wiki/Bit_blit

Implements color16_graphics.

◆ TFTchangeInvertMode()

void GC9A01_TFT::TFTchangeInvertMode ( bool invert )

Toggle the invert mode.

Parameters

invert true invert off , false invert on

◆ TFTClock_Data_ChipSelect_Pins()

rdlib::Return_Codes_e GC9A01_TFT::TFTClock_Data_ChipSelect_Pins ( void )

private

: Method for Clock, data and chip select pin setup routine for software SPI.

Returns

a rdlib::Return_Codes_e code

◆ TFTDataCommandPin()

rdlib::Return_Codes_e GC9A01_TFT::TFTDataCommandPin ( void )

private

: Method for Data or Command pin setup

Returns

a rdlib::Return_Codes_e code

◆ TFTenableDisplay()

void GC9A01_TFT::TFTenableDisplay ( bool enableDisplay )

enable /disable display mode

Parameters

enableDisplay true enable on false disable

Note: Temporarily blank the screen. Use Case: Screen blanking, brief off periods without resetting or reinitializing the display.

◆ TFTGC9A01Initialize()

rdlib::Return_Codes_e GC9A01_TFT::TFTGC9A01Initialize ( void )

private

init routine for GC9A01 controller

Returns

a rdlib::Return_Codes_e code

◆ TFTInitScreenSize()

void GC9A01_TFT::TFTInitScreenSize	(	uint16_t	width_TFT,
		uint16_t	height_TFT
	)

initialise the variables that define the size of the screen

Parameters

width_TFT	width in pixels
height_TFT	height in pixels

◆ TFTInitSPI() [1/2]

rdlib::Return_Codes_e GC9A01_TFT::TFTInitSPI	(	int	device,
		int	channel,
		int	speed,
		int	flags,
		int	gpioDev
	)

intialise SPI, Hardware SPI

Parameters

device	A SPI device, >= 0.
channel	A SPI channel, >= 0.
speed	The speed of serial communication in bits per second.
flags	The flags may be used to modify the default behaviour. Set to 0(mode 0) for this device.
gpioDev	The device number of a gpiochip.

Returns

rdlib::Success = success
upstream failure from TFTGC9A01Initialize()

Note: overloaded 2 off, 1 for HW SPI , 1 for SW SPI

◆ TFTInitSPI() [2/2]

rdlib::Return_Codes_e GC9A01_TFT::TFTInitSPI	(	uint16_t	CommDelay,
		int	gpioDev
	)

intialise PCBtype and SPI, Software SPI

Parameters

CommDelay	uS GPIO delay used in software SPI
gpioDev	The device number of a gpiochip.

Returns

rdlib::Success = success
upstream failure from TFTGC9A01Initialize()

Note: overloaded 2 off, 1 for HW SPI , 1 for SW SPI

◆ TFTPowerDown()

rdlib::Return_Codes_e GC9A01_TFT::TFTPowerDown ( void )

Call when powering down TFT.

Returns

a rdlib::Return_Codes_e code

Note: Turns off Display Sets GPIO low and turns off SPI

◆ TFTResetPin()

rdlib::Return_Codes_e GC9A01_TFT::TFTResetPin ( void )

Method for Hardware Reset pin control.

If you have a display with no reset pin this will issue the software reset command this software reset is untested on actual hardware.

Returns

a rdlib::Return_Codes_e code

◆ TFTsetBrightness()

void GC9A01_TFT::TFTsetBrightness ( uint8_t level )

Set display brightness (0–255).

Parameters

level Brightness level, 0 = darkest, 255 = brightest

Note: This is a software brightness control, not hardware PWM, may not work on all displays.

◆ TFTsetPowerMode()

void GC9A01_TFT::TFTsetPowerMode ( PowerState_e mode )

Set the power mode of the display.

Parameters

mode	The power state to set

Power states are based on the power control flow chart in the datasheet. FIG 89 5.10.2. Power Flow Chart

◆ TFTsetRotation()

void GC9A01_TFT::TFTsetRotation ( display_rotate_e mode )

: change rotation of display.

Parameters

mode	display_rotate_e enum 0 = Normal 1= 90 rotate 2 = 180 rotate 3 = 270 rotate

◆ TFTsetScrollArea()

void GC9A01_TFT::TFTsetScrollArea	(	uint16_t	topFixed,
		uint16_t	scrollArea,
		uint16_t	bottomFixed
	)

This method defines the Vertical Scrolling Area of the display where:

Parameters

topFixed	describes the Top Fixed Area.
scrollArea	describes the Scrolling Area.
bottomFixed	describes the Bottom Fixed Area.

◆ TFTsetScrollStart()

void GC9A01_TFT::TFTsetScrollStart ( uint16_t vsp )

This method is used together with the setScrollDefinition.

Parameters

vsp	scrolling mode

◆ TFTSetupGPIO() [1/2]

void GC9A01_TFT::TFTSetupGPIO	(	int8_t	rst,
		int8_t	dc
	)

sets up TFT GPIO for Hardware SPi

Parameters

rst	reset GPIO
dc	data or command GPIO.

for software reset pass -1 to rst

Note: overloaded 2 off, 1 for HW SPI , 1 for SW SPI

◆ TFTSetupGPIO() [2/2]

void GC9A01_TFT::TFTSetupGPIO	(	int8_t	rst,
		int8_t	dc,
		int8_t	cs,
		int8_t	sclk,
		int8_t	din
	)

sets up TFT GPIO for software SPI

Parameters

rst	reset GPIO
dc	data or command GPIO.
cs	chip select GPIO
sclk	Data clock GPIO
din	Data to TFT GPIO

for software reset pass -1 to rst

Note: overloaded 2 off, 1 for HW SPI , 1 for SW SPI

◆ TFTSetupResetPin()

void GC9A01_TFT::TFTSetupResetPin ( int8_t rst )

private

sets up TFT GPIO reset pin

Parameters

rst	reset GPIO

if rst value is -1 use software reset, else use Hardware reset.

Member Data Documentation

◆ _colstart

uint8_t GC9A01_TFT::_colstart = 0

private

Used to offset column in the event of defect at edge of screen

◆ _currentPowerState

PowerState_e GC9A01_TFT::_currentPowerState = PowerState_e::NormalIdleOff

private

Enum to hold display mode

◆ _displayOn

bool GC9A01_TFT::_displayOn = false

private

Enum to hold display on/off status

◆ _heightStartTFT

uint16_t GC9A01_TFT::_heightStartTFT = 240

private

never change after first init

◆ _resetPinOn

bool GC9A01_TFT::_resetPinOn = true

private

reset pin? true:hw rst pin, false:sw rt

◆ _rowstart

uint8_t GC9A01_TFT::_rowstart = 0

private

Used to offset row in the event of defect at edge of screen

◆ _sleepDelay

const uint16_t GC9A01_TFT::_sleepDelay = 120

private

Sleep delay in ms ?

◆ _spiBaud

int GC9A01_TFT::_spiBaud = 50000

private

The speed of serial communication in bits per second.

◆ _spiChan

int GC9A01_TFT::_spiChan = 0

private

A SPI channel, >= 0.

◆ _spiDev

int GC9A01_TFT::_spiDev = 0

private

A SPI device, >= 0.

◆ _spiFlags

int GC9A01_TFT::_spiFlags = 0

private

The flags 2 LSB defines SPI mode

◆ _widthStartTFT

uint16_t GC9A01_TFT::_widthStartTFT = 240

private

never change after first init

◆ displayRotate

display_rotate_e GC9A01_TFT::displayRotate = Degrees_0

Enum to hold rotation

◆ GC9A01_BLANK_PORCH_CTRL

constexpr uint8_t GC9A01_TFT::GC9A01_BLANK_PORCH_CTRL = 0xB5

staticconstexprprivate

Blanking Porch Control (B5h)

◆ GC9A01_CASET

constexpr uint8_t GC9A01_TFT::GC9A01_CASET = 0x2A

staticconstexprprivate

Column Address Set

◆ GC9A01_COLMOD

constexpr uint8_t GC9A01_TFT::GC9A01_COLMOD = 0x3A

staticconstexprprivate

Pixel Format Set

◆ GC9A01_CONTINUE

constexpr uint8_t GC9A01_TFT::GC9A01_CONTINUE = 0x3C

staticconstexprprivate

Write Memory Continue

◆ GC9A01_DISPOFF

constexpr uint8_t GC9A01_TFT::GC9A01_DISPOFF = 0x28

staticconstexprprivate

Display OFF

◆ GC9A01_DISPON

constexpr uint8_t GC9A01_TFT::GC9A01_DISPON = 0x29

staticconstexprprivate

Display ON

◆ GC9A01_FRAMERATE

constexpr uint8_t GC9A01_TFT::GC9A01_FRAMERATE = 0xE8

staticconstexprprivate

Frame rate control

◆ GC9A01_FUNCTION_CTRL

constexpr uint8_t GC9A01_TFT::GC9A01_FUNCTION_CTRL = 0xB6

staticconstexprprivate

Display Function Control

◆ GC9A01_GAMMA1

constexpr uint8_t GC9A01_TFT::GC9A01_GAMMA1 = 0xF0

staticconstexprprivate

Set gamma 1

◆ GC9A01_GAMMA2

constexpr uint8_t GC9A01_TFT::GC9A01_GAMMA2 = 0xF1

staticconstexprprivate

Set gamma 2

◆ GC9A01_GAMMA3

constexpr uint8_t GC9A01_TFT::GC9A01_GAMMA3 = 0xF2

staticconstexprprivate

Set gamma 3

◆ GC9A01_GAMMA4

constexpr uint8_t GC9A01_TFT::GC9A01_GAMMA4 = 0xF3

staticconstexprprivate

Set gamma 4

◆ GC9A01_GETLINE

constexpr uint8_t GC9A01_TFT::GC9A01_GETLINE = 0x45

staticconstexprprivate

Get Scanline

◆ GC9A01_IDLEOFF

constexpr uint8_t GC9A01_TFT::GC9A01_IDLEOFF = 0x38

staticconstexprprivate

Idle mode OFF

◆ GC9A01_IDLEON

constexpr uint8_t GC9A01_TFT::GC9A01_IDLEON = 0x39

staticconstexprprivate

Idle mode ON

◆ GC9A01_IFACE

constexpr uint8_t GC9A01_TFT::GC9A01_IFACE = 0xF6

staticconstexprprivate

Interface control

◆ GC9A01_INREGEN1

constexpr uint8_t GC9A01_TFT::GC9A01_INREGEN1 = 0xFE

staticconstexprprivate

Inter register enable 1

◆ GC9A01_INREGEN2

constexpr uint8_t GC9A01_TFT::GC9A01_INREGEN2 = 0xEF

staticconstexprprivate

Inter register enable 2

◆ GC9A01_INVOFF

constexpr uint8_t GC9A01_TFT::GC9A01_INVOFF = 0x20

staticconstexprprivate

Display Inversion OFF

◆ GC9A01_INVON

constexpr uint8_t GC9A01_TFT::GC9A01_INVON = 0x21

staticconstexprprivate

Display Inversion ON

◆ GC9A01_MADCTL

constexpr uint8_t GC9A01_TFT::GC9A01_MADCTL = 0x36

staticconstexprprivate

Memory Access Control

◆ GC9A01_NORON

constexpr uint8_t GC9A01_TFT::GC9A01_NORON = 0x13

staticconstexprprivate

Normal Display Mode ON

◆ GC9A01_POWER1

constexpr uint8_t GC9A01_TFT::GC9A01_POWER1 = 0xC1

staticconstexprprivate

Power Control 1

◆ GC9A01_POWER2

constexpr uint8_t GC9A01_TFT::GC9A01_POWER2 = 0xC3

staticconstexprprivate

Power Control 2

◆ GC9A01_POWER3

constexpr uint8_t GC9A01_TFT::GC9A01_POWER3 = 0xC4

staticconstexprprivate

Power Control 3

◆ GC9A01_POWER4

constexpr uint8_t GC9A01_TFT::GC9A01_POWER4 = 0xC9

staticconstexprprivate

Power Control 4

◆ GC9A01_POWER7

constexpr uint8_t GC9A01_TFT::GC9A01_POWER7 = 0xA7

staticconstexprprivate

Power Control 7

◆ GC9A01_PTLAR

constexpr uint8_t GC9A01_TFT::GC9A01_PTLAR = 0x30

staticconstexprprivate

Partial Area

◆ GC9A01_PTLON

constexpr uint8_t GC9A01_TFT::GC9A01_PTLON = 0x12

staticconstexprprivate

Partial Mode ON

◆ GC9A01_RAMWR

constexpr uint8_t GC9A01_TFT::GC9A01_RAMWR = 0x2C

staticconstexprprivate

Memory Write

◆ GC9A01_RASET

constexpr uint8_t GC9A01_TFT::GC9A01_RASET = 0x2B

staticconstexprprivate

Row Address Set

◆ GC9A01_RDDID

constexpr uint8_t GC9A01_TFT::GC9A01_RDDID = 0x04

staticconstexprprivate

Read display identification information

◆ GC9A01_RDDST

constexpr uint8_t GC9A01_TFT::GC9A01_RDDST = 0x09

staticconstexprprivate

Read Display Status

◆ GC9A01_RDID1

constexpr uint8_t GC9A01_TFT::GC9A01_RDID1 = 0xDA

staticconstexprprivate

Read ID 1

◆ GC9A01_RDID2

constexpr uint8_t GC9A01_TFT::GC9A01_RDID2 = 0xDB

staticconstexprprivate

Read ID 2

◆ GC9A01_RDID3

constexpr uint8_t GC9A01_TFT::GC9A01_RDID3 = 0xDC

staticconstexprprivate

Read ID 3

◆ GC9A01_SETBRIGHT

constexpr uint8_t GC9A01_TFT::GC9A01_SETBRIGHT = 0x51

staticconstexprprivate

Write Display Brightness

◆ GC9A01_SETCTRL

constexpr uint8_t GC9A01_TFT::GC9A01_SETCTRL = 0x53

staticconstexprprivate

Write CTRL Display

◆ GC9A01_SLPIN

constexpr uint8_t GC9A01_TFT::GC9A01_SLPIN = 0x10

staticconstexprprivate

Enter Sleep Mode

◆ GC9A01_SLPOUT

constexpr uint8_t GC9A01_TFT::GC9A01_SLPOUT = 0x11

staticconstexprprivate

Sleep Out

◆ GC9A01_SPI2DATA

constexpr uint8_t GC9A01_TFT::GC9A01_SPI2DATA = 0xE9

staticconstexprprivate

SPI 2DATA control

◆ GC9A01_SWRESET

constexpr uint8_t GC9A01_TFT::GC9A01_SWRESET = 0x01

staticconstexprprivate

Software Reset

◆ GC9A01_TEARSET

constexpr uint8_t GC9A01_TFT::GC9A01_TEARSET = 0x44

staticconstexprprivate

Set Tear Scanline

◆ GC9A01_TEOFF

constexpr uint8_t GC9A01_TFT::GC9A01_TEOFF = 0x34

staticconstexprprivate

Tearing Effect Line OFF

◆ GC9A01_TEON

constexpr uint8_t GC9A01_TFT::GC9A01_TEON = 0x35

staticconstexprprivate

Tearing Effect Line ON

◆ GC9A01_TEWC

constexpr uint8_t GC9A01_TFT::GC9A01_TEWC = 0xBA

staticconstexprprivate

Tearing effect width control

◆ GC9A01_VSCRDEF

constexpr uint8_t GC9A01_TFT::GC9A01_VSCRDEF = 0x33

staticconstexprprivate

Vertical Scrolling Definition

◆ GC9A01_VSCRSADD

constexpr uint8_t GC9A01_TFT::GC9A01_VSCRSADD = 0x37

staticconstexprprivate

Vertical Scrolling Start Address

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

Classes

Public Types

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ PowerState_e

Member Function Documentation

◆ HighFreqDelayGet()

◆ HighFreqDelaySet()

◆ setAddrWindow()

◆ TFTchangeInvertMode()

◆ TFTClock_Data_ChipSelect_Pins()

◆ TFTDataCommandPin()

◆ TFTenableDisplay()

◆ TFTGC9A01Initialize()

◆ TFTInitScreenSize()

◆ TFTInitSPI() [1/2]

◆ TFTInitSPI() [2/2]

◆ TFTPowerDown()

◆ TFTResetPin()

◆ TFTsetBrightness()

◆ TFTsetPowerMode()

◆ TFTsetRotation()

◆ TFTsetScrollArea()

◆ TFTsetScrollStart()

◆ TFTSetupGPIO() [1/2]

◆ TFTSetupGPIO() [2/2]

◆ TFTSetupResetPin()

Member Data Documentation

◆ _colstart

◆ _currentPowerState

◆ _displayOn

◆ _heightStartTFT

◆ _resetPinOn

◆ _rowstart

◆ _sleepDelay

◆ _spiBaud

◆ _spiChan

◆ _spiDev

◆ _spiFlags

◆ _widthStartTFT

◆ displayRotate

◆ GC9A01_BLANK_PORCH_CTRL

◆ GC9A01_CASET

◆ GC9A01_COLMOD

◆ GC9A01_CONTINUE

◆ GC9A01_DISPOFF

◆ GC9A01_DISPON

◆ GC9A01_FRAMERATE

◆ GC9A01_FUNCTION_CTRL

◆ GC9A01_GAMMA1

◆ GC9A01_GAMMA2

◆ GC9A01_GAMMA3

◆ GC9A01_GAMMA4

◆ GC9A01_GETLINE

◆ GC9A01_IDLEOFF

◆ GC9A01_IDLEON

◆ GC9A01_IFACE

◆ GC9A01_INREGEN1

◆ GC9A01_INREGEN2

◆ GC9A01_INVOFF

◆ GC9A01_INVON

◆ GC9A01_MADCTL

◆ GC9A01_NORON

◆ GC9A01_POWER1

◆ GC9A01_POWER2

◆ GC9A01_POWER3

◆ GC9A01_POWER4

◆ GC9A01_POWER7

◆ GC9A01_PTLAR

◆ GC9A01_PTLON

◆ GC9A01_RAMWR

◆ GC9A01_RASET

◆ GC9A01_RDDID

◆ GC9A01_RDDST