GLCD Library - Osama's Lab file:///D:/reema/r/New folder/re/New folder (2)/ec/pic24/GLCD Library ...

Quick Navigation Home > Projects list >

Home GLCD Library
Projects list
Topics
Free Tools
Spark Loader
Subscribe
Contents
Feedback
Sitemap Introduction
Features
Function summary
Before you begin
Using the library
Download the library
Initialize the library
Use the library
How to
Reading the contents of a certain location on the display
Drawing solid, dotted, and dashed lines and shapes
Specifying the color of lines and shapes
Moving the whole contents of the display up and down without repainting
Writing Arabic and English texts
Hardware connections
Examples
License
FAQ
How to turn on/off the backlight?
How to reset the GLCD module?
Can I assign control pins that belong to different ports?
The GLCD displays hazy or messy paints and texts, what is the problem?
The backlight shines, but nothing appears on the display, what is the problem?
Only one half of the display work, what is the problem?
How can I adjust the contrast of the display?
How can I change the font?
How can I ask a question not listed here?
Version History
References

Osama's Lab GLCD Library

1 of 17 13-Nov-17, 9:18 AM
GLCD Library - Osama's Lab file:///D:/reema/r/New folder/re/New folder (2)/ec/pic24/GLCD Library ...

Introduction
Osamas Lab GLCD Library is used for controlling KS0108 dependent graphic LCD
modules, it provides a number of easy to use funcons for reading and wring
from and to the RAM of the GLCD.

Features
Compable with CodeVisionAVR and GCC (two versions)

Arabic, Farsi and English texts at 7 dierent sizes

Character spacing

BMP images display

Turning the display on and o

Changing the start line of the display

Reading, wring, and clearing any line

Drawing single points without changing the neighboring points

Drawing the following geometric shapes, each can be drawn solid, doed, or
dashed, even the length of dashes can be controlled!
o Horizontal lines

o Vercal lines

o Inclined lines

o Rectangles (Note: Squares are rectangles)

2 of 17 13-Nov-17, 9:18 AM
GLCD Library - Osama's Lab file:///D:/reema/r/New folder/re/New folder (2)/ec/pic24/GLCD Library ...

o Cuboids (Note: Cubes are cuboids)

o Horizontal parallelograms

o Vercal parallelograms

o Horizontal parallelepipeds

o Vercal parallelepipeds

o Circles

Function summary
The following funcons are provided by the library:
bmp_disp
circle
cuboid
glcd_clear
glcd_clrln
glcd_o
glcd_on
glcd_putchar
glcd_puts
glcd_read
glcd_write
goto_col
goto_row
goto_xy
h_line
h_parallelepiped
h_parallelogram
line
point_at
rectangle
set_start_line
v_line
v_parallelepiped
v_parallelogram

Method Descripon Parameters

glcd_on() Turn on the GLCD No
glcd_o() Turn o the GLCD No

3 of 17 13-Nov-17, 9:18 AM
GLCD Library - Osama's Lab file:///D:/reema/r/New folder/re/New folder (2)/ec/pic24/GLCD Library ...

set_start_line(unsigned char Changes the top line line: line number to be

line) [1] set at the top (Range:
on the display 0 63)
goto_col(unsigned int x) Go to the specied x: Column number
column (Range: 0 127)
goto_row(unsigned int y) Go to the specied y: Row address
[1] (Range: 0 7)
row
goto_xy(unsigned int x, Go to the specied x: Column number
unsigned ,int y) column and row y: Row address
glcd_write(unsigned char b) Writes 1 byte data at b: 1 byte data to be
the wrien at the current
current locaon locaon
glcd_clrln(unsigned char ln) Clears the specied ln: the number of the row
1 to be cleared (Range:
row
0 7)
glcd_clear() Clears the display No
glcd_read(unsigned char Reads the byte at the column: Current column
column) current posion [2]
number
point_at( Adds a point at the x: column number
unsigned int x, specied locaon y: row number
unsigned int y, color: 0 Light spot
byte color) 1 Dark spot
h_line( Draws a horizontal x: The column number at
unsigned int x,unsigned int y, line which the line starts
byte l,byte s,byte c) y: The row number at
which the line starts
l: Line length
s: The space between line
points:
0 solid line
1 doed line
>1 dashed line
c: 0 Light spots
1 Dark spots
v_line( Draws a vercal line x: The column number at
unsigned int x,unsigned int y, which the line starts
signed int l,byte s,byte c) y: The row number at
which the line starts
l: Line length
s: The space between line
points:
0 solid line
1 doed line

