Matrix Orbital GLK 12232-25-WBL LCD Display Technical Manual

Distributed by:
www.Jameco.com ✦ 1-800-831-4242
The content and copyrights of the attached
material are the property of its owner.
Jameco Part Number 281404
GLK12232-25-WBL
Technical Manual
Revision: 2.0
Contents
Contents
ii
1 Introduction
1.1 What to Expect From the GLK12232-25-WBL . .
1.2 What Not to Expect From the GLK12232-25-WBL
1.3 Keypad Interface . . . . . . . . . . . . . . . . . .
1.4 mogd.exe . . . . . . . . . . . . . . . . . . . . . .
1.5 Setting up . . . . . . . . . . . . . . . . . . . . . .
1.6 Trying Out the GLK12232-25-WBL . . . . . . . .
1.7 Trying out a Keypad . . . . . . . . . . . . . . . .
1.7.1 Here’s what to do: . . . . . . . . . . . . .
1.8 Manual Over-ride . . . . . . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
1
1
1
1
1
2
3
3
3
4
2 Connectionshttp://www.atmel.com/dyn/resources/prod_documents/doc2593.pdf
2.1 Connector Pinout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.1.1 Power Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.1.2 RS-232 Communications . . . . . . . . . . . . . . . . . . . . . . . . .
2.1.3 I2 C Communications . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.1.4 ACK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2.2 General Purpose Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
4
4
6
6
6
7
8
3 Displaying Text
3.1 General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3.2 Writing Text to the Display . . . . . . . . . . . . . . . . . . . . .
3.3 Text Commands . . . . . . . . . . . . . . . . . . . . . . . . . . .
3.3.1 Auto scroll on (254 81) . . . . . . . . . . . . . . . . . . .
3.3.2 Auto scroll off (254 82) . . . . . . . . . . . . . . . . . .
3.3.3 Set text insertion point (254 71 [col] [row]) . . . . . . . .
3.3.4 Set current text insertion point to top Left (254 72) . . . .
3.3.5 Set text insertion point using pixel values (254 121 [x][y])
3.3.6 Set current font (254 49 [font ID]) . . . . . . . . . . . . .
3.3.7 Set font metrics (254 50 [metrics]) . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
9
9
9
9
10
10
10
10
10
10
11
4 Displaying Graphics
4.1 General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4.2 Graphics Commands . . . . . . . . . . . . . . . . . . . . . . . .
4.2.1 Set drawing color (254 99 [color]) . . . . . . . . . . . . .
4.2.2 Draw line (254 108 [x1][y1][x2][y2]) . . . . . . . . . . .
4.2.3 Continue line (254 101 [x][y]) . . . . . . . . . . . . . . .
4.2.4 Put pixel (254 112 [x][y]) . . . . . . . . . . . . . . . . .
4.2.5 Draw outline rectangle (254 114 [color][x1][y1][x2][y2]) .
4.2.6 Draw solid rectangle (254 120 [color][x1][y1][x2][y2]) . .
4.2.7 Initialize bar graph (254 103 [ref][type][x1][y1][x2][y2])
4.2.8 Write to bar graph (254 105 [reference number][value]) .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
11
11
12
12
12
13
13
13
13
13
14
Matrix Orbital
.
.
.
.
.
.
.
.
.
GLK12232-25-WBL
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
ii
4.3
4.2.9 Display saved bitmap (254 98 [reference number][x][y])
Flow Control . . . . . . . . . . . . . . . . . . . . . . . . . . .
4.3.1 Enter Flow Control Mode (254 58 [full][empty]) . . . .
4.3.2 Exit Flow Control Mode (254 59) . . . . . . . . . . . .
5 Keypad Interface
5.1 General . . . . . . . . . . . . . . . . . . . . .
5.2 Connections . . . . . . . . . . . . . . . . . . .
5.3 I2 C Interface . . . . . . . . . . . . . . . . . .
5.4 RS-232 Interface . . . . . . . . . . . . . . . .
5.5 Commands . . . . . . . . . . . . . . . . . . .
5.5.1 Auto repeat mode on (254 126 [mode])
5.5.2 Auto repeat mode off (254 96) . . . . .
5.5.3 Auto transmit keypresses on (254 65) .
5.5.4 Auto transmit keypresses off (254 79) .
5.5.5 Clear key buffer (254 69) . . . . . . . .
5.5.6 Poll keypad (254 38) . . . . . . . . . .
5.5.7 Set debounce time (254 85 [time]) . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
14
14
14
15
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
15
15
15
16
16
17
17
17
17
18
18
18
18
6 Fonts and Graphics Files
6.1 General . . . . . . . . . . . . . . . . . . . . . . . . . .
6.2 Using mogd.exe . . . . . . . . . . . . . . . . . . . . . .
6.3 Commands . . . . . . . . . . . . . . . . . . . . . . . .
6.3.1 Erase file (254 173 [type] [ref]) . . . . . . . . .
6.3.2 Purge memory (254 33 89 33) . . . . . . . . . .
6.3.3 Upload Font (254 36 [ref] [file size] [file data]) .
6.3.4 Upload Bitmap (254 94[ref] [file size] [file data])
6.4 Working with Font Files . . . . . . . . . . . . . . . . .
6.4.1 Font File in Table Form . . . . . . . . . . . . .
6.4.2 Uploading the File to the Module . . . . . . . .
6.4.3 A Sample Font File . . . . . . . . . . . . . . . .
6.5 Working with Bitmap Files . . . . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
18
18
19
19
19
20
20
20
20
20
21
22
24
7 Miscellaneous Commands
7.1 General . . . . . . . . . . . . . . . . . . . . . . .
7.1.1 Clear display (254 88) . . . . . . . . . . .
7.1.2 Set contrast (254 80 [contrast]) . . . . . . .
7.1.3 Set contrast and save (254 145 [contrast]) .
7.1.4 Backlight on (254 66 [minutes]) . . . . . .
7.1.5 Backlight off (254 70) . . . . . . . . . . .
7.1.6 General purpose output on (254 86 [gpo #])
7.1.7 General purpose output off (254 87 [gpo #])
7.1.8 Set I2 C address 254 51 [address]) . . . . .
7.1.9 Read module type (254 55) . . . . . . . . .
7.1.10 Set RS-232 port speed (254 57 [speed]) . .
7.1.11 Set Serial Number (254 52 [byte1] [byte2] .
7.1.12 Read Serial Number (254 53) . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
24
24
25
25
25
25
25
25
26
26
26
26
27
27
Matrix Orbital
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
GLK12232-25-WBL
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
iii
7.1.13 Read Version Number 254 54) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
8 Appendix: Command Summary
8.1 General . . . . . . . . . . .
8.2 Issuing Commands . . . . .
8.3 Text Commands . . . . . . .
8.4 Graphics Commands . . . .
8.5 Keypad Interface Commands
8.6 File System Commands . . .
8.7 Miscellaneous Commands .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
9 Appendix: Specifications
Matrix Orbital
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
27
27
27
28
28
29
30
31
32
34
GLK12232-25-WBL
iv
1 Introduction
The GLK12232-25-WBL comes equipped with the following features;
•
•
•
•
•
•
122 x 32 pixel graphics display
Text display using built in or user supplied fonts
Adjustable contrast
Backlighting
Keypad interface
RS-232 or I2 C communications
1.1 What to Expect From the GLK12232-25-WBL
The GLK12232-25-WBL is designed as the display unit for an associated controller. The controller may
be anything from a single board, special purpose micro-controller to a PC, depending on the application.
This controller is responsible for what is displayed on the screen of the display.
The display provides a simple command structure to allow both text and graphics to be transferred to the
screen. Text fonts and graphics, if desired, are stored in the display’s flash ROM and may be regarded as
’permanent’ in that they survive power-off periods and don’t change until explicitly reprogrammed.
The screen is backlit for low-light situations. Backlighting may be turned on or off under program
control. Contrast is adjustable to compensate for differing lighting conditions and viewing angles.
1.2 What Not to Expect From the GLK12232-25-WBL
Since the display is intended to be used with a controller, it does not have any built in text editing
functions. If a stream of ASCII characters is inputed they will be displayed, but the CR, LF, backspace, etc.,
will be ignored. If the user’s application requires these functions, they must be provided by the software in
the user’s controller, which can issue the appropriate positioning commands to the display.
1.3 Keypad Interface
The keypad interface takes row / column input and converts it to ASCII characters, which are delivered
out the RS-232 or I2 C port to the associated controller. Note that the keypad is not used to directly control
any aspect of the operation of the display, which acts simply as a matrix to serial converter. In order to use
the keypad to control the display, the user must program their controller accordingly.
1.4 mogd.exe
Matrix Orbital has developed an interface program which exercises all the features of the display. It
is also used to manage font and graphics downloads. The program, called "mogd.exe", is provided on the
Matrix Orbital Cd and website.
To install mogd.exe follow these steps;
Matrix Orbital
GLK12232-25-WBL
1
1.
2.
3.
4.
5.
Insert the Matrix Orbital CD-ROM into the Cd drive.
Locate the file "mogd.zip". It should be in the "Download" directory.
Unzip mogd.zip to a temporary directory, using a program such as Winzip, Pkzip, etc.
Double click on "setup.exe".
Follow the instructions on the screen to complete the installation.
After installation is complete there will be a Matrix Orbital entry under "Programs" in the "Start Menu".
Click on this entry to run mogd.exe.
The first time mogd.exe is run, some information will be required;
• The port number to be used (usually COM1 or COM2)
• The baud rate for the connection. It is recommended to use 19,200 for initial startup of the display
• The type of display unit, set to 240 x 64 for the GLK12232-25-WBL
Once this information is entered, the program can be used to control all functions of the display.
1.5 Setting up
Before setting up an application the user may want to try out their display. This is easily done with a PC.
The following will be required;
• The PC cable available from Matrix Orbital (this is the simplest way to make test connections without
having to solder cables and connectors).
NOTE Make sure that the display is equipped with the proper connector for use with this
cable. This connector can be specified at time of order.
•
•
•
•
•
A 5 V power supply
A PC with a spare RS-232 port (COM1 or COM2)
The mogd.exe program
A power connector. The type used for 3.5" floppy drives works fine
A 9 or 25 pin RS-232 serial cable. If using a 25 conductor cable, a 9 to 25 pin adapter will be required
Figure 1: Connections for Testing
Matrix Orbital
GLK12232-25-WBL
2
1. Refer to the Figure above for the following steps.
2. Wire the connector to the power supply. On most connectors the RED lead will go to +5V and the
BLACK lead to GND.
NOTE The Manufacturer’s Warranty becomes void if the unit is subjected to over-voltage
or reversed polarity.
3. Connect the display to the PC using the serial cable and adapter if required.
4. Connect the power connector, making sure that the +5V goes to V+ as shown in the diagram.
5. Turn on the power: the LCD backlight should come on.
1.6 Trying Out the GLK12232-25-WBL
The unit should be connected to power and the PC and backlight should be on.
1. Use the mogd.exe program to exercise some of the features of the display to ensure everything works
properly.
2. To experiment with typing text, run a PC terminal program, such as Hyperterm. Make sure it’s configured to use the correct port. Set the baud rate to 19,200.
If characters are typed on the keyboard, they should now appear on the display screen. Please note that CR,
backspace, etc., won’t have any effect. Text will wrap around to the next line when the end of a line has been
reached.
1.7 Trying out a Keypad
Since a number of different keypad types can be connected to the display, the results may be a little
unpredictable. At this point all we need to do is make sure that the keypad and interface work, and possibly
generate an ASCII map for any programming needs.
The keypad interface on the display converts a row / column connection to an ASCII character. By
default, a keypress is transmitted as serial data immediately. Keypad buffering can be selected using the
appropriate commands.
1.7.1 Here’s what to do:
1. The PC should be running a terminal program such as Hyperterm.
2. With the display connected to the PC, plug in the keypad. If the connector has fewer pins than the one
on the display, center it as well as possible.
Matrix Orbital
GLK12232-25-WBL
3
NOTES
• The keypad connector must be wired with columns on one side and rows on the other
side of the center of the connector. If the keypad isn’t wired this way, an adapter will
need to be made. Another method would be to rewire the connector to meet this
requirement.
• The connector is reversible. Reversing the connector will not damage the keypad or
the display, but will however, change the ASCII character map.
3. Press a key on the keypad. An upper case ASCII character (A-Y) should appear on the PC screen.
Different keys should generate different characters.
To experiment, reverse the connector and see if it generates a more logical set of characters. Ultimately, the
program in the micro-controller will have to ’map’ these characters to the ones marked on the keypad, which
will likely be different.
1.8 Manual Over-ride
Manual over-ride should only be required in one instance. If for some reason the module is set at a baud
rate which cannot be produced by the host system and all communication to the display is lost, then the user
should follow this simple procedure;
1.
2.
3.
4.
5.
6.
Turn off the display.
Put a jumper on pins 5 and 6 of the keypad connector.
Power up the display. The baud rate is now set to 19,200.
Remove the jumper and change the RS-232 port settings to the desired baud rate.
Turn off the display.
Power up the display.
NOTE This procedure does not change settings in the memory chip, it uses default settings stored in the main processor. This allows the user to communicate with the display
when all other communications are lost. Once able to communicate with the display, the
user may then change the default settings in the memory chip.
2 Connectionshttp://www.atmel.com/dyn/resources/prod_do
2.1 Connector Pinout
Refer to the diagram below for this chapter.
Matrix Orbital
GLK12232-25-WBL
4
Figure 2: Electrical Connections
All connections are made via a 25 pin in-line connector area near the bottom edge of the PCB. Pin
descriptions are as follows;
Table 1: Pin Descriptions
Pin
1
2
3
4
5
6
7
8
9
10
11
12
13
Matrix Orbital
Marked
Yellow
Black
Black
Red
SCL
SDA
GND
Rx
Tx
+5V
G1
G2
GND
Function
do not use
ground
ground
+5V power input
I2 C clock
I2 C data
ground
RS-232 receive data
RS-232 transmit data
+5V power input
General purpose output 1
General purpose output 2
ground for GPOs
Pin
14
15
16
17
18
19
20
21
22
23
24
25
GLK12232-25-WBL
Marked
C1
C2
C3
C4
C5
R1
R2
R3
R4
R5
Rst
Cont
Function
Keypad column 1
Keypad column 2
Keypad column 3
Keypad column 4
Keypad column 5
Keypad row 1
Keypad row 2
Keypad row 3
Keypad row 4
Keypad row 5
do not use
do not use
5
2.1.1 Power Connections
WARNINGS
• Do not apply any power with reversed polarization.
• Do not apply any voltage other than the specified voltage.
• Do not use any cables other than the cables supplied by Matrix
Orbital, unless aware of the modifications required.
• Do not under any circumstances use an unmodified floppy drive
power cable.
• Do not apply power to both the DB-9 connector AND the 4-pin
power connector.
• Do not apply more than +5Vdc to pin #9 of the DB-9 connector.
2.1.2 RS-232 Communications
A group of four connections (pins 7-10) provide for RS-232 communications and power. A 4 pin SIP
connector soldered to these pins can be connected to a Matrix Orbital supplied PC cable.
The RS-232 connector on the PC cable is wired so that a standard ’straight through’ 9 pin D-sub cable
may be used to connect the modules to a standard serial port such as COM ports on PCs. Note that this
device complies with the EIA232 standard in that it uses signal levels from +/- 3V to +/- 12V. It will not
operate correctly at TTL (0 to +5V) levels.
Table 2: RS-232 Pinout
Pin Number
2
3
5
Direction
Data from LCD
Data to LCD
-
Description
Data Out (LCD)
Data In (LCD)
Ground
LCD
Tx
Rx
gnd
Host
Rx
Tx
gnd
2.1.3 I2 C Communications
The display has I2 C communications runs at 100 Kbps and supports up to 127 units on a single communications line. The I2 C data line operates on 5 volt CMOS levels. The power connector is also the I2 C
communication line.
Matrix Orbital
GLK12232-25-WBL
6
Figure 3: Power and I2 C Connector
Table 3: Connector Pinout
Pin 4
Pin 3
Pin 2
Pin 1
Ground
SDA (I2 C data)
SCL (I2 C clock)
Vdc
2.1.4 ACK
The idea of ACK is to indicate when the data has been received correctly. ACK does not indicate data
incorrectly received. ACK simply fails to indicate when data is correctly received. Clearly, this is of limited
usefulness and even less so with Matrix Orbital modules. Matrix orbital modules are not capable of failing
to acknowledge an incorrectly received byte in response to that byte’s transition. They are only capable of
failing to acknowledge the bytes following the byte, which weren’t received. To fully understand the reasons
for this one needs to understand something about how a Matrix Orbital module processes data. Basically the
reason why a Matrix Orbital module might fail to receive a byte correctly is that it was unable to process the
byte previous before the failed byte was transmitted. Because the module cannot possibly know that it would
be unable to store the byte before the next byte was received it cannot know to not ACK. The reason for this
situation in deference to situations one might be familiar with (i.e., memory chips, etc) is that the Matrix
Orbital module employs a micro-processor to perform these data storage functions. A memory chip takes
care of these things entirely within hardware subsystems which operate at the same speed as the transmission
themselves.
The display uses a standard Phillips 7bit address as defined by Phillips. However, Matrix Orbital specifies
I2 C address in 8bits. The 8th bit, least significant bit (LSB or Low Order Bit) of the 8bit address is a read
/ write bit. If we take a standard Phillips 7bit address of 45hex this would be in binary; 1000101. This is
7bits. Matrix Orbital would describe the Phillips I2 C address of 45hex as 8Ahex. The read address would
be 8Bhex.
For more information on Phillips I2 C please visit;
http://www.ping.be/~ping0751/i2cfaq/i2cindex.htm
Matrix Orbital
GLK12232-25-WBL
7
2.2 General Purpose Outputs
The display has two general purpose outputs, G1 and G2. These are provided to conthttp://www.atmel.com/dyn/resources/prod_d
relays or other electronic devices. This allows external devices to be turned on or off using the PC or controller and software commands.
The two outputs differ slightly in specification;
• G1 provides an output which is switched LOW when ON. When G1 is OFF it is pulled up to +5V
through 150 kohms, in other words it can only be used to ’ground’ an external device. Maximum
current is 20 mA.
• G2 provides an output which is switched LOW when ON. When G2 is OFF it is pulled up to +5V,
supplied by the module. Maximum current is 20 mA.
Both outputs are referenced to ground.
Typical use of these outputs is shown in the Figure below.
Figure 4: Using the General Purpose Outputs
If the device which is being driven by a GPO requires a relatively high current (such as a relay) it must
have an internal resistance greater than 250 ohms, or must be current limited to 20 mA by means of a suitable
resistor.
NOTE The GPOs do not have any over current or over / under voltage protection so care
must be taken when using them. For instance if the external device is a relay it must be
fully clamped (using a diode and capacitor) to absorb any generated back electro-motive
force (EMF).
Matrix Orbital
GLK12232-25-WBL
8
Figure 5: Clamping a Relay
3 Displaying Text
This chapter describes the various text-display commands in detail.
3.1 General
Text is displayed on the display using fonts saved in its internal flash memory. The display is supplied
with a 5x7 font installed. If this is suitable, there will be no need to install any other fonts.
3.2 Writing Text to the Display
When the display receives a character, it displays that character at the position currently defined. The next
character sent to the module then advances to the following position on the display. Characters are drawn
using the currently selected font, and only characters defined in the current font are actually processed.
Characters which are not defined by the current font are ignored, and the positioning is not advanced for the
next character.
The position where text is to be displayed is a single pixel location stored in the display’s volatile memory
and maintained internally by the display’s firmware. It can be manually manipulated with two commands;
1. Set current text position (254 71 [col] [row]) positions the characters using a text oriented coordinate
system, dividing the display into character cells.
2. Set text cursor - pixel values (254 121 [x][y]) Sets text cursor to position (x,y), where x and y are in
pixels. Value is top left corner of next text character. This positions the character at a specific pixel,
allowing more ’fine grained’ control when needed.
3.3 Text Commands
In this section commands are identified by their names and decimal values. Hex and ASCII equivalents
are given in the summary.
Matrix Orbital
GLK12232-25-WBL
9
3.3.1 Auto scroll on (254 81)
When auto scrolling is on, it causes the display to shift the entire display’s contents up to make room for
a new line of text when the text reaches the scroll position defined by the "Set font metrics" command in the
display memory (normally the bottom right character position - default value for the GLK12232-25-WBL is
64).
3.3.2 Auto scroll off (254 82)
When auto scrolling is disabled, text will wrap to the top left corner of the display area. Existing graphics
or text in the display area are not erased before text is placed. When using proportional fonts without auto
scrolling, care should be taken to clear areas where text is being written, particularly when wrapping occurs.
This may be done using the "Draw solid rectangle" command with the colour set to white.
3.3.3 Set text insertion point (254 71 [col] [row])
This command sets the insertion point to the [column] and [row] specified. The insertion point is positioned using the base size of the current font (this command does not position the insertion point at a specific
pixel). The pixel column used is determined by multiplying the width of the widest character in the font
by [column]. The pixel row used is determined by multiplying the height of the font by [row + interline
spacing].
3.3.4 Set current text insertion point to top Left (254 72)
This command moves the text insertion point to the top left of the display area, based on the metrics of
the current font.
3.3.5 Set text insertion point using pixel values (254 121 [x][y])
This command sets the next position for text placement to an individual pixel location. The coordinate
([x position],[y position]) defines a pixel on the screen where the top left corner of the screen is defined as
(0,0). This pixel location will be used as the top left corner of the next character of text which is sent to the
module without any regard to ’font metrics’ like character spacing or line spacing.
3.3.6 Set current font (254 49 [font ID])
This command instructs the display to use the font specified by [font identifier] as the default font. The
value specified should refer to a font already present in the display’s memory.
Matrix Orbital
GLK12232-25-WBL
10
NOTE The font ID is established when the font is saved to the display, normally using
the mogd.exe program. The installed 5x7 font ID is "1", unless changed by user.
3.3.7 Set font metrics (254 50 [metrics])
Where [metrics] = [left margin][top margin][x space][y space][scroll row]
This command defines the metrics of a font already present in the display’s memory.
• [left margin] specifies the first pixel column to use for the first character in a row. In some instances, a
font may not evenly fit on the screen, and dividing the extra space between the margins will improve
the overall appearance of the font.
• [top margin] specifies the top pixel row to begin drawing the first row of text on the display area.
• [x space] specifies the number of pixels to place between characters (i.e., character spacing).
• [y space] specifies the number of pixels to place between rows of text (i.e., line spacing).
• [scroll row] specifies the pixel row where scrolling should start (or, if auto scrolling is off, where
wrapping should occur). Typically, this value should be set to the first pixel row immediately below
the last row of text that will fit the display.
4 Displaying Graphics
This chapter describes the various graphics-display commands in detail.
4.1 General
Since the display is a bit mapped device, it may be used to display graphics. Graphic images may be
created by means of a pixel-oriented graphics program, saved as bitmaps, and loaded into the display using
the mogd.exe program. Images may be saved in the display’s memory, and displayed upon command, or
they may be downloaded ’on the fly’ (inline) during display operation.
Note that ’saved’ and ’on the fly’ graphics images are processed differently. These differences must be
taken into account when processing graphics.
• Saved bitmaps: These use each byte (8 bits) to represent a vertical column of 8 pixels. The next byte
represents the next column to the right. If the graphic is ’taller’ than 8 pixels, the LSB of the next data
byte will be the next pixel. Orientation is top to bottom - LSB to MSB. Pixels / bits are ’packed’ - that
is, if the height of the graphic is not an even multiple of 8, the leftover bits go on the next X column
to the right, etc.
• Inline bitmaps: These are processed horizontally, and each byte represents a horizontal row of 8 bits,
with the next byte representing the next 8 bits to the right. Orientation is left to right - MSB to LSB,
which is the opposite to the serial transmission sequence (bytes are sent LSB first).
Matrix Orbital
GLK12232-25-WBL
11
Figure 6: Graphic Bitmaps
Each pixel in a bitmap is described by a single bit, and may only have the values ON or OFF. For
example, shades of grey are not supported.
4.2 Graphics Commands
In this section commands are identified by their names and decimal values. Hex and ASCII equivalents
are given in the summary.
The coordinate origin (0,0) is at the top left corner of the display. X values go from 0 to 239 (increasing
toward the right) and Y values go from 0 to 63 (increasing toward the bottom).
4.2.1 Set drawing color (254 99 [color])
This command sets the drawing color for subsequent graphic commands that do not have the drawing
color passed as a parameter. The parameter [color] is the value of the color where white 0 Hex, and black is
255 Hex.
NOTE All non-zero values will display as black.
4.2.2 Draw line (254 108 [x1][y1][x2][y2])
This command will draw a line from (x1,y1) to (x2,y2) using the current drawing color. Lines may
be drawn from any part of the display to any other part, but may be important to note that the line may
interpolate differently right to left, or left to right. This means that a line drawn in white from right to left
may not fully erase the same line drawn in black from left to right.
Matrix Orbital
GLK12232-25-WBL
12
4.2.3 Continue line (254 101 [x][y])
This command will draw line with the current drawing color from the last line end (x2,y2) to (x,y). This
command uses the global drawing color so the “Set drawing color” command should be used before the first
line segment if required.
4.2.4 Put pixel (254 112 [x][y])
This command will draw a pixel at (x,y) using the current drawing color. The unit processes these
requests fast enough to keep up with a steady stream at 115 kbaud, so flow control is not required.
4.2.5 Draw outline rectangle (254 114 [color][x1][y1][x2][y2])
This command draws a rectangular box in the specified color (0 = white, non-zero = black). The top left
corner is specified by (x1,y1) and the bottom right corner by (x2,y2).
4.2.6 Draw solid rectangle (254 120 [color][x1][y1][x2][y2])
This command draws a solid rectangle in the specified color (0 = white, non-zero = black). The top left
corner is specified by (x1,y1) and the bottom right corner by (x2,y2). Since this command involves considerable processing overhead, we strongly recommend the use of flow control, particularly if the command
is to be repeated frequently.
This procedure is common for monitoring applications where there is a ’field’ on the display that is
constantly being updated from, say, a temperature sensor.
4.2.7 Initialize bar graph (254 103 [ref][type][x1][y1][x2][y2])
This command initializes a bar graph referred to by number [reference number] of type [type] with size
from (x1,y1) (top left) to (x2,y2) (bottom right). A maximum of 16 bar graphs with reference numbers from
0 to 15 can be initialized as;
•
•
•
•
[type = 0] Vertical, bottom referenced
[type = 1] Horizontal left referenced
[type = 2] Vertical top referenced
[type = 3] Horizontal right referenced
The bar graphs may be located anywhere on the display, but if they overlap, they will not display properly.
NOTE It is important that [x1] is less than [x2], and [y1] is less than [y2].
This command doesn’t actually draw the graph, it must be ’filled in’ using the “Write to bar graph” command, described below. The unit saves time by only drawing that part of the bar graph which has changed
Matrix Orbital
GLK12232-25-WBL
13
from the last write, so the representation on the screen may not survive a screen clear or other corruptive
action. A write of value zero, followed by new values will restore the proper look of the bar graph.
4.2.8 Write to bar graph (254 105 [reference number][value])
Once the bar graph has been initialized it can be ’filled in’ using this command. This command sets the
bar graph [reference number] to value [value]. [value] is given in pixels and should not exceed the available
height / width of the graph. (If it does, the graph will simply be written to its maximum size.)
4.2.9 Display saved bitmap (254 98 [reference number][x][y])
This command causes a previously stored bitmap referenced by [reference number] to be displayed to
the screen at pixel location (x, y) where this location defines the top left corner of the bitmap. Bitmaps and
fonts may use the same reference numbers, for example it is possible to have both a bitmap 1 and a font 1.
NOTE The reference number is established when the bitmap is saved, normally using
mogd.exe.
4.3 Flow Control
The display has built in flow control which is very useful during direct bitmap display and multiple pixel
placement. Flow control is enabled or disabled by two commands. If flow control is enabled, the display
will return an "almost full" message (0xFE) to the micro-controller when its internal buffer fills to a defined
level, and an "almost empty" message (0xFF) when the buffer contents drop to a defined level.
4.3.1 Enter Flow Control Mode (254 58 [full][empty])
NOTE Flow control applies only to the RS-232 interface. It is not available for I2 C.
This command enables flow control. When the buffer fills so that only [full] bytes are available the display
will return an "almost full" message (0xFE) to the micro-controller. When the buffer empties so that only
[empty] bytes remain the display will return an "almost empty" message (0xFF) to the micro-controller.
The display will return the "almost full" message for every byte sent to the display until the used buffer
space once more drops below the [full] level.
Whether the user is in ’flow control mode’ or not, the module will ignore display or command bytes
which would overrun the buffer. While in ’flow control mode’ the unit will return 0xFE when the buffer is
almost full even though it may have already thrown rejected data away. The buffer size for the display is 96
bytes.
When using this command in an application, selection of the value for the buffer almost full should be
considered very carefully. This is a critical aspect of using this command to it’s full potential. When using a
Matrix Orbital
GLK12232-25-WBL
14
host system or PC which contains a FIFO, the user should set the value of equal to or greater than the size of
the FIFO. The reason for this is that the FIFO may be full when the host system receives 0xFE. In the case
of 16550 UART the size at its maximum is 16, therefore the value of should be set to 16 or greater.
NOTE This mode must not be used during loading of fonts and bitmaps. It is highly
recommended for use with direct screen write and multiple pixel placements.
4.3.2 Exit Flow Control Mode (254 59)
This command turns off flow control. Bytes may overflow the buffer without warning.
5 Keypad Interface
This chapter describes the keypad interface and associated commands in detail.
5.1 General
The display keypad interface processes the keypad row / column matrix into a serial (RS-232 or I2 C)
data byte stream. Aside from this processing, the keypad has no effect on the display. If it is necessary to
send keystrokes to the display, they must be routed through the micro-controller.
5.2 Connections
Figure 7: Keypad Connector
The connector is not ’keyed’ so the keypad will probably plug in either of two ways. The display will
not be damaged by reversing the connector. However, the keypad will generate a different ASCII character
mapping for each position. If the connector has fewer than 10 pins it should be centered on the display
connector.
The diagram shows the logical layout (row 1, column 1 in upper left). The connector for the keypad is a
10 pin 0.1" spacing male header. Pins 1 through 5 are columns and pins 6 through 10 are rows. The keypad
Matrix Orbital
GLK12232-25-WBL
15
is scanned whenever a key is pressed; there is no continuous key scan. This means that key presses are dealt
with immediately without any appreciable latency. This also prevents electrical noise which is often caused
by continuous key scans.
NOTE Please note that keypads may be laid out in a different pattern. If this is the case,
the user will need to interpret the key codes differently.
Table 4: Keypad Layout
Rows
1
2
3
4
5
1
A
F
K
P
U
Columns
2
3
B C
G H
L M
Q R
V W
4
D
I
N
S
X
5
E
J
O
T
Y
NOTE The keypad connector must be wired with columns on one side and rows on the
other side of the center of the connector. In situations where the keypad isn’t wired this
way an adapter will need to be made, or the user should rewire the connector to meet this
requirement.
5.3 I2 C Interface
The keypad is read by I2 C master read. In short, this means that a read of the module will always return
the first unread key press. A read is initiated by writing to the module with its base address plus 1, then
clocking the module’s return byte after the module releases the SDA line. Much more detail on this basic
I2 C function can be found in the I2 C specification by Phillips. A good reference is also available at;
http://www.ping.be/~0751/i2cfaq/i2cindex.htm
The module contains a ten key press buffer so that it can be polled for key presses at an infrequent rate
(every 500 to 1000 mS is typical). All returned key presses indicate the presence or absence of additional
logged key presses by the most significant bit (MSB - bit 7). If the user has pressed two keys since the last
poll of the keypad interface, the first read will return the key code with bit 7 set and the second read will
return the key code with bit 7 clear. The application must take into account this bit to keep up with user key
presses. If there are no keypresses detected, the module will return zero (0x00).
5.4 RS-232 Interface
By default on any press of a key, the module will immediately send out the key code at the selected baud
rate. This behavior can be modified using commands found in the next section.
Matrix Orbital
GLK12232-25-WBL
16
5.5 Commands
5.5.1 Auto repeat mode on (254 126 [mode])
[mode] = 0 gives Resend Key Code mode
[mode] = 1 gives Key down / Key up code mode
Two Modes of auto repeat are available and are set via the same command.
1. Resend Key Code: This mode is similar to the action of a keyboard on a PC. In this mode, when a
key is held down, the key code is transmitted immediately followed by a 1/2 second delay. After this
delay, key codes will be sent via the RS-232 interface at a rate of about 5 codes per second. This mode
has no effect if polling or if using the I2 C interface.
2. Key down / Key up codes: This mode may be used when the typematic parameters of the Resend Key
code mode are unacceptable or if the unit is being operated in polled mode. The host system detects
the press of a key and simulates an auto repeat inside the host system until the key release is detected.
In this mode, when a key is held down, the key code is transmitted immediately and no other codes will be
sent until the key is released. On the release of the key, the key release code transmitted will be a value equal
to the key down code plus 20 hex. For example, the key code associated with key ’P’ (0x50) is pressed, the
release code is ’p’ (0x70).
In RS-232 polled mode or via the I2 C interface, the key down / key up codes are used. However, the user
should be careful of timing details. If the poll rate is slower than the simulated auto-repeat it is possible that
polling for a key up code will be delayed long enough for an unwanted key repeat to be generated.
Figure 8: Poll Timing
5.5.2 Auto repeat mode off (254 96)
This command turns off auto repeat mode.
5.5.3 Auto transmit keypresses on (254 65)
In this mode, all keypresses are sent immediately to the host system without the use of poll keypad
command. This is the default mode on power up.
Matrix Orbital
GLK12232-25-WBL
17
5.5.4 Auto transmit keypresses off (254 79)
In this mode, up to 10 keypresses are buffered until the unit is polled by the host system via the poll
keypad command. Issuing this command places the unit in polled mode.
5.5.5 Clear key buffer (254 69)
This command clears any unread keypresses. In a menuing application, if the user presses a key which
changes the menu context, any following key presses may be inaccurate and can be cleared out of the buffer
between menu changes to prevent jumping around the menu tree. It may also be used to, in effect, reset the
keypad in case the host application resets for whatever reason.
5.5.6 Poll keypad (254 38)
This command returns any unbuffered keypresses via the RS-232 interface. The host system must be
set up to receive the key codes. When the display receives this command it will immediately return any
unbuffered keypresses which may have not been read already. If there is more than one keypress buffered,
then the high order bit (MSB) of this returned keycode will be set (1). If this is the only buffered keypress,
then the MSB will be reset (0). If there are no buffered keypresses, then the returned code will be 0x00.
Please note to make use of this command the "Auto transmit keypress" mode should be off.
5.5.7 Set debounce time (254 85 [time])
[time] is in increments of 6554 microseconds.
This command sets the time between key press and key read. All key types with the exception of latched
piezo switches will ’bounce’ for a varying time, depending on their physical characteristics. The default
debounce time for the module is about 52 mS, which is adequate for most membrane keypads.
6 Fonts and Graphics Files
6.1 General
Matrix Orbital graphic modules contain a sophisticated file system for storing and retrieving font information, bitmaps and system parameters; not unlike the way that a computer deals with files on a hard drive.
However, the modules use no moving parts, therefore, data is stored far more reliably than data on a home
PC.
Operationally, there is one important difference between the Matrix Orbital file system and that of a PC.
While a PC will allow fragmentation of its files across the available file space, the Matrix Orbital file system
takes great care to ensure that all parts of a file are stored together. This system works well to maximize
storage space and operational efficiency, however, during file downloads, the modules may need to spend
Matrix Orbital
GLK12232-25-WBL
18
considerable time moving files to make room for the new file. This delay during download can be as much
as a minute, but generally it will not exceed 10 seconds.
When a file is being downloaded with the same ’name’ or reference number as a previously existing
file, the old file needs to be deleted first. We cannot know if the new file is exactly the same size as the old
file, since the space vacated by the old files is filled by moving previously existing files down to fill up the
vacated space. This ensures that no file space is wasted.
Of course, the average module will simply have files loaded into it and it will then get to work, without
ever having to perform this file reorganization task. The file space may be rewritten up to 100 000 times, but
most users will simply load in their fonts and bitmaps once and that will be it.
6.2 Using mogd.exe
The Matrix Orbital interface program "mogd.exe", which is provided on the disk and the website, generates and saves fonts larger than 14 pixels in height. It is also used to save graphic images (bitmaps) to the
display.
To make use of smaller fonts it is recommended that a pre-generated font be used. These fonts can
be located on the disk or the website. Unfortunately, integrating these fonts is not as straight forward as
generating the fonts. To make use of these fonts the user must place the font files in their font directory as
defined in the interface program. This directory can be found under "settings".
A font file consists of a single file with an extension.mgf and a directory which contains bitmaps for
every character. All .mgf files are contained within the font directory and all bitmap directories are sub
directories of the font directory. After download of a font file use a "Zip" program to "UnZip" the .mgf file
and bitmap sub-directory into the font directory. Start or restart mogd.exe and click on the font tab. The font
list of mogd should now display the new pre-generated font list.
6.3 Commands
In addition to the commands listed below, the mogd.exe program saves fonts and bitmaps to the display’s
flash memory.
6.3.1 Erase file (254 173 [type] [ref])
This command erases a file within the display’s memory, in addition to erasing a single file at a time.
This command needs to be given two parameters: [type] and [ref]. The file type and reference number
are defined when the file is saved to the display using mogd.exe. Since there is no command to list files in
memory, the user must keep track of the memory contents.
• [type] = 1 is a font file
• [type] = 5 is a bitmap
Once this command is completed, all files ’move up’ and recover the empty space for efficient memory
management.
Matrix Orbital
GLK12232-25-WBL
19
6.3.2 Purge memory (254 33 89 33)
This command completely erases the display’s non-volatile memory. This removes all fonts, font metrics,
bitmaps, and settings (current font, cursor position, communication speed, etc.). It is an ’odd’ command in
that it is three bytes in length. This is to prevent accidental execution.
6.3.3 Upload Font (254 36 [ref] [file size] [file data])
This command begins a font upload to the display’s non-volatile memory. [ref] is the reference number
to be used for this font. File size is a 2 byte value that must be calculated by the host before the transfer takes
place.
6.3.4 Upload Bitmap (254 94[ref] [file size] [file data])
This command begins a bitmap upload to the display’s non-volatile memory. [ref] is the reference
number to be used for this bitmap. File size is a 2 byte value that must be calculated by the host before
the transfer takes place.
6.4 Working with Font Files
A font file consists of a header, a character list and character bitmaps.
The header consists of;
• Placeholder for actual EOF (2 bytes, use 0xFF 0xFF - these bytes will be set to their final value by the
module)
• Nominal character width (1 byte)
• Absolute font height (1 byte)
• ASCII value of first character defined in this file (1 byte)
• ASCII value of last character defined in this file (1 byte)
The character list consists of groups of 3 bytes per character;
• Offset to character bitmap (2 bytes)
• Actual width of this character (1 byte)
6.4.1 Font File in Table Form
The table below shows the layout of a font file in table form.
Matrix Orbital
GLK12232-25-WBL
20
Table 5: File Format
0xFF
Width
O-Low
O-High
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
0xFF
O-High
Width
O-Low
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
X size
O-Low
O-High
Width
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Y size
Width
O-Low
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Start
O-High
Width
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
End
O-Low
O-High
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
O-High
Width
O-Low
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
O-Low
O-High
Width
Data
Data
Data
Data
Data
Data
Data
Data
Data
Data
6.4.2 Uploading the File to the Module
The “Upload font” command is used to actually upload the font file. Recall that the syntax for this
command is;
0xFE 0x24 [ref] [file size] [file data]
In this example the file size is 94 bytes (0x5E) and the reference number is 2. The communications
exchange between the host and the module looks like this;
Matrix Orbital
GLK12232-25-WBL
21
Table 6: Uploading the File to the Module
Host sends
0xfe
’$’ (command))
’2’ (reference
Module sends
’2’ (echo reference)
0x01 (host confirms echo)
0x5e (low size)
0x5e (echo)
0x01 (host confirms echo)
0x00 (high size)
0x00 (echo)
0x01 (file fits)*
0xFF (first byte of data)
0xFF (echo)
0x01 (host confirms echo)
0xFF (second byte of data)
0xFF (echo)
0x01 (host confirms echo)
0x20 (third byte of data)
0x20 (echo)
0x01 (host confirms echo)
etc
NOTE If the module detects that the file will not fit in the available memory when the file
size has been transmitted, it will send 0x08 instead of 0x01. In this case, the host should
cease transmission. The module will return to a ready state.
From this point, the module treats all data as raw and just stores it away. The module will store the data, then
read it back from memory and send the read value back to the host. If the host system receives an incorrect
echo, it should send status as 0x08 instead of 0x01. This will terminate the transfer. Upon termination, the
module will delete the partially completed file and return to a ready state.
6.4.3 A Sample Font File
Let’s look at a short sample font file containing only the letters "h", "i" and "j". First we need to define
the font size. For this example we’ll use a 5x7 pixel font. Next, we have to draw the bitmaps for each of the
characters. We’ll use the examples shown in the Figure below.
Matrix Orbital
GLK12232-25-WBL
22
Figure 9: Bitmaps for h, i, and j
Now the bitmaps have to be converted to bytes. If the font is 8 bits high, this is a pretty simple job
because each vertical column is simply one byte (lsb at the top). In this case however, the font is only 7 bits
high so the bytes "wrap around" as shown in the Figure below.
Figure 10: Bytes For a 7 Bit High Font
We’ve marked in the bits that are set for the letter "h". Remember that the bytes are ’inverted’, i.e., the
LSB is at the top. Each byte is shown in a different colour in the diagram. When the bytes are straightened
out, it’s simple enough to find their hex values, which are shown in the diagram above each byte. Trailing
zero bytes at the end of narrow characters are not included in the file.
Table 7: Example of a File Font
0xFF
0x05
0x04
0x20
0xFF
0x00
0x81
0xB1
0X05
0x14
0x80
0x07
0x07
0x03
0x07
0x68
0x00
0xC4
0x6A
0x17
0x3E
0x00
0x04
0x10
0x0F
0x7F
0x02
The colours refer to: Font information header, character ’h’, character ’i’, character ’j’.
Matrix Orbital
GLK12232-25-WBL
23
Table 8: Explanation of Bytes in the File
FF FF
05
07
68
70
00 0F
05
00 1 4
03
00 017
04
7F 04 81 80 07
C4 3E 10
02 20 B1 07
placeholders for actual EOF
font width
font height
first ASCII character defined
last ASCII character defined
offset to definition of first character
(h)
number of bytes in definition of first
character
offset to definition of second character (i)
number of bytes in definition of second character
offset to definition of third character
(j)
number of bytes in definition of
third character
definition of first character
definition of second character
definition of third character
6.5 Working with Bitmap Files
Uploading a bitmap is the same as uploading a font file except that the character header information is
not required.
The bitmap file consists of a header followed by the bitmap data. The header format is as follows;
• Placeholder for actual EOF (2 bytes, use 0xFF 0xFF - these bytes will be set to their final value by the
module)
• x size of bitmap (1 byte)
• y size of bitmap (1 byte)
Bitmap data follows with the bits organized vertically from the top left. The last byte may be padded with
zeros.
7 Miscellaneous Commands
7.1 General
The commands listed in this chapter don’t readily fit in any of the other categories, or are used in more
than one category.
Matrix Orbital
GLK12232-25-WBL
24
7.1.1 Clear display (254 88)
This command clears the display and resets the text write position to the top left of the screen.
7.1.2 Set contrast (254 80 [contrast])
This command sets the display’s contrast to [contrast], where [contrast] is a value between 0x00 and
0xFF (between 0 and 255). Lower values cause ’on’ elements in the display area to appear lighter, while
higher values cause ’on’ elements to appear darker.
Lighting conditions will affect the actual value used for optimal viewing. Individual display modules
will also differ slightly from each other in appearance. In addition, values for optimal viewing while the
display backlight is on may differ from values used when backlight is off.
7.1.3 Set contrast and save (254 145 [contrast])
This command works in exactly the same way as the "Set contrast" command. The only difference is
it saves the contrast value in the memory of the module, whereas the previous command only changes the
value for the duration of use.
7.1.4 Backlight on (254 66 [minutes])
This command turns on the backlight for a time of [minutes] minutes (this specifies how long the backlight will remain on after reception of the command). If [minutes] is zero (0), the backlight will remain on
indefinitely.
NOTE Backlight is always on by default on power up.
7.1.5 Backlight off (254 70)
This command turns the backlight of the display off.
7.1.6 General purpose output on (254 86 [gpo #])
This command turns ON either of the general purpose outputs. [gpo #] is 1 for G1 or 2 for G2. Note that
ON means that the output is pulled low.
Matrix Orbital
GLK12232-25-WBL
25
7.1.7 General purpose output off (254 87 [gpo #])
This command turns OFF either of the General Purpose Outputs. [gpo #] is 1 for G1 or 2 for G2. For G1
OFF allows the output to ’float’. For G2 OFF pulls the output to +5V.
7.1.8 Set I2 C address 254 51 [address])
This command sets the I2 C write address of the module. This value must be an even number and the
read address is one higher. For example if the I2 C write address is set to 0x50, then the read address is 0x51.
The change in address is immediate. This address is 0x50 by default, and is reset temporarily back to that
value when the ’manual over-ride’ jumper is used on power up.
7.1.9 Read module type (254 55)
This command will return, over the RS-232 interface, the model type value of the module. It will return
a 1-byte hex value. Values for various modules at the time of this publication are as follows;
Table 9: Module Values
LCD0821 - 0x01
LCD4021 - 0x06
LK204-25 - 0x09
VFD2041 - 0x0C
VK204-25 - 0x0F
GLK24064-25 - 0x15
LK404-AT - 0x31
LK204-25PC - 0x35
LCD2021 - 0x03
LCD4041 - 0x07
LK404-55 - 0x0A
VFD4021 - 0x0D
GLC12232 - 0x10
GLK12232-25-WBL - 0x22
LK402-12 - 0x33
LCD2041 - 0x05
LK202-25 - 0x08
VFD2021 - 0x0B
VK202-25 - 0x0E
GLC24064 - 0x13
GLK12232-25-SM - 0x24
LK162-12 - 0x34
7.1.10 Set RS-232 port speed (254 57 [speed])
This command sets the display’s RS-232 port to the specified [speed]. The change takes place immediately. [speed] is a single byte specifying the desired port speed. Valid speeds are shown in the table below.
The display can be manually reset to 19,200 baud in the event of an error during transmission (including
transmitting a value not listed below) by setting the ’manual over-ride’ jumper on the display controller
board during power up. This command is ignored until this jumper is removed again.
Matrix Orbital
GLK12232-25-WBL
26
Table 10: Speed Settings
Speed Value
20 Hex
0F Hex
95 Hex
03 Hex
8A Hex
Speed
9600 baud
19200 baud
57600 baud
76800 baud
115000 baud
7.1.11 Set Serial Number (254 52 [byte1] [byte2]
Modules may be delivered with the serial number blank. In this case the user may set the desired 2 byte
serial number using this one time only command.
Upon the execution of this command, the module will echo these two bytes back over the RS-232 interface. The serial number may be set only once. Any future attempt to execute this command will result in no
change and the module will return to the originally set serial number.
7.1.12 Read Serial Number (254 53)
This command will return, over the RS-232 interface, the two-byte serial number of the module as it was
previously stored.
7.1.13 Read Version Number 254 54)
This command will return the firmware version number of the display. It will return a 1-byte hex value.
8 Appendix: Command Summary
8.1 General
The operation of the display is controlled by a simple and consistent command set.
Commands control;
•
•
•
•
Text display
Graphics display
Keypad interface the display file system
Miscellaneous operating parameters
This chapter includes summary tables of all commands.
Matrix Orbital
GLK12232-25-WBL
27
8.2 Issuing Commands
Commands are issued to the display by the micro-controller. In a test setup commands can be issued
to the display by means of a BASIC program using the chr$( ) function. In the tables below, we’ve shown
commands in hex, ASCII and decimal form. All commands begin with the prefix character 0xFE (254
decimal). These commands are issued on the serial communications link (I2 C or RS-232) at the currently
defined baud rate.
For example, using BASIC in a test setup, the user could issue the command to clear the screen on the
display by including the line;
PRINT#1,chr$(254);chr$(88)
in the user’s BASIC program .
Or, with C the user could (using Zcomm serial library)
ZComm1->WriteCommByte(0xfe);
ZComm1->WriteCommByte(’X’);
8.3 Text Commands
Table 11: Text Commands
Command
Auto scroll on
Syntax
FE 51
254 81
254 ’Q’
Default
off
Auto scroll off
FE 52
254 82
254 ’R’
off
Set text insertion point
FE 47 [col] [row] 254 71
[col] [row] 254 ’G’ [col]
[row]
n/a
Matrix Orbital
GLK12232-25-WBL
Notes
Enables scroll at
bottom of screen.
Text will push
display up one
line to make room
for new line.
Disables
auto
scroll. Text will
wrap to top left
and
overwrite
existing text.
Sets text insertion
point using the
base size of the
current font.
28
Command
Set text insertion point to
top left
Syntax
FE 48
254 72
254 ’H’
Default
Set text insertion point using pixel values
FE 79 [x] [y]
254 121 [x] [y]
254 ’y’ [x] [y]
n/a
Set current font
FE 31 [font id]
254 49
254 ’1’
FE 32 [metrics]
254 50 [metrics]
254 ’2’ [metrics]
n/a
Set font metrics
n/a
Notes
This
command
moves the text
insertion
point
to the top left
of the display
area, based on
the metrics of the
current font. See
"Set font metrics"
for more details.
Sets text insertion
point to position
(x,y), where x and
y are in pixels.
Value is top left
corner of next text
character.
Sets font to [font
id]. Font must be
in memory.
For definition of
[metrics] see section 3.3.7.
8.4 Graphics Commands
Table 13: Graphic Commands
Command
Set drawing color
Draw line
Continue line
Matrix Orbital
Syntax
FE 63 [color]
254 99 [color]
254 ’c’ [color]
FE 6C [x1][y1][x2][y2]
254 108 [x1][y1][x2][y2]
254 ’l’ [x1][y1][x2][y2]
FE 65 [x][y]
254 101 [x][y]
254 ’e’ [x][y]
GLK12232-25-WBL
Notes
Sets color (0 = white, 255 = black)
for the various drawing commands.
Draws a line from x1,y1 to x2, y2. x
values are from 0 - 63 (decimal) and
y values from 0 - 239 (decimal).
Continues line from last line end
(x2,y2) to (x,y). Uses current drawing color.
29
Command
Put pixel
Draw outline rectangle
Draw solid rectangle
Initialize bar graph
Write to bar graph
Display saved bitmap
Syntax
FE 70 [x][y]
254 112 [x][y]
254 ’p’ [x][y]
FE
72
[color][x1][y1][x2][y2]
254
114
[color][x1][y1][x2][y2]
254
’r’
[color][x1][y1][x2][y2]
FE
78
[color][x1][y1][x2][y2]
254
120
[color][x1][y1][x2][y2]
254
’x’
[color][x1][y1][x2][y2]
[ref][type][x1][y1][x2][y2]
254
103
[ref][type][x1][y1][x2][y2]
254
’g’
[ref][type][x1][y1][x2][y2]
FE 69 [ref][value]
254 105 [ref][value]
254 ’I’ [ref][value]
FE 62 [ref][x][y]
254 98 [ref][x][y]
254 ’b’ [ref][x][y]
Notes
Puts pixel in position (x,y). Uses
current drawing color.
Draws a rectangular outline using
color [color].
Draws a solid rectangle using color
[color].
Sets aside space for a bar graph.
[ref] is reference number (0-15) for
use by the Write to Bar Graph command. [type] has values:
0 = vertical, starting from bottom
1 = horizontal, starting from left
2 = vertical, starting from top 3 =
horizontal, starting from right
Fills the bar graph referred to as [ref]
from start to [value]. [value] is in
pixels.
Causes bitmap [ref] to be displayed
with its top left corner starting at position (x,y).
8.5 Keypad Interface Commands
Table 15: Keypad Interface Commands
Command
Auto repeat mode on
Matrix Orbital
Syntax
FE 7E [0|1]
254 126 [0|1]
254 ’~’ [0|1]
GLK12232-25-WBL
Default
off
Notes
Applies to keypad
only. 0 = 200
ms typematic, 1 =
key down/key up
codes sent.
30
Command
Auto repeat mode off
Auto transmit keypresses
on
Auto transmit keypresses
off
Clear key buffer
Poll keypad
Set debounce time
Syntax
FE 60
254 96
254 ’‘’
FE 41
254 65
254 ’A’
Default
off
Notes
Applies to keypad
only.
on
FE 4F
254 79
254 ’O’
FE 45
254 69
254 ’E’
FE 26
254 38
254 ’&’
FE 55 [time]
254 85 [time]
254 ’U’ [time]
off
Sets auto transmit
mode for keypad.
Keypresses are
transmitted
to
host
without
polling.
Up to 10 keypresses buffered
until polled.
Clear unread keypresses.
n/a
n/a
52 ms
Returns buffered
keypresses to application.
Resolution: 1 =
0.6554 ms
8.6 File System Commands
In addition to these commands, the mogd.exe program is used to download fonts and graphics to the
display.
Table 17: File System Commands
Command
Erase file
Syntax
FE B0 [type] [ref]
254 173 [type] [ref]
Default
n/a
Purge memory
FE 21 59 21
254 33 89 33
n/a
Matrix Orbital
GLK12232-25-WBL
Notes
Erases file in
memory. Type =
1 is font, type = 5
is bitmap. [ref] is
reference number.
Removes
all
fonts, font metrics, bitmaps and
settings
from
memory.
31
Command
Upload bitmap
Upload font
Syntax
FE 6E [ref] [size] [data]
254 94[ref] [size] [data]
254 ’^’ [ref] [size] [data]
FE 24 [ref] [size] [data]
254 36 [ref] [size] [data]
254 ’$’ [ref] [size] [data]
Default
n/a
n/a
Notes
Uploads a bitmap
to the memory of
the display.
Uploads a font to
the memory of the
display.
8.7 Miscellaneous Commands
Table 19: Miscellaneous Commands
Command
Clear display
Syntax
FE 58
254 88
254 ’X’
Default
n/a
Set contrast
FE 50 [contrast] 254 80
[contrast] 254 ’P’ [contrast]
128
Set contrast and save
FE 91 [contrast] 254 145
[contrast]
128
Backlight on
FE 42 [minutes]
254 66 [minutes] 254 ’B’
[minutes]
on
Matrix Orbital
GLK12232-25-WBL
Notes
Clears screen of
text and graphics,
places text cursor
at top left.
Sets display contrast.
Compensates for viewing
angle. Contrast
is a value between
0 and 255 (hex 0
to FF). Larger =
darker.
Set contrast and
save FE 91 [contrast] 254 145
[contrast] 128.
Same as "Set contrast" but saves
[contrast] as default.
Backlight
will
stay on for [minutes]. If [minutes]
= 0 backlight
will
stay
on
permanently.
32
Command
Backlight off
General purpose output on
General purpose output off
Set I2 C address
Read module type
Set RS-232 port speed
Enter flow control mode
Exit flow control mode
Set Serial Number
Read Serial Number
Matrix Orbital
Syntax
FE 46
254 70
254 ’F’
FE 56
254 86
254 ’V’
FE 57
254 87
254 ’W’
FE 33 [address]
254 51 [address]
254 ’3’ [address]
Default
on
Notes
Turns off backlight.
off
FE 37
254 55
254 ’7’
FE 39 [speed]
254 57 [speed]
254 ’9’ [speed]
FE 3A [full] [empty]
254 58 [full] [empty]
254 ’:’ [full] [empty]
see table
Turns the general
purpose
output
ON.
Turns the general
purpose
output
OFF.
Value is write address and must be
even, read address
is 1 higher.
Reads the module
type. Returns 1byte hex value.
Sets
RS-232
speed.
FE 3B
254 59
254 ’;’
FE 34 [byte 1] [byte 2]
254 52 [byte 1] [byte 2]
254 ’4’ [byte 1] [byte 2]
FE 35
254 53
254 ’5’
GLK12232-25-WBL
off
ox50
19,200
off
Sets "full" and
"empty" marks
for the 96 byte
display
buffer.
When
buffer
reaches
[full]
display
will
return 0xFE to
host.
When
buffer
reaches
[empty] display
will return 0xFF.
Turns off flow
control
(buffer
handshaking).
This is a onetime-use
command
which
works only on
units
without
factory set serial
numbers.
Reads the two
byte serial number of the module.
33
Command
Read Version Number
Syntax
FE 36
254 54
254 ’6’
Default
Notes
Reads
the
firmware
version
number
of the module.
Returns
1-byte
hex value.
9 Appendix: Specifications
Table 21: Environmental Specifications
Operating Temperature
Storage Temperature
Operating Relative Humidity
Vibration (Operating)
Vibration (Non-Operating)
Shock (Operating)
Shock (Non-Operating)
Standard Temperature
0◦ C to +50◦ C
-20◦ C to +70◦ C
90% max non-condensing
4.9 m/s2 XYZ directions
19.6 m/s2 XYZ directions
29.4 m/s2 XYZ directions
490 m/s2 XYZ directions
Table 22: Electrical Specifications
Supply Voltage
Supply Current
Supply Backlight Current
Matrix Orbital
4.75 - 5.25 Vdc
18 mA typical
60 mA typical
GLK12232-25-WBL
34
Table 23: Optical Characteristics
Pixel Layout
Number of Characters
Display Area
Dot Size
Dot Pitch
LED / CCFL Backlight Life
Color of Illumination
122 x 32pixels XxY
80 (maximum 20 characters x 4Lines with 5x7 font)
69.50 x 20.76mm XxY
0.52 x 0.62mm (XxY)
0.53 x 0.53mm (XxY)
100, 000 hours typical
Ice Blue
Figure 11: Physical Layout
Table 24: Display Options
Matrix Orbital
GLK12232-25-WBL
35
Model
LCD0821
LCD2041
LCD4021
LCD4041
LK162-12
LK202-25
LK204-25
L402-12
LK404-55
LK404-AT
BLC2041
VFD2041
VK202-25
VK204-25
BVF2041
GLC24064
GLK12232-25-WBL
GLK24064-25
Matrix Orbital
E
a
a
a
a
a
a
a
a
a
a
a
a
a
a
a
a
n/a
a
V
a
a
a
n/a
a
a
a
a
n/a
n/a
a
a
a
a
a
n/a
n/a
n/a
VPT
n/a
n/a
n/a
a
n/a
n/a
a
a
a
a
n/a
n/a
n/a
a
n/a
a
n/a
a
GLK12232-25-WBL
EL
n/a
n/a
n/a
a
n/a
n/a
n/a
n/a
a
a
n/a
n/a
n/a
n/a
n/a
a
n/a
n/a
FL
n/a
n/a
n/a
n/a
n/a
n/a
n/a
n/a
n/a
n/a
n/a
n/a
n/a
n/a
n/a
n/a
n/a
a
36