SPI Graphic Lcd Library

mikroBasic PRO for ARM provides a library for operating Graphic Lcd 128x64 (with commonly used Samsung KS108/KS107 controller) via SPI interface.

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

Important :

When using this library with ARM family MCUs be aware of their voltage incompatibility with certain number of Samsung KS0108 based Glcd modules.
So, additional external power supply for these modules may be required.
Library uses the SPI module for communication. The user must initialize the appropriate SPI module before using the SPI Glcd Library.
For MCUs with multiple SPI modules it is possible to initialize all of them and then switch by using the SPI_Set_Active() routine. See the SPI Library functions.
This Library is designed to work with the mikroElektronika's Serial Lcd/Glcd Adapter Board pinout, see schematic at the bottom of this page for details.

Library Dependency Tree

External dependencies of SPI Lcd Library

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

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

Library Routines

Basic routines:

SPI_Glcd_Init
SPI_Glcd_Set_Side
SPI_Glcd_Set_Page
SPI_Glcd_Set_X
SPI_Glcd_Read_Data
SPI_Glcd_Write_Data
SPI_Glcd_Set_Ext_Buffer

Advanced routines:

SPI_Glcd_Fill
SPI_Glcd_Dot
SPI_Glcd_Line
SPI_Glcd_V_Line
SPI_Glcd_H_Line
SPI_Glcd_Rectangle
SPI_Glcd_Rectangle_Round_Edges
SPI_Glcd_Rectangle_Round_Edges_Fill
SPI_Glcd_Box
SPI_Glcd_Circle
SPI_Glcd_Circle_Fill
SPI_Glcd_Set_Font
SPI_Glcd_Set_Font_Adv
SPI_Glcd_Write_Char
SPI_Glcd_Write_Char_Adv
SPI_Glcd_Write_Text
SPI_Glcd_Write_Text_Adv
SPI_Glcd_Image
SPI_Glcd_Ext_Image
SPI_Glcd_PartialImage
SPI_Glcd_Ext_PartialImage

SPI_Glcd_Init

Prototype	sub procedure SPI_Glcd_Init(dim DeviceAddress as byte)
Description	Initializes the Glcd module via SPI interface.
Parameters	`DeviceAddress:` SPI expander hardware address, see schematic at the bottom of this page
Returns	Nothing.
Requires	External dependencies are the same as Port Expander Library external dependencies. The SPI module needs to be initialized. See SPIx_Init and SPIx_Init_Advanced routines.
Example	Stellaris ' Port Expander module connections dim SPExpanderRST as sbit at GPIO_PORTA_DATA0_bit dim SPExpanderCS as sbit at GPIO_PORTA_DATA1_bit dim SPExpanderRST_Direction as sbit at GPIO_PORTA_DIR0_bit dim SPExpanderCS_Direction as sbit at GPIO_PORTA_DIR1_bit ' End Port Expander module connections ... ' If Port Expander Library uses SPI1 module SPI1_Init() ' Initialize SPI module used with PortExpander SPI_Glcd_Init(0) ' initialize GLCD mode over spi interface STM32 ' Port Expander module connections dim SPExpanderRST as sbit at GPIOB_ODR.B0 SPExpanderCS as sbit at GPIOB_ODR.B1 ' End Port Expander module connections ... ' If Port Expander Library uses SPI1 module SPI1_Init() ' Initialize SPI module used with PortExpander SPI_Glcd_Init(0) ' initialize GLCD over spi interface
Notes	None.

SPI_Glcd_Set_Side

Prototype	sub procedure SPI_Glcd_Set_Side(dim x_pos as byte)
Description	Selects Glcd side. Refer to the Glcd datasheet for detail explanation.
Parameters	`x_pos:` position on x-axis. Valid values: 0..127 The parameter `x_pos` specifies the Glcd side: values from 0 to 63 specify the left side, values from 64 to 127 specify the right side.
Returns	Nothing.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.
Example	The following two lines are equivalent, and both of them select the left side of Glcd: SPI_Glcd_Set_Side(0) SPI_Glcd_Set_Side(10)
Notes	For side, x axis and page layout explanation see schematic at the bottom of this page.