4 of 17 13-Nov-17, 9:18 AM
GLCD Library - Osama's Lab file:///D:/reema/r/New folder/re/New folder (2)/ec/pic24/GLCD Library ...

>1 dashed line

c: 0 Light spots
1 Dark spots
line(unsigned int x1,unsigned Draws a general x1: The column number
int y1, unsigned int x2,unsigned (inclined) line at which the line starts
int y2, byte s,byte c) y1: The row number at
which the line starts
x2: The column number
at which the line ends
y2: The row number at
which the line ends
s: The space between line
points:
0 solid line
1 doed line
>1 dashed line
c: 0 Light spots
1 Dark spots
rectangle( Draws a rectangle x1: The x of the upper le
unsigned int x1,unsigned int y1, point
unsigned int x2,unsigned int y2, y1: The y of the upper le
byte s,byte c) point
x2: The x of the lower
right point
y2: The y of the lower
right point
s: The space between
each line points:
0 solid line
1 doed line
>1 dashed line
c: 0 Light spots
1 Dark spots
cuboid( Draws a cuboid by x11: The x of the upper
unsigned int x11,unsigned int dening two surfaces le point of the rst
y11, unsigned int x12,unsigned surface
int y12, y11: The y of the upper
unsigned int x21,unsigned int le point of the rst
y21, surface
unsigned int x22,unsigned int x12: The x of the lower
y22, right point of the rst
byte s,byte c) surface
y12: The y of the lower
right point of the rst
surface

5 of 17 13-Nov-17, 9:18 AM
GLCD Library - Osama's Lab file:///D:/reema/r/New folder/re/New folder (2)/ec/pic24/GLCD Library ...

X21: The x of the upper

le point of the second
surface
Y21: The y of the upper
le point of the second
surface
x22: The x of the lower
right point of the second
surface
y22: The y of the lower
right point of the second
surface
s: The space between
each line points:
0 solid line
1 doed line
>1 dashed line
c: 0 Light spots
1 Dark spots
h_parallelogram( Draws a x1: The x of the upper le
unsigned int x1,unsigned int y1, parallelogram its point
unsigned int x2,unsigned int y2, upper and lower y1: The y of the upper le
byte l,byte s,byte c) sides are horizontal point
x2: The x of the lower
right point
y2: The y of the lower
right point
l: The length of the
horizontal side (upper or
lower)
s: The space between
each line points:
0 solid line
1 doed line
>1 dashed line
c: 0 Light spots
1 Dark spots
v_parallelogram( Draws a x1: The x of the upper le
unsigned int x1,unsigned int y1, parallelogram its point
unsigned int x2,unsigned int y2, right and le sides y1: The y of the upper le
byte l,byte s,byte c) are vercal point
x2: The x of the lower
right point
y2: The y of the lower
right point

6 of 17 13-Nov-17, 9:18 AM
GLCD Library - Osama's Lab file:///D:/reema/r/New folder/re/New folder (2)/ec/pic24/GLCD Library ...

l: The length of the

vercal side (right or le)
s: The space between
each line points:
0 solid line
1 doed line
>1 dashed line
c: 0 Light spots
1 Dark spots
h_parallelepiped( Draws a x11: The x of the upper
unsigned int x11,unsigned int parallelepiped its le point of the rst
y11, bases are two surface
unsigned int x12,unsigned int horizontal y11: The y of the upper
y12, parallelograms le point of the rst
byte l1, (Seeh_parallelogram) surface
unsigned int x21,unsigned int x12: The x of the lower
y21, unsigned int x22,unsigned right point of the rst
int y22, surface
byte l2, y12: The y of the lower
byte s,byte c) right point of the rst
surface
X21: The x of the upper
le point of the second
surface
Y21: The y of the upper
le point of the second
surface
x22: The x of the lower
right point of the second
surface
y22: The y of the lower
right point of the second
surface
s: The space between
each line points:
0 solid line
1 doed line
>1 dashed line
c: 0 Light spots
1 Dark spots
l1: The length of the
horizontal side of the rst
surface
l2: The length of the
horizontal side of the

7 of 17 13-Nov-17, 9:18 AM
GLCD Library - Osama's Lab file:///D:/reema/r/New folder/re/New folder (2)/ec/pic24/GLCD Library ...

second surface

