Initializes the Glcd module via SPI interface.

• DeviceAddress: SPI expander hardware address, see schematic at the bottom of this page

Nothing.

• SPExpanderCS: Chip Select line
• SPExpanderRST: Reset line
• SPExpanderCS_Direction: Direction of the Chip Select pin
• SPExpanderRST_Direction: Direction of the Reset pin

The SPI module needs to be initialized. See SPIx_Init and SPIx_Init_Advanced routines.

// Port Expander module connections
var SPExpanderRST : sbit at LATF0_bit;
    SPExpanderCS  : sbit at LATF1_bit;
    SPExpanderRST_Direction : sbit at TRISF0_bit;
    SPExpanderCS_Direction  : sbit at TRISF1_bit;
// End Port Expander module connections
...

// If Port Expander Library uses SPI module :
SPI1_Init();  // Initialize SPI module used with PortExpander
SPI_Glcd_Init(0);

None.

Selects Glcd side. Refer to the Glcd datasheet for detail explanation.

• 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.

Nothing.

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

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);

For side, x axis and page layout explanation see schematic at the bottom of this page.

Selects page of Glcd.

• page: page number. Valid values: 0..7

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

SPI_Glcd_Set_Page(5);

For side, x axis and page layout explanation see schematic at the bottom of this page.

Sets x-axis position to x_pos dots from the left border of Glcd within the selected side.

• x_pos: position on x-axis. Valid values: 0..63

Nothing.

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

SPI_Glcd_Set_X(25);

For side, x axis and page layout explanation see schematic at the bottom of this page.

Reads data from the current location of Glcd memory and moves to the next location.

One byte from Glcd memory.

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.

None.

var data_ : byte;
...
data_ := SPI_Glcd_Read_Data();

None.

Writes one byte to the current location in Glcd memory and moves to the next location.

• data_: data to be written

Nothing.

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.

var data_ : byte;
...
SPI_Glcd_Write_Data(data_);

None.

Nothing.

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: function External(offset : dword; count : dword; var num : dword) : ^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).

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.

SPI_Glcd_Set_Ext_Buffer(@ReadExternalBuffer);

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).

• pattern: byte to fill Glcd memory with

Nothing.

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

// Clear screen
SPI_Glcd_Fill(0);

None.

Draws a dot on Glcd at coordinates (x_pos, y_pos).

• 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.

Nothing.

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

// Invert the dot in the upper left corner
SPI_Glcd_Dot(0, 0, 2);

For x and y axis layout explanation see schematic at the bottom of this page..

Draws a line on Glcd.

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.

Nothing.

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

// Draw a line between dots (0,0) and (20,30)
SPI_Glcd_Line(0, 0, 20, 30, 1);

None.

Draws a vertical line on Glcd.

• 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.

Nothing.

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

// Draw a vertical line between dots (10,5) and (10,25)
SPI_Glcd_V_Line(5, 25, 10, 1);

None.

Draws a horizontal line on Glcd.

• 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.

Nothing.

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

// Draw a horizontal line between dots (10,20) and (50,20)
SPI_Glcd_H_Line(10, 50, 20, 1);

None.

Draws a rectangle on Glcd.

• 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.

Nothing.

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

// Draw a rectangle between dots (5,5) and (40,40)
SPI_Glcd_Rectangle(5, 5, 40, 40, 1);

None.

Draws a rounded edge rectangle on Glcd.

• 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
• radius: rounded edge radius.
• 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.

Nothing.

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routines.

// 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);

None.

Draws a filled rounded edge rectangle on Glcd.

• 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
• radius: rounded edge radius.
• 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.

Nothing.

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routines.

// Draws a filled rounded edge rectangle between dots (5,5) and (40,40) with the edge radius of 12
SPI_Glcd_Rectangle_Round_Edges(5, 5, 40, 40, 12, 1);

None.

Draws a box on Glcd.

• 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.

Nothing.

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

