GLK24064-16-1U Including GLK24064-16-1U and GLK24064-16-1U-USB Technical Manual Revision 1.1 PCB Revision: 1.0 or Higher Firmware Revision: 7.
Revision History Revision 1.1 1.0 0.2 0.
Contents 1 Introduction ............................................................................................................................................... 1 2 Quick Connect Guide.................................................................................................................................. 2 2.1 Standard Module ................................................................................................................................ 2 Recommended Parts ...................
5 Commands ............................................................................................................................................... 15 5.1 Communications ............................................................................................................................... 15 5.2 Text.................................................................................................................................................... 17 5.3 Fonts...................................
1 Introduction Figure 1: GLK24064-16-1U Display The GLK24064-16-1U is an intelligent graphic liquid crystal engineered to quickly and easily add an elegant creativity to any application. In addition to the RS232, TTL and I2C protocols available in the standard model, the USB communication model allows the GLK24064-16-1U to be connected to a wide variety of host controllers. Communication speeds of up to 115.2kbps for serial protocols and 100kbps for I2C ensure lightning fast text and graphic display.
2 Quick Connect Guide 2.1 Standard Module Table 1: Standard Headers Figure 2: Standard Connections # 1 2 3 4 Header Power/Communication DB9 Keypad GPO Mate SCCPC5V/BBC CSS1FT/CSS4FT KPP4x4 None Offered The standard version of the GLK24064-16-1U allows for user configuration of three common communication protocols. First, the unit can communicate using serial protocol at either RS323 or TTL voltage levels. Second, it can communicate using the Inter-Integrated Circuit connect, or I2C protocol.
Serial Connections Serial protocol provides a classic connection to the GLK24064-16-1U. The Communication/Power Cable is most commonly used for this set up as it provides connections for DB9 serial and floppy power cables. To place your board in Serial mode, adhere to the steps laid out below. 1. Set the Protocol Select jumpers. RS232: Connect the three jumpers* in the 232 protocol box with the zero ohm jumper resistors provided or an alternate wire or solder solution.
I2C Connections A more advanced connection to the GLK24064-16-1U is provided by the I2C protocol setting. This is best accomplished using a breadboard and the Breadboard Cable. Power must be supplied from your breadboard or another external source. To dive right into your application and use the GLK24064-16-1U in I2C mode, get started with the guidelines below. 1. Set the Protocol Select switches.
2.2 USB Module Table 2: Standard Headers Figure 5: USB Connections # Header 1 Mini USB 2 3 4 Alternate Power Keypad GPO Mate EXTMUSB3FT/ INTMUSB3FT PCS KPP4x4 None Offered The GLK24064-16-1U-USB offers a single USB protocol for easy connection to a host computer. The simple and widely available protocol can be accessed using the on board mini B style USB connector as outlined in the USB Connections section.
USB Connections The USB connection is the quickest, easiest solution for PC development. After driver installation, the GLK24064-16-1U-USB will be accessible through a virtual serial port, providing the same result as a serial setup without the cable hassle. To connect to your GLK24064-16-1U-USB please follow the steps below. 1. Set the Protocol Select jumpers. USB: The GLK24064-16-1U-USB offers USB protocol only.
3 Software The multiple communication protocols available and simple command structure of the GLK24064-16-1U means that a variety of applications can be used to communicate with the display. Text is sent to the display as a character string, for example, sending the decimal value 41 will result in an 'A' appearing on the screen. A single control character is also available. Commands are merely values prefixed with a special command byte, 254 in decimal.
3.2 MOGD# The Matrix Orbital Graphic Display interface, MOGD#, is offered as a free download from www.matrixorbital.ca/software/software_graphic. It provides a simple graphical interface that allows settings, fonts, and bitmaps to be easily customised for any application. While monotone bitmaps can easily be created in virtually any image editing program, MOGD# provides an extensive font generation quite to stylize your display to any project design.
4 Hardware 4.1 Standard Model Power/Communication Header Table 5: Communication/Power Pinout Figure 9: Communication/Power Header Pin 1 2 3 4 Function Vcc Rx (SCL) Tx (SDA) Gnd The Communication/Power Header provides a standard connector for interfacing to the GLK24064-161U. Voltage is applied through pins one and four of the four pin Communication/Power Header. Please ensure the correct voltage input for your display by referencing the electrical specifications in Table 51 before connecting power.
Power Through DB9 Jumper In order to provide power through pin 9 of the DB-9 Connector you must connect the Power Through DB-9 Jumper labelled D, as illustrated below. This connection can be made using a zero ohm resistor, recommended size 0603, or a solder bridge. The GLK24064-16-1U allows all voltage models to use the power through DB-9 option, see the specifications in Table 51 for voltage requirements.
4.2 USB Model Mini USB Connector Table 10: Mini USB Pinout Figure 11: Mini USB Connector Pin 1 2 3 5 Function Vcc DD+ Gnd The GLK24064-16-1U-USB comes with a familiar Mini USB Connector to fulfill both communication and power needs. The standard MiniB style header can be connected to any other USB style using the appropriate cable. Most commonly used with a PC, this connection creates a virtual com port that offers a simple power solution with a familiar communication scheme.
4.3 Common Features Keypad Header Table 12: Keypad Pinout Figure 13: Keypad Header Pin 1 2 3 4 5 6 7 8 9 10 Function Gnd Row 1 Row 2 Row 3 Row 4 Column 1 Column 2 Column 3 Column 4 Gnd/Vcc* To facilitate user input, the GLK24064-16-1U provides a Keypad Interface Connector which allows matrix style keypad of up to sixteen keys to be directly connected to the display module. Key presses are generated when a short is detected between a row and a column.
Troubleshooting 4.4 Power In order for your Matrix Orbital display to function correctly, it must be supplied with the appropriate power. If the screen does not illuminate, power may not applied correctly. Try following the tips below. • • • • • First, make sure that you are using the correct power connector. Standard floppy drive power cables from your PC power supply may fit on the Communication/Power Header; however they do not have the correct pin out to provide power.
4.6 Communication When communication of either text or commands is interrupted, try the steps below. • • • • • • • • 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/USB Port. Next, please ensure that the display module is set to communicate on the protocol that you are using, by checking the Protocol Select Jumpers.
5 Commands 5.1 Communications 1.1 Changing the I2C Slave Address Dec 254 51 Address Hex FE 33 Address ASCII ■ 3 Address Immediately changes the I2C write address. Only even values are permitted as the next odd address will become the read address. Default is 80. Address 1 byte, even value 1.2 Changing the Baud Rate Dec 254 57 Speed Hex FE 39 Speed ASCII ■ 9 Speed Immediately changes the baud rate. Not available in I2C. Baud rate can be temporarily forced to 19200 by a manual override.
1.5 Turn Flow Control On Dec 254 58 Full Empty Hex FE 3A Full Empty ASCII ■ : Full Empty Enables simple flow control. The display will return a single byte (254) to the host when the display buffer is almost full and a different byte (255) when the buffer is almost empty. Full value should provide enough room for the largest data packet to be received without buffer overflow. No data should be sent to the display between full 2 and empty responses to permit processing. Buffer size is 128 bytes.
5.2 Text 2.1 Auto Scroll On Dec 254 81 Hex FE 51 ASCII ■Q The entire contents of screen are shifted up one line when the end of the screen is reached. Display default is on. 2.2 Auto Scroll Off Dec 254 82 Hex FE 52 ASCII ■R New text is written over the top line when the end of the screen is reached. Display default is Auto Scroll on. 2.3 Clear Screen Dec 254 88 Hex FE 58 ASCII ■X Clears the contents of the screen. 2.
5.3 Fonts 3.1 Upload a Font File Dec 254 36 ID Size Data Hex FE 24 ID Size Data ASCII ■ $ ID Size Data Upload a font to a graphic display. To create a font see the Font File Creation section, for upload protocol see the File Upload Protocol or XModem Upload Protocol entries. ID 1 byte, unique font identification number, must be less than 128 Size 2 bytes, LSB followed by MSB, size of the entire font file Data variable length, font file data, see Font File Creation for example 3.
Font File Creation Matrix Orbital graphic displays are capable of displaying text in a wide variety of styles customizable to suit any project design. Front files alter the style of text and appearance of the display. By default, a Matrix Orbital graphic display is loaded with a small filled font in slot one and a future bk bt 16 style in slot two. Both are available at www.matrixorbital.ca/software/graphic_fonts.
The character data is a binary graphical representation of each glyph in a font. Each character is drawn on a grid containing as many rows as the height specified in the header and as many columns as the width specified in the character table. Cells are drawn by writing a one in their location and cleared by setting a value of zero. Starting at the top left, moving right, then down, eight of these cells form a character data byte.
5.4 Bitmaps 4.1 Upload a Bitmap File Dec 254 94 ID Size Data Hex FE 5E ID Size Data ASCII ■ ^ ID Size Data Upload a bitmap to a graphic display. To create a bitmap see the Bitmap File Creation section, for upload protocol see the File Upload Protocol or XModem Upload Protocol entries. ID 1 byte, unique bitmap identification number, must be less than 128 Size 2 bytes, width and height of the bitmap Data variable length, bitmap file data, see Bitmap File Creation example 4.
Bitmap File Creation In addition to fonts, Matrix Orbital graphic displays can also hold a number of customizable bitmaps to provide further stylistic product integration. Like font files, bitmaps files are most easily uploaded to a display using MOGD#. However, the critical data component of the bitmap upload command is detailed below for reference. The bitmap data block is similar to that of a font. However, as a bitmap is only a single glyph, no header or table is required.
5.5 Drawing 5.1 Set Drawing Colour Dec 254 99 Colour Hex FE 63 Colour ASCII ■ c Colour Change the drawing colour used for all subsequent drawing commands that do not implicitly specify colour. Colour 1 byte, 0 for background or 1 to 255 for text colour 5.2 Draw Pixel Dec 254 112 X Position Y Position Hex FE 70 X Position Y Position ASCII ■ p X Position Y Position Draw a single pixel on the graphic display using the current drawing colour.
5.6 Draw a Solid Rectangle Dec 254 120 Colour X1 Position Y1 Position X2 Position Y2 Position Hex FE 78 Colour X1 Position Y1 Position X2 Position Y2 Position ASCII ■ x Colour X1 Position Y1 Position X2 Position Y2 Position Draw a filled rectangle using the colour specified; current drawing colour is ignored.
5.9 Initialize a Strip Chart Dec 254 106 ID X1 Position Y1 Position X2 Position Y2 Position Hex FE 6A ID X1 Position Y1 Position X2 Position Y2 Position ASCII ■ j ID X1 Position Y1 Position X2 Position Y2 Position Designate a portion of the screen for horizontal scrolling. Can be used to create scrolling graphs or marquee text.
5.7 Keypad 7.1 Auto Transmit Key Presses On Dec 254 65 Hex FE 41 ASCII ■A Key presses are automatically sent to the host when received by the display. Default is Auto Transmit on. 7.2 Auto Transmit Key Presses Off Dec 254 79 Hex FE 4F ASCII ■O Key presses are held in the 10 key buffer to be polled by the host using the Poll Key Press command. Use this mode for I2C transactions. Default is Auto Transmit on. 7.
7.6 Set Auto Repeat Dec 254 126 Mode Mode Hex FE 7E Mode Sets key press repeat mode to typematic or hold. In typematic mode if a key press is held, the key value is transmitted immediately, then 5 times a second after a 1 second delay. In hold mode, the key down value is transmitted once when pressed, and then the key up value is sent when the key is released. Default is typematic. Mode 1 byte, 1 for hold mode or 0 for typematic 7.7 Auto Repeat Dec 254 96 Mode Off Hex FE 60 Turns auto repeat mode off.
5.8 Display Functions 8.1 Display On Dec 254 66 Minutes Hex FE 42 Minutes ASCII ■ B Minutes Turns the display backlight on for a specified length of time. If an inverse display color is used this command will essentially turn on the text. Minutes 1 byte, number of minutes to leave backlight on, a value of 0 leaves the display on indefinitely 8.2 Display Off Dec 254 70 Hex FE 46 ASCII ■F Turns the display backlight off. If an inverse display colour is used this command will turn off the text. 8.
8.7 Set and Save Dec 254 145 Contrast Contrast Hex FE 91 Contrast Immediately sets and saves the contrast between background and text. Although contrast can be changed using the set command, it is reset to this saved value on start up. Default is 128. Contrast 1 byte, contrast level from 0(Light) to 255(Dark) 5.9 Filesystem 9.1 Wipe Filesystem Dec 254 33 89 33 Hex FE 21 59 21 ASCII ■!Y! Completely erase all fonts and bitmaps from a graphic display.
9.5 Filesystem Dec 254 176 Size Data Upload Hex FE B0 Size Data This command will upload a filesystem image to the display. The size used is almost always the entire 16kB memory. Filesystem data can be uploaded LSB to MSB in the same manner as a font or bitmap file. Size 4 bytes, size of the filesystem to upload, LSB to MSB, usually 0x00 0x40 0x00 0x00 for 16kB Data variable length, data to upload 9.
File Upload Protocol Once a bitmap or font file has been created and paired to its command it must be sent using a file protocol developed specifically for Matrix Orbital displays. Once a file upload command has been sent requesting a unique reference number and specifying the file size required, the display will respond indicating whether it has enough room to save the file or not.
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. Though a protocol similar to the original upload scheme is used, a two byte CRC check is preformed at the end of each packet in place of the byte echo system.
5.10 Data Security 10.1 Set Dec 254 147 Switch Remember Hex FE 93 Switch Allows changes to specific settings to be saved to the display memory. Writing to non-volatile memory can be slow and each change consumes 1 write of approximately 100,000 available. The Command Summary outlines which commands are saved always, never, and when this command is on only. Remember is off by default. Switch 1 byte, 1 for on or 0 for off 10.
5.11 Miscellaneous 11.1 Write Customer Data Dec 254 52 Data Hex FE 34 Data ASCII ■ 4 Data Saves a user defined block of data to non-volatile memory. Useful for storing display information for later use. Data 16 bytes, user defined data 11.2 Read Customer Data Dec 254 53 Hex FE 35 ASCII ■5 Reads data previously written to non-volatile memory. Data is only changed when written, surviving power cycles. Response 16 bytes, previously saved user defined data 11.
6 Appendix 6.1 Command Summary Available commands below include identifying number, required parameters, the returned response and an indication of whether settings are remembered always, never, or with remember set to on.
Table 41: Drawing Command Summary Name Set Drawing Colour Draw Pixel Draw a Line Continue a Line Draw a Rectangle Draw a Solid Rectangle Initialize a Bar Graph Draw a Bar Graph Initialize a Strip Chart Shift a Strip Chart Dec 99 112 108 101 114 120 103 105 106 107 Hex 63 70 6C 65 72 78 67 69 6A 6B ASCII c p l e r x g i j k Parameters Colour X, Y X1, Y1, X2, Y2 X, Y Colour, X1, Y1, X2, Y2 Colour, X1, Y1, X2, Y2 ID, Type, X1, Y1, X2, Y2 ID, Value ID, X1, Y1, X2, Y2 DirectionID Response None None None No
Table 45: Filesystem Command Summary Name Wipe Filesystem Delete a File Get Filesystem Space Get Filesystem Directory Filesystem Upload Download a File Dec 33, 89, 33 173 175 179 176 178 Hex 21, 59, 21 AD AF B3 B0 B2 ASCII !, Y, ! ¡ » │ ° ▓ Move a File 180 B4 ┤ Dump the Filesystem 48 30 0 Parameters None Type, ID None None Size [4], Data[] Type, ID Old Type, Old ID, New Type, New ID None Response None None Space [4] Entries [] None Data [] Remembered Always Always Never Never Always Never No
6.2 Environmental Specifications Table 48: Environmental Limits Operating Temperature Storage Temperature Operating Relative Humidity Standard Extended (-E) 0°C to +50°C -10°C to +60°C -10°C to +60°C -20°C to +70°C Maximum 90% non-condensing 6.
6.
7 Ordering 7.1 Part Numbering Scheme Table 53: Part Numbering Scheme GLK 1 -24064 2 -16 3 -1U 4 -USB 5 -FGW 6 7 -E 8 7.
7.3 Accessories Power Table 55: Power Accessories PCS Standard Power Cable Communication Table 56: Communication Accessories 41 CSS4FT 4 ft.
Peripherals Table 57: Peripheral Accessories KPP4x4 16 Button Keypad Mounting Table 58: Mounting Accessories B24064-BK 24064-1U Black Mounting Bracket 42
8 Definitions ASCII: American standard code for information interchange used to give standardized numeric codes to alphanumeric characters. BPS: Bits per second, a measure of transmission speed. FFSTN: Double film super-twisted nematic in reference to an LCD. The addition of two layers of film between the STN display and polarizer improves contrast. GPO: General purpose output, used to control peripheral devices from a display. GUI: Graphical user interface. Hexadecimal: values 0-15.