SPI_Glcd_Set_Page

Prototype	sub procedure SPI_Glcd_Set_Page(dim page as byte)
Description	Selects page of Glcd.
Returns	`page:` page number. Valid values: 0..7
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.
Example	SPI_Glcd_Set_Page(5)
Notes	For side, x axis and page layout explanation see schematic at the bottom of this page.

SPI_Glcd_Set_X

Prototype	sub procedure SPI_Glcd_Set_X(dim x_pos as byte)
Description	Sets x-axis position to `x_pos` dots from the left border of Glcd within the selected side.
Parameters	`x_pos:` position on x-axis. Valid values: 0..63
Returns	Nothing.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.
Example	SPI_Glcd_Set_X(25)
Notes	For side, x axis and page layout explanation see schematic at the bottom of this page.

SPI_Glcd_Read_Data

Prototype	sub function SPI_Glcd_Read_Data() as byte
Description	Reads data from the current location of Glcd memory and moves to the next location.
Returns	One byte from Glcd memory.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine. Glcd side, x-axis position and page should be set first. See the functions SPI_Glcd_Set_Side, SPI_Glcd_Set_X, and SPI_Glcd_Set_Page.
Parameters	None.
Example	dim data_ as byte ... data_ = SPI_Glcd_Read_Data()
Notes	None.

SPI_Glcd_Write_Data

Prototype	sub procedure SPI_Glcd_Write_Data(dim data_ as byte)
Description	Writes one byte to the current location in Glcd memory and moves to the next location.
Parameters	`data_:` data to be written
Returns	Nothing.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine. Glcd side, x-axis position and page should be set first. See the functions SPI_Glcd_Set_Side, SPI_Glcd_Set_X, and SPI_Glcd_Set_Page.
Example	dim data_ as byte ... SPI_Glcd_Write_Data(data_)
Notes	None.

SPI_Glcd_Set_Ext_Buffer