v_parallelepiped( Draws a x11: The x of the upper

unsigned int x11,unsigned int parallelepiped its le point of the rst
y11, bases are two vercal surface
unsigned int x12,unsigned int parallelograms y11: The y of the upper
y12, byte l1, (Seev_parallelogram) le point of the rst
unsigned int x21,unsigned int surface
y21, x12: The x of the lower
unsigned int x22,unsigned int right point of the rst
y22, byte l2, surface
byte s,byte c) y12: The y of the lower
right point of the rst
surface
X21: The x of the upper
le point of the second
surface
Y21: The y of the upper
le point of the second
surface
x22: The x of the lower
right point of the second
surface
y22: The y of the lower
right point of the second
surface
s: The space between
each line points:
0 solid line
1 doed line
>1 dashed line
c: 0 Light spots
1 Dark spots
l1: The length of the
vercal side of the rst
surface
l2: The length of the
vercal side of the
second surface
circle( Draws a circle x0: The x point of the
unsigned int x0,unsigned int y0, center of the circle
unsigned int r,byte s,byte c) y0: The y point of the
center of the circle
r: Circles radius
s: The space between

8 of 17 13-Nov-17, 9:18 AM
GLCD Library - Osama's Lab file:///D:/reema/r/New folder/re/New folder (2)/ec/pic24/GLCD Library ...

perimeter points:
0 solid line
1 doed line
>1 dashed line
c: 0 Light spots
1 Dark spots
glcd_putchar(byte c,int x,int Writes a character at c: The character to be
y,byte l, byte sz) the specied typed
posion, with size sz x: The column number to
start typing the character
at (One character
occupies 8 columns)
y: The row number to
type the character at
l: The language of the
character
0 English
1 Arabic
sz: Font size (from 1 to 7)
Writes a string c: A pointer to the string
glcd_puts(
,stored in the ash to be wrien on the
byte *c,int x,int y,unsigned memory ,on the display
char l, byte sz,signed char display x: The column number to
space) start typing the character
at (One character
occupies 8 columns)
y: The row number to
type the character at
l: The language of the
character
0 English
1 Arabic
sz: Font size (from 1 to 7)
space:
English: Character spacing
Arabic and Farsi:Word
spacing
bmp_disp(ash byte *bmp, Displays a bmp image bmp: A pointer to the
unsigned int x1,unsigned int y1, array stored in the array where the bmp
unsigned int x2,unsigned int y2) ash memory image is stored
x1: The x of the upper le
point of the image on the
glcd
y1: The y of the upper le
point of the image on the

9 of 17 13-Nov-17, 9:18 AM
GLCD Library - Osama's Lab file:///D:/reema/r/New folder/re/New folder (2)/ec/pic24/GLCD Library ...

glcd
x2: The x of the lower
right point of the image
on the glcd
y2: The y of the lower
right point of the image
on the glcd
[1]
Each row consists of 8 lines, hence, the GLCD contains 8 rows and 64 lines

[2]
The column number is just used for enabling the appropriate GLCD half

Before you begin

Please read the following notes carefully before you start using the library:

For exibility, ports used for interfacing the graphic LCD arent inialized by the
library, you must inialize them at the start of your program:

Some compilers dont support Arabic texts, you can type any Arabic string
you want in the code, and it will be displayed properly on the GLCD even if it
appears in the code editor improperly:

There are two versions of the library, CodeVisionAVR version and gcc
version, if you use gcc version, only one port can be used as a control port,
but if you use CodeVisionAVR version, each control pin can be specied
separately.

CodeVisionAVR gcc
#dene CS1 PORTC.2 #dene CONTROLPORT PORTC
#dene CS2 PORTC.3 #dene CS1 (1<<2)
#dene RS PORTD.7 #dene CS2 (1<<3)
#dene RW PORTC.0 #dene DI (1<<4)
#dene EN PORTC.1 #dene RW (1<<0)
#dene EN (1<<1)

10 of 17 13-Nov-17, 9:18 AM
GLCD Library - Osama's Lab file:///D:/reema/r/New folder/re/New folder (2)/ec/pic24/GLCD Library ...

You can specify control pins You can select the order of control
individually and in dierent pins, but they must be in the same
ports port

Some graphic LCD modules use acve low enable pins, while other
modules use acve high enable pins, refer to the datasheet before you use
the library to know to which type your module belongs, then it is easy to tell the
library which type it uses by un/commenng the #dene CS_ACTIVE_LOW in
the library.

Acve High Acve Low

From the NA
datasheet

In the library //#dene CS_ACTIVE_LOW 0 #dene