// Draw a box between dots (5,15) and (20,40)
SPI_Glcd_Box(5, 15, 20, 40, 1);

None.

Draws a circle on Glcd.

• 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.

Nothing.

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

// Draw a circle with center in (50,50) and radius=10
SPI_Glcd_Circle(50, 50, 10, 1);

None.

Draws a filled circle on Glcd.

• 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.

Nothing.

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

// Draw a filled circle with center in (50,50) and radius=10
SPI_Glcd_Circle_Fill(50, 50, 10, 1);

None.

Sets font that will be used with SPI_Glcd_Write_Char and SPI_Glcd_Write_Text routines.

• 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 mikroPascal PRO for PIC32 character set and regular ASCII set (eg. if 'A' is 65 in ASCII character, and 'A' is 45 in the mikroPascal PRO for PIC32 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.

• 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)

Nothing.

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

// Use the custom 5x7 font "myfont" which starts with space (32):
SPI_Glcd_Set_Font(@myfont, 5, 7, 32);

None.

Sets font that will be used with SPI_Glcd_Write_Char_Adv and SPI_Glcd_Write_Text_Adv routines.

• activeFont: font to be set. Needs to be formatted as an array of char.
• font_color: sets font color.
• font_orientation: sets font orientation.

Nothing.

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

SPI_Glcd_Set_Font_Adv(@myfont, 0, 0);

None.

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.

• 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.

Nothing.

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

SPI_Glcd_Set_Ext_Font_Adv(173296, 5, 7, 32);

None.

Prints character on the Glcd.

• 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.

Nothing.

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.

// Write character 'C' on the position 10 inside the page 2:
SPI_Glcd_Write_Char('C', 10, 2, 1);

For x axis and page layout explanation see schematic at the bottom of this page.

Nothing.

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.

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

SPI_Glcd_Write_Char_Adv('A',22,23);

Prints text on Glcd.

• 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.

Nothing.

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.

// Write text "Hello world!" on the position 10 inside the page 2:
SPI_Glcd_Write_Text('Hello world!', 10, 2, 1);

For x axis and page layout explanation see schematic at the bottom of this page.

Nothing.

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.

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

SPI_Glcd_Write_Text_Adv("GLCD LIBRARY DEMO, WELCOME !", 0, 0);	

Displays bitmap on Glcd.

• image: image to be displayed. Bitmap array can be located in both code and RAM memory (due to the mikroPascal PRO for PIC32 pointer to const and pointer to RAM equivalency).

Nothing.

SPI_Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

// Draw image my_image on Glcd
SPI_Glcd_Image(@my_image);

Use the mikroPascal PRO for PIC32 integrated Glcd Bitmap Editor, Tools > Glcd Bitmap Editor, to convert image to a constant array suitable for displaying on Glcd.

Displays a bitmap from an external resource.

• image: image to be displayed. This parameter represents the address in the exteral resource from where the image data begins.

Nothing.

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

SPI_Glcd_Ext_Image(153608);

Use the mikroPascal PRO for PIC32 integrated Glcd Bitmap Editor, Tools > Glcd Bitmap Editor, to convert image to a constant array suitable for displaying on Glcd.

Displays a partial area of the image on a desired location.

• 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 mikroPascal PRO for PIC pointer to const and pointer to RAM equivalency).

Nothing.

SPI_Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

// 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);

Use the mikroPascal PRO for PIC32 integrated Glcd Bitmap Editor, Tools > Glcd Bitmap Editor, to convert image to a constant array suitable for displaying on Glcd.

Displays a partial area of the image, located on an external resource, on a desired location of the screen.

• 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.

Nothing.

Glcd needs to be initialized for SPI communication, see SPI_Glcd_Init routine.

SPI_Glcd_Ext_PartialImage(10, 12, 10, 15, 16, 32, 0);

Use the mikroPascal PRO for PIC32 integrated Glcd Bitmap Editor, Tools > Glcd Bitmap Editor, to convert image to a constant array suitable for displaying on Glcd.