SPI T6963C Graphic Lcd Library

The mikroBasic PRO for PIC32 provides a library for working with Glcds based on TOSHIBA T6963C controller via SPI interface. The Toshiba T6963C is a very popular Lcd controller for the use in small graphics modules. It is capable of controlling displays with a resolution up to 240x128. Because of its low power and small outline it is most suitable for mobile applications such as PDAs, MP3 players or mobile measurement equipment. Although this controller is small, it has a capability of displaying and merging text and graphics and it manages all interfacing signals to the displays Row and Column drivers.

For creating a custom set of Glcd images use Glcd Bitmap Editor Tool.

Important :

When using this library with PIC32 family MCUs be aware of their voltage incompatibility with certain number of T6963C based Glcd modules. So, additional external power supply for these modules may be required.
Glcd size based initialization routines can be found in setup library files located in the Uses folder.
The user must make sure that used MCU has appropriate ports and pins. If this is not the case the user should adjust initialization routines.
The library uses the SPI module for communication. The user must initialize the appropriate SPI module before using the SPI T6963C Glcd Library.
For MCUs with multiple SPI modules it is possible to initialize both of them and then switch by using the SPI_Set_Active() routine. See the SPI Library functions.
This Library is designed to work with mikroElektronika's Serial Glcd 240x128 and 240x64 Adapter Boards pinout, see schematic at the bottom of this page for details.
To use constants located in __Lib_SPIT6963C_Const.mbas file, user must include it the source file : include __Lib_SPIT6963C_Const.

Some mikroElektronika's adapter boards have pinout different from T6369C datasheets. Appropriate relations between these labels are given in the table below:

Adapter Board	T6369C datasheet
RS	C/D
R/W	/RD
E	/WR

Library Dependency Tree

External dependencies of SPI T6963C Graphic Lcd Library

The implementation of SPI T6963C Graphic Lcd Library routines is based on Port Expander Library routines.

External dependencies are the same as Port Expander Library external dependencies.

Library Routines

SPI_T6963C_config
SPI_T6963C_writeData
SPI_T6963C_writeCommand
SPI_T6963C_setPtr
SPI_T6963C_Set_Ext_Buffer
SPI_T6963C_waitReady
SPI_T6963C_fill
SPI_T6963C_dot
SPI_T6963C_Set_Font_Adv
SPI_T6963C_Set_Font_Ext_Adv
SPI_T6963C_write_char
SPI_T6963C_Write_Char_Adv
SPI_T6963C_Write_Text
SPI_T6963C_Write_Text_Adv
SPI_T6963C_line
SPI_T6963C_rectangle
SPI_T6963C_rectangle_round_edges
SPI_T6963C_rectangle_round_edges_fill
SPI_T6963C_box
SPI_T6963C_circle
SPI_T6963C_circle_fill
SPI_T6963C_image
SPI_T6963C_Ext_Image
SPI_T6963C_PartialImage
SPI_T6963C_Ext_PartialImage
SPI_T6963C_sprite
SPI_T6963C_set_cursor
SPI_T6963C_clearBit
SPI_T6963C_setBit
SPI_T6963C_negBit
SPI_T6963C_displayGrPanel
SPI_T6963C_displayTxtPanel
SPI_T6963C_setGrPanel
SPI_T6963C_setTxtPanel
SPI_T6963C_panelFill
SPI_T6963C_grFill
SPI_T6963C_txtFill
SPI_T6963C_cursor_height
SPI_T6963C_graphics
SPI_T6963C_text
SPI_T6963C_cursor
SPI_T6963C_cursor_blink

SPI_T6963C_config

Prototype	sub procedure SPI_T6963C_config(dim width, height, fntW as word, dim DeviceAddress as byte, dim wr, rd, cd, rst as byte)
Description	Initializes T6963C Graphic Lcd controller. Display RAM organization: The library cuts RAM into panels : a complete panel is one graphics panel followed by a text panel (see schematic below). +---------------------+ /\ + GRAPHICS PANEL #0 + \| + + \| + + \| + + \| +---------------------+ \| PANEL 0 + TEXT PANEL #0 + \| + + \/ +---------------------+ /\ + GRAPHICS PANEL #1 + \| + + \| + + \| + + \| +---------------------+ \| PANEL 1 + TEXT PANEL #1 + \| + + \| +---------------------+ \/
Parameters	`width:` width of the Glcd panel `height:` height of the Glcd panel `fntW:` font width `DeviceAddress:` SPI expander hardware address, see schematic at the bottom of this page `wr:` write signal pin on Glcd control port `rd:` read signal pin on Glcd control port `cd:` command/data signal pin on Glcd control port `rst:` reset signal pin on Glcd control port
Returns	Nothing.
Requires	Global variables : `SPExpanderCS`: Chip Select line `SPExpanderRST`: Reset line `SPExpanderCS_Direction`: Direction of the Chip Select pin `SPExpanderRST_Direction`: Direction of the Reset pin must be defined before using this function. The SPI module needs to be initialized. See the SPIx_Init and SPIx_Init_Advanced routines.
Example	' Port Expander module connections dim SPExpanderRST as sbit at LATF0_bit SPExpanderCS as sbit at LATF1_bit SPExpanderRST_Direction as sbit at TRISF0_bit SPExpanderCS_Direction as sbit at TRISF1_bit ' End Port Expander module connections ... ' Initialize SPI module SPI1_Init() SPI_T6963C_Config(240, 64, 8, 0, 0, 1, 3, 4)
Notes	None.