CS_ACTIVE_LOW 0
It is strongly recommended that you read precauons at the end of the
datasheet of the GLCD module you use.

Using the library

Download the library
There are two versions of the library; CodeVisionAVR version and gcc version, Select
any of them:
CodeVisionAVR
GCC

- Extract the compressed le, and include glcd.h into your project, font.h
is included implicitly by glcd.h.

Initialize the library

CodeVisionAVR GCC Notes
Modify the following lines at the start of glcd.h le
Trigger pulse d: delay me in us (5
delay us is suitable)
#dene E_DELAY d #dene E_DELAY d
Data port #dene DATAPORT PORTX #dene DATAPORT PORTX X: port name (A, B,
#dene DATADDR DDRX #dene DATADDR DDRX )
#dene DATAPIN PINX #dene DATAPIN PINX
Control #dene CS1 PORTX.n #dene CS1 (1<<n) X: port name (A, B,
pins/port #dene CS2 PORTX.n #dene CS2 (1<<n) )
#dene RS PORTX.n #dene DI (1<<n) n: pin number (0, 1,
#dene RW PORTX.n #dene RW (1<<n) 2, . )
#dene EN PORTX.n #dene EN (1<<n)

11 of 17 13-Nov-17, 9:18 AM
GLCD Library - Osama's Lab file:///D:/reema/r/New folder/re/New folder (2)/ec/pic24/GLCD Library ...

Acve #deneCS_ACTIVE_LOW 0 #deneCS_ACTIVE_LOW 0 - Uncomment this

High/Low line for acve LOW
- 0 can be any
other number
Add the following lines at the start of your code (inside the main() body)
Data direcon DATADDR = 0x; DATADDR = 0x;
of data port
Data direcon DDRX = paern; DDRX = paern; X: data port name (A,
of control B, .)
port - paern depends
on Control
pins/port sengs

Use the library

Now, you are ready to use the library, each funcon is described in Funcon
summary secon

How to
Read the contents of a certain locaon on the display
Draw solid, doed, and dashed lines and shapes
Specify the color of lines and shapes
Move the whole contents of the display up and down without repainng
Write Arabic and English texts

Reading the contents of a certain location on the display

Use goto_xy funcon to go to the required locaon

Use glcd_read funcon to read the byte at the current row

Drawing solid, dotted, and dashed lines and shapes

For each drawing funcon, there is an argument named s, this species the
separaon between the points of the shape
Example:
h_line(1,1,20,2,0)
The third parameter is the separaon, in this example it is 2, this means that the
horizontal line consists of a point followed by two blank spaces, actually these two
spaces are not always blank, but I mean here that they arent touched, so if they
contained any data previously, this data will remain untouched. For drawing solid
shapes, simply set this parameter to 0

12 of 17 13-Nov-17, 9:18 AM
GLCD Library - Osama's Lab file:///D:/reema/r/New folder/re/New folder (2)/ec/pic24/GLCD Library ...

Specifying the color of lines and shapes

For each drawing funcon, there is an argument named c, this argument denes the
color of the shape, 0 for light shapes, and 1 for light shapes
Example:
h_line(1,1,20,0,0) Draws bright horizontal line
h_line(1,1,20,0,1) Draws dark horizontal line

Moving the whole contents of the display up and down without

repainting
The funcon set_start_line changes the line to be displayed at the top of the
display, thus you can make the any line top one.
Example:
The following example scrolls the display vercally, once a line disappears at the top,
it appears at the boom, as if the display is mounted on a pulley.

Writing Arabic and English texts

glcd_puts and glcd_putchar funcons, have an argument named l, this
argument denes the language of the wrien string; 0 for English strings, and 1 for
Arabic strings
Example:
char ar_string[] = ;
char *en_string[] = Hello;
glcd_puts(ar_string,5,5,1); //Writes an Arabic string
glcd_puts(en_string,5,5,0); //Writes an English(Lan) string

Hardware connections
The order of the pins diers from a module to another, so before you connect your
hardware please double check your connecons not to connect any wire
improperly, this may damage your module, the order and the name of each pin can
be found in the datasheet under a secon named Terminal Funcons or a similar
name.

Examples
There are four illustrave examples:
CodeVisionAVR with acve HIGH GLCD

CodeVisionAVR with acve LOW GLCD

13 of 17 13-Nov-17, 9:18 AM
GLCD Library - Osama's Lab file:///D:/reema/r/New folder/re/New folder (2)/ec/pic24/GLCD Library ...

