void Glcd_Init();

Nothing.

Initializes the Glcd module. Each of the control lines is both port and pin configurable, while data lines must be on a single port (pins <0:7>).

Global variables :

• GLCD_CS1 : Chip select 1 signal pin
• GLCD_CS2 : Chip select 2 signal pin
• GLCD_RS : Register select signal pin
• GLCD_RW : Read/Write Signal pin
• GLCD_EN : Enable signal pin
• GLCD_RST : Reset signal pin
• GLCD_DataPort : Data port


• GLCD_CS1_Direction : Direction of the Chip select 1 pin
• GLCD_CS2_Direction : Direction of the Chip select 2 pin
• GLCD_RS_Direction : Direction of the Register select signal pin
• GLCD_RW_Direction : Direction of the Read/Write signal pin
• GLCD_EN_Direction : Direction of the Enable signal pin
• GLCD_RST_Direction : Direction of the Reset signal pin

void Glcd_Set_Side(unsigned short x_pos);

Nothing.

Selects Glcd side. Refer to the Glcd datasheet for detailed 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.

Glcd needs to be initialized, see Glcd_Init routine.

The following two lines are equivalent, and both of them select the left side of Glcd:

void Glcd_Set_X(unsigned short x_pos);

Nothing.

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

Glcd needs to be initialized, see Glcd_Init routine.

void Glcd_Set_Page(unsigned short page);

Nothing.

Selects page of the Glcd.

Parameters :

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

Glcd needs to be initialized, see Glcd_Init routine.

unsigned short Glcd_Read_Data();

One byte from Glcd memory.

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

Glcd needs to be initialized, see Glcd_Init routine.

Glcd side, x-axis position and page should be set first. See functions Glcd_Set_Side, Glcd_Set_X, and Glcd_Set_Page.

void Glcd_Write_Data(unsigned short ddata);

Nothing.

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

Parameters :

• ddata: data to be written

Glcd needs to be initialized, see Glcd_Init routine.

Glcd side, x-axis position and page should be set first. See functions Glcd_Set_Side, Glcd_Set_X, and Glcd_Set_Page.

void Glcd_Set_Ext_Buffer(char* (*getExtDataPtr)(unsigned long offset, unsigned int count, unsigned int *num));

Nothing.

Function sets pointer to the user function which manipulates the external resource.

Parameters :

• 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 ob byte (less or equal to the number of acqired bytes).

Glcd module needs to be initialized. See the Glcd_Init routine.

void Glcd_Fill(unsigned short pattern);

Nothing.

Fills Glcd memory with the byte pattern.

Parameters :

• pattern: byte to fill Glcd memory with

To clear the Glcd screen, use Glcd_Fill(0).

To fill the screen completely, use Glcd_Fill(0xFF).

Glcd needs to be initialized, see Glcd_Init routine.

void Glcd_Dot(unsigned short x_pos, unsigned short y_pos, unsigned short color);

Nothing.

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 a dot state: 0 clears dot, 1 puts a dot, and 2 inverts dot state.

Glcd needs to be initialized, see Glcd_Init routine.

void Glcd_Line(int x_start, int y_start, int x_end, int y_end, unsigned short color);

Nothing.

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

The parameter color determines the line color: 0 white, 1 black, and 2 inverts each dot.

Glcd needs to be initialized, see Glcd_Init routine.

void Glcd_V_Line(unsigned short y_start, unsigned short y_end, unsigned short x_pos, unsigned short color);

Nothing.

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

The parameter color determines the line color: 0 white, 1 black, and 2 inverts each dot.

Glcd needs to be initialized, see Glcd_Init routine.

void Glcd_H_Line(unsigned short x_start, unsigned short x_end, unsigned short y_pos, unsigned short color);

Nothing.

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.

Glcd needs to be initialized, see Glcd_Init routine.

void Glcd_Rectangle(unsigned short x_upper_left, unsigned short y_upper_left, unsigned short x_bottom_right, unsigned short y_bottom_right, unsigned short color);

Nothing.

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.

Glcd needs to be initialized, see Glcd_Init routine.

void Glcd_Rectangle_Round_Edges(unsigned short x_upper_left, unsigned short y_upper_left, unsigned short x_bottom_right, unsigned short y_bottom_right, unsigned short round_radius, unsigned short color);

Nothing.

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.

Glcd needs to be initialized, see Glcd_Init routine.