SPI_T6963C_writeData

Prototype	sub procedure SPI_T6963C_writeData(dim data_ as byte)
Description	Writes data to T6963C controller via SPI interface.
Parameters	`data_:` data to be written
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_writeData(data_)
Notes	None.

SPI_T6963C_writeCommand

Prototype	sub procedure SPI_T6963C_writeCommand(dim data_ as byte)
Description	Writes command to T6963C controller via SPI interface.
Parameters	`data_:` command to be written
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_writeCommand(SPI_T6963C_CURSOR_POINTER_SET)
Notes	None.

SPI_T6963C_setPtr

Prototype	sub procedure SPI_T6963C_setPtr(dim p as word, dim c as byte)
Description	Sets the memory pointer `p` for command `p`.
Parameters	`p:` address where command should be written `c:` command to be written
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_setPtr(SPI_T6963C_grHomeAddr + start, SPI_T6963C_ADDRESS_POINTER_SET)
Notes	None.

SPI_T6963C_Set_Ext_Buffer

Prototype	sub procedure SPI_T6963C_Set_Ext_Buffer(dim getExtDataPtr as ^TSPI_T6963C_Get_Ext_Data_Ptr)
Returns	Nothing.
Description	Function sets pointer to the user function which manipulates the external resource. Parameters : `TSPI_T6963C_Get_Ext_Data_Ptr` - pointer to the user function. User function prototype should be in the following format: `sub function External(dim offset as longword, dim count as longword, dim byref num as longword) as ^byte` Parameters used in the function have the following meaning : `offset` - offset from the beginning of the resource from where the data is requested. `count` - requested number of bytes. `num` - variable for holding the returned number of bytes (less or equal to the number of acquired bytes).
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_Set_Ext_Buffer(@ReadExternalBuffer)

SPI_T6963C_waitReady

Prototype	sub procedure SPI_T6963C_waitReady()
Description	Pools the status byte, and loops until Toshiba Glcd module is ready.
Parameters	None.
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_waitReady()
Notes	None.

SPI_T6963C_fill

Prototype	sub procedure SPI_T6963C_fill(dim v as byte, dim start, len as word)
Description	Fills controller memory block with given byte.
Parameters	`v:` byte to be written `start:` starting address of the memory block `len:` length of the memory block in bytes
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_fill(0x33,0x00FF,0x000F)
Notes	None.

SPI_T6963C_dot

Prototype	sub procedure SPI_T6963C_dot(dim x, y as integer, dim color as byte)
Description	Draws a dot in the current graphic panel of Glcd at coordinates (x, y).
Returns	`x:` dot position on x-axis `y:` dot position on y-axis `color:` color parameter. Valid values: SPI_T6963C_BLACK and SPI_T6963C_WHITE
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_dot(x0, y0, SPI_T6963C_BLACK)
Notes	None.

SPI_T6963C_Set_Font_Adv

Prototype	sub procedure SPI_T6963C_Set_Font_Adv(dim activeFont as ^const byte, dim font_color as word, dim font_orientation as byte)
Description	Sets font that will be used with SPI_T6963C_Write_Char_Adv and SPI_T6963C_Write_Text_Adv routines.
Parameters	`activeFont:` font to be set. Needs to be formatted as an array of char. `font_color:` sets font color. `font_orientation:` sets font orientation.
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_Set_Font_Adv(@myfont, 1, 0)
Notes	None.

SPI_T6963C_Set_Ext_Font_Adv

Prototype	sub procedure SPI_T6963C_Set_Ext_Font_Adv(dim activeFont as longword, dim font_color as word, dim font_orientation as word)
Description	Sets font that will be used with SPI_T6963C_Write_Char_Adv and SPI_T6963C_Write_Text_Adv routines. Font is located in an external resource.
Parameters	`activeFont:` font to be set. This parameter represents the address in the exteral resource from where the font data begins. `font_color:` sets font color. `font_orientation:` sets font orientation.
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_Set_Ext_Font_Adv(173296, 0, 0)
Notes	None.

SPI_T6963C_write_char