Prototype	sub procedure SPI_Glcd_Set_Ext_Buffer(dim getExtDataPtr as ^TSPI_Glcd_Get_Ext_Data_Ptr)
Returns	Nothing.
Description	Function sets pointer to the user function which manipulates the external resource. Parameters : `TSPI_Glcd_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	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine. Glcd side, x-axis position and page should be set first. See the functions SPI_Glcd_Set_Side, SPI_Glcd_Set_X, and SPI_Glcd_Set_Page.
Example	Glcd_Set_Ext_Buffer(@ReadExternalBuffer)

SPI_Glcd_Fill

Prototype	sub procedure SPI_Glcd_Fill(dim pattern as byte)
Description	Fills Glcd memory with byte `pattern`. To clear the Glcd screen, use `SPI_Glcd_Fill(0)`. To fill the screen completely, use `SPI_Glcd_Fill(0xFF)`.
Parameters	`pattern:` byte to fill Glcd memory with
Returns	Nothing.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.
Example	' Clear screen SPI_Glcd_Fill(0)
Notes	None.

SPI_Glcd_Dot

Prototype	sub procedure SPI_Glcd_Dot(dim x_pos, y_pos, color as byte)
Description	Draws a dot on Glcd at coordinates (`x_pos`, `y_pos`).
Parameters	`x_pos:` x position. Valid values: 0..127 `y_pos:` y position. Valid values: 0..63 `color:` color parameter. Valid values: 0..2 The parameter `color` determines the dot state: 0 clears dot, 1 puts a dot, and 2 inverts dot state.
Returns	Nothing.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.
Example	' Invert the dot in the upper left corner SPI_Glcd_Dot(0, 0, 2)
Notes	For x and y axis layout explanation see schematic at the bottom of this page..

SPI_Glcd_Line

Prototype	sub procedure SPI_Glcd_Line(dim x_start, y_start, x_end, y_end as integer, dim color as byte)
Description	Draws a line on Glcd. Parameters :
Parameters	`x_start:` x coordinate of the line start. Valid values: 0..127 `y_start:` y coordinate of the line start. Valid values: 0..63 `x_end:` x coordinate of the line end. Valid values: 0..127 `y_end:` y coordinate of the line end. Valid values: 0..63 `color:` color parameter. Valid values: 0..2 Parameter `color` determines the line color: 0 white, 1 black, and 2 inverts each dot.
Returns	Nothing.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.
Example	' Draw a line between dots (0,0) and (20,30) SPI_Glcd_Line(0, 0, 20, 30, 1)
Notes	None.

SPI_Glcd_V_Line

Prototype	sub procedure SPI_Glcd_V_Line(dim y_start, y_end, x_pos, color as byte)
Description	Draws a vertical line on Glcd.
Parameters	`y_start:` y coordinate of the line start. Valid values: 0..63 `y_end:` y coordinate of the line end. Valid values: 0..63 `x_pos:` x coordinate of vertical line. Valid values: 0..127 `color:` color parameter. Valid values: 0..2 Parameter `color` determines the line color: 0 white, 1 black, and 2 inverts each dot.
Returns	Nothing.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.
Example	' Draw a vertical line between dots (10,5) and (10,25) SPI_Glcd_V_Line(5, 25, 10, 1)
Notes	None.

SPI_Glcd_H_Line

Prototype	sub procedure SPI_Glcd_H_Line(dim x_start, x_end, y_pos, color as byte)
Description	Draws a horizontal line on Glcd.
Parameters	`x_start:` x coordinate of the line start. Valid values: 0..127 `x_end:` x coordinate of the line end. Valid values: 0..127 `y_pos:` y coordinate of horizontal line. Valid values: 0..63 `color:` color parameter. Valid values: 0..2 The parameter `color` determines the line color: 0 white, 1 black, and 2 inverts each dot.
Returns	Nothing.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.
Example	' Draw a horizontal line between dots (10,20) and (50,20) SPI_Glcd_H_Line(10, 50, 20, 1)
Notes	None.

SPI_Glcd_Rectangle

Prototype	sub procedure SPI_Glcd_Rectangle(dim x_upper_left, y_upper_left, x_bottom_right, y_bottom_right, color as byte)
Description	Draws a rectangle on Glcd.
Parameters	`x_upper_left:` x coordinate of the upper left rectangle corner. Valid values: 0..127 `y_upper_left:` y coordinate of the upper left rectangle corner. Valid values: 0..63 `x_bottom_right:` x coordinate of the lower right rectangle corner. Valid values: 0..127 `y_bottom_right:` y coordinate of the lower right rectangle corner. Valid values: 0..63 `color:` color parameter. Valid values: 0..2 The parameter `color` determines the color of the rectangle border: 0 white, 1 black, and 2 inverts each dot.
Returns	Nothing.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.
Example	' Draw a rectangle between dots (5,5) and (40,40) SPI_Glcd_Rectangle(5, 5, 40, 40, 1)
Notes	None.

SPI_Glcd_Rectangle_Round_Edges

Prototype	sub procedure Glcd_Rectangle_Round_Edges(dim x_upper_left as byte, dim y_upper_left as byte, dim x_bottom_right as byte, dim y_bottom_right as byte, dim radius as byte, dim color as byte)
Description	Draws a rounded edge rectangle on Glcd.
Parameters	`x_upper_left:` x coordinate of the upper left rectangle corner. Valid values: 0..127 `y_upper_left:` y coordinate of the upper left rectangle corner. Valid values: 0..63 `x_bottom_right:` x coordinate of the lower right rectangle corner. Valid values: 0..127 `y_bottom_right:` y coordinate of the lower right rectangle corner. Valid values: 0..63 `round_radius:` radius of the rounded edge. `color:` color parameter. Valid values: 0..2 The parameter `color` determines the color of the rectangle border: 0 white, 1 black, and 2 inverts each dot.
Returns	Nothing.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routines.
Example	' Draw a rounded edge rectangle between dots (5,5) and (40,40) with the radius of 12 SPI_Glcd_Rectangle_Round_Edges(5, 5, 40, 40, 12, 1)
Notes	None.

SPI_Glcd_Rectangle_Round_Edges_Fill

Prototype	sub procedure SPI_Glcd_Rectangle_Round_Edges_Fill(dim x_upper_left as byte, dim y_upper_left as byte, dim x_bottom_right as byte, dim y_bottom_right as byte, dim radius as byte, dim color as byte)
Description	Draws a filled rounded edge rectangle on Glcd.
Parameters	`x_upper_left:` x coordinate of the upper left rectangle corner. Valid values: 0..127 `y_upper_left:` y coordinate of the upper left rectangle corner. Valid values: 0..63 `x_bottom_right:` x coordinate of the lower right rectangle corner. Valid values: 0..127 `y_bottom_right:` y coordinate of the lower right rectangle corner. Valid values: 0..63 `round_radius:` radius of the rounded edge. `color:` color parameter. Valid values: 0..2 The parameter `color` determines the color of the rectangle : 0 white, 1 black, and 2 inverts each dot.
Returns	Nothing.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routines.
Example	' Draws a filled rounded edge rectangle between dots (5,5) and (40,40) with the radius of 12 SPI_Glcd_Rectangle_Round_Edges_Fill(5, 5, 40, 40, 12, 1)
Notes	None.

SPI_Glcd_Box

Prototype	sub procedure SPI_Glcd_Box(dim x_upper_left, y_upper_left, x_bottom_right, y_bottom_right, color as byte)
Description	Draws a box on Glcd.
Parameters	`x_upper_left:` x coordinate of the upper left box corner. Valid values: 0..127 `y_upper_left:` y coordinate of the upper left box corner. Valid values: 0..63 `x_bottom_right:` x coordinate of the lower right box corner. Valid values: 0..127 `y_bottom_right:` y coordinate of the lower right box corner. Valid values: 0..63 `color:` color parameter. Valid values: 0..2 The parameter `color` determines the color of the box fill: 0 white, 1 black, and 2 inverts each dot.
Returns	Nothing.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.
Example	' Draw a box between dots (5,15) and (20,40) SPI_Glcd_Box(5, 15, 20, 40, 1)
Notes	None.

SPI_Glcd_Circle

Prototype	sub procedure SPI_Glcd_Circle(dim x_center, y_center, radius as integer, dim color as byte)
Description	Draws a circle on Glcd.
Parameters	`x_center:` x coordinate of the circle center. Valid values: 0..127 `y_center:` y coordinate of the circle center. Valid values: 0..63 `radius:` radius size `color:` color parameter. Valid values: 0..2 The parameter `color` determines the color of the circle line: 0 white, 1 black, and 2 inverts each dot.
Returns	Nothing.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.
Example	' Draw a circle with center in (50,50) and radius=10 SPI_Glcd_Circle(50, 50, 10, 1)
Notes	None.

SPI_Glcd_Circle_Fill

Prototype	sub procedure SPI_Glcd_Circle_Fill(dim x_center as integer, dim y_center as integer, dim radius as integer, dim color as byte)
Description	Draws a filled circle on Glcd.
Parameters	`x_center:` x coordinate of the circle center. Valid values: 0..127 `y_center:` y coordinate of the circle center. Valid values: 0..63 `radius:` radius size `color:` color parameter. Valid values: 0..2 The parameter `color` determines the color of the circle : 0 white, 1 black, and 2 inverts each dot.
Returns	Nothing.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.
Example	' Draw a circle with center in (50,50) and radius=10 SPI_Glcd_Circle_Fill(50, 50, 10, 1)
Notes	None.

SPI_Glcd_Set_Font

Prototype	sub procedure SPI_Glcd_Set_Font(dim activeFont as LongInt, dim aFontWidth, aFontHeight as byte, dim aFontOffs as word)
Description	Sets font that will be used with SPI_Glcd_Write_Char and SPI_Glcd_Write_Text routines.
Parameters	`activeFont:` font to be set. Needs to be formatted as an array of char `aFontWidth:` width of the font characters in dots. `aFontHeight:` height of the font characters in dots. `aFontOffs:` number that represents difference between the mikroBasic PRO for ARM character set and regular ASCII set (eg. if 'A' is 65 in ASCII character, and 'A' is 45 in the mikroBasic PRO for ARM character set, aFontOffs is 20). Demo fonts supplied with the library have an offset of 32, which means that they start with space. The user can use fonts given in the file `__Lib_GLCDFonts` file located in the Uses folder or create his own fonts. List of supported fonts: `Font_Glcd_System3x5` `Font_Glcd_System5x7` `Font_Glcd_5x7` `Font_Glcd_Character8x7` For the sake of the backward compatibility, these fonts are supported also: `System3x5` (equivalent to `Font_Glcd_System3x5`) `FontSystem5x7_v2` (equivalent to `Font_Glcd_System5x7`) `font5x7` (equivalent to `Font_Glcd_5x7`) `Character8x7` (equivalent to `Font_Glcd_Character8x7`)
Returns	Nothing.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.
Example	' Use the custom 5x7 font "myfont" which starts with space (32): SPI_Glcd_Set_Font(@myfont, 5, 7, 32)
Notes	None.

SPI_Glcd_Set_Font_Adv

Prototype	sub procedure SPI_Glcd_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_Glcd_Write_Char_Adv and SPI_Glcd_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	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.
Example	SPI_Glcd_Set_Font_Adv(@myfont, 0, 0)
Notes	None.

SPI_Glcd_Set_Ext_Font_Adv

Prototype	sub procedure SPI_Glcd_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_Glcd_Write_Char_Adv and SPI_Glcd_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. `aFontWidth:` width of the font characters in dots. `aFontHeight:` height of the font characters in dots. `aFontOffs:` number that represents difference between the mikroBasic PRO for ARM character set and regular ASCII set (eg. if 'A' is 65 in ASCII character, and 'A' is 45 in the mikroBasic PRO for ARM character set, aFontOffs is 20). Demo fonts supplied with the library have an offset of 32, which means that they start with space.
Returns	Nothing.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.
Example	Glcd_Set_Ext_Font_Adv(173296, 5, 7, 32)
Notes	None.

SPI_Glcd_Write_Char

Prototype	sub procedure SPI_Glcd_Write_Char(dim chr1, x_pos, page_num, color as byte)
Description	Prints character on Glcd.
Parameters	`chr1:` character to be written `x_pos:` character starting position on x-axis. Valid values: 0..(127-FontWidth) `page_num:` the number of the page on which character will be written. Valid values: 0..7 `color:` color parameter. Valid values: 0..2 The parameter `color` determines the color of the character: 0 white, 1 black, and 2 inverts each dot.
Returns	Nothing.
Requires	SPI_Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine. Use the SPI_Glcd_Set_Font to specify the font for display; if no font is specified, then the default `Font_Glcd_System5x7` font supplied with the library will be used.
Example	' Write character 'C' on the position 10 inside the page 2: SPI_Glcd_Write_Char("C", 10, 2, 1)
Notes	For x axis and page layout explanation see schematic at the bottom of this page.

SPI_Glcd_Write_Char_Adv

Prototype	sub procedure SPI_Glcd_Write_Char_Adv(dim ch, x, y as word)
Returns	Nothing.
Description	Writes a char on the glcd at coordinates (x, y). `c:` char to be written. `x:` char position on x-axis. `y:` char position on y-axis.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.
Example	Glcd_Write_Char_Adv("A",22,23)

SPI_Glcd_Write_Text

Prototype	sub procedure SPI_Glcd_Write_Text(dim byref text as char[40], dim x_pos, page_num, color as byte)
Description	Prints text on Glcd.
Parameters	`text:` text to be written `x_pos:` text starting position on x-axis. `page_num:` the number of the page on which text will be written. Valid values: 0..7 `color:` color parameter. Valid values: 0..2 The parameter `color` determines the color of the text: 0 white, 1 black, and 2 inverts each dot.
Returns	Nothing.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine. Use the SPI_Glcd_Set_Font to specify the font for display; if no font is specified, then the default `Font_Glcd_System5x7` font supplied with the library will be used.
Example	' Write text "Hello world!" on the position 10 inside the page 2: SPI_Glcd_Write_Text("Hello world!", 10, 2, 1)
Notes	For x axis and page layout explanation see schematic at the bottom of this page.

SPI_Glcd_Write_Text_Adv

Prototype	sub procedure SPI_Glcd_Write_Text_Adv(dim byref text as string, dim x, y as word)
Returns	Nothing.
Description	Writes text on the glcd at coordinates (x, y). Parameters : `text:` text to be written. `x:` text position on x-axis. `y:` text position on y-axis.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.
Example	Glcd_Write_Text_Adv("GLCD LIBRARY DEMO, WELCOME !", 0, 0)

SPI_Glcd_Image

Prototype	sub procedure SPI_Glcd_Image(dim byref const image as byte)
Description	Displays bitmap on Glcd.
Parameters	`image:` image to be displayed. Bitmap array can be located in both code and RAM memory (due to the mikroBasic PRO for ARM pointer to const and pointer to RAM equivalency).
Returns	Nothing.
Requires	SPI_Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.
Example	SPI_Glcd_Image(@my_image)
Notes	Use the mikroBasic PRO for ARM integrated Glcd Bitmap Editor, Tools > Glcd Bitmap Editor, to convert image to a constant array suitable for displaying on Glcd.

SPI_Glcd_Ext_Image

Prototype	sub procedure SPI_Glcd_Ext_Image(dim image as longword)
Description	Displays a bitmap from an external resource.
Parameters	`image:` image to be displayed. This parameter represents the address in the exteral resource from where the image data begins.
Returns	Nothing.
Requires	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.
Example	Glcd_Ext_Image(153608)
Notes	Use the mikroBasic PRO for ARM integrated Glcd Bitmap Editor, Tools > Glcd Bitmap Editor, to convert image to a constant array suitable for displaying on Glcd.

SPI_Glcd_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 ARM pointer to const and pointer to RAM equivalency).
Returns	Nothing.
Requires	SPI_Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init 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_Glcd_PartialImage(10, 12, 10, 15, 16, 32, @image)
Notes	Use the mikroBasic PRO for ARM integrated Glcd Bitmap Editor, Tools > Glcd Bitmap Editor, to convert image to a constant array suitable for displaying on Glcd.

SPI_Glcd_Ext_PartialImage

Prototype	sub procedure SPI_Glcd_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, located on an external resource, on a desired location of the screen.
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	Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.
Example	Glcd_Ext_PartialImage(10, 12, 10, 15, 16, 32, 0)
Notes	Use the mikroBasic PRO for ARM integrated Glcd Bitmap Editor, Tools > Glcd Bitmap Editor, to convert image to a constant array suitable for displaying on Glcd.

Library Example

The example demonstrates how to communicate to KS0108 Glcd via the SPI module, using serial to parallel convertor MCP23S17.

Stellaris

Copy Code To Clipboard

program SPI_Glcd

' Port Expander module connections
dim SPExpanderRST as sbit at GPIO_PORTA_DATA.B0
    SPExpanderCS  as sbit at GPIO_PORTA_DATA.B1
    SPExpanderRST_Direction as sbit at GPIO_PORTA_DIR.B0
    SPExpanderCS_Direction  as sbit at GPIO_PORTA_DIR.B1
' End Port Expander module connections

dim someText as char[20]
    counter as byte

sub procedure Delay2S
  Delay_ms(2000)
end sub

main:

  ' Initialize SPI module used with PortExpander
  SPI0_Init()

  SPI_Glcd_Init(0)                                        ' Initialize Glcd via SPI
  SPI_Glcd_Fill(0x00)                                     ' Clear Glcd

  while TRUE
    SPI_Glcd_Image(@truck_bmp)                            ' Draw image
    Delay2s() Delay2s()
    SPI_Glcd_fill(0x00)                                   ' Clear GLCD
    SPI_Glcd_PartialImage(0,0,68,30,128,64,@truck_bmp)    ' Partial image
    Delay_ms(500)
    SPI_Glcd_PartialImage(24,16,68,30,128,64,@truck_bmp)
    Delay_ms(500)
    SPI_Glcd_PartialImage(56,34,68,30,128,64,@truck_bmp)
    Delay2s() Delay2s()
    SPI_Glcd_Fill(0x00)                                   ' Clear GLCD

    SPI_Glcd_Box(62,40,124,56,1)                          ' Draw box
    SPI_Glcd_Rectangle(5,5,84,35,1)                       ' Draw rectangle
    Delay_ms(1000)
    SPI_Glcd_Rectangle_Round_Edges(2,2,87,38,7,1)
    Delay_ms(1000)
    SPI_Glcd_Rectangle_Round_Edges_Fill(8,8,81,32,12,1)
    Delay_ms(1000)
    SPI_Glcd_Line(0, 0, 127, 63, 1)                       ' Draw line
    Delay2s()

    counter = 5

    while (counter <= 59)                                 ' Draw horizontal and vertical lines
      Delay_ms(250)
      SPI_Glcd_V_Line(2, 54, counter, 1)
      SPI_Glcd_H_Line(2, 120, counter, 1)
      counter = counter + 5
    wend

    Delay2S()

    SPI_Glcd_Fill(0x00)                                   ' Clear GLCD

    SPI_Glcd_Set_Font(@Font_Glcd_Character8x7, 8, 7, 32)  ' Choose font "Character8x7"
    SPI_Glcd_Write_Text("mikroE", 1, 7, 2)                ' Write string

    for counter = 1 to 10                                 ' Draw circles
      SPI_Glcd_Circle(63,32, 3*counter, 1)
    next counter
    Delay2S()

    SPI_Glcd_Circle_Fill(63,32, 30, 1)                    ' Draw circles
    Delay2s()

    SPI_Glcd_Box(10,20, 70,63, 2)                         ' Draw box
    Delay2s()

    SPI_Glcd_Fill(0xFF)                                   ' Fill GLCD
    SPI_Glcd_Set_Font(@Font_Glcd_Character8x7, 8, 7, 32)  ' Change font
    someText = "8x7 Font"
    SPI_Glcd_Write_Text(someText, 5, 0, 2)                ' Write string
    Delay2s()

    SPI_Glcd_Set_Font(@Font_Glcd_System3x5, 3, 5, 32)     ' Change font
    someText = "3X5 CAPITALS ONLY"
    SPI_Glcd_Write_Text(someText, 60, 2, 2)               ' Write string
    Delay2s()

    SPI_Glcd_Set_Font(@Font_Glcd_5x7, 5, 7, 32)           ' Change font
    someText = "5x7 Font"
    SPI_Glcd_Write_Text(someText, 5, 4, 2)                ' Write string
    Delay2s()

    SPI_Glcd_Set_Font(@Font_Glcd_System5x7, 5, 7, 32)     ' Change font
    someText = "5x7 Font (v2)"
    SPI_Glcd_Write_Text(someText, 50, 6, 2)               ' Write string
    Delay2s()
  wend
end.

STM32

Copy Code To Clipboard

program SPI_Glcd

' Port Expander module connections
dim SPExpanderRST as sbit at GPIOB_ODR.B0
    SPExpanderCS  as sbit at GPIOB_ODR.B1
' End Port Expander module connections

dim someText as char[20]
    counter as byte

sub procedure Delay2S
  Delay_ms(2000)
end sub

main:

  ' Initialize SPI module used with PortExpander
  SPI1_Init_Advanced(_SPI_FPCLK_DIV4, _SPI_MASTER  or _SPI_8_BIT or
                     _SPI_CLK_IDLE_LOW or _SPI_FIRST_CLK_EDGE_TRANSITION or
                     _SPI_MSB_FIRST or _SPI_SS_DISABLE or _SPI_SSM_ENABLE or _SPI_SSI_1,
                     @_GPIO_MODULE_SPI1_PB345)

  GPIO_Alternate_Function_Enable(@_GPIO_MODULE_SWJ_JTAGDISABLE)

  SPI_Glcd_Init(0)                                        ' Initialize Glcd via SPI
  SPI_Glcd_Fill(0x00)                                     ' Clear Glcd

  while TRUE
    SPI_Glcd_Image(@truck_bmp)                            ' Draw image
    Delay2s() Delay2s()
    SPI_Glcd_fill(0x00)                                   ' Clear GLCD
    SPI_Glcd_PartialImage(0,0,68,30,128,64,@truck_bmp)    ' Partial image
    Delay_ms(500)
    SPI_Glcd_PartialImage(24,16,68,30,128,64,@truck_bmp)
    Delay_ms(500)
    SPI_Glcd_PartialImage(56,34,68,30,128,64,@truck_bmp)
    Delay2s() Delay2s()
    SPI_Glcd_Fill(0x00)                                   ' Clear GLCD

    SPI_Glcd_Box(62,40,124,56,1)                          ' Draw box
    SPI_Glcd_Rectangle(5,5,84,35,1)                       ' Draw rectangle
    Delay_ms(1000)
    SPI_Glcd_Rectangle_Round_Edges(2,2,87,38,7,1)
    Delay_ms(1000)
    SPI_Glcd_Rectangle_Round_Edges_Fill(8,8,81,32,12,1)
    Delay_ms(1000)
    SPI_Glcd_Line(0, 0, 127, 63, 1)                       ' Draw line
    Delay2s()

    counter = 5

    while (counter <= 59)                                 ' Draw horizontal and vertical lines
      Delay_ms(250)
      SPI_Glcd_V_Line(2, 54, counter, 1)
      SPI_Glcd_H_Line(2, 120, counter, 1)
      counter = counter + 5
    wend

    Delay2S()

    SPI_Glcd_Fill(0x00)                                   ' Clear GLCD

    SPI_Glcd_Set_Font(@Font_Glcd_Character8x7, 8, 7, 32)  ' Choose font "Character8x7"
    SPI_Glcd_Write_Text("mikroE", 1, 7, 2)                ' Write string

    for counter = 1 to 10                                 ' Draw circles
      SPI_Glcd_Circle(63,32, 3*counter, 1)
    next counter
    Delay2S()

    SPI_Glcd_Circle_Fill(63,32, 30, 1)                    ' Draw circles
    Delay2s()

    SPI_Glcd_Box(10,20, 70,63, 2)                         ' Draw box
    Delay2s()

    SPI_Glcd_Fill(0xFF)                                   ' Fill GLCD
    SPI_Glcd_Set_Font(@Font_Glcd_Character8x7, 8, 7, 32)  ' Change font
    someText = "8x7 Font"
    SPI_Glcd_Write_Text(someText, 5, 0, 2)                ' Write string
    Delay2s()

    SPI_Glcd_Set_Font(@Font_Glcd_System3x5, 3, 5, 32)     ' Change font
    someText = "3X5 CAPITALS ONLY"
    SPI_Glcd_Write_Text(someText, 60, 2, 2)               ' Write string
    Delay2s()

    SPI_Glcd_Set_Font(@Font_Glcd_5x7, 5, 7, 32)           ' Change font
    someText = "5x7 Font"
    SPI_Glcd_Write_Text(someText, 5, 4, 2)                ' Write string
    Delay2s()

    SPI_Glcd_Set_Font(@Font_Glcd_System5x7, 5, 7, 32)     ' Change font
    someText = "5x7 Font (v2)"
    SPI_Glcd_Write_Text(someText, 50, 6, 2)               ' Write string
    Delay2s()
  wend
end.

Want more examples and libraries?
Find them on