GLK12232-25-SM-WB

GLK12232-25-SM Technical Manual Revision: 2.1 Contents Contents 1 2 3 4 5 ii Getting Started 1.1 Display Options Available 1.2 Accessories . . . . . . . . 1.3 Features . . . . . . . . . . 1.4 Connecting to a PC . . . . 1.5 Installing the Software . . 1.5.1 MOGD# . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1 2 3 4 4 4 Hardware Information 2.1 Power/Data Connector . . . 2.2 Protocol Select Jumpers . . . 2.3 Keypad Interface Connector 2.4 GPO . . . . . . . . . . . . . 2.5 Manual Override . . . . . . 2.6 Filesystem Lock Jumper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 6 8 9 9 10 11 Troubleshooting 3.1 The display does not turn on when power is applied. . . . . . . . . . . . . 3.2 The display module is not communicating. . . . . . . . . . . . . . . . . . 3.3 The display module is communicating, however text cannot be displayed. 3.4 There is a problem uploading fonts or bitmaps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 12 12 13 13 Communications 4.1 Introduction . . . . . . . . . . . . . . 4.1.1 I2 C Communication Summary 4.1.2 I2 C Transaction Example . . . 4.1.3 Serial Communication . . . . 4.2 Turn Flow Control On . . . . . . . . 4.3 Turn Flow Control Off . . . . . . . . 4.4 Changing the I2 C Slave Address . . . 4.5 Changing the Baud Rate . . . . . . . 4.6 Setting a Non-Standard Baud Rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 13 14 14 15 15 16 16 17 18 Fonts 5.1 Introduction . . . . . . . 5.1.1 Font File Format 5.1.2 Creating a Font . 5.2 Uploading a Font File . . 5.3 Setting the Current Font . 5.4 Font Metrics . . . . . . . 5.5 Set Box Space Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 19 20 20 22 22 23 23 Matrix Orbital . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GLK12232-25-SM ii 6 7 8 Text 6.1 Introduction . . . . . . . . . . 6.1.1 Character Set . . . . . 6.1.2 Control Characters . . 6.2 Move Cursor Home . . . . . . 6.3 Setting the Cursor Position . . 6.4 Setting the Cursor Coordinate 6.5 Auto Scroll On . . . . . . . . 6.6 Auto Scroll Off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 24 24 24 24 25 25 25 26 Bitmaps 7.1 Introduction . . . . . . . . . . . 7.2 Uploading a Bitmap File . . . . 7.3 Drawing a Bitmap from Memory 7.4 Drawing a Bitmap Directly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 26 26 27 27 Bar Graphs and Drawing 8.1 Introduction . . . . . . . . 8.2 Set Drawing Color . . . . 8.3 Draw Pixel . . . . . . . . 8.4 Drawing a Line . . . . . . 8.5 Continue a Line . . . . . . 8.6 Draw a Rectangle . . . . . 8.7 Drawing a Solid Rectangle 8.8 Initializing a Bar Graph . . 8.9 Drawing a Bar Graph . . . 8.10 Initializing a Strip Chart . 8.11 Shifting a Strip Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 28 28 29 29 29 30 30 31 31 32 33 General Purpose Output 9.1 Introduction . . . . . . . . . 9.2 General Purpose Output Off 9.3 General Purpose Output On . 9.4 Set Startup GPO state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 34 34 34 35 10 Keypad 10.1 Introduction . . . . . . . . . . 10.1.1 I2 C Interface . . . . . 10.1.2 RS232 Interface . . . 10.2 Auto Transmit Key Presses On 10.3 Auto Transmit Key Presses Off 10.4 Poll Key Press . . . . . . . . . 10.5 Clear Key Buffer . . . . . . . 10.6 Set Debounce Time . . . . . . 10.7 Set Auto Repeat Mode . . . . 10.8 Auto Repeat Mode Off . . . . 10.9 Assign Keypad Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 35 36 36 36 36 37 37 37 38 39 39 9 Matrix Orbital GLK12232-25-SM iii 11 Display Functions 11.1 Introduction . . . . . . . 11.2 Clear Screen . . . . . . . 11.3 Display On . . . . . . . 11.4 Display Off . . . . . . . 11.5 Set Brightness . . . . . . 11.6 Set and Save Brightness . 11.7 Set Contrast . . . . . . . 11.8 Set and Save Contrast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 40 40 40 40 41 41 41 42 12 Filesystem 12.1 Introduction . . . . . . . . . . . . 12.1.1 File Upload Protocol . . . 12.1.2 XModem Upload Protocol 12.2 Wipe Filesystem . . . . . . . . . 12.3 Deleting a File . . . . . . . . . . . 12.4 Get Filesystem Space . . . . . . . 12.5 Get Filesystem Directory . . . . . 12.6 Filesystem Upload . . . . . . . . 12.7 Downloading a File . . . . . . . . 12.8 Moving a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 43 43 45 45 47 47 48 48 48 49 13 Data Security 13.1 Introduction . . . . . . 13.2 Set Remember . . . . . 13.3 Data Lock . . . . . . . 13.4 Set and Save Data Lock 13.5 Dump the Filesystem . 13.6 Write Customer Data . 13.7 Read Customer Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 49 50 50 52 52 52 52 14 Miscellaneous 14.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14.2 Read Version Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14.3 Read Module Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 53 53 53 15 Command Summary 15.1 Communications . . . . 15.2 Fonts . . . . . . . . . . 15.3 Text . . . . . . . . . . . 15.4 Bitmaps . . . . . . . . . 15.5 Bar Graphs and Drawing 15.6 General Purpose Output . 15.7 Keypad . . . . . . . . . 15.8 Display Functions . . . . 15.9 Filesystem . . . . . . . . 15.10Data Security . . . . . . 55 55 55 55 56 56 57 57 58 58 59 Matrix Orbital . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GLK12232-25-SM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv 15.11Miscellaneous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.12Command By Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Appendix 16.1 Specifications . . . . . . . 16.1.1 Environmental . . 16.1.2 Electrical . . . . . 16.2 Optical Characteristics . . 16.3 Physical Layout . . . . . . 16.4 Ordering Information() . . 16.5 Definitions . . . . . . . . . 16.6 Contacting Matrix Orbital . 16.7 Revision History . . . . . Matrix Orbital . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GLK12232-25-SM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 60 61 61 61 62 62 62 64 64 64 65 v 1 Getting Started Figure 1: GLK12232-25-SM The GLK12232-25-SM is an intelligent graphic LCD display designed to decrease development time by providing an instant solution to any project. With the ability to communicate via serial RS-232/TTL and I2 C protocols, the versatile GLK12232-25-SM can be used with virtually any controller. The ease of use is further enhanced by an intuitive command structure to allow display settings such as backlight brightness, contrast and baud rate to be software controlled. Additionally, text and fonts may be uploaded to the display and stored in the on board memory. 1.1 Display Options Available The GLK12232-25-SM comes in two colour options, white text with blue background and blue text with white background. Extended voltage and temperature options are also available to allow you to select the display which will best fit your project needs. Matrix Orbital GLK12232-25-SM 1 Figure 2: GLK12232-25-SM Options 1.2 Accessories NOTE Matrix Orbital provides all the interface accessories needed to get your display up and running. You will find these accessories and others on our e-commerce website at http://www.matrixorbital.com. To contact a sales associate see Section 16.6 for contact information. Figure 3: 5V Power Cable Adapter Figure 4: 12V Power Cable Adaptor (V Models) Figure 5: Breadboard Cable Figure 6: Serial Cable 4FT Matrix Orbital GLK12232-25-SM 2 Figure 7: Communication and 5V Power Cable Figure 8: 4x4 Keypad 1.3 • • • • • • Features 122 x 32 pixel graphics display Selectable communication protocol, Serial at RS-232 or TTL Levels or I2 C Two 5V - 20mA General Purpose Outputs 16 KB memory for fonts and bitmaps Lightning fast communication speeds, up to 115 kbps for RS-232 and 100 kbps for I2 C Adjustable contrast and backlight brightness Matrix Orbital GLK12232-25-SM 3 • Extended temperature available for extreme environments of -20C to 70C • Extended voltage and efficient power supply available • Support for up to a twenty five key matrix style keypad 1.4 Connecting to a PC The GLK12232-25-SM connects seamlessly to a PC and it is an excellent means of testing the functionality and uploading new fonts and bitmaps. You will require a Communication and 5V Power Cable such as the one shown in Figure 7. In order to connect your display to a personal computer follow these easy instructions: 1. Plug the DB9 end of the Communication and 5V Power cable cable into the com port you wish to use. 2. Connect the power connector end of the Communication and 5V Power cable into the PC power supply (you will have to open your computer case if you do not have a separate power supply). 3. Connect the power and data connector of the Communication and 5V Power cable into the back of the display, see Section 2.1 for details. 1.5 Installing the Software 1.5.1 MOGD# MOGD# is the latest updated version of MOGD and can be used to manage font and graphics downloads as well as exercise all of the features of our graphical displays. MOGD# provides a new user friendly interface as well as many feature enhancements. To install MOGD# from the Matrix Orbital website, follow the following steps: 1. Go to the website location: http://www.matrixorbital.ca/software/software_graphic/MOGDsharp/ 2. Click on “Download Here” Matrix Orbital GLK12232-25-SM 4 3. 4. 5. 6. 7. Locate the file MogdSharp.zip on your desktop Unzip MogdSharp.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 MOGD# requires the .NET framework 2.0 and will download and install it automatically After the installation is complete there will be a Matrix Orbital entry under "Start->Programs->Matrix Orbital" in the start menu. Click on the ’Mogd Sharp’ entry to run the program. Be sure to check the information selected in the configuration panel the first time MOGD# is run. Once this information is entered correctly the program can be used to control all functions of the graphic display. Port The serial port the display is plugged in to. Speed The communication speed the display module is set to. (Default 19,200) Display Type The type of display (GLK1223225-SM) PCB Revision The revision of the display you are using. (Found on the back of the PCB). Figure 9: Mogd Sharp Settings • Winzip is available as a free download from http://www.winzip.com Matrix Orbital GLK12232-25-SM 5 2 Hardware Information Refer to the following diagram for this chapter: Figure 10: GLK12232-25-SM Table 1: Hardware information 1 Power/Data Connector 5 Protocol Select Jumpers 2 Floppy Power Connector 6 Filesystem Lock Jumper 3 Keypad Interface Connector 7 Manual Override 4 GPO 2.1 Power/Data Connector Matrix Orbital GLK12232-25-SM 6 Power/Connector Vcc +5V +12V Regular GLK12232-25-SM input +5V only +5V only N/C -V option input 9-15V N/C +12V NOTE +12V is nominal for the -V but supply of 9-15V is acceptable Figure 11: Power and Data Configuration To power up and communicate with a GLK12232-25-SM (standard or wide voltage options), the users have two options for connections: • power and data connections using the Power/Data Connector of the GLK12232-25-SM (supply Vcc with the proper voltage) • power connections using the Floppy Power connector and data (RX/TX) and ground using the Power/Data connector NOTES • A common ground should be used at all times • Each module ordered has specific voltages and cannot be interchanged Matrix Orbital GLK12232-25-SM 7 WARNINGS • Do not apply and 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 in the wrong connector 2.2 Protocol Select Jumpers The Protocol Select Jumpers, pictured below in Figure 12, provide the means necessary to toggle the display module between RS-232, TTL and I2 C protocols. As a default, the jumpers are set to RS-232 mode with zero ohm resistors on the 232 jumpers. In order to place the display module in I2 C mode you must first remove the zero ohm resistors from the 232 jumpers and then solder the resistors on to the I2C jumpers, or bridge solder across the pads. The display will now be in I2 C mode and have a default slave address of 0x50 unless it has been changed. Similarly, in order to change the display to TTL mode, simply remove the zero ohm resistors from the 232 or I2 C jumpers and solder them to the TTL jumpers. Figure 12: Protocol-Select-Jumpers Matrix Orbital GLK12232-25-SM 8 2.3 Keypad Interface Connector The GLK12232-25-SM provides a Keypad Interface Connector which allows for up to a five by five matrix style keypad to be directly connected to the display module. Key presses are generated, when a short is detected between a row and a column. When a key press is generated a character, which is associated with the particular key press, is automatically sent on the Tx communication line. If the display module is running in I2 C mode, the "Auto Transmit Keypress" function may be turned off, to allow the key presses to remain in the buffer so that they may be polled. The character that is associated with each key press may also be altered using the "Assign Key Codes" command, for more detailed information see the Keypad Section. Figure 13: Keypad Interface Connector 2.4 GPO A unique feature of the GLK12232-25-SM is the ability to control relays and other external devices using a General Purpose Output (3), which can provide up to 20 mA of current and +5Vdc from the positive side of the GPO. This is limited by a 240 ohm resistor which is located directly above the positive pin as pictured below in Figure 14 on the following page. If the device, which is being driven by a GPO, requires a Matrix Orbital GLK12232-25-SM 9 relatively high current (such as a relay) and has an internal resistance of its own greater than 250 ohms, then the 240 ohm resistor may be removed and replaced with a jumper. Pin 1 (from left) Pin 2 GPO 1 Pin 3 Pin 4 GPO 2 -GND +MAX: 20mA, +5Vdc -GND +MAX: 20mA, +5Vdc Figure 14: General Purpose Output WARNING Warning: If connecting a relay, be sure that it is fully clamped using a diode and capacitor in order to absorb any electromotive force (EMF) which will be generated. 2.5 Manual Override The Manual Override is provided to allow the GLK12232-25-SM to be temporarily reset to some of the factory defaults. This can be particularly helpful if the display module has been set to an unknown baud rate or I2 C Slave Address and you are no longer able to communicate with it. If you wish to return the module to its default settings you must: 1. Power off the display module. 2. Place a Jumper on the Manual Override pins 1 and 2 as pictured below. 3. Power up the display module. 4. The display module is now set to its default values listed below in table 2. 5. Edit and save settings. Matrix Orbital GLK12232-25-SM 10 Figure 15: Manual Override Jumper Table 2: Default Values Contrast 128 Backlight 255 Baud Rate 19.2 kbps I2 C Slave Address 0x50 Data Lock 0x00 RS232AutoTransmitData True NOTE The display module will revert back to the old settings once turned off, unless the settings are saved. 2.6 Filesystem Lock Jumper The Filesystem Lock Jumper allows you to lock the filesystem on the GLK12232-25-SM so that no fonts or bitmaps can be either written or deleted from the on board memory. This feature is useful in order to protect data integrity of production units, if protection of other settings is required see Section 13 To lock the filesystem, solder a zero ohm resistor or use a solder jumper pictured in Figure 16 below. Matrix Orbital GLK12232-25-SM 11 Figure 16: Filesystem Lock Jumper 3 Troubleshooting 3.1 The display does not turn on when power is applied. • First, you will want to make sure that you are using the correct power connector. Standard floppy drive power cables from your PC power supply may fit on the Power/Data Connector however they do not have the correct pinout as can be seen in Figure ??. Matrix Orbital supplies power cable adapters for connecting to a PC, which can be found in the Accessories Section on page 2. • The next step is to check the power cable which you are using for continuity. If you don’t have an ohm meter, try using a different power cable, if this does not help try using a different power supply. • The last step will be to check the Power / Data Connector on the GLK12232-25-SM. If the Power / Data Connector has become loose, or you are unable to resolve the issue, please contact Matrix Orbital see 16.6 on page 64 for contact information. 3.2 The display module is not communicating. • First, check the communication cable for continuity. If you don’t have an ohm meter, try using a different communication cable. If you are using a PC try using a different Com port. • Second, please ensure that the display module is set to communicate on the protocol that you are using, by checking the Protocol Select Jumpers. To change the protocol used by the display module see Section 2.2 on page 8. • Third, ensure that the host system and display module are both communicating on the same baud rate. The default baud rate for the display module is 19200 bps. Matrix Orbital GLK12232-25-SM 12 • If you are communicating to the display via I2 C please ensure that the data is being sent to the correct address. The default slave address for the display module is 0x50. NOTE I2 C communication will always require pull up resistors. • Finally, you may reset the display to it’s default settings using the Manual Override Jumper, see Section 2.5 on page 10. 3.3 The display module is communicating, however text cannot be displayed. • The cause of this is often that no font has been loaded onto the display. To load a font onto the display see Section 4.2.1 on page 16. • Another common cause may be that the contrast settings have been set to low. The solution to this problem is to adjust the contrast settings, the default setting that will work in most environments is 128 NOTE Optimal contrast settings may vary according to factors such as temperature, viewing angle and lighting conditions. 3.4 There is a problem uploading fonts or bitmaps. • First, ensure that you can communicate to the display. A good test is to use a PC, with MOGD# installed, to connect to the display. See Section 1.4 on page 4for setting up a PC to test the GLK1223225-SM. • Second, ensure that the Filesystem Lock Jumper has not been set. See Section 2.6 on page 11. • Third, please ensure that the display module’s memory is not full. The GLK12232-25-SM has 16 Kb of memory for fonts and bitmaps. NOTE If you are unable to resolve any issue please contact Matrix Orbital. See 16.6 on page 64 for contact information. 4 Communications 4.1 Introduction The commands listed in this chapter describe how to configure data flow on the GLK12232-25-SM. Matrix Orbital GLK12232-25-SM 13 4.1.1 I2 C Communication Summary The GLK12232-25-SM is capable of communicating at 100 KHz in I2 C mode, with 127 units addressable on a single I2 C communication line. However, in order to communicate via I2 C you must first ensure that pull up resistors, with a nominal value of 1K to 10K, are placed on the SCL and SDA communication lines coming from pins two and three of the Data / Power Connector respectively. Data responses by the module are automatically output via RS232, in case the host will be querying the module, it is necessary for the host to inform the module that its responses are to be output via I2 C. This can be done by sending command 254 /160 / 0 to turn off auto transmission of data in RS232. This will keep the data in the buffer until the master clocks a read of the slave. The I2 C data lines operate at 5V normally or 3.3V for -1U style units. The GLK12232-25-SM uses 8-bit addressing, with the 8th or Least Significant Bit (LSB) bit designated as the read/write bit, a 0 designates a write address and a 1 designates a read address. The default read address of the display module will be 0x51, whereas the write address is 0x50 by default. This address may be changed by using cmd 254 / 51 / . The GLK12232-25-SM should only be sent addresses that are even (LSB is 0). When the I2 C master wishes to write to the display, the effective address is $50 (0101 0000) , since the LSB has to be 0 for an I2 C master write. When the I2 C master wishes to read the GLK12232-25-SM, the effective address is $51 (0101 0001), since the LSB has to be 1 for an I2 C master read. If we take a standard Phillips 7 bit address of $45 (100 0101), Matrix Orbital’s GLK12232-25-SM would describe this Phillips I2 C address as $8A (1000 1010). The read address would be $8B (1000 1011). The unit does not respond to general call address ($00). When communicating in I2 C the GLK12232-25-SM will send an ACK on the 9th clock cycle when addressed. When writing to the display module, the display will respond with a ACK when the write has successfully been completed. However if the buffer has been filled, or the module is too busy processing data it will respond with a NAK. When performing a multiple byte read within one I2 C transaction, each byte read from the slave should be followed by an ACK to indicate that the master still needs data, and a NAK to indicate that the transmission is over. The GLK12232-25-SM has some speed limitations, especially when run in I2 C mode. Here are some considerations when writing I2 C code: * to be able to read the replies of query commands (eg. cmds 54, 55) the following command must be sent (only needs to be sent once, so this can be done somewhere in init): 254 / 160 / 0 this command puts the reply data in the I2 C output buffer instead of the RS232 output buffer. Please note that due to a 16 byte output buffer, query commands that reply with more than 16 bytes cannot be read (eg cmd Get FileSystem Directory) * 3ms delay between the read commands * 625us delay in between data bytes within a transaction is necessary * 375us between transactions is necessary NOTE These delays are consrevative, and may be decreased based on performance 4.1.2 I2 C Transaction Example The typical I2 C transaction contains four parts: the start sequence, addressing, information, and stop sequence. To begin a transaction the data line, SDA, must toggle from high to low while the clock line, SCL, Matrix Orbital GLK12232-25-SM 14 is high. Next, the display must be addressed using a one byte hexadecimal value, the default to write to the unit is 0x50, while read is 0x51. Then information can be sent to the unit; even when reading, a command must first be sent to let the unit know what type of information it is required to return. After each bit is sent, the display will issue an ACK or NACK as described above. Finally, when communication is complete, the transaction is ended by toggling the data line from low to high while the clock line is high. An example of the use of this algorithm to write a simple “HELLO” message can be seen in 3. Table 3: I2 C Transaction Algorithm START Toggle SDA high to low Address 0x50 Information 0x48 0x45 0x4C 0x4C 0x4F STOP Toggle SDA low to high 4.1.3 Serial Communication In addition to being able to communicate via I2 C the GLK12232-25-SM communicates natively through the RS-232 protocol at at a default baud rate of 19,200 bps and is capable of standard baud rates from 9600 to 115,200 bps. Furthermore the GLK12232-25-SM is also capable of reproducing any non-standard baud rate in between using values entered into our baud rate generation algorithm and set through command 164 (0xA4). The display module communicates at standard voltage levels of -30V to +30V or at TTL levels of 0 to +5V by setting the Protocol Select Jumpers to TTL. 4.2 Turn Flow Control On Syntax Parameters Hexadecimal Decimal ASCII Parameter full empty Matrix Orbital 0xFE 0x3A [full] [empty] 254 58 [full] [empty] 254 “:” [full] [empty] Length Description 1 Bytes remaining before issuing a almost full message. (Full is 0) 1 Bytes available before issuing a almost empty message. (Empty is 128) GLK12232-25-SM 15 Description 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 host controller. When the buffer empties so that only [empty] bytes remain, the display will return an “almost empty” message (0xFF) to the host 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 buffer is almost full even though it may have already thrown rejected data away. The buffer size for the display is 128 bytes. When using this command in an application, selection of the value for the buffer [full] should be considered very carefully. This is a critical aspect to be able to use this feature to it’s full potential. When using a host system or PC which contains a FIFO, the user should set the value of [full] 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 [full] should be set to 16 or greater. It is suggested that the “almost full” parameter be equal to the largest chunk of data the host will be sending the display (should be less than 127). NOTE This command is not available in I2 C mode. Remembered Default 4.3 Yes Off Turn Flow Control Off Syntax Description Hexadecimal 0xFE 0x3B Decimal 254 59 ASCII 254 “;” This command turns off flow control. Bytes may overflow the buffer without warning. NOTE This command is not available in I2 C mode. Remembered 4.4 Yes Changing the I2 C Slave Address Matrix Orbital GLK12232-25-SM 16 Syntax Parameters Description Hexadecimal Decimal ASCII Parameter adr 0xFE 0x33 [adr] 254 51 [adr] 254 “3” [adr] Length Description 1 The new I2 C write address (0x00 0xFF). This command sets the I2 C write address of the module between 0x00 and 0xFF. The I2 C write address must be an even number and the read address is automatically set to one higher. For example if the I2 C write address is set to 0x50, then the read address is 0x51. NOTE The change in address is immediate. Remembered Default 4.5 Always 0x50 Changing the Baud Rate Syntax Parameters Matrix Orbital Hexadecimal Decimal ASCII Parameter speed 0xFE 0x39 [speed] 254 57 [speed] 254 “9” [speed] Length Description 1 Hex value corresponding to a baud rate. GLK12232-25-SM 17 Description This command sets the 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 module 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 override jumper during power up. However, it should be noted that this command will be ignored until the manual override jumper is removed again. Hex Value 0xCF 0x8A 0x67 0x44 0x33 0x22 0x19 0x10 Baud Rate 9600 14400 19200 28800 38400 57600 76800 115200 NOTE This command is not available in I2 C mode. Remembered Default 4.6 Always 19,200 bps Setting a Non-Standard Baud Rate Syntax Parameters Description Remembered Matrix Orbital Hexadecimal Decimal Parameter speed 0xFE 0xA4 [speed] 254 164 [speed] Length Description 2 Inputed LSB MSB from baud rate formula (12-2047). This command sets the RS-232 port to a non-standard baud rate. The command accepts a two byte parameter that goes directly into the CrystalSpeed − 1 to modules baud generator. Use the formula, speed = 8×DesiredBaud calculate the [speed] for any baud rate setting. The speed can be anywhere from 12 to 2047 which corresponds to a baud range of 977 to 153,800 baud. Setting the baud rate out of this range could cause the display to stop working properly and require the Manual Override jumper to be set. Always GLK12232-25-SM 18 Examples Crystal Speed 16 Mhz Desired BAUD 13,500 speed = crystalspeed −1 8 ∗ DesiredBaud speed = 148.15 − 1 speed = 16, 000, 000 −1 8 ∗ 13, 500 speed = 147.15 • LSB = 0x93 (rounded) • MSB = 0x00 • Intended Baud Rate: 13,500 baud Actual Baud Rate: 16,000,000 =13,514 Percent Difference: 0.1% 8(147+1) NOTES • Results from the formula are rounded down to the nearest whole number (i.e 73.07 = 73). • This formula becomes less acurate as baud rates increase, due to rounding. • Place the speed result backwards into the formula to receive the actual baud rate. (Baud = CrystalSpeed 8(speed+1) ) • The actual baud rate must be within 3% of the intended baud rate for the device to communicate. NOTES • This command is not available in I2 C mode. 5 5.1 Fonts Introduction The GLK12232-25-SM comes loaded with the ’Small Filled’ and ’Futura Bk BT 16’ fonts by default. However, it is capable of displaying any font that is uploaded to it in the correct format. MOGD# provides a simple method of generating font files from your installed fonts. For instructions on how to install MOGD# see Section 1.5.1 on page 4. Matrix Orbital GLK12232-25-SM 19 5.1.1 Font File Format A font file consists of three parts, a header, a character table and bitmap data. 1. Header (4 bytes) (a) (b) (c) (d) Nominal Width (1 byte) Height (1 byte) ASCII Start Value (1 byte) ASCII End Value (1 byte) 2. Character Table (3 bytes for every character between the ASCII Start and End values inclusive) (a) High Offset MSB (1 byte) (b) Low Offset LSB(1 byte) (c) Character Width (1 byte) 3. Bitmap Data 5.1.2 Creating a Font The following is an example of how to create a font file for the letters h, i and j. First you must create the bitmaps containing the character data in bitmap form. Figure 17 below illustrates the bit pattern for the h, i and j bitmap data. Figure 17: Bitmaps for h, i, and j Second you may begin to create the font file starting with the header. The header will contain the nominal width, the height and the ASCII start and end values inclusive that you wish to create characters for. Nominal Width 0x05 Table 9: Font File Header Height ASCII Start Val 0x07 0x68 ASCII End Val 0x6A Next we will have to find out how many bytes each character will use up, in order to create the character table. The bitmaps are encoded horizontally and may have variable widths, h has a width of five, i a width of three and j a width of four, see the figure below for an example of encoding the first letter h: Matrix Orbital GLK12232-25-SM 20 1 1 1 1 1 1 1 Bitmap Data 0 0 0 0 0 0 0 1 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 Byte Hex Value 10000100 00101101 10011000 11000110 00100000 0x84 0x2D 0x98 0xC6 0x20 Figure 18: Bitmap Encoding As you can see the letter h will take up five bytes with the last five bits being zero padded to form a full byte. So if you continue the process you will get the character data as seen in table 5.1.2. Character Data h i j 0x84 0x43 0x2D Character Data 0x2D 0x98 0xC6 0x24 0x84 0x98 0x19 0x60 0x20 Byte Size (For Reference) 0x05 0x03 0x04 The second part of the font file is the character table. The character table is comprised of three bytes for every glyph in the font file. The first two bytes represents the position, in bytes, of the glyph stored MSB LSB referenced from the beginning of the file (including the header. The third byte is the width of the glyph in pixels. So because there will be 0x09 bytes in the character table (three bytes for each glyph) and four bytes in the header section, the first entry in the table will be 13, or 0x00 0x0D in hexadecimal, and 0x05 for the width. To calculate the second entry in the character table, representing the position and width of the second glyph, take the offset of the first entry and add the size of the first bitmap in bytes. Since the first glyph occupies 0x05 bytes as seen in table 5.1.2 above, and the offset is 0x00 0x0D, the offset of the second entry will be 0x00 0x12 and the width of the glyph is 0x03. Calculate the third entry the same way as the second to get table 10 below. h i j Table 10: Character Table High Offset (MSB) Low Offset (LSB) 0x00 0x0D 0x00 0x12 0x00 0x15 Character Width 0x05 0x03 0x04 Once completed, place the character table after the header and the character data aat the end, as seen in table 11. Matrix Orbital GLK12232-25-SM 21 0x05 0x12 0xC6 0x60 0x07 0x03 0x20 Table 11: Sample Font File 0x68 0x6A 0x00 0x0D 0x00 0x15 0x04 0x84 0x43 0x24 0x84 0x2D 0x05 0x2D 0x98 0x00 0x98 0x19 Red = Header Blue = Character Table Purple = Character Data 5.2 Uploading a Font File Syntax Parameters Description Hexadecimal Decimal ASCII Parameter refID 0xFE 0x24 [refID] [size] [data] 254 36 [refID] [size] [data] 254 “$” [refID] [size] [data] Length Description 1 A unique font identification number. size 2 Font file size (LSB to MSB). data x Font file data. In order to upload a font to the GLK12232-25-SM you must first initiate the upload font file command (0xFE 0x24), you must then pass it a reference identification number, which must be unique for every font on the display module. You may then pass the display module the two byte file size, which needs to be transfered LSB, then MSB. The last part of uploading a font is transmitting the font file data. For detailed instructions on uploading a file to the GLK12232-25-SM see Section 12 on page 43. NOTE This command is available but not supported in I2 C. Remembered 5.3 Always Setting the Current Font Syntax Parameters Matrix Orbital Hexadecimal Decimal ASCII Parameter refID 0xFE 0x31 [refID] 254 49 [refID] 254 “1” [refID] Length Description 1 A unique font identification number. GLK12232-25-SM 22 5.4 Description In order to set the font on the GLK12232-25-SM you must know the font identification number of the font that you wish to use. The font ID is established when the font is saved to the display. The default installed fonts are “Small Filled” and “Futura Bk BT 16” and their font ID’s are 0x01 and 0x02 respectfully, with “Small Filled” being the default selected font. Once you are aware of the font ID for the font that you wish you use, simply send the command bytes (0xFE 0x31) and then send the font ID corresponding to the font. A directory listing of the contents of the entire filesystem may be obtained by using the “Get Filesystem Directory” command, see Section 12.5 on page 48 for more detailed information. Remembered Yes Font Metrics Syntax Parameters Description Remembered 5.5 Hexadecimal Decimal ASCII Parameter lm tm csp 0xFE 0x32 [lm] [tm] [csp] [lsp] [srow] 254 50 [lm] [tm] [csp] [lsp] [srow] 254 “2” [lm] [tm] [csp] [lsp] [srow] Length Description 1 Left margin: Location in pixels. 1 Top margin: Location in pixels. 1 Character Spacing: Amount of space in pixels between characters. lsp 1 Line Spacing: Amount of space between lines in pixels. srow 1 Scroll Row: The Y location of the last row in pixels. Font metrics define where the characters are positioned on the screen, by setting where the rows and columns begin based on the [lm][tm][csp][lsp][srow] parameters. [lm] defines the leftmost position and [tm] the topmost. [csp] controls the amount of pixels that are placed in between characters and [lsp] controls the amount of pixels that are placed in between lines. [srow] is the location of the top of the last row that will be displayed on the GLK12232-25-SM. It defines the row that, when filled, will cause the display to auto scroll if auto scrolling is enabled. The font metrics will have to be reconfigured after changing to a different font. Yes Set Box Space Mode Matrix Orbital GLK12232-25-SM 23 Syntax Parameters Description Remembered Default 6 6.1 Hexadecimal 0xFE 0xAC [value] Decimal 254 172 [value] Parameter Length Description value 1 Value (0: Off, 1: On) This command will toggle the box space mode. Box space mode is when a box, the size of the character to be written, is printed to the display before a character is written. Yes On Text Introduction The GLK12232-25-SM is an intelligent display module, designed to reduce the amount of code necessary to begin displaying data. This means that it is able to display all ASCII formated characters and strings that are sent to it, which are defined in the current character set. The display module will begin displaying text at the top left corner of the display area, known as home, and continue to print to the display as if it was a page on a typewriter. When the text reaches the bottom right row, it is able to automatically scroll all of the lines up and continue to display text, with the auto scroll option set to on. 6.1.1 Character Set The graphic displays such as the GLK12232-25-SM, do not have built in character sets. Instead fonts are uploaded to the display using the commands detailed in Section 5 on page 19. 6.1.2 Control Characters In addition to a full text set, the GLK12232-25-SM display supports the following ASCII Control characters: 0x0A Line feed / New line - when this value is not defined in the font file. This command will create a new line on the display. If scrolling is on and the display is at the bottom of the screen, the whole screen is scrolled up. 6.2 Move Cursor Home Syntax Matrix Orbital Hexadecimal Decimal ASCII 0xFE 0x48 254 72 254 “H” GLK12232-25-SM 24 6.3 Description This command moves the text insertion point to the top left of the display area (Row 1, Column 1). Remembered No Setting the Cursor Position Description Hexadecimal 0xFE 0x47 [col] [row] Decimal 254 71 [col] [row] ASCII 254 “G” [col] [row] Parameter Length Description col 1 Column row 1 Row This command sets the text insertion point to the [col] 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 column used is determined by multiplying the width of the widest character in the font by the [column]. The row used is determined by multiplying the height of the font by [row + Metrics: line spacing]. Remembered No Syntax Parameters 6.4 Setting the Cursor Coordinate Syntax Parameters Description Remembered 6.5 Hexadecimal 0xFE 0x79 [x] [y] Decimal 254 121 [x] [y] ASCII 254 “y” [x] [y] Parameter Length Description x 1 The horizontal position in pixels. y 1 The vertical position in pixels. This command positions the insertion point at a specific pixel (X,Y), which references the top left corner of the font insertion point. No Auto Scroll On Syntax Matrix Orbital Hexadecimal Decimal ASCII 0xFE 0x51 254 81 254 “Q” GLK12232-25-SM 25 6.6 Description 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 end of the scroll row defined in the font metrics (the bottom right character position) see Section 5.4 on page 23. Remembered Default Yes On Auto Scroll Off Syntax Description Remembered 7 7.1 Hexadecimal 0xFE 0x52 Decimal 254 82 ASCII 254 “R” When auto scrolling is disabled, text will wrap to the top left corner of the display area when the text reaches the end of the scroll row defined in the font metrics (the bottom right character position) see Section 5.4 on page 23. Existing text in the display area is not erased before new text is placed. A series of spaces followed by a “Cursor Home” command may be used to erase the top line of text. Yes Bitmaps Introduction One of the main features of the GLK12232-25-SM is its ability to display bitmap images, that are either loaded onto its on board memory, or written directly to the screen. This chapter will cover creating a bitmap, uploading the bitmap, as well as drawing the bitmap from memory and directly. 7.2 Uploading a Bitmap File Syntax Parameters Hexadecimal Decimal ASCII Parameter refID size data Matrix Orbital 0xFE 0x5E [refID] [size] [data] 254 94 [refID] [size] [data] 254 “^” [refID] [size] [data] Length Description 1 A unique bitmap identification number. 2 Bitmap file size (LSB to MSB). x Bitmap data. GLK12232-25-SM 26 Description The GLK12232-25-SM is capable of storing 128 font and bitmap files up to 16 Kbytes total. In order to upload a bitmap to the GLK12232-25-SM you must first initiate the upload font file command (0xFE 0x5E), you must then pass it a reference identification number, which must be unique for every font on the display module. You may then pass the display module the two byte file system size, which needs to be transfered LSB, then MSB. This is almost always the entire 16kB, meaning the values 0x00 0x40 0x00 0x00 must be issued. The last part of uploading a bitmap is transmitting the bitmap file data. For detailed instructions on uploading a file to the GLK12232-25-SM see Section 12 on page 43. NOTE This command is available but not not supported in I2 C. Remembered 7.3 Drawing a Bitmap from Memory Description Hexadecimal 0xFE 0x62 [refID] [X] [Y] Decimal 254 98 [refID] [X] [Y] ASCII 254 “b” [refID] [X] [Y] Parameter Length Description refID 1 The bitmap identification number. X 1 Left bounds. Y 1 Top bounds. This command will draw a bitmap that is located in the on board memory. The bitmap is referenced by the bitmaps reference identification number, which is established when the bitmap is uploaded to the display module. The bitmap will be drawn beginning at the top left, from the specified X,Y coordinates. A directory listing of the contents of the entire filesystem may be obtained by using the “Get Filesystem Directory” command, see Section 12.5 on page 48 for more detailed information. Remembered No Syntax Parameters 7.4 Always Drawing a Bitmap Directly Syntax Matrix Orbital Hexadecimal Decimal ASCII 0xFE 0x64 [X] [Y] [W] [H] [D] 254 100 [X] [Y] [W] [H] [D] 254 “d” [X] [Y] [W] [H] [D] GLK12232-25-SM 27 Parameters Description Parameter Length Description X 1 Left bounds. Y 1 Top bounds. W 1 Width H 1 Height D (width*height)/8Data Drawing a bitmap to the GLK12232-25-SM, without first uploading the image to the memory can be a very useful feature for drawing images that are not used very often. In order to accomplish this, you must supply the display module with the X,Y coordinates, representing the top left corner of where you would like to draw the bitmap on the screen, as well as the width and the height of the bitmap. After you have supplied this data you may then upload the bitmap data to the GLK12232-25-SM. The length of this file is the bitmap width multiplied by height, divided by eight. The bitmap data is encoded into bytes horizontally and is transfered the same as if you were uploading a file, see Section 12 on page 43 for more information about transferring data to the display module. NOTE Drawing a bitmap directly to the display is supported by flow control. This command is available but not support in I2 C mode. Remembered 8 8.1 No Bar Graphs and Drawing Introduction Supplementary to the ability of the GLK12232-25-SM to display bitmaps and fonts, the GLK12232-25SM also allows for a robust 2D drawing environment. With the ability to draw by pixel, line or rectangle, as well as the ability to continue a line to form a polygon, we are certain that you will spend less time, developing and creating better looking projects. With the addition of custom bar and strip graphs, you are sure to find the right tools to make any graphical layout a success. 8.2 Set Drawing Color Syntax Parameters Matrix Orbital Hexadecimal Decimal ASCII Parameter color 0xFE 0x63 [color] 254 99 [color] 254 “c” [color] Length Description 1 Drawing color (0: White, 1-255: Black). GLK12232-25-SM 28 8.3 Description 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 is 0 and black is 1-255. Remembered No Draw Pixel Syntax Parameters Description Remembered 8.4 No Drawing a Line Syntax Parameters Description Remembered 8.5 Hexadecimal 0xFE 0x70 [x] [y] Decimal 254 112 [x] [y] ASCII 254 “p” [x] [y] Parameter Length Description x 1 X screen location. y 1 Y screen location. 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 Kbps so flow control is not required. Hexadecimal 0xFE 0x6C [x1] [y1] [x2] [y2] Decimal 254 108 [x1] [y1] [x2] [y2] ASCII 254 “l” [x1] [y1] [x2] [y2] Parameter Length Description x1 1 Left bounds. y1 1 Top Bounds. x2 1 Right Bounds. y2 1 Bottom Bounds. 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. However, it 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. No Continue a Line Matrix Orbital GLK12232-25-SM 29 Syntax Parameters Description Remembered 8.6 No Draw a Rectangle Syntax Parameters Description Remembered 8.7 Hexadecimal 0xFE 0x65 [x] [y] Decimal 254 101 [x] [y] ASCII 254 “e” [x] [y] Parameter Length Description x 1 Left bounds. y 1 Top Bounds. This command will draw a line with the current drawing color from the last line end (x2,y2) to (x,y). This command uses the global drawing color. Hexadecimal Decimal ASCII Parameter color 0xFE 0x72 [color] [x1] [y1] [x2] [y2] 254 114 [color] [x1] [y1] [x2] [y2] 254 “r” [color] [x1] [y1] [x2] [y2] Length Description 1 Drawing color (0: White, 1-255: Black). x1 1 Left bounds. y1 1 Top Bounds. x2 1 Right Bounds. y2 1 Bottom Bounds. This command draws a rectangular box in the specified color (0: White, 1: Black). The top left corner is specified by (x1,y1) and the bottom right corner by (x2,y2). No Drawing a Solid Rectangle Syntax Parameters Hexadecimal Decimal ASCII Parameter color x1 y1 x2 y2 Matrix Orbital 0xFE 0x78 [color] [x1] [y1] [x2] [y2] 254 120 [color] [x1] [y1] [x2] [y2] 254 “x” [color] [x1] [y1] [x2] [y2] Length Description 1 Drawing color (0: White, 1-255: Black). 1 Left bounds. 1 Top Bounds. 1 Right Bounds. 1 Bottom Bounds. GLK12232-25-SM 30 8.8 Description This command draws a solid rectangle in the specified color (0: White, 1: 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. Remembered No Initializing a Bar Graph Syntax Parameters Description Hexadecimal 0xFE 0x67 [refID] [type] [x1] [y1] [x2] [y2] Decimal 254 103 [refID] [type] [x1] [y1] [x2] [y2] ASCII 254 “g” [refID] [type] [x1] [y1] [x2] [y2] Parameter Length Description refID 1 Reference number type 1 Type of bar graph. x1 1 Left bounds. y1 1 Top Bounds. x2 1 Right Bounds. y2 1 Bottom Bounds. 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 1 2 3 Remembered 8.9 Direction Vertical Horizontal Vertical Horizontal Bar Start Point Bottom Left Top Right The bar graphs may be located anywhere on the display, but if they overlap, they will not display properly. 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 Fill Bar Graph command. The unit saves time by only drawing that part of the bar graph which has changed from the last write, so the representation on the screen may not survive a screen clear or other corrupting action. A write of value zero, followed by new values will restore the proper look of the bar graph. No Drawing a Bar Graph Matrix Orbital GLK12232-25-SM 31 Syntax Parameters Description Remembered Hexadecimal Decimal ASCII Parameter ref 0xFE 0x69 [ref] [value] 254 105 [ref] [value] 254 “i” [ref] [value] Length Description 1 Initialized bar graph reference number. value 1 The number of pixels to fill. Once the bar graph has been initialized it can be filled in using this command. This command sets the bar graph specified by the [ref] number to fill in [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.) No 8.10 Initializing a Strip Chart Syntax Parameters Matrix Orbital Hexadecimal Decimal ASCII Parameter refID x1 y1 x2 y2 0xFE 0x6A [refID] [x1] [y1] [x2] [y2] 254 106 [refID] [x1] [y1] [x2] [y2] 254 “j” [refID] [x1] [y1] [x2] [y2] Length Description 1 Reference number 1 Left bounds. 1 Top Bounds. 1 Right Bounds. 1 Bottom Bounds. GLK12232-25-SM 32 Description A strip chart is an area of the screen reserved for horizontal scrolling. This is normally used as follows: • Initialize the strip chart, which reserves the appropriate area of the screen. • Draw a line segment at the right or left side of the strip chart. • Shift the strip chart to the right or left. • Draw the next line segment. • Used this way the strip chart can produce a graph which scrolls smoothly horizontally in either direction. With text the strip chart can produce a marquis effect. NOTE If the strip chart is used with text we recommend the use of a 6 or 7 pixel wide fixed width character set, with each character placed 8 pixels from the start of the previous one. Up to 7 strip charts ([ref] = 0 - 6) may be defined. To initialize a strip chart the user must define an area on the display in which to place the strip chart.(x1,y1) is the top left corner of the area to be used, where [x1] is the placement of the column where the strip chart is to begin and [y1] is the row. The user must then define [x2] as the bottom right column of the area to be utilized and [y2] as the bottom right row. NOTE The definition of x must lie on byte boundaries. That is, x must be defined as 0x00, 0x08, 0x10, etc. This restriction does not apply to y values. Remembered No 8.11 Shifting a Strip Chart Syntax Parameters Matrix Orbital Hexadecimal Decimal ASCII Parameter ref 0xFE 0x6B [ref] 254 107 [ref] 254 “k” [ref] Length Description 1 Reference number of a strip chart that has already been created. GLK12232-25-SM 33 Description This command shifts the strip chart left or right. [ref] determines both which strip chart is used and which direction it will shift. The direction is selected by the most significant bit (MSB): • MSB: 0 shifts left • MSB: 1 shifts right For example if [ref] is 1: • 254 107 1 (hex FE 6B 01) shifts left • 254 107 129 (hex FE 6B 81) shifts right This command shifts the contents of the area defined in the Initialize Strip Chart command 8 pixels at a time. Remembered 9 9.1 No General Purpose Output Introduction General purpose outputs allow you to connect devices, such as LEDs, to the GLK12232-25-SM and supply them with up to 20mA of current at 5V. The GLK12232-25-SM has 2 GPOs which are software controlled, with functions to turn them on/off and set the power state for the next startup. 9.2 General Purpose Output Off Syntax Parameters Description Hexadecimal 0xFE 0x56 [Num] Decimal 254 86 [Num] ASCII 254 “V” [Num] Parameter Length Description Num 1 GPO number. This command turns OFF general purpose output [num]. NOTE OFF means that the output is pulled LOW. Remembered 9.3 Yes General Purpose Output On Matrix Orbital GLK12232-25-SM 34 Syntax Parameters Description Hexadecimal 0xFE 0x57 [Num] Decimal 254 87 [Num] ASCII 254 “W” [Num] Parameter Length Description Num 1 GPO number. This command turns ON general purpose output [num]. The standard GPO’s on the GLK12232-25-SM output 20mA of current at 5V. NOTE ON means the output is pulled HIGH. Remembered 9.4 Yes Set Startup GPO state Syntax Parameters Description Hexadecimal 0xFE 0xC3 [Num] [state] Decimal 254 195 [Num] [state] Parameter Length Description Num 1 GPO number. state 1 Startup state (0: Off, 1: On) This command will set the startup state for the GPO on the next power up. A value of one will cause the GPO to be off on the next startup while a value of one will cause the GPO to be on. NOTE This command does not affect the current state of the GPO. Remembered 10 Always Keypad 10.1 Introduction The GLK12232-25-SM supports up to a 25 key, matrix style, keypad and may be configured to allow key presses to be automatically transmitted via RS-232 or polled through I2 C. The GLK12232-25-SM also allows for auto-repeating key presses, and remapping of all keypad character codes. 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 keypad 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. Matrix Orbital GLK12232-25-SM 35 10.1.1 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. 10.1.2 RS232 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. 10.2 Auto Transmit Key Presses On Syntax Description Hexadecimal 0xFE 0x41 Decimal 254 65 ASCII 254 “A” In this mode, all key presses are sent immediately to the host system without the use of the poll keypad command. This is the default mode on power up. NOTE This command is not available in I2 C. Remembered Default Yes On 10.3 Auto Transmit Key Presses Off Syntax Description Hexadecimal 0xFE 0x4F Decimal 254 79 ASCII 254 “O” In this mode, up to 10 key presses are buffered until the unit is polled by the host system, via the poll keypad command 254 38. Issuing this command places the unit in polled mode. NOTE This command is not available in I2 C. Remembered Matrix Orbital Yes GLK12232-25-SM 36 10.4 Poll Key Press Syntax Description Hexadecimal 0xFE 0x26 Decimal 254 38 ASCII 254 “&” This command returns any buffered key presses via the serial interface. The host system must be set up to receive key codes. When the display receives this command, it will immediately return any buffered key presses which may have not been read already. If there is more than one key press buffered, then the high order bit (MSB) of the returned key code will be set (1). If this is the only buffered key press, then the MSB will be cleared (0). If there are no buffered key presses, then the returned code will be 0x00. Please note that to make use of this command, the “Auto Transmit Key Presses” mode should be off. NOTE This command is not available in I2 C. To read keys in I2 C mode, one just needs to address the module and read a byte. No preceding commands are necessary. If there are no keys pressed the read will result in a 0x00. Remembered No 10.5 Clear Key Buffer Syntax Description Remembered Hexadecimal 0xFE 0x45 Decimal 254 69 ASCII 254 “E” This command clears any unread key presses. In a menu 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, in effect, to reset the keypad in case the host application resets for whatever reason. No 10.6 Set Debounce Time Syntax Matrix Orbital Hexadecimal Decimal ASCII 0xFE 0x55 [time] 254 85 [time] 254 “U” [time] GLK12232-25-SM 37 Parameters Description Remembered Default Parameter time Length 1 Description Debounce time in increments of 6.554ms (0 - 255). 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 [time] value is in increments of 6.554ms. The default debounce time for the module is 8 (about 52ms), which is adequate for most membrane keypads. Yes 8 10.7 Set Auto Repeat Mode Syntax Parameters Description Hexadecimal Decimal ASCII Parameter mode 0xFE 0x7E [mode] 254 126 [mode] 254 “~” [mode] Length Description 1 Auto Repeat Mode (0: Resend Key , 1: Key Up/Down) Two auto repeat modes are available and are set via the same command: • Resend Key Mode: 0x00 • Key Up/Down Mode: 0x01 Resend Key Mode 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. Key Up/Down Mode 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. Remembered Matrix Orbital Yes GLK12232-25-SM 38 Examples When 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, 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. 10.8 Auto Repeat Mode Off Description Hexadecimal 0xFE 0x60 Decimal 254 96 ASCII 254 “‘” This command turns auto repeat mode off. See Set Auto Repeat Mode. Remembered No Syntax 10.9 Assign Keypad Codes Syntax Parameters Description Remembered Matrix Orbital Hexadecimal 0xFE 0xD5 [KDown] [KUp] Decimal 254 213 [KDown] [KUp] Parameter Length Description KDown 25 Key down codes KUp 25 Key up codes This command will allow you to reassign the key codes that correspond to the key presses on the matrix style key pad. The first 25 bytes that are transmitted will be used for the key down codes and the next 25 bytes that are transmitted will be used for the key up codes. Key Down Key Up 1 2 3 4 5 1 2 3 4 5 1 A B C D E 1 a b c d e 2 F G H I J 2 f g h i j 3 K L M N O 3 k l m n o 4 P Q R S T 4 p q r s t 5 U V W X Y 5 u v w x y Always GLK12232-25-SM 39 11 Display Functions 11.1 Introduction The GLK12232-25-SM employs software controlled display settings, which allow for control over, clearing the screen, changing the brightness and contrast or setting timers for turning it on or off. The combination of these allow you complete software control over your display’s appearance. 11.2 Clear Screen Syntax Description Remembered Hexadecimal 0xFE 0x58 Decimal 254 88 ASCII 254 “X” This command clears the display and resets the text insertion position to the top left position of the screen defined in the font metrics. No 11.3 Display On Syntax Parameters Description Remembered Default Hexadecimal Decimal ASCII Parameter min 0xFE 0x42 [min] 254 66 [min] 254 “B” [min] Length Description 1 Minutes before turning the display on (0 to 90). This command turns the backlight on after the [minutes] timer has expired, with a ninety minute maximum timer. A time of 0 specifies that the backlight should turn on immediately and stay on. When this command is sent while the remember function is on, the timer will reset and begin after power up. Yes 0 11.4 Display Off Syntax Matrix Orbital Hexadecimal Decimal ASCII 0xFE 0x46 254 70 254 “F” GLK12232-25-SM 40 Description This command turns the backlight off immediately. The backlight will remain off until a ’Display On’ command has been received. Remembered Yes 11.5 Set Brightness Syntax Parameters Description Remembered Default Hexadecimal Decimal Parameter brightness 0xFE 0x99 [brightness] 254 153 [brightness] Length Description 1 Display brightness setting (0 to 255). This command sets the display [brightness]. If the remember function is on, this command acts the same as ’Set and Save Brightness’. Yes 255 11.6 Set and Save Brightness Description Hexadecimal 0xFE 0x98 [brightness] Decimal 254 152 [brightness] Parameter Length Description brightness 1 Backlight setting (0 to 255). This command sets and saves the display [brightness] as default. Remembered Always Syntax Parameters 11.7 Set Contrast Syntax Parameters Matrix Orbital Hexadecimal Decimal ASCII Parameter contrast 0xFE 0x50 [contrast] 254 80 [contrast] 254 “P” [contrast] Length Description 1 Contrast value (0 to 255). GLK12232-25-SM 41 Description This command sets the display’s contrast to [contrast], where [contrast] is a value between 0x00 and 0xFF (between 0 to 255). Lower values cause ‘on’ elements in the display area to appear lighter, while higher values cause ‘on’ elements to appear darker. Lighting and temperature 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. This command does not save the [contrast] value, and is lost after power down; but this command has the option of remembering the settings when issued with the Remember function ‘on’ . When this is the case, this command is the same as the Set and Save Contrast command. NOTE This command has only 32 levels for X-Board based displays, meaning eight contrast settings will have the same single effect. Efectively, values 0 through 7, 8 through 15, and so on will result in the same setting. Remembered Default Yes 128 11.8 Set and Save Contrast Syntax Parameters Description Hexadecimal 0xFE 0x91 [contrast] Decimal 254 145 [contrast] Parameter Length Description contrast 1 Contrast value (0 to 255). This command sets the display’s contrast to [contrast], where [contrast] is a value between 0x00 and 0xFF (between 0 to 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. NOTE This command saves the [contrast] value so that it is not lost after power down. Remembered Default Matrix Orbital Yes 128 GLK12232-25-SM 42 12 Filesystem 12.1 Introduction The GLK12232-25-SM incorporates a 16 Kbyte on board flash memory in order to allow up to 128 font and bitmap files to be transfered directly onto the display and recalled whenever necessary. The filesystem can address font and bitmap files combined up to 16 Kbytes. It is recommended that fonts and bitmaps are uploaded when possible all together after a filesystem wipe ro preserve memory integrity. These fonts and bitmaps can then be locked to ensure they remain intact. This section covers uploading, downloading, deleting and moving files, as well as getting the remaining space or wiping the filesystem. 12.1.1 File Upload Protocol In order to allow fonts and bitmaps to be uploaded to the on board flash memory Matrix Orbital has developed a simple protocol that supports RS-232/TTL or I2 C communications. In order to begin a file transmission the first step will be to provide the display module with the appropriate command bytes, meaning the command prefix, 0xFE, followed by the command number, 0x24 for a font file, or 0x5E for a bitmap file. This will begin the file transfer sequence. The next step will be to request a reference identification number (ref ID) which will allow you to identify the file for future use. Reference ID numbers can be any byte between 0x00 and 0x7F, however each ID must be unique. The next part of uploading a font file is to provide the display module with the two byte file size of the data that you wish to transfer, LSB to MSB. The LSB must be transmitted first followed by the MSB. After receiving the MSB the display module will send a confirm byte, 0x01, if the file fits and continue, or decline byte, 0x08, and terminate the session. Byte 0x01 0x08 Description Confirm: Will continue the file transfer. Decline: Terminate the session. The last part of uploading a font file is to upload the file data. After transmitting each byte of the file the module will echo the byte and wait for a confirmation byte of 0x01 until the file has completed uploading. Below is an example of uploading the font file which we created in Section 5.1.2 on page 20. At times that the display or the host sees anything else other than 0x01 for confirmation (usually a 0x08) the upload is aborted. Matrix Orbital GLK12232-25-SM 43 Host 0xFE 0x24 0x01 0x19 0x00 Display 0x01 0x01 0x05 0x05 0x01 0x07 0x07 0x01 0x49 0x49 0x01 ... 0x60 ... 0x60 0x01 Comments Command Prefix Upload Font File Command Reference ID Size (LSB) Size (MSB) Confirmation Byte Confimation Byte Font Width Echo Font Width Confimation Byte Font Height Echo Font Height Confimation Byte Font ASCII Start Value Echo Font ASCII Start Value Confimation Byte ... Last Font File Byte Echo Last Font File Byte Confirm Upload Finished Table 52: Upload Protocol Matrix Orbital GLK12232-25-SM 44 NOTES • The GLK12232-25-SM has watch dog timer, set to 2.1 seconds in between transmissions, in order prevent the display module from staying in a waiting state. • Once the timeout has been reached the timer will reset the display and issue a 0xFE 0xD4 response to the host to signal that this has happened. 12.1.2 XModem Upload Protocol In addition to its original simple upload format, Matrix Orbital has added an XModem based protocol. This facilitates much faster download speeds by increasing the packet size from 1 byte to 128 bytes greatly increasing throughput. A two byte CRC check is preformed at the end of each packet in place of the byte echo system seen in the original protocol. However, the overall protocol remains much the same as the original, but much faster. To begin the upload, a series of command bytes are sent, much like the original protocol. However, no distinction is made between bitmap and font as the XModem protocol is used to upload bin or ebin files that contain all the bitmaps and fonts required for the unit. Once the command bytes are sent, the size of the file is sent in two bytes, least signifcant byte first. Then two additional bytes are sent of the value zero. At this point the display will respond with an ACK if the file fits, or a NAK otherwise. Please note that these values are different than those of the orignal protocol as seen in the table below. If a NAK is seen at any point by the host, the upload is to be aborted in the same fashion as the regular protocol. If the file will fit, the start of header byte will be sent by the host, follwed by a block count representing the number of 128 byte blocks remaing to upload in regular and inverted forms. The display will then check to make sure the block count value matches its own before ACKing. The host can then send a 128 byte block of data followed by that blocks high and low CRC16 bytes. The display then preforms a CRC check on the data receive and ACKs if it matches that which was sent. Transfer continues with a block count and continues in this way until the end of file is reached. Once the end of the upload file is reached, the host should transmit a single end of transmission byte. If the end of file is expected, the display will ACK one last time. This EOT byte along with the other special characters mentioned above is listed in the table below. Character ACK NAK SOH EOT Byte 0x06 0x21 0x01 0x04 Description Acknowledged; successful data transmission Not Acknowledged; transmission unsuccessful, abort upload Start of Header; begin upload process End of Transmission; file upload complete Below is an example of uploading a bin or ebin file using the XModem protocol. 12.2 Wipe Filesystem Matrix Orbital GLK12232-25-SM 45 Host 0xFE 0xDB 0x85 0x06 0x30 0x00 0x40 0x00 0x00 Display 0x06 0x01 0x80 0x7F 0x06 0x1E 0x47 0x06 0x7F 0x80 0x06 0x5A 0x0D ... 0x04 0x06 ... 0x06 Comments Command Prefix XModem Upload Command Command byte 1 Command byte 2 Command byte 3 Size Low Byte Size High Byte 0 0 ACK (NAK if file is too big) Start of Header Block Count 255 - Block Count ACK (NAK if counts don’t match) Data Block CRC High Byte CRC Low Byte ACK (NAK if CRCs don’t match) Block Count 255 - Block Count ACK (NAKif counts don’t match) Data Block CRC High Byte CRC Low Byte ACK (NAKif CRCs don’t match) ... End of Transmission ACK (NAK if EOT is not expected) Table 53: XModem Upload Protocol Matrix Orbital GLK12232-25-SM 46 Syntax Description Hexadecimal 0xFE 0x21 0x59 0x21 Decimal 254 33 89 33 ASCII 254 “!” “Y” “!” This command completely erases the display’s non-volatile memory. It 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 in order to prevent accidental execution. NOTE After deleting the file system it is important to cycle power to your display to ensure the removal process is completed. Remembered Yes 12.3 Deleting a File Syntax Parameters Description Hexadecimal 0xFE 0xAD [type] [refID] Decimal 254 173 [type] [refID] Parameter Length Description type 1 Type of file (0:Font, 1:Bitmap) refID 1 Reference ID of the file to delete. This command erases a single file at a time within the GLK12232-25-SM memory when given two parameters: [type] and [refID]. The file type and reference number are defined when the file is saved to the GLK12232-25-SM. • [type] = 1: Bitmap • [type] = 0: Font NOTE After deleting a file it is important to cycle power to your display to ensure file system integrity. Remembered Yes 12.4 Get Filesystem Space Syntax Description Remembered Matrix Orbital Hexadecimal 0xFE 0xAF Decimal 254 175 This command will return 4 bytes, LSB to MSB for how many bytes are remaining in the 16 KB on board memory. No GLK12232-25-SM 47 12.5 Get Filesystem Directory Syntax Description Hexadecimal 0xFE 0xB3 Decimal 254 179 This command will return a directory of the contents of the file system. The first byte returned will be a hex value representing the number of entries in the filesystem, followed by four bytes for each entry. See the following tables: Bytes 1 Bytes 1 1 1 1 Remembered Filesystem Header Description Hex value representing the number of entries in the filesystem File Entry Description Flag: Hex value of 0x00 indicates that this file entry has not been used. FileID/Type: 1st bit is the file type (0: Font, 1: Bitmap). Next 7 bits are the file ID. File Size: LSB File Size: MSB No 12.6 Filesystem Upload Syntax Parameters Description Remembered Hexadecimal 0xFE 0xB0 [Size] [Data] Decimal 254 176 [Size] [Data] Parameter Length Description Size 4 LSB to MSB filesystem image data Data var Actual data to upload This command will upload a filesystem image, LSB to MSB to the display (16KB). The size used is almost always the entire 16kB, meaning the values 0x00 0x40 0x00 0x00 must be issued. Afterwhich the filesystem data can be uploaded LSB to MSB in the same manner as a font or bitmap file. Always 12.7 Downloading a File Matrix Orbital GLK12232-25-SM 48 Syntax Parameters Description Remembered Hexadecimal 0xFE 0xB2 [Type] [refID] Decimal 254 178 [Type] [refID] Parameter Length Description Type 1 File type (0:Font File, 1:Bitmap) refID 1 Reference ID number Download a specified file from the filesystem. The first 4 bytes will be the length of the file (LSB to MSB) followed by 2 bytes representing the width and height of the image then the data contained in the file. No 12.8 Moving a File Syntax Parameters Description Remembered 13 Hexadecimal 0xFE 0xB4 [oldT] [oldID] [newT] [newID] Decimal 254 180 [oldT] [oldID] [newT] [newID] Parameter Length Description oldT 1 Old file type oldID 1 Old file ID newT 1 New file type newID 1 New file ID This command can be used to move a file to a new file ID, or correct the type of a file that was uploaded incorrectly. The command first checks to see if there is a file identified by [oldT] and [oldID]. If it does exist, and there is no file already with the desired type and ID, the ID and type of the old file will be changed to [newT] and [newID] respectively. Always Data Security 13.1 Introduction Ensuring that your GLK12232-25-SM display’s exactly what you want it to can be the difference between a projects success and failure. This is why we incorporate features such as Data Lock into the GLK12232-25-SM With this new feature you now are in control over of how and when settings will be changed so there is no need to worry about the module acting exactly like you expected it to because all the settings may be locked and remembered for the next power up. Matrix Orbital GLK12232-25-SM 49 13.2 Set Remember Syntax Parameters Description Hexadecimal 0xFE 0x93 [switch] Decimal 254 147 [switch] Parameter Length Description switch 1 0: Do not remember, 1: Remember This command allows you to switch the remember function on and off. To use the remember function, set remember to on, then set all of the settings that you wish to save, settings that are listed as ’Remember: Yes’ support being saved into the non-volatile memory. After you have set all of the commands that you wish to save, you may then cycle the power and check the display settings to ensure that all the settings have been saved. If you wish to use remember again after cycling the power, you must set it to on again. NOTES • Writing to non-volatile memory is time consuming and slows down the operation of the display. • Non-volatile memory has a ‘write limit’ and may only be changed approximately 100,000 times. Remembered Default No Do not remember 13.3 Data Lock Syntax Parameters Matrix Orbital Hexadecimal Decimal Parameter level 0xFE 0xCA 0xF5 0xA0 [level] 254 202 245 160 [level] Length Description 1 Sets the data lock level GLK12232-25-SM 50 Description Paranoia allows you to lock the module from displaying information, as well as enables the protection of the filesystem and module settings. Each bit corresponds corresponds to a different lock level, while sending a zero will unlock your display as the following tables explains: Bit 0-2 3 Data Lock Level Reserved Communication Speed Lock 4 Setting Lock 5 Filesystem Lock 6 Command Lock 7 Display Lock Description Should be left 0 When this bit is set (1) the Baud Rate and I2 C Slave address are locked When this bit is set (1) the display settings such as backlight, contrast and GPO settings are locked. (Internal EEPROM) When this bit is set (1) the external EEPROM is locked, this has the same effect as the File System Jumper When this bit is set (1) all commands but commands 202/203 are locked. (cmd lock) When this bit is set (1) the module is locked from displaying any new information. (text lock) NOTES • Sending a new data lock level will override the previous data lock level. • Data lock levels may be combined. Remembered Default Examples Always 0 Hex 0x00 0x50 Matrix Orbital Dec 0 80 Binary 0 01010000 GLK12232-25-SM Description Unlock Setting and Command Lock 51 13.4 Set and Save Data Lock Syntax Parameters Description Remembered Default Hexadecimal 0xFE 0xCB 0xF5 0xA0 [level] Decimal 254 203 245 160 [level] Parameter Length Description level 1 Sets the data lock level This command will set and save the data lock level. See the Data Lock section for more information. Always 0 13.5 Dump the Filesystem Syntax Description Remembered Hexadecimal 0xFE 0x30 Decimal 254 48 ASCII 254 “0” This will allow you to dump the filesystem for debugging purposes. It will return a 4 byte value LSB to MSB followed by 16384 bytes making up the file system. No 13.6 Write Customer Data Syntax Parameters Description Remembered Hexadecimal 0xFE 0x34 [data] Decimal 254 52 [data] ASCII 254 “4” [data] Parameter Length Description data 16 Writes the customer data Writes the customer Data. 16 Bytes of data can be saved in non-volatile memory. No 13.7 Read Customer Data Syntax Matrix Orbital Hexadecimal Decimal ASCII 0xFE 0x35 254 53 254 “5” GLK12232-25-SM 52 14 Description Reads whatever was written by Write Customer Data. Remembered No Miscellaneous 14.1 Introduction This chapter covers the ’Report Version Number’ and ’Read Module Type’ commands. These commands can be particularly useful to find out more information about the display module before contacting technical support. 14.2 Read Version Number Syntax Description Hexadecimal 0xFE 0x36 Decimal 254 54 ASCII 254 “6” This command will return a byte representing the version of the module, see the following table as an example: Hex Value 0x19 0x57 Remembered Version Number Version 1.9 Version 5.7 No 14.3 Read Module Type Syntax Matrix Orbital Hexadecimal Decimal ASCII 0xFE 0x37 254 55 254 “7” GLK12232-25-SM 53 Description Remembered Matrix Orbital This command will return a hex value corresponding to the the model number of the module see the following table: Hex 1 5 7 9 B D F 13 15 21 23 25 27 29 2B 31 33 35 37 39 3B 3D 3F 41 43 45 47 49 4B 4D 4F 51 53 55 57 5B 71 73 77 79 No Product ID LCD0821 LCD2041 LCD4041 LK204-25 VFD2021 VFD4021 VK204-25 GLC24064 GLK24064-25 Unused Unused GLK24064-16-1U-USB GLK19264-7T-1U-USB GLK12232-16-SM LK204-7T-1U LK404-AT LK402-12 LK204-25PC VK202-24-USB VK204-24-USB VK162-12 PK202-25 MOS-AL-202A MOS-AP-202A MOS-AL-082 MOS-AV-204 MOS-AV-402 VK402-12 LK402-25 PK204-25 MOS XBoard-S MOU LK202-25-USB LK204-25-USB LK162-12-TC Unused LK404-25 Unused GLT480282 GLK12232-25-SM Hex 2 6 8 A C E 10 14 16 22 24 26 28 2A 2C 32 34 36 38 3A 3C 3E 40 42 44 46 48 4A 4C 4E 50 52 54 56 58 5C 72 74 78 7A Product ID LCD2021 LCD4021 LK202-25 LK404-55 VFD2041 VK202-25 GLC12232 Unused Unused GLK12232-25 GLK12232-25-SM GLK24064-16-1U GLK12232-16 GLK19264-7T-1U LK204-7T-1U-USB MOS-AV-162A LK162-12 LK202-24-USB LK204-24-USB PK162-12 MOS-AP-162A MOS-AL-162A MOS-AV-202A PK202-24-USB MOS-AL-204 MOS-AL-402 LK082-12 VK404-55 VK402-25 Unused MOI XBoard-I XBoard-U VK202-25-USB VK204-25-USB Unused GLK240128-25 VK404-25 GLT320240 GLT240128 54 15 Command Summary 15.1 Communications Description Turn Flow Control On Turn Flow Control Off Changing the I2 C Slave Address Changing the Baud Rate Setting a Non-Standard Baud Rate Syntax Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal 0xFE 0x3A [full] [empty] 254 58 [full] [empty] 254 “:” [full] [empty] 0xFE 0x3B 254 59 254 “;” 0xFE 0x33 [adr] 254 51 [adr] 254 “3” [adr] 0xFE 0x39 [speed] 254 57 [speed] 254 “9” [speed] 0xFE 0xA4 [speed] 254 164 [speed] Syntax Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal 0xFE 0x24 [refID] [size] [data] 254 36 [refID] [size] [data] 254 “$” [refID] [size] [data] 0xFE 0x31 [refID] 254 49 [refID] 254 “1” [refID] 0xFE 0x32 [lm] [tm] [csp] [lsp] [srow] 254 50 [lm] [tm] [csp] [lsp] [srow] 254 “2” [lm] [tm] [csp] [lsp] [srow] 0xFE 0xAC [value] 254 172 [value] Syntax Hexadecimal Decimal ASCII 0xFE 0x48 254 72 254 “H” Page 15 16 16 17 18 15.2 Fonts Description Uploading a Font File Setting the Current Font Font Metrics Set Box Space Mode Page 22 22 23 23 15.3 Text Description Move Cursor Home Matrix Orbital GLK12232-25-SM Page 24 55 Description Setting the Cursor Position Setting the Cursor Coordinate Auto Scroll On Auto Scroll Off Syntax Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII 0xFE 0x47 [col] [row] 254 71 [col] [row] 254 “G” [col] [row] 0xFE 0x79 [x] [y] 254 121 [x] [y] 254 “y” [x] [y] 0xFE 0x51 254 81 254 “Q” 0xFE 0x52 254 82 254 “R” Syntax Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII 0xFE 0x5E [refID] [size] [data] 254 94 [refID] [size] [data] 254 “^” [refID] [size] [data] 0xFE 0x62 [refID] [X] [Y] 254 98 [refID] [X] [Y] 254 “b” [refID] [X] [Y] 0xFE 0x64 [X] [Y] [W] [H] [D] 254 100 [X] [Y] [W] [H] [D] 254 “d” [X] [Y] [W] [H] [D] Page 25 25 25 26 15.4 Bitmaps Description Uploading a Bitmap File Drawing a Bitmap from Memory Drawing a Bitmap Directly Page 26 27 27 15.5 Bar Graphs and Drawing Description Set Drawing Color Draw Pixel Drawing a Line Continue a Line Matrix Orbital Syntax Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII 0xFE 0x63 [color] 254 99 [color] 254 “c” [color] 0xFE 0x70 [x] [y] 254 112 [x] [y] 254 “p” [x] [y] 0xFE 0x6C [x1] [y1] [x2] [y2] 254 108 [x1] [y1] [x2] [y2] 254 “l” [x1] [y1] [x2] [y2] 0xFE 0x65 [x] [y] 254 101 [x] [y] 254 “e” [x] [y] GLK12232-25-SM Page 28 29 29 29 56 Description Draw a Rectangle Drawing a Solid Rectangle Initializing a Bar Graph Drawing a Bar Graph Initializing a Strip Chart Shifting a Strip Chart Syntax Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII 0xFE 0x72 [color] [x1] [y1] [x2] [y2] 254 114 [color] [x1] [y1] [x2] [y2] 254 “r” [color] [x1] [y1] [x2] [y2] 0xFE 0x78 [color] [x1] [y1] [x2] [y2] 254 120 [color] [x1] [y1] [x2] [y2] 254 “x” [color] [x1] [y1] [x2] [y2] 0xFE 0x67 [refID] [type] [x1] [y1] [x2] [y2] 254 103 [refID] [type] [x1] [y1] [x2] [y2] 254 “g” [refID] [type] [x1] [y1] [x2] [y2] 0xFE 0x69 [ref] [value] 254 105 [ref] [value] 254 “i” [ref] [value] 0xFE 0x6A [refID] [x1] [y1] [x2] [y2] 254 106 [refID] [x1] [y1] [x2] [y2] 254 “j” [refID] [x1] [y1] [x2] [y2] 0xFE 0x6B [ref] 254 107 [ref] 254 “k” [ref] Page 30 30 31 31 32 33 15.6 General Purpose Output Description General Purpose Output Off General Purpose Output On Set Startup GPO state Syntax Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal 0xFE 0x56 [Num] 254 86 [Num] 254 “V” [Num] 0xFE 0x57 [Num] 254 87 [Num] 254 “W” [Num] 0xFE 0xC3 [Num] [state] 254 195 [Num] [state] Syntax Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII 0xFE 0x41 254 65 254 “A” 0xFE 0x4F 254 79 254 “O” 0xFE 0x26 254 38 254 “&” Page 34 34 35 15.7 Keypad Description Auto Transmit Key Presses On Auto Transmit Key Presses Off Poll Key Press Matrix Orbital GLK12232-25-SM Page 36 36 37 57 Description Clear Key Buffer Set Debounce Time Set Auto Repeat Mode Auto Repeat Mode Off Assign Keypad Codes Syntax Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal 0xFE 0x45 254 69 254 “E” 0xFE 0x55 [time] 254 85 [time] 254 “U” [time] 0xFE 0x7E [mode] 254 126 [mode] 254 “~” [mode] 0xFE 0x60 254 96 254 “‘” 0xFE 0xD5 [KDown] [KUp] 254 213 [KDown] [KUp] Page 37 37 38 39 39 15.8 Display Functions Description Clear Screen Display On Display Off Set Brightness Set and Save Brightness Set Contrast Set and Save Contrast Syntax Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal Hexadecimal Decimal Hexadecimal Decimal ASCII Hexadecimal Decimal 0xFE 0x58 254 88 254 “X” 0xFE 0x42 [min] 254 66 [min] 254 “B” [min] 0xFE 0x46 254 70 254 “F” 0xFE 0x99 [brightness] 254 153 [brightness] 0xFE 0x98 [brightness] 254 152 [brightness] 0xFE 0x50 [contrast] 254 80 [contrast] 254 “P” [contrast] 0xFE 0x91 [contrast] 254 145 [contrast] Syntax Hexadecimal Decimal ASCII 0xFE 0x21 0x59 0x21 254 33 89 33 254 “!” “Y” “!” Page 40 40 40 41 41 41 42 15.9 Filesystem Description Wipe Filesystem Matrix Orbital GLK12232-25-SM Page 45 58 Description Deleting a File Get Filesystem Space Get Filesystem Directory Filesystem Upload Downloading a File Moving a File Syntax Hexadecimal Decimal Hexadecimal Decimal Hexadecimal Decimal Hexadecimal Decimal Hexadecimal Decimal Hexadecimal Decimal 0xFE 0xAD [type] [refID] 254 173 [type] [refID] 0xFE 0xAF 254 175 0xFE 0xB3 254 179 0xFE 0xB0 [Size] [Data] 254 176 [Size] [Data] 0xFE 0xB2 [Type] [refID] 254 178 [Type] [refID] 0xFE 0xB4 [oldT] [oldID] [newT] [newID] 254 180 [oldT] [oldID] [newT] [newID] Syntax Hexadecimal Decimal Hexadecimal Decimal Hexadecimal Decimal Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII 0xFE 0x93 [switch] 254 147 [switch] 0xFE 0xCA 0xF5 0xA0 [level] 254 202 245 160 [level] 0xFE 0xCB 0xF5 0xA0 [level] 254 203 245 160 [level] 0xFE 0x30 254 48 254 “0” 0xFE 0x34 [data] 254 52 [data] 254 “4” [data] 0xFE 0x35 254 53 254 “5” Syntax Hexadecimal Decimal ASCII Hexadecimal Decimal ASCII 0xFE 0x36 254 54 254 “6” 0xFE 0x37 254 55 254 “7” Page 47 47 48 48 48 49 15.10 Data Security Description Set Remember Data Lock Set and Save Data Lock Dump the Filesystem Write Customer Data Read Customer Data Page 50 50 52 52 52 52 15.11 Miscellaneous Description Read Version Number Read Module Type Matrix Orbital GLK12232-25-SM Page 53 53 59 15.12 Command By Number Command Hex 0x21 0x24 0x26 0x30 0x31 0x32 0x33 0x34 0x35 0x36 0x37 0x39 0x3A 0x3B 0x41 0x42 0x45 0x46 0x47 0x48 0x4F 0x50 0x51 0x52 0x55 0x56 0x57 0x58 0x5E 0x60 0x62 0x63 0x64 0x65 0x67 0x69 0x6A 0x6B 0x6C 0x70 0x72 Matrix Orbital Description Page Dec ASCII 33 “!” 36 “$” 38 “&” 48 “0” 49 “1” 50 “2” 51 “3” 52 “4” 53 “5” 54 “6” 55 “7” 57 “9” 58 “:” 59 “;” 65 “A” 66 “B” 69 “E” 70 “F” 71 “G” 72 “H” 79 “O” 80 “P” 81 “Q” 82 “R” 85 “U” 86 “V” 87 “W” 88 “X” 94 “^” 96 “‘” 98 “b” 99 “c” 100 “d” 101 “e” 103 “g” 105 “i” 106 “j” 107 “k” 108 “l” 112 “p” 114 “r” Wipe Filesystem Uploading a Font File Poll Key Press Dump the Filesystem Setting the Current Font Font Metrics Changing the I2 C Slave Address Write Customer Data Read Customer Data Read Version Number Read Module Type Changing the Baud Rate Turn Flow Control On Turn Flow Control Off Auto Transmit Key Presses On Display On Clear Key Buffer Display Off Setting the Cursor Position Move Cursor Home Auto Transmit Key Presses Off Set Contrast Auto Scroll On Auto Scroll Off Set Debounce Time General Purpose Output Off General Purpose Output On Clear Screen Uploading a Bitmap File Auto Repeat Mode Off Drawing a Bitmap from Memory Set Drawing Color Drawing a Bitmap Directly Continue a Line Initializing a Bar Graph Drawing a Bar Graph Initializing a Strip Chart Shifting a Strip Chart Drawing a Line Draw Pixel Draw a Rectangle GLK12232-25-SM 45 22 37 52 22 23 16 52 52 53 53 17 15 16 36 40 37 40 25 24 36 41 25 26 37 34 34 40 26 39 27 28 27 29 31 31 32 33 29 29 30 60 Command Hex 0x78 0x79 0x7E 0x91 0x93 0x98 0x99 0xA4 0xAC 0xAD 0xAF 0xB0 0xB2 0xB3 0xB4 0xC3 0xCA 16 Description Page Dec ASCII 120 “x” 121 “y” 126 “~” 145 147 152 153 164 172 173 175 176 178 179 180 195 202 Drawing a Solid Rectangle Setting the Cursor Coordinate Set Auto Repeat Mode Set and Save Contrast Set Remember Set and Save Brightness Set Brightness Setting a Non-Standard Baud Rate Set Box Space Mode Deleting a File Get Filesystem Space Filesystem Upload Downloading a File Get Filesystem Directory Moving a File Set Startup GPO state Data Lock 30 25 38 42 50 41 41 18 23 47 47 48 48 48 49 35 50 Appendix 16.1 Specifications 16.1.1 Environmental Table 81: Environmental Specifications Standard Temperature Extended Temperature Operating Temperature 0◦ C to +50◦C -20◦C to +70◦C ◦ ◦ Storage Temperature -20 C to +70 C -30◦C to +80◦C Operating Relative Humidity 90% max non-condensing Vibration (Operating) 4.9 m/s2 XYZ directions Vibration (Non-Operating) 19.6 m/s2 XYZ directions Shock (Operating) 29.4 m/s2 XYZ directions Shock (Non-Operating) 490 m/s2 XYZ directions Matrix Orbital GLK12232-25-SM 61 16.1.2 Electrical Table 82: Electrical Specifications Standard Wide Voltage (V) Supply Voltage +5Vdc ±0.25V +9V to +15V Minimum Current 30mA typical Backlight On (GW & WB) add 20mA (50mA) typical 16.2 Optical Characteristics Table 83: Optical Characteristics Pixel Layout 122 x 32 pixels XxY Number of Characters 80 (maximum 20 characters x 4 Lines with 5x7 font) Display Area 60.2 x 18.00mm XxY Dot Size 0.40 x 0.40mm Dot Pitch 0.44 x 0.44mm (XxY) LED Backlight Life (GW & WB) 10, 000 hours typical NOTE To prolong life, it is recommended that the backlight be turned off when the display is not in use. 16.3 Physical Layout Matrix Orbital GLK12232-25-SM 62 Figure 19: Physical Diagram Matrix Orbital GLK12232-25-SM 63 16.4 Ordering Information() G 1 L 2 K 3 122 4 32 5 -25 6 -SM 7 -WB 8 -V 9 -E 10 Table 84: Part Numbering Scheme # 1 2 3 4 5 6 7 8 Description Screen Type Display Technology Input Interface Width Height Keypad Buttons Form Factor Colour (Text/Background) 9 Input Voltage 10 Temperature Options G: Graphic L: Liquid Crystal Display K: Keypad 122: Pixel Width Count 32: Pixel Height Count -25: External 25 Key Input Maximum -SM: Small NP: Standard (Grey/White) -WB: White/Blue NP: Standard (4.75-5.25V) -V: Extended Voltage (9.00-15.0V) NP: Standard (0◦ C to +50◦C) -E: Extended Temperature (-20◦ C to +70◦ C) Table 85: Part Options 16.5 Definitions E Extended Temperature (-20C to 70C) V Wide Voltage (+9 to +15Vdc) GW Grey Text / White Background WB White Text / Blue Background MSB Most Significant Byte LSB Least Significant Byte 16.6 Contacting Matrix Orbital Telephone Matrix Orbital GLK12232-25-SM 64 Sales: 1(403)229-2737 Support: 1(403)204-3750 On The Web Sales: http://www.MatrixOrbital.com Support: http://www.MatrixOrbital.ca Forums: http://www.lcdforums.com 16.7 Revision History Table 86: Revision History Revision Number Description 2.0 Rev 2.0 of the PCB 2.1 Updated Backlight Life Matrix Orbital GLK12232-25-SM Author Clark Clark 65