Prototype	sub procedure SPI_T6963C_write_char(dim c, x, y, mode as byte)
Description	Writes a char in the current text panel of Glcd at coordinates (x, y).
Parameters	`c:` char to be written `x:` char position on x-axis `y:` char position on y-axis `mode:` mode parameter. Valid values: SPI_T6963C_ROM_MODE_OR, SPI_T6963C_ROM_MODE_XOR, SPI_T6963C_ROM_MODE_AND and SPI_T6963C_ROM_MODE_TEXT Mode parameter explanation: OR Mode: In the OR-Mode, text and graphics can be displayed and the data is logically "OR-ed". This is the most common way of combining text and graphics for example labels on buttons. XOR-Mode: In this mode, the text and graphics data are combined via the logical "exclusive OR". This can be useful to display text in the negative mode, i.e. white text on black background. AND-Mode: The text and graphic data shown on display are combined via the logical "AND function". TEXT-Mode: This option is only available when displaying just a text. The Text Attribute values are stored in the graphic area of display memory. For more details see the T6963C datasheet.
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_write_char("A",22,23,SPI_T6963C_ROM_MODE_AND)
Notes	None.

SPI_T6963C_write_char_adv

Prototype	sub procedure SPI_T6963C_write_char_adv(dim ch, x, y as word)
Description	Writes a char in the current text panel of Glcd at coordinates (x, y).
Parameters	`c:` char to be written `x:` char position on x-axis `y:` char position on y-axis
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_write_char_adv("A",22,23)
Notes	None.

SPI_T6963C_write_text

Prototype	sub procedure SPI_T6963C_write_text(dim byref str as byte[10], dim x, y, mode as byte)
Description	Writes text in the current text panel of Glcd at coordinates (x, y).
Parameters	`str:` text to be written `x:` text position on x-axis `y:` text position on y-axis `mode:` mode parameter. Valid values: SPI_T6963C_ROM_MODE_OR, SPI_T6963C_ROM_MODE_XOR, SPI_T6963C_ROM_MODE_AND and SPI_T6963C_ROM_MODE_TEXT Mode parameter explanation: OR Mode: In the OR-Mode, text and graphics can be displayed and the data is logically "OR-ed". This is the most common way of combining text and graphics for example labels on buttons. XOR-Mode: In this mode, the text and graphics data are combined via the logical "exclusive OR". This can be useful to display text in the negative mode, i.e. white text on black background. AND-Mode: The text and graphic data shown on display are combined via the logical "AND function". TEXT-Mode: This option is only available when displaying just a text. The Text Attribute values are stored in the graphic area of display memory. For more details see the T6963C datasheet.
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_write_text("GLCD LIBRARY DEMO, WELCOME !", 0, 0, SPI_T6963C_ROM_MODE_XOR)
Notes	None.

SPI_T6963C_Write_Text_Adv

Prototype	sub procedure SPI_T6963C_Write_Text_Adv(dim byref text as string, dim x, y as word)
Description	Writes text in the current text panel of Glcd at coordinates (x, y).
Parameters	`str:` text to be written `x:` text position on x-axis `y:` text position on y-axis
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	T6963C_Write_Text_Adv("Glcd LIBRARY DEMO, WELCOME !", 0, 0)
Notes	None.

SPI_T6963C_line

Prototype	sub procedure SPI_T6963C_line(dim x0, y0, x1, y1 as integer, dim pcolor as byte)
Description	Draws a line from (x0, y0) to (x1, y1).
Parameters	`x0:` x coordinate of the line start `y0:` y coordinate of the line end `x1:` x coordinate of the line start `y1:` y coordinate of the line end `pcolor:` color parameter. Valid values: SPI_T6963C_BLACK and SPI_T6963C_WHITE
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_line(0, 0, 239, 127, SPI_T6963C_WHITE)
Notes	None.

SPI_T6963C_rectangle

Prototype	sub procedure SPI_T6963C_rectangle(dim x0, y0, x1, y1 as integer, dim pcolor as byte)
Description	Draws a rectangle on Glcd.
Parameters	`x0:` x coordinate of the upper left rectangle corner `y0:` y coordinate of the upper left rectangle corner `x1:` x coordinate of the lower right rectangle corner `y1:` y coordinate of the lower right rectangle corner `pcolor:` color parameter. Valid values: SPI_T6963C_BLACK and SPI_T6963C_WHITE
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_rectangle(20, 20, 219, 107, SPI_T6963C_WHITE)
Notes	None.

SPI_T6963C_rectangle_round_edges

Prototype	sub procedure SPI_T6963C_rectangle_round_edges(dim x0 as integer, dim y0 as integer, dim x1 as integer, dim y1 as integer, dim radius as integer, dim pcolor as byte)
Description	Draws a rounded edge rectangle on Glcd.
Parameters	`x0:` x coordinate of the upper left rectangle corner `y0:` y coordinate of the upper left rectangle corner `x1:` x coordinate of the lower right rectangle corner `y1:` y coordinate of the lower right rectangle corner `round_radius:` radius of the rounded edge. `pcolor:` color parameter. Valid values: `SPI_T6963C_BLACK` and `SPI_T6963C_WHITE`
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_rectangle_round_edges(20, 20, 219, 107, 12, SPI_T6963C_WHITE)
Notes	None.

SPI_T6963C_rectangle_round_edges_fill