GCC with acve HIGH GLCD

GCC with acve LOW GLCD

- For compiling GCC projects, I used eclipse with AVR eclipse plug-in.

- The latest version of eclipse is available here.

- AVR Eclipse download

- Download CodeVisionAVR

- Download Proteus Simulator

License
This program is free soware: you can redistribute it and/or modify it under the
terms of the GNU Aero General Public License as published by the Free Soware
Foundaon, either version 3 of the license.
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE. See the
GNU Aero General Public License for more details.
You should have received a copy of the GNU Aero General Public License along with
this program. If not, seehp://www.gnu.org/licenses/

FAQ
How to turn on/o the backlight?
How to reset the GLCD module?
Can I assign control pins that belong to dierent ports?
The GLCD displays hazy or messy paints and texts, what is the problem?
The backlight shines, but nothing appears on the display, what is the
problem?
Only one half of the display work, what is the problem?
How can I adjust the contrast of the display?
How can I change the font?
How can I ask a queson not listed here?

How to turn on/off the backlight?

The backlight is a part of the LCD itself, not the controller, so, it is out of the GLCD
controllers control, but you can assign a pin in your microcontroller to enable/disable
a buer that acts as a switch for the backlight.

14 of 17 13-Nov-17, 9:18 AM
GLCD Library - Osama's Lab file:///D:/reema/r/New folder/re/New folder (2)/ec/pic24/GLCD Library ...

How to reset the GLCD module?

Simply, connect one of the free pins of the microcontroller to the RST pin of the
GLCD module, and then you can reset the GLCD module by pulling this pin low for a
short period, this period can be found in the datasheet of the GLCD module, it is
about 200 nsec.

Can I assign control pins that belong to different ports?

Only in CodeVisionAVR version, this is not available in gcc version

The GLCD displays hazy or messy paints and texts, what is the
problem?
Make sure that the data port and control pins are dened properly at the
library header le
Make sure that you set the data direcon of the data port and the control port
properly, remember, the data direcon registers are not set by the library, you
must set them manually.

This problem is mostly caused by the delay me, try increasing the dened
delay me at the start of the library header le:
#dene E_DELAY 3

If it didnt work, try increasing the other delays at the dierent funcons of the
library
Bad connecons can also cause such problems, double check your
connecons
Poor power supplies may also be the reason, ensure that your power supply is
sucient

The backlight shines, but nothing appears on the display, what

is the problem?
The previous answer.

Only one half of the display work, what is the problem?

15 of 17 13-Nov-17, 9:18 AM
GLCD Library - Osama's Lab file:///D:/reema/r/New folder/re/New folder (2)/ec/pic24/GLCD Library ...

Check your connecons

Make sure that the data direcon registers, the control pins, and the data port
are inialized properly (Refer to"Before you begin" secon).

Refer to this answer

How can I adjust the contrast of the display?
This must be illustrated in the datasheet under a secon entled Adjusng the LCD
display contrast or a similar tle, but in general, this is achieved by using a 25 50k
ohms potenometer, the middle terminal is connected to Vo pin, and the other two
terminals are connected to Vout and the power source posive terminal (Vdd)

How can I change the font?

1. Download arabic.zip and extract it.
2. Download LCD font generator.
3. Open "arabic.l" and modify each character as you like.
4. Generate the modied array and replace the array font in "font.h" with
the newly generated array, don't change arrays name or type, leave it as it is.

How can I ask a queson not listed here?

Use the feedback form at Osamas Lab website
Or contact me by e-mail:
[email protected]

Version History
Ver. 2.00

Farsi language support

Different text sizes support (for all languages)
delay.h/ util/delay.h have been included into glcd.h, you no longer have to
include them

References
KS0108 datasheet

LM12864LFW LCD module manual

If you have any queson, suggeson, note, found a bug, or like to say anything, please
don't hesitate to contact me.
Thanks,

16 of 17 13-Nov-17, 9:18 AM
GLCD Library - Osama's Lab file:///D:/reema/r/New folder/re/New folder (2)/ec/pic24/GLCD Library ...

Osama Salah Eldin

See also
Arabic - English Graphic LCD Library (controller KS0108)
Displaying a BMP Image on a graphic LCD (controller KS0108)

- Feedback
- Download this documentation in pdf
- Subscribe to Osama's Lab newsletter

Sign in | Report Abuse | Print Page | Remove Access | Powered By Google Sites

17 of 17 13-Nov-17, 9:18 AM