void Glcd_Rectangle_Round_Edges_Fill(unsigned short x_upper_left, unsigned short y_upper_left, unsigned short x_bottom_right, unsigned short y_bottom_right, unsigned short round_radius, unsigned short color);

Nothing.

Draws a filled rounded edge rectangle on Glcd with color.

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.

Glcd needs to be initialized, see Glcd_Init routine.

void Glcd_Box(unsigned short x_upper_left, unsigned short y_upper_left, unsigned short x_bottom_right, unsigned short y_bottom_right, unsigned short color);

Nothing.

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.

Glcd needs to be initialized, see Glcd_Init routine.

void Glcd_Circle(int x_center, int y_center, int radius, unsigned short color);

Nothing.

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.

Glcd needs to be initialized, see Glcd_Init routine.

void Glcd_Circle_Fill(int x_center, int y_center, int radius, unsigned short color);

Nothing.

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 line: 0 white, 1 black, and 2 inverts each dot.

Glcd needs to be initialized, see Glcd_Init routine.

void Glcd_Set_Font(const char *activeFont, unsigned short aFontWidth, unsigned short aFontHeight, unsigned int aFontOffs);

Nothing.

Sets font that will be used with Glcd_Write_Char and 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 mikroC PRO for PIC character set and regular ASCII set (eg. if 'A' is 65 in ASCII character, and 'A' is 45 in the mikroC PRO for PIC 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)

Glcd needs to be initialized, see Glcd_Init routine.

void Glcd_Set_Font_Adv(const far char *activeFont, unsigned char font_color, char font_orientation);

Sets font that will be used with Glcd_Write_Char_Adv and 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, see Glcd_Init routine.

None.

void Glcd_Set_Ext_Font_Adv(unsigned long activeFont, unsigned int font_color, char font_orientation);

Sets font that will be used with Glcd_Write_Char_Adv and 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, see Glcd_Init routine.

None.

void Glcd_Write_Char(unsigned short chr, unsigned short x_pos, unsigned short page_num, unsigned short color);

Nothing.

Prints character on the Glcd.

Parameters :

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

Glcd needs to be initialized, see Glcd_Init routine. Use Glcd_Set_Font to specify the font for display; if no font is specified, then default Font_Glcd_System5x7 font supplied with the library will be used.

void Glcd_Write_Char_Adv(unsigned char ch, unsigned int x, unsigned int y);

Nothing.

Writes a char on the glcd at coordinates (x, y).

• ch: char to be written.
• x: char position on x-axis.
• y: char position on y-axis.

glcd module needs to be initialized. See the Glcd_Init routine.

void Glcd_Write_Text(char *text, unsigned short x_pos, unsigned short page_num, unsigned short color);

Nothing.

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.

Glcd needs to be initialized, see Glcd_Init routine. Use Glcd_Set_Font to specify the font for display; if no font is specified, then default Font_Glcd_System5x7 font supplied with the library will be used.

void Glcd_Write_Text_Adv(unsigned char *text, unsigned int x, unsigned int y);

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 module needs to be initialized. See the Glcd_Init routine.

void Glcd_Write_Const_Text_Adv(const far char *ctext, unsigned int x, unsigned int y);

Nothing.

Writes text located in the program memory 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 module needs to be initialized. See the Glcd_Init routine.

void Glcd_Image(code const unsigned short *image);

Nothing.

Displays bitmap on Glcd.

Parameters :

• image: image to be displayed. Bitmap array must be located in code memory.

Use the mikroC PRO for PIC integrated Glcd Bitmap Editor to convert image to a constant array suitable for displaying on Glcd.

Glcd needs to be initialized, see Glcd_Init routine.

void Glcd_Ext_Image(unsigned long image);

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, see Glcd_Init routine.

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

void Glcd_PartialImage(unsigned int x_left, unsigned int y_top, unsigned int width, unsigned int height, unsigned int picture_width, unsigned int picture_height, code const unsigned short * image);

Nothing.

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 is located in code memory.

Use the integrated Glcd Bitmap Editor (menu option Tools › Glcd Bitmap Editor) to convert image to a constant array suitable for displaying on Glcd.

Glcd needs to be initialized, see Glcd_Init routine.

void Glcd_Ext_PartialImage(unsigned int x_left, unsigned int y_top, unsigned int width, unsigned int height, unsigned int picture_width, unsigned int picture_height, unsigned long image);

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, see Glcd_Init routine.

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