Prototype	sub procedure SPI_T6963C_rectangle_round_edges_fill(dim x0 as integer, dim y0 as integer, dim x1 as integer, dim y1 as integer, dim radius as integer, dim pcolor as byte)
Description	Draws a filled rounded edge rectangle on Glcd.
Parameters	`x0:` x coordinate of the upper left rectangle corner `y0:` y coordinate of the upper left rectangle corner `x1:` x coordinate of the lower right rectangle corner `y1:` y coordinate of the lower right rectangle corner `round_radius:` radius of the rounded edge `pcolor:` color parameter. Valid values: `SPI_T6963C_BLACK` and `SPI_T6963C_WHITE`
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_rectangle_round_edges_fill(20, 20, 219, 107, 12, SPI_T6963C_WHITE)
Notes	None.

SPI_T6963C_box

Prototype	sub procedure SPI_T6963C_box(dim x0, y0, x1, y1 as integer, dim pcolor as byte)
Description	Draws a box on the Glcd
Parameters	`x0:` x coordinate of the upper left box corner `y0:` y coordinate of the upper left box corner `x1:` x coordinate of the lower right box corner `y1:` y coordinate of the lower right box corner `pcolor:` color parameter. Valid values: SPI_T6963C_BLACK and SPI_T6963C_WHITE
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_box(0, 119, 239, 127, SPI_T6963C_WHITE)
Notes	None.

SPI_T6963C_circle

Prototype	sub procedure SPI_T6963C_circle(dim x, y as integer, dim r as longint, dim pcolor as word)
Description	Draws a circle on the Glcd.
Parameters	`x:` x coordinate of the circle center `y:` y coordinate of the circle center `r:` radius size `pcolor:` color parameter. Valid values: SPI_T6963C_BLACK and SPI_T6963C_WHITE
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_circle(120, 64, 110, SPI_T6963C_WHITE)
Notes	None.

SPI_T6963C_circle_fill

Prototype	sub procedure SPI_T6963C_circle_fill(dim x as integer, dim y as integer, dim r as longint, dim pcolor as byte)
Description	Draws a filled circle on the Glcd.
Parameters	`x:` x coordinate of the circle center `y:` y coordinate of the circle center `r:` radius size `pcolor:` color parameter. Valid values: `SPI_T6963C_BLACK` and `SPI_T6963C_WHITE`
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_circle_fill(120, 64, 110, SPI_T6963C_WHITE)
Notes	None.

SPI_T6963C_image

Prototype	sub procedure SPI_T6963C_image(dim pic as ^ const byte)
Description	Displays bitmap on Glcd.
Parameters	`pic:` image to be displayed. Bitmap array can be located in both code and RAM memory (due to the mikroBasic PRO for PIC32 pointer to const and pointer to RAM equivalency).
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_image(my_image)
Notes	Image dimension must match the display dimension. Use the integrated Glcd Bitmap Editor (menu option Tools › Glcd Bitmap Editor) to convert image to a constant array suitable for displaying on Glcd.

SPI_T6963C_Ext_Image

Prototype	sub procedure SPI_T6963C_Ext_Image(dim image as longword)
Description	Displays a bitmap from an external resource.
Parameters	`pic:` image to be displayed. This parameter represents the address in the exteral resource from where the image data begins.
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_Ext_image(153608)
Notes	Image dimension must match the display dimension. Use the integrated Glcd Bitmap Editor (menu option Tools › Glcd Bitmap Editor) to convert image to a constant array suitable for displaying on Glcd.

SPI_T6963C_PartialImage

Prototype	sub procedure SPI_T6963C_PartialImage(dim x_left, y_top, width, height, picture_width, picture_height as word, const image as ^byte)
Description	Displays a partial area of the image on a desired location.
Parameters	`x_left:` x coordinate of the desired location (upper left coordinate). `y_top:` y coordinate of the desired location (upper left coordinate). `width:` desired image width. `height:` desired image height. `picture_width:` width of the original image. `picture_height:` height of the original image. `image:` image to be displayed. Bitmap array can be located in both code and RAM memory (due to the mikroBasic PRO for PIC pointer to const and pointer to RAM equivalency).
Description	Displays a partial area of the image on a desired location.
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	' Draws a 10x15 part of the image starting from the upper left corner on the coordinate (10,12). Original image size is 16x32. SPI_T6963C_PartialImage(10, 12, 10, 15, 16, 32, @image)
Notes	Image dimension must match the display dimension. Use the integrated Glcd Bitmap Editor (menu option Tools › Glcd Bitmap Editor) to convert image to a constant array suitable for displaying on Glcd.

SPI_T6963C_Ext_PartialImage

Prototype	sub procedure SPI_T6963C_Ext_PartialImage(dim x_left, y_top, width, height, picture_width, picture_height as word, dim image as longword)
Description	Displays a partial area of the image (from an external resource) on a desired location.
Parameters	`x_left:` x coordinate of the desired location (upper left coordinate). `y_top:` y coordinate of the desired location (upper left coordinate). `width:` desired image width. `height:` desired image height. `picture_width:` width of the original image. `picture_height:` height of the original image. `image:` image to be displayed. This parameter represents the address in the exteral resource from where the image data begins.
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_Ext_PartialImage(10, 12, 10, 15, 16, 32, 0)
Notes	Image dimension must match the display dimension. Use the integrated Glcd Bitmap Editor (menu option Tools › Glcd Bitmap Editor) to convert image to a constant array suitable for displaying on Glcd.

SPI_T6963C_sprite

Prototype	sub procedure SPI_T6963C_sprite(dim px, py as byte, dim const pic as ^byte, dim sx, sy as byte)
Description	Fills graphic rectangle area (px, py) to (px+sx, py+sy) with custom size picture.
Parameters	`px:` x coordinate of the upper left picture corner. Valid values: multiples of the font width `py:` y coordinate of the upper left picture corner `pic:` picture to be displayed `sx:` picture width. Valid values: multiples of the font width `sy:` picture height
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_sprite(76, 4, einstein, 88, 119) ' draw a sprite
Notes	If `px` and `sx` parameters are not multiples of the font width they will be scaled to the nearest lower number that is a multiple of the font width.

SPI_T6963C_set_cursor

Prototype	sub procedure SPI_T6963c_set_cursor(dim x, y as byte)
Description	Sets cursor to row x and column y.
Parameters	`x:` cursor position row number `y:` cursor position column number
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963c_set_cursor(cposx, cposy)
Notes	None.

SPI_T6963C_clearBit

Prototype	sub procedure SPI_T6963C_clearBit(dim b as byte)
Description	Clears control port bit(s).
Parameters	`b:` bit mask. The function will clear bit `x` on control port if bit `x` in bit mask is set to 1.
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	' clear bits 0 and 1 on control port SPI_T6963C_clearBit(0x0003)
Notes	None.

SPI_T6963C_setBit

Prototype	sub procedure SPI_T6963C_setBit(dim b as byte)
Description	Sets control port bit(s).
Parameters	`b:` bit mask. The function will set bit `x` on control port if bit `x` in bit mask is set to 1.
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	' set bits 0 and 1 on control port SPI_T6963C_setBit(0x0003)
Notes	None.

SPI_T6963C_negBit

Prototype	sub procedure SPI_T6963C_negBit(dim b as byte)
Description	Negates control port bit(s).
Parameters	`b:` bit mask. The function will negate bit `x` on control port if bit `x` in bit mask is set to 1.
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	' negate bits 0 and 1 on control port SPI_T6963C_negBit(0x0003)
Notes	None.

SPI_T6963C_displayGrPanel

Prototype	sub procedure SPI_T6963C_displayGrPanel(dim n as word)
Description	Display selected graphic panel.
Parameters	`n:` graphic panel number. Valid values: `0` and `1`.
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	' display graphic panel 1 SPI_T6963C_displayGrPanel(1)
Notes	None.

SPI_T6963C_displayTxtPanel

Prototype	sub procedure SPI_T6963C_displayTxtPanel(dim n as word)
Description	Display selected text panel.
Parameters	`n:` text panel number. Valid values: `0` and `1`.
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	' display text panel 1 SPI_T6963C_displayTxtPanel(1)
Notes	None.

SPI_T6963C_setGrPanel

Prototype	sub procedure SPI_T6963C_setGrPanel(dim n as word)
Description	Compute start address for selected graphic panel and set appropriate internal pointers. All subsequent graphic operations will be preformed at this graphic panel.
Parameters	`n:` graphic panel number. Valid values: `0` and `1`.
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	' set graphic panel 1 as current graphic panel. SPI_T6963C_setGrPanel(1)
Notes	None.

SPI_T6963C_setTxtPanel

Prototype	sub procedure SPI_T6963C_setTxtPanel(dim n as word)
Description	Compute start address for selected text panel and set appropriate internal pointers. All subsequent text operations will be preformed at this text panel.
Parameters	`n:` text panel number. Valid values: `0` and `1`.
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	' set text panel 1 as current text panel. SPI_T6963C_setTxtPanel(1)
Notes	None.

SPI_T6963C_panelFill

Prototype	sub procedure SPI_T6963C_panelFill(dim v as word)
Description	Fill current panel in full (graphic+text) with appropriate value (0 to clear).
Parameters	`v:` value to fill panel with.
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	' clear current panel SPI_T6963C_panelFill(0)
Notes	None.

SPI_T6963C_grFill

Prototype	sub procedure SPI_T6963C_grFill(dim v as word)
Description	Fill current graphic panel with appropriate value (0 to clear).
Parameters	`v:` value to fill graphic panel with.
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	' clear current graphic panel SPI_T6963C_grFill(0)
Notes	None.

SPI_T6963C_txtFill

Prototype	sub procedure SPI_T6963C_txtFill(dim v as word)
Description	Fill current text panel with appropriate value (0 to clear).
Parameters	`v:` this value increased by 32 will be used to fill text panel.
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	' clear current text panel SPI_T6963C_txtFill(0)
Notes	None.

SPI_T6963C_cursor_height

Prototype	sub procedure SPI_T6963C_cursor_height(dim n as byte)
Description	Set cursor size.
Parameters	`n:` cursor height. Valid values: `0`..`7`.
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	SPI_T6963C_cursor_height(7)
Notes	None.

SPI_T6963C_graphics

Prototype	sub procedure SPI_T6963C_graphics(dim n as word)
Description	Enable/disable graphic displaying.
Parameters	`n:` graphic enable/disable parameter. Valid values: `0` (disable graphic dispaying) and `1` (enable graphic displaying).
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	' enable graphic displaying SPI_T6963C_graphics(1)
Notes	None.

SPI_T6963C_text

Prototype	sub procedure SPI_T6963C_text(dim n as word)
Description	Enable/disable text displaying.
Parameters	`n:` text enable/disable parameter. Valid values: `0` (disable text dispaying) and `1` (enable text displaying).
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	' enable text displaying SPI_T6963C_text(1)
Notes	None.

SPI_T6963C_cursor

Prototype	sub procedure SPI_T6963C_cursor(dim n as word)
Description	Set cursor on/off.
Parameters	`n:` on/off parameter. Valid values: `0` (set cursor off) and `1` (set cursor on).
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	' set cursor on SPI_T6963C_cursor(1)
Notes	None.

SPI_T6963C_cursor_blink

Prototype	sub procedure SPI_T6963C_cursor_blink(dim n as word)
Description	Enable/disable cursor blinking.
Parameters	`n:` cursor blinking enable/disable parameter. Valid values: `0` (disable cursor blinking) and `1` (enable cursor blinking).
Returns	Nothing.
Requires	Toshiba Glcd module needs to be initialized. See SPI_T6963C_Config routine.
Example	' enable cursor blinking SPI_T6963C_cursor_blink(1)
Notes	None.

Library Example

The following drawing demo tests advanced routines of the SPI T6963C Glcd library. Hardware configurations in this example are made for the LV-32MX v6 board and PIC32MX460F512L.

Copy Code To Clipboard

program SPI_T6963C_240x128

include __Lib_SPIT6963C_Const

dim
' Port Expander module connections
   SPExpanderRST as sbit at LATD8_bit     ' for writing to output pin always use latch
   SPExpanderCS  as sbit at LATD9_bit     ' for writing to output pin always use latch
   SPExpanderRST_Direction as sbit at TRISD8_bit
   SPExpanderCS_Direction  as sbit at TRISD9_bit
' End Port Expander module connections

dim   panel as byte         ' current panel
          i as word         ' general purpose register
      curs  as byte         ' cursor visibility
      cposx,
      cposy as word         ' cursor x-y position
      txt, txt1 as string[29]
      txt2 as string[21]
main:
  #DEFINE COMPLETE_EXAMPLE
  #DEFINE LINE_DEMO           ' Uncomment to demonstrate line drawing routines
  #DEFINE FILL_DEMO           ' Uncomment to demonstrate fill routines
  #DEFINE PARTIAL_IMAGE_DEMO  ' Uncomment to demonstrate partial image routine

  txt1 = " EINSTEIN WOULD HAVE LIKED mE"
  txt  = " GLCD LIBRARY DEMO, WELCOME !"
  txt2 = " Partial image demo! "

  CHECON = 0x32
  AD1PCFG = 0xFFFF                               ' initialize AN pins as digital

  TRISB8_bit = 1               ' Set RB8 as input
  TRISB9_bit = 1               ' Set RB9 as input
  TRISB10_bit = 1              ' Set RB10 as input
  TRISB11_bit = 1              ' Set RB11 as input
  TRISB12_bit = 1              ' Set RB12 as input
  TRISB13_bit = 1              ' Set RB13 as input
  
  panel = 0
  i = 0
  curs = 0
  cposx = 0
  cposy = 0

  ' If Port Expander Library uses SPI1 module
  ' Initialize SPI module used with PortExpander
  SPI2_Init_Advanced(_SPI_MASTER,_SPI_8_BIT, 4, _SPI_SS_DISABLE,_SPI_DATA_SAMPLE_MIDDLE,_SPI_CLK_IDLE_LOW,_SPI_ACTIVE_2_IDLE)

  ' If Port Expander Library uses SPI2 module
  ' SPI2_Init_Advanced(_SPI_MASTER, _SPI_8_BIT, _SPI_PRESCALE_SEC_1, _SPI_PRESCALE_PRI_4, _SPI_SS_DISABLE, _SPI_DATA_SAMPLE_MIDDLE, _SPI_CLK_IDLE_LOW, _SPI_IDLE_2_ACTIVE)

'   * init display for 240 pixel width and 128 pixel height
'   * 8 bits character width
'   * data bus on MCP23S17 portB
'   * control bus on MCP23S17 portA
'   * bit 2 is !WR
'   * bit 1 is !RD
'   * bit 0 is !CD
'   * bit 4 is RST
'   * chip enable, reverse on, 8x8 font internaly set in library
  
  ' Initialize SPI Toshiba 240x128
  SPI_T6963C_Config(240, 128, 8, 0, 2, 1, 0, 4)
  Delay_ms(1000)

'     * Enable both graphics and text display at the same time
  
  SPI_T6963C_graphics(1)
  SPI_T6963C_text(1)

'     * Text messages
  SPI_T6963C_write_text(txt, 0, 0, SPI_T6963C_ROM_MODE_XOR)
  SPI_T6963C_write_text(txt1, 0, 15, SPI_T6963C_ROM_MODE_XOR)

  '*
  '* Cursor
  '*
  SPI_T6963C_cursor_height(8)         ' 8 pixel height
  SPI_T6963C_set_cursor(0, 0)         ' move cursor to top left
  SPI_T6963C_cursor(0)                ' cursor off

  '*
  '* Draw solid boxes
  '*
  SPI_T6963C_box(0, 0, 239, 8, SPI_T6963C_WHITE)
  SPI_T6963C_box(0, 119, 239, 127, SPI_T6963C_WHITE)

'   *
'   * Draw rectangles
'   *
  #IFDEF LINE_DEMO
    SPI_T6963C_rectangle(0, 0, 239, 127, SPI_T6963C_WHITE)
    SPI_T6963C_rectangle(20, 20, 219, 107, SPI_T6963C_WHITE)
    SPI_T6963C_rectangle(40, 40, 199, 87, SPI_T6963C_WHITE)
    SPI_T6963C_rectangle(60, 60, 179, 67, SPI_T6963C_WHITE)
  #ENDIF

'   *
'   * Draw rounded edge rectangle
'   *
  #IFDEF LINE_DEMO
    SPI_T6963C_Rectangle_Round_Edges(10, 10, 229, 117, 12, SPI_T6963C_WHITE)
    SPI_T6963C_Rectangle_Round_Edges(30, 30, 209, 97, 12, SPI_T6963C_WHITE)
    SPI_T6963C_Rectangle_Round_Edges(50, 50, 189, 77, 12, SPI_T6963C_WHITE)
  #ENDIF

'   *
'   * Draw filled rounded edge rectangle
'   *
  #IFDEF FILL_DEMO
    SPI_T6963C_Rectangle_Round_Edges_Fill(10, 10, 229, 117, 12, SPI_T6963C_WHITE)
    SPI_T6963C_Rectangle_Round_Edges_Fill(20, 20, 219, 107, 12, SPI_T6963C_BLACK)
    SPI_T6963C_Rectangle_Round_Edges_Fill(30, 30, 209, 97, 12, SPI_T6963C_WHITE)
    SPI_T6963C_Rectangle_Round_Edges_Fill(40, 40, 199, 87, 12, SPI_T6963C_BLACK)
    SPI_T6963C_Rectangle_Round_Edges_Fill(50, 50, 189, 77, 12, SPI_T6963C_WHITE)
  #ENDIF

'   *
'   * Draw a cross
'   *
  #IFDEF LINE_DEMO
    SPI_T6963C_line(0, 0, 239, 127, SPI_T6963C_WHITE)
    SPI_T6963C_line(0, 127, 239, 0, SPI_T6963C_WHITE)
  #ENDIF

'   *
'   * Draw circles
'   *
  #IFDEF LINE_DEMO
    SPI_T6963C_circle(120, 64, 10,  SPI_T6963C_WHITE)
    SPI_T6963C_circle(120, 64, 30,  SPI_T6963C_WHITE)
    SPI_T6963C_circle(120, 64, 50,  SPI_T6963C_WHITE)
    SPI_T6963C_circle(120, 64, 70,  SPI_T6963C_WHITE)
    SPI_T6963C_circle(120, 64, 90,  SPI_T6963C_WHITE)
    SPI_T6963C_circle(120, 64, 110, SPI_T6963C_WHITE)
    SPI_T6963C_circle(120, 64, 130, SPI_T6963C_WHITE)
  #ENDIF

'   *
'   * Draw filled circles
'   *
  #IFDEF FILL_DEMO
    SPI_T6963C_circle_fill(120, 64, 60, SPI_T6963C_WHITE)
    SPI_T6963C_circle_fill(120, 64, 55, SPI_T6963C_BLACK)
    SPI_T6963C_circle_fill(120, 64, 50, SPI_T6963C_WHITE)
    SPI_T6963C_circle_fill(120, 64, 45, SPI_T6963C_BLACK)
    SPI_T6963C_circle_fill(120, 64, 40, SPI_T6963C_WHITE)
    SPI_T6963C_circle_fill(120, 64, 35, SPI_T6963C_BLACK)
    SPI_T6963C_circle_fill(120, 64, 30, SPI_T6963C_WHITE)
    SPI_T6963C_circle_fill(120, 64, 25, SPI_T6963C_BLACK)
    SPI_T6963C_circle_fill(120, 64, 20, SPI_T6963C_WHITE)
    SPI_T6963C_circle_fill(120, 64, 15, SPI_T6963C_BLACK)
    SPI_T6963C_circle_fill(120, 64, 10, SPI_T6963C_WHITE)
    SPI_T6963C_circle_fill(120, 64, 5, SPI_T6963C_BLACK)
  #ENDIF

  Delay_ms(1000)
  SPI_T6963C_sprite(76, 4, @einstein_bmp, 88, 119)       ' Draw a sprite
  Delay_ms(1000)

  SPI_T6963C_setGrPanel(1)                           ' Select other graphic panel

  SPI_T6963C_image(@mikroE_240x128_bmp)
  SPI_T6963C_displayGrPanel(1)
  Delay_ms(1000)
  #IFDEF PARTIAL_IMAGE_DEMO
    SPI_T6963C_grFill(0)
    SPI_T6963C_PartialImage(0, 0, 64, 64, 240, 128, @mikroE_240x128_bmp)  ' Display partial image
    Delay_ms(1000)
    SPI_T6963C_graphics(0)
  #ENDIF
  SPI_T6963C_image(@mikroE_240x128_bmp)
  SPI_T6963C_graphics(1)
  SPI_T6963C_displayGrPanel(0)

  while TRUE                                        ' Endless loop

     '*
     '* If RB8 is pressed, toggle the display between graphic panel 0 and graphic 1
     '*
    if( RB8_bit <> 0) then
        Inc(panel)
        panel = panel and 1
        SPI_T6963C_setPtr((SPI_T6963C_grMemSize + SPI_T6963C_txtMemSize) * panel, SPI_T6963C_GRAPHIC_HOME_ADDRESS_SET)
        Delay_ms(300)

      '*
      '* If RB9 is pressed, display only graphic panel
      '*
      else
        if ( RB9_bit <> 0) then
            SPI_T6963C_graphics(1)
            SPI_T6963C_text(0)
            Delay_ms(300)

      '*
      '* If RB10 is pressed, display only text panel
      '*
        else
          if ( RB10_bit <> 0) then
              SPI_T6963C_graphics(0)
              SPI_T6963C_text(1)
              Delay_ms(300)

      '*
      '* If RB11 is pressed, display text and graphic panels
      '*
          else
            if ( RB11_bit <> 0) then
                SPI_T6963C_graphics(1)
                SPI_T6963C_text(1)
                Delay_ms(300)

      '*
      '* If RB12 is pressed, change cursor
      '*
            else
              if( RB12_bit <> 0) then
                  Inc(curs)
                  if (curs = 3) then
                    curs = 0
                  end if
                  select case curs
                    case 0
                       ' no cursor
                       SPI_T6963C_cursor(0)

                    case 1
                         ' blinking cursor
                         SPI_T6963C_cursor(1)
                         SPI_T6963C_cursor_blink(1)
                    case 2
                         ' non blinking cursor
                         SPI_T6963C_cursor(1)
                         SPI_T6963C_cursor_blink(0)
                  end select
                  Delay_ms(300)
              end if
      '*
      '* If RB13 is pressed, perform the "Partial image" demonstration
      '*
            #IFDEF PARTIAL_IMAGE_DEMO
              if( RB13_bit = 1) then
                SPI_T6963C_setGrPanel(0)
                SPI_T6963C_setTxtPanel(0)
                SPI_T6963C_txtFill(0)
                SPI_T6963C_setGrPanel(1)
                SPI_T6963C_setTxtPanel(0)
                SPI_T6963C_graphics(1)
                SPI_T6963C_text(1)
                SPI_T6963C_displayGrPanel(1)
                SPI_T6963C_write_text(txt2, 5, 15, SPI_T6963C_ROM_MODE_XOR)
                Delay_1sec()

                SPI_T6963C_grFill(0)
                SPI_T6963C_PartialImage(0, 0, 64, 64, 240, 128, @mikroE_240x128_bmp)
                Delay_ms(1500)

                SPI_T6963C_PartialImage(0, 0, 128, 128, 240, 128, @mikroE_240x128_bmp)
                Delay_ms(1500)

                SPI_T6963C_PartialImage(0, 0, 240, 128, 240, 128, @mikroE_240x128_bmp)
                Delay_ms(1500)

                SPI_T6963C_txtFill(0)
                SPI_T6963C_write_text(txt, 0, 0, SPI_T6963C_ROM_MODE_XOR)
                SPI_T6963C_write_text(txt1, 0, 15, SPI_T6963C_ROM_MODE_XOR)
              end if
            #ENDIF
            end if
          end if
        end if
    end if

      '*
      '* Move cursor, even if not visible
      '*
      Inc(cposx)
      if (cposx = SPI_T6963C_txtCols) then
        cposx = 0
        Inc(cposy)
        if (cposy = SPI_T6963C_grHeight div SPI_T6963C_CHARACTER_HEIGHT) then
          cposy = 0
        end if
      end if
      SPI_T6963C_set_cursor(cposx, cposy)

      Delay_ms(100)
  wend
end.

HW Connection

SPI T6963C Glcd HW connection

Want more examples and libraries?
Find them on