GLK240128-25-V

GLK240128-25/GLT240128 Including GLK240128-25-USB, GLK240128-25-422, GLT240128-USB, and GLT240128-422 Technical Manual Revision 3.1 PCB Revision: 4.0 or Higher Firmware Revision: 8.1 or Higher Revision History Revision 3.1 3.0 2.9 2.8 2.7 2.6 2.5 2.4 2.3 2.2 2.1 2.0 0.2 0.1 Date January 3, 2018 October 19, 2015 May 21, 2014 March 12, 2014 September 9, 2013 July 10, 2013 December 13, 2012 October 23, 2012 October 13, 2011 March 8, 2011 January 27, 2011 November 3, 2010 Description Correction to Set Non-Standard Baud Rate command Revision to Commands for Firmware Revision 8.6 Revision to Commands for Firmware Revision 8.5 Revision and correction to Colour in Ordering Options Corrected Scripted Button/Key and Keypad Brightness Commands Updated Data Packet Size Definitions Added Firmware Revision 8.4 Commands Added Alternate Power requirement for YG units Major Command Additions Updated Electrical Specifications Filesystem Command Updates for Firmware Revision 8.1 Initial Release Updated Images Initial Concept Author Divino Clark Martino Martino Clark Clark Clark Clark Clark Clark Clark Clark Clark Clark Contents 1 Introduction ............................................................................................................................................... 1 2 Quick Connect Guide.................................................................................................................................. 2 2.1 Available Headers ............................................................................................................................... 2 2.2 Standard Module ................................................................................................................................ 3 Recommended Parts ............................................................................................................................. 3 Serial Connections................................................................................................................................. 3 I2C Connections ..................................................................................................................................... 4 2.3 USB Module ........................................................................................................................................ 5 Recommended Parts ............................................................................................................................. 5 USB Connections ................................................................................................................................... 5 2.4 RS422 Module ..................................................................................................................................... 6 RS422 Connections ............................................................................................................................... 6 3 Software ..................................................................................................................................................... 7 3.1 MOGD# ............................................................................................................................................... 7 3.2 Firmware Upgrade .............................................................................................................................. 8 3.3 Application Notes................................................................................................................................ 8 4 Hardware.................................................................................................................................................... 9 4.1 Standard Model .................................................................................................................................. 9 Extended Communication/Power Header ............................................................................................ 9 Serial DB9 Connector ............................................................................................................................ 9 Power Through DB9 Jumper ............................................................................................................... 10 Protocol Select Jumpers ...................................................................................................................... 10 Hardware Lock .................................................................................................................................... 10 4.2 USB Model......................................................................................................................................... 11 Mini USB Connector ............................................................................................................................ 11 Alternate USB Header ......................................................................................................................... 11 Alternate Power Connector ................................................................................................................ 11 4.3 RS422 Model ..................................................................................................................................... 12 RS422 Header ...................................................................................................................................... 12 Alternate Power Connector ................................................................................................................ 12 4.4 GLK Model ......................................................................................................................................... 13 Keypad Header .................................................................................................................................... 13 4.5 GLT Model ......................................................................................................................................... 14 Touch Screen ....................................................................................................................................... 14 Coordinate Mode ................................................................................................................................ 14 Region Mode ....................................................................................................................................... 14 4.6 Common Features ............................................................................................................................. 15 General Purpose Outputs ................................................................................................................... 15 Dallas One-Wire Connector ................................................................................................................ 15 5 Troubleshooting ....................................................................................................................................... 16 5.1 Power ................................................................................................................................................ 16 5.2 Display ............................................................................................................................................... 16 5.3 Communication ................................................................................................................................. 17 5.4 Manual Override ............................................................................................................................... 17 6 Commands ............................................................................................................................................... 18 6.1 Communication ................................................................................................................................. 18 6.2 Text.................................................................................................................................................... 20 6.3 Drawing ............................................................................................................................................. 22 6.4 Fonts.................................................................................................................................................. 27 Font File Creation ................................................................................................................................ 28 6.5 Bitmaps ............................................................................................................................................. 29 Bitmap File Creation............................................................................................................................ 30 Bitmap Masking .................................................................................................................................. 31 6.6 9-Slices .............................................................................................................................................. 31 9-Slice File Creation............................................................................................................................. 32 6.7 Animations ........................................................................................................................................ 33 Animation File Creation ...................................................................................................................... 34 6.8 General Purpose Output ................................................................................................................... 34 6.9 Piezo Buzzer ...................................................................................................................................... 35 6.10 Keypad............................................................................................................................................. 35 6.11 Touchpad ........................................................................................................................................ 37 6.12 Display Functions ............................................................................................................................ 40 6.13 Scripting .......................................................................................................................................... 41 6.14 Filesystem ....................................................................................................................................... 42 File Transfer Protocol .......................................................................................................................... 45 XModem Transfer Protocol................................................................................................................. 46 6.15 Data Security ................................................................................................................................... 48 6.16 Miscellaneous ................................................................................................................................. 48 7 Appendix .................................................................................................................................................. 51 7.1 Command Summary ......................................................................................................................... 51 7.1 Block Diagram ................................................................................................................................... 56 7.2 Environmental Specifications............................................................................................................ 56 7.3 Electrical Tolerances ......................................................................................................................... 56 7.4 Dimensional Drawings ...................................................................................................................... 57 7.1 Optical Characteristics ...................................................................................................................... 59 8 Ordering ................................................................................................................................................... 59 8.1 Part Numbering Scheme ................................................................................................................... 59 8.2 Options .............................................................................................................................................. 59 8.3 Accessories ........................................................................................................................................ 60 9 Definitions ................................................................................................................................................ 62 10 Contact ................................................................................................................................................... 62 1 Introduction Figure 1: GLK240128-25/GLT240128 Display The GLK240128-25/GLT240128 is an intelligent graphic liquid crystal display 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, USB and RS422 communication models allow the GLK24012825/GLT240128 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. The simple command structure permits easy software control of many settings including backlight brightness, screen contrast, and baud rate. On board memory provides a whopping 256KB of customizable fonts and bitmaps to enhance the graphical user experience. User input on the GLK240128-25 is available through a five by five matrix style keypad or a resistive touch overlay on the GLT240128. Six general purpose outputs provide simple switchable five volt sources on each model. In addition, a versatile Dallas One-Wire header provides a communication interface for up to thirty-two devices. The versatile GLK240128-25/GLT240128, with all the features mentioned above, is available in a variety of colour, voltage, and temperature options to suit almost any application. Command Summary 1 2 Quick Connect Guide 2.1 Available Headers Figure 2: GLK240128-25/GLT240128 Header Locations Table 1: List of Available Headers # 1 2 3 4 5 6 7 2 Header Mini USB Connector RS422 Terminal Block DB9 Serial Header Extended Communication/Power Connector Alternate Power Connector GPO Header Keypad Mate EXTMUSB3FT/INTMUSB3FT 16-30 AWG Wire CSS1FT/CSS4FT ESCCPC5V/BBC PCS None Offered KPP4x4 Command Summary Population USB Model Only 422 Model Only Standard Model Only Standard Model Only 422 and USB Models Only All Models GLK Model Only 2.2 Standard Module The standard version of the GLK240128-25/GLT240128 allows for user configuration of two 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. Connections for each protocol can be accessed through the four pin Communication/Power Header as outlined in the Serial Connections and I2C Connections sections below. Recommended Parts The most common cable choice for any standard Matrix Orbital display, the Extended Communication/ Power Cable offers a simple connection to the unit with familiar interfaces. DB9 and floppy power headers provide all necessary input to drive your display. Figure 3: Extended Communication/Power Cable (ESCCPC5V) For a more flexible interface to the GLK240128-25/GLT240128, a Breadboard Cable may be used. This provides a simple four wire connection that is popular among developers for its ease of use in a breadboard environment. Figure 4: Breadboard Cable (BBC) Serial Connections Serial protocol provides a classic connection to the GLK240128-25/GLT240128. The Extended 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 five jumpers* in the 232 protocol box with the zero ohm jumper resistors provided or an alternate wire or solder solution.  TTL: Connect the four jumpers* in the TTL protocol box. *Note: Jumpers must be removed from all protocol boxes save for the one in use. Command Summary 3 2. Make the connections. a. Connect the six pin female header of the Communication/Power Cable to the Extended Communication/Power Header of your GLK240128-25/GLT240128. b. Insert the male end of your serial cable to the corresponding DB9 header of the Extended Communication/Power Cable and the mate the female connector with the desired communication port of your computer. c. Select an unmodified floppy cable from a PC power supply and connect it to the power header of the Communication/Power Cable. 3. Create.  MOGD# or a terminal program will serve to get you started, and then you can move on with your own development. Instructions for the former can be found below and a variety of application notes are available for the latter at www.matrixorbital.ca/appnotes. I2C Connections A more advanced connection to the GLK240128-25/GLT240128 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 GLK24012825/GLT240128 in I2C mode, get started with the guidelines below. 1. Set the Protocol Select switches.  I2C: Ensure that the two I2C jumpers in the corresponding protocol box are connected while all others are open. 2. Make the connections. a. Connect the Breadboard Cable to the Extended Communication/Power Header on your GLK240128-25/GLT240128 and plug the four leads into your breadboard. The red lead will require power, while the black should be connected to ground, and the green and yellow should be connected to your controller clock and data lines respectively. b. Pull up the clock and data lines to five volts using a resistance between one and ten kilohms on your breadboard. 3. Create.  This time you're on your own. While there are many examples within the Matrix Orbital AppNote section, www.matrixorbital.ca/appnotes, too many controllers and languages exist to cover them all. If you get stuck in development, it is possible to switch over to another protocol on the standard board, and fellow developers are always on our forums for additional support. 4 Command Summary 2.3 USB Module The GLK240128-25-USB/GLT240128-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. Recommended Parts The External Mini USB cable is recommended for the GLK240128-25USB/GLT240128-USB display. It will connect to the miniB style header on the unit and provide a connection to a regular A style USB connector, commonly found on a PC. Figure 5: Mini USB Cable (EXTMUSB3FT) USB Connections The USB connection is the quickest, easiest solution for PC development. After driver installation, the GLK240128-25-USB/GLT240128-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 GLK240128-25-USB/GLT240128USB please follow the steps below. 1. Set the Protocol Select jumpers.  USB: The GLK240128-25-USB/GLT240128-USB offers USB protocol only. Model specific hardware prevents this unit from operating in any other protocol, and does not allow other models to operate in USB. Protocol Select jumpers on the USB model cannot be moved. 2. Make the connections.  Plug the mini-B header of your External Mini USB cable into your GLK240128-25USB/GLT240128-USB and the regular USB header into your computer USB jack*. 3. Install the drivers. a. Download the latest drivers at www.matrixorbital.ca/drivers, and save them to a known location. b. When prompted, install the USB bus controller driver automatically c. If asked, continue anyway, even though the driver is not signed d. When the driver install is complete, your display will turn on, but communication will not yet be possible. e. At the second driver prompt, install the serial port driver automatically f. Again, if asked, continue anyway 4. Create.  Use MOGD# or a terminal program to get started, and then move on with your own development. Instructions for the former can be found below and a number of application notes are available for the latter at www.matrixorbital.ca/appnotes. *Note: The YG version of the GLK240128-25-USB/GLT240128-USB will require the alternate power connection. Command Summary 5 2.4 RS422 Module The GLK240128-25-422/GLT240128-422 provides an industrial alternative to the standard RS232 communication protocol. Rather than single receive and transmit lines, the RS422 model uses a differential pair for receive and transmit signals to reduce degradation and increase transmission lengths. Power can be transmitted at distance to a -VPT module or supplied from the immediate vicinity to a regular or -V unit. RS422 signals are available in a six pin connector as described in the RS422 Connections section. RS422 Connections The GLK240128-25-422/GLT240128-422 provides a robust RS422 interface to the display line. For this interface, a series of six wires are usually screwed into the RS422 terminal block provided. An alternate header is also available to provide local power to a regular or -V unit. To connect to your GLK24012825-422/GLT240128-422, adhere to the steps laid out below. 1. Set the Protocol Select jumpers.  RS422: The GLK240128-25-422/GLT240128-422 offers only RS422 protocol and does not require any jumper changes. 2. Make the connections. a. Screw one wire; sized 16 to 30 on the American Wire Gauge, into each of the six terminal block positions. When local power is supplied, a floppy cable may link to the alternate power header. b. Connect the Vcc wire to the positive terminal of your power supply and the GND terminal to the negative or ground lead to provide appropriate power as per Voltage Specifications. c. Secure the A and B wires to your non-inverting and inverting output signals respectively, while attaching the Z and Y wires to your inverting and non-inverting inputs. 3. Create. a. In a PC environment, MOGD# or a terminal program will serve to get you started. In addition, a variety of application notes are available online in a number of different languages to aid in the development of a host controller. Instructions for these programs can be found below and the simple C# example at www.matrixorbital.ca/appnotes is a great first programming reference. 6 Command Summary 3 Software The multiple communication protocols available and simple command structure of the GLK24012825/GLT240128 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. Table 2: Reserved Control Characters 7 Control Characters Bell / Sound Buzzer 10 Line feed / New line Once the correct communication port is identified, the following communication settings can be applied to communicate correctly with the GLK240128-25/GLT240128. Table 3: Communication Settings BPS 19200 Data Bits 8 Parity None Stop Bits 1 Flow Control None Finally, with a communication port identified and correctly setup simple text strings or even command bytes can easily be transmitted to control your display. 3.1 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 monochromatic bitmaps can easily be created in virtually any image editing program, MOGD# provides an extensive font generation suite to stylize your display to any project design. In addition to standard font wide modifications, character ranges can be specified by start and end values to eliminate unused symbols, and individual glyphs can be modified with a double click. Finally, text spacing can be tailored and a complete font library built with your Matrix Orbital graphic display. Like uProject, MOGD# offers a scripting capability that provides the ability to stack, run, and save a series of commands. The most basic function is the Send Numeric tool which is used to transmit a string of values to the display to write text or execute a command. Command Summary 7 Figure 6: MOGD# Command Example Again, the clear screen command is sent to a connected display, this time using the MOGD# Send Numeric function command style. Scripts can be run as a whole using the Play button from the toolbar or as single commands by selecting Step; once executed it must be Reset. Before issuing commands, it is a good idea to ensure communication with a display is successful using the autodetect button. This program provides both a staging areas for your graphics display and a proving ground that will prepare it for any application environment. 3.2 Firmware Upgrade Beginning with revision 8.1, the firmware of the GLK240128-25/GLT240128 can be upgraded in the field. All firmware revisions can be installed using software found at www.matrixorbital.ca/software/GLT Series. If it is necessary to forgo all current and future upgrades to the filesystem and subsequent commands, firmware revision 8.0 may be ordered as a part of a custom order. Please use the Contact section to request more information from the Matrix Orbital sales team. 3.3 Application Notes Full demonstration programs and code are available for Matrix Orbital displays in the C# language from Simple C# AppNote Pack in the Application Note section at www.matrixorbital.ca/appnotes. Difficulty increases from beginner, with the Hello World program, to advanced with the Dallas One-Wire temperature reading application. Many additional applications are available in a number of different programming languages. These programs are meant to showcase the capability of the display and are not intended to be integrated into a final design. For additional information regarding code, please read the On Code document also found on the support site. 8 Command Summary 4 Hardware 4.1 Standard Model Extended Communication/Power Header Table 4: Extended Communication/Power Pinout Pin 1 2 3 4 5 6 Function Vcc Rx (SCL) Tx (SDA) Gnd CTS RTS Figure 7: Extended Communication/Power Header The Extended Communication/Power Header provides a standard connector for interfacing to the GLK240128-25/GLT240128. 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 Voltage Specifications before connecting power. Pins two and three are reserved for serial transmission, using either the RS-232/TTL or clocking data through the I²C protocol, depending on what has been selected by the Protocol Select Jumpers. Pins five and six can be used for serial transmission hardware flow control, and are ignored for I²C communications. The Molex 22-04-1061 style header used can be mated to a number of connectors, a 22-01-1062 for example. Serial DB9 Connector Table 5: Serial DB9 Pinout Pin 2 3 5 7 8 9 Function Tx Rx Gnd CTS RTS NC/Vcc* Figure 8: Serial DB9 Connector The GLK240128-25/GLT240128 provides a DB-9 Connector to readily interface with serial devices using EIA232 standard signal levels. It is also possible to communicate at TTL levels of 0 to +5V by setting the Protocol Select Jumpers to TTL. As an added feature it is also possible to apply power through pin 9 of the DB-9 Connector in order to reduce cable clutter. A standard male DB9 header will provide the perfect mate for this connector. *Note: Do not apply voltage through pin 9 of the DB-9 Connector AND through the Communication/Power Header at the same time. Command Summary 9 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 R82, as illustrated below. This connection can be made using a zero ohm resistor, recommended size 0603, or a solder bridge. The GLK240128-25/GLT240128 allows all voltage models to use the power through DB-9 option, see the Voltage Specifications for power requirements. Figure 9: Power Through DB9 Jumper Protocol Select Jumpers The Protocol Select Jumpers provide the means necessary to toggle the GLK240128-25/GLT240128 between RS-232, TTL and I²C protocols. As a default, the jumpers are set to RS-232 mode with solder jumps on the RS232 jumpers. In order to place the display module in I²C mode you must first remove the solder jumps from the RS232 jumpers and then place them on the I2C jumpers. The display will now be in I²C mode and have a default slave address of 80, unless changed with the appropriate command. Similarly, in order to change the display to TTL mode, simply remove the zero ohm resistors from the RS232 or I²C jumpers and solder them to the TTL jumpers. Hardware Lock The Hardware Lock allows fonts, bitmaps, and settings to be saved, unaltered by any commands. By connecting the two pads near the memory chip, designated R60, with a zero ohm resistor, the display will be locked. This supersedes the data lock command and cannot be circumvented by any software means. To unlock the display and make changes simply remove the jumper. 10 Command Summary 4.2 USB Model Mini USB Connector Table 6: Mini USB Pinout Pin 1 2 3 5 Function Vcc DD+ Gnd Figure 10: Mini USB Connector The GLK240128-25-USB/GLT240128-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. Alternate USB Header Some advanced applications may prefer the straight four pin connection offered through the Optional Alternate USB Header. This header offers power and communication access in a simple interface package. The Optional Alternate USB Header may be added to the GLK240128-25-USB/GLT240128-USB for an added charge as part of a custom order. Please use the Contact section to request more information from the friendly Matrix Orbital sales team. Alternate Power Connector Table 7: Alternate Power Pinout Pin 1 2 3 4 Function Vcc Gnd Gnd NC Figure 11: Alternate Power Connector The Alternate Power Connector provides the ability to power the GLK240128-25-USB/GLT240128-USB using a second cable*. The Tyco 171825-4 style header is particularly useful for connecting to an unmodified floppy power cable, a 171822-4 for example, from a PC power supply for a simple bench power solution. *Note: The YG version of the GLK240128-25-USB/GLT240128-USB may draw more than the 500mA of current permitted by USB standards and will require the alternate power connection. Command Summary 11 4.3 RS422 Model RS422 Header Table 8: RS422 Pinout Pin 1 2 3 4 5 6 Function Gnd Rx (Y) Inv Rx (Z) Inv Tx (B) Tx (A) Vcc Figure 12: RS422 Header The six pin RS422 interface header of the GLK240128-25-422/GLT240128-422 offers power and ground connections as well as two differential pair communication lines. Regular and inverted lines are provided for both receive and transmit signals. Power is supplied locally to the regular or –V variants while the –VPT can receive power over a distance. The Tyco 282834-6 style header is most suited to a simple wire connection. Alternate Power Connector Table 9: Alternate Power Pinout Pin 1 2 3 4 Function Vcc Gnd Gnd NC Figure 13: Alternate Power Connector The Alternate Power Connector provides the ability to power the GLK240128-25-USB/GLT240128-USB using a second cable. The Tyco 171825-4 style header is particularly useful for connecting to an unmodified floppy power cable, a 171822-4 for example, from a PC power supply for a simple bench power solution. 12 Command Summary 4.4 GLK Model Keypad Header Table 10: Keypad Pinout Pin 1 2 3 4 5 6 Figure 14: Keypad Header Function Gnd Row 1 Row 2 Row 3 Row 4 Row 5 Pin 7 8 9 10 11 12 Function Column 1 Column 2 Column 3 Column 4 Column 5 Gnd/Vcc* To facilitate user input, the GLK240128-25 provides a Keypad Interface Connector which allows a matrix style keypad of up to twenty-five keys 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 specific to that key press is automatically sent on the Tx communication line. If a synchronous read method is desired in serial mode*, the “Auto Transmit Keypress” function can 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. The straight twelve pin header of the Keypad Interface Connector will interface to a variety of different devices including the Matrix Orbital KPP4x4 keypad. 2 *Note: In I C mode, the “Auto Transmit Keypress” function should always be on, keypresses should not be polled. **Note: The Ground / +5V pin is toggled by the jumper to the right of the keypad connector. Jump pads 1 & 2 for +5V or 2 & 3 for GND. Command Summary 13 4.5 GLT Model Touch Screen The GLT240128 facilitates user touch input in one of two distinct ways. Coordinate mode will report events by supplying their exact position on the screen. Region mode will report events within defined boundaries on the screen. Both modes are outlined below. Coordinate Mode In coordinate mode all touch events are reported using three single byte values. First, the type of event is transmitted, followed by the x and y coordinates of its position. Pressure and drag thresholds must be exceeded for an event to be registered. A low drag threshold will result in greater tracking accuracy but transmits much more data to the host. Care should be taken to find balance. This mode offers a great degree of flexibility and creativity. Table 11: Coordinate Mode Event Prefixes Return Value Touch Event 1 Press 2 Release 4 Drag Region Mode A simpler, keypad style alternative to coordinate mode, region mode offers only a single byte for each touch event. Unique regions are created by specifying a position, size, and return values. A value corresponding to a specific region is returned when an event occurs within its bounds. Events outside of regions result in transmission of the value 255. Regions can be deleted individually or collectively when no longer needed. This mode allows quick and easy set up. Table 12: Region Mode Event Responses Return Value Touch Event 14 Key Down Press Key Up Release Key Down Drag Command Summary 255 Out of Region 4.6 Common Features General Purpose Outputs Table 13: GPO Pinout Figure 15: GPO Header Pin 1 2 3 4 5 6 7 Function GPO 1 GPO 2 GPO 3 GPO 4 GPO 5 GPO 6 Vcc Pin 8 9 10 11 12 13 14 Function Gnd Gnd Gnd Gnd Gnd Gnd Gnd A unique feature of the GLK240128-25/GLT240128 is the ability to control relays* and other external devices using either one or six General Purpose Outputs. Each can source up to 10mA of current at five volts when on or sink 20mA at zero volts when off. The two row, fourteen pin header can be interfaced to a number of female connectors to provide control to any peripheral devices required. *Note: If connecting a relay, be sure that it is fully clamped using a diode and capacitor in order to absorb any electro-motive force (EMF) which will be generated. Dallas One-Wire Connector Table 14: Dallas One-Wire Pinout Pin 1 2 3 Figure 16: Dallas One-Wire Connector Function Vcc D Gnd In addition to the six general purpose outputs the GLK240128-25/GLT240128 offers an Optional Dallas One-Wire bridge, to allow for an additional thirty two one-wire devices to be connected to the display. This header can be populated with a Tyco 173979 connector at an added cost by custom order only. Please use the Contact section to request more information from the Matrix Orbital sales team. Command Summary 15 5 Troubleshooting 5.1 Power In order for your Matrix Orbital display to function correctly, it must be supplied with the appropriate power. If the power LED near the top right corner of the board is not illuminated, power is not applied correctly. Try following the tips below.     First, 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. If power is applied through the DB9 connector, ensure that the Power Through DB9 Jumper is connected. If changes have been made to the protocol select block, ensure all the appropriate protocol select jumpers are connected and all unused protocol jumpers are disconnected. The last step will be to check the interface connector in use on your display. If the power connections have become loose, or you are unable to resolve the issue, please Contact Matrix Orbital for more information. 5.2 Display If your display is powered successfully, the Matrix Orbital logo, or user created screen should display on start up. If this is not the case, check out these tips. • • 16 Ensure the contrast is not too high or too low. This can result in a darkened or blank screen respectively. See the Manual Override section to reset to default. Make sure that the start screen is not blank. It is possible to overwrite the Matrix Orbital logo start screen, if this happens the screen may be blank. Try writing to the display to ensure it is functional, after checking the contrast above. Command Summary 5.3 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. In serial and USB protocols, ensure that the host system and display module are both communicating on the same baud rate. The default rate for the display module is 19200 bps. Match Rx from your display to the transmitting pin from your host and the Tx pin to the receiving pin. If you are communicating to the display via I²C* please ensure that the data is being sent to the correct address. The default slave address for the display module is 80. In I2C mode, connect Rx to the clock line of your controller and Tx to the data output. Unlock the display. See the Set and Save Data Lock command for more info. Finally, you may reset the display to its default settings using the Manual Override procedure outlined below. *Note: I²C communication will always require pull up resistors on SCL and SDA of one to ten kilohms. 5.4 Manual Override Should the settings of your display become altered in a way that dramatically impacts usability, the default settings can be temporarily restored. To override the display, please follow the steps below. 1. Disconnect power from your display. 2. Place a jumper on the two manual override pins, for the GLK240128-25 model these are the middle two keypad pins, for the GLT240128 these are the two pins near the keypad header. 3. Reconnect power to your unit, and wait for the start screen before removing the jumper. Please note the jumper will adversely affect GLT240128 performance if left in place during use. 4. Settings will be temporarily** overridden to the defaults listed in the Manual Override Settings table. At this point any important settings, such as contrast, backlight, or baud rate, should not only be set but saved so they remain when the override is removed. Parameter Backlight Contrast Baud Rate 2 I C Address Value 255 128 19200 80 Table 15: Manual Override Settings **Note: The display module will revert back to the old settings once turned off, unless desired settings are saved. Command Summary 17 6 Commands 6.1 Communication 1.1 Change Baud Rate Dec 254 57 Speed v8.0 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. Speed Byte Valid settings shown below. Table 16: Accepted Baud Rate Values Rate Speed 9600 207 14400 138 19200 103 28800 68 38400 51 57600 34 76800 25 115200 16 1.2 Change I2C Slave Address Dec 254 51 Address v8.0 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 Byte Even value. 1.3 Transmission Protocol Select Dec 254 160 Protocol v8.0 Hex FE A0 Protocol ASCII ■ á Protocol Selects the protocol used for data transmission from the display. Data transmission to the display is not affected. Must be set to the protocol in use to receive data correctly. Protocol Byte 1 for Serial (RS232/RS422/TTL/USB) or 0 for I2C. 1.4 Set a Non-Standard Baud Rate Dec 254 164 Baud Hex FE A4 Baud ASCII ■ ñ Baud Immediately changes the baud rate to the value specified. Baud must be a whole number between 0 and 1,000,000. Not available in I2C. Can be temporarily forced to 19200 by a manual override. Baud Integer Baud rate speed. The value must be sent using little endian format. *Note: Command was restructured at firmware revision 8.0 1.5 Set Flow Control Mode v5.0 Dec 254 63 Mode v8.0 Hex FE 3F Mode ASCII ■ ? Mode Toggles flow control between hardware, software and off settings. Software and Hardware control can be further tuned using the settings above. Default is Off, or 0. Mode Byte Flow control setting as below. Table 17: Hardware Flow Control Trigger Levels Bytes Level 18 1 0 4 1 8 2 14 3 Table 18: Flow Control Settings Flow Control Mode Command Summary None 0 Software 1 Hardware 2 1.6 Set Hardware Dec 254 62 Level v8.0 Flow Control Hex FE 3E Level Trigger Level ASCII ■ > Level Sets the hardware flow control trigger level. The Clear To Send signal will be deactivated once the number of characters in the display buffer reaches the level set; it will be reactivated once all data in the buffer is handled. Level Byte Trigger level as above. 1.7 Turn Dec 254 58 Almost Full Almost Empty v8.0 Software Flow Hex FE 3A Almost Full Almost Empty Control On ASCII ■ : Almost Full Almost Empty Enables simple flow control. The display will return a single, Xoff, byte to the host when the display buffer is almost full and a different, Xon, byte 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 256* bytes. Not available in I C. Default off. Almost Full Byte Number of bytes remaining before buffer is completely full, 0 < Full < Empty < 256*. Almost Empty Byte Number of bytes before buffer can be considered empty enough to accept data. *Note: Buffer size was increased to 256 bytes from 128 bytes at firmware revision 8.3. 1.8 Turn Dec 254 59 v8.0 Software Flow Hex FE 3B Control Off ASCII ■; Disables flow control. Bytes sent to the display may be permitted to overflow the buffer resulting in data loss. 1.9 Set Software Dec 254 60 Xon Xoff v8.0 Flow Control Hex FE 3C Xon Xoff Response ASCII ■ < Xon Xoff Sets the values returned for almost full and almost empty messages when in flow control mode. This command permits the display to utilize standard flow control values of 0x11 and 0x13, note that defaults are 0xFF and 0xFE. Xon Byte Value returned when display buffer is almost empty, permitting transmission to resume. Xoff Byte Value returned when display buffer is almost full, signaling transmission to halt. 1.10 Echo Dec 254 255 Length Data v8.3 Hex FE FF Length Data ■ Length Data ASCII Send data to the display that it will echo. Useful to confirm communication or return information from scripts. Length Short Length of data array to be echoed. Data Byte(s) An arbitrary array of data that the module will return. Response Byte(s) The same arbitrary array of data originally sent. 1.11 Delay Dec 254 251 Time Hex FE FB Time ASCII ■ √ Time Pause command execution to and responses from the display for the specified length of time. Time Short Length of delay in ms, maximum 2000. Command Summary v8.3 19 1.12 Software Reset Dec 254 253 77 79 117 110 v8.4 Hex FE FD 4D 4F 75 6E ASCII ■²MOun Reset the display as if power had been cycled via a software command. No commands should be sent while the unit is in the process of resetting; a response will be returned to indicate the unit has successfully been reset. Response Short Successful reset response, 254 212. 6.2 Text 2.1 Clear Screen Dec 254 88 Hex FE 58 ASCII ■X Clears the contents of the screen. v8.0 2.2 Go Home Dec 254 72 Hex FE 48 ASCII ■H Returns the cursor to the top left of the screen. v8.0 2.3 Set Cursor Position Dec 254 71 Column Row Hex FE 47 Column Row ASCII ■ G Column Row Sets the cursor to a specific cursor position where the next transmitted character is printed. Column Byte Value between 1 and number of character columns. Row Byte Value between 1 and number of character rows. v8.0 2.4 Set Cursor Coordinate v8.0 Dec 254 121 X Y Hex FE 79 X Y ASCII ■y X Y Sets the cursor to an exact pixel position where the next transmitted character is printed. X Byte Value between 1 and screen width, represents leftmost character position. Y Byte Value between 1 and screen height, represents topmost character position. 2.5 Get String Extents Dec 254 41 Text v8.6 Hex FE 29 Text ASCII ■ ) Text Read the size of the rectangle that the specified string would occupy if it was rendered with the current font. Text String String on which to preform extents calculation. A single line of text is assumed. Response Byte(s) Width and height of the string in pixels. A width greater than the screen will return 0. 20 Command Summary 2.6 Initialize Text Window Dec 254 43 ID X1 Y1 X2 Y2 Font CharSpace LineSpace Scroll v8.3 Hex FE 2B ID X1 Y1 X2 Y2 Font CharSpace LineSpace Scroll ASCII ■ + ID X1 Y1 X2 Y2 Font CharSpace LineSpace Scroll Designates a portion of the screen to which text can be confined. Font commands affect only the current window, default (entire screen) is window 0. ID Byte Unique text window identification number, value between 0 and 15. X1 Byte Leftmost coordinate. Y1 Byte Topmost coordinate. X2 Byte Rightmost coordinate. Y2 Byte Bottommost coordinate. Font* Short Unique font ID to use for this window, value between 0 and 1023. CharSpace Byte Spacing between characters to use for this window. LineSpace Byte Spacing between lines to use for this window. Scroll Byte Number of pixel rows to write to before scrolling text. *Note: Font was changed from a Byte length at firmware revision 8.5 2.7 Set Text Window Dec 254 42 ID v8.3 Hex FE 2A ID ASCII ■ * ID Sets the text window to which subsequent text and commands will apply. Default (entire screen) is window 0. ID Byte Unique text window to use. 2.8 Clear Text Window Dec 254 44 ID Hex FE 2C ID ASCII ■ , ID Clear the contents of a specific text window, similar to the clear screen command. ID Byte Unique text window to clear. v8.3 2.9 Initialize Label Dec 254 45 ID X1 Y1 X2 Y2 Vert Hor Font Background CharSpace v8.3 Hex FE 2D ID X1 Y1 X2 Y2 Vert Hor Font Background CharSpace ASCII ■ - ID X1 Y1 X2 Y2 Vert Hor Font Background CharSpace Designates a portion of the screen that can be easily updated with one line of text, often used to display variables. ID Byte Unique label identification number, value between 0 and 15. X1 Byte Leftmost coordinate. Y1 Byte Topmost coordinate. X2 Byte Rightmost coordinate. Y2 Byte Bottommost coordinate. Vert Byte Vertical justification of the label text; 0 for top, 1 for middle, or 2 for bottom. Hor Byte Horizontal justification of the label text; 0 for left, 1 for centre, or 2 for right. Font* Short Unique font ID to use for this label, value between 0 and 1023. Background Byte State of the pixels in the label region that is not occupied by text; 0 for off or 1 for on. CharSpace Byte Spacing between characters to use for this label. *Note: Font was changed from a Byte length at firmware revision 8.5 Command Summary 21 2.10 Initialize Scrolling Label Dec 254 47 ID X1 Y1 X2 Y2 Vert Dir Font Background CharSpace Delay v8.6 Hex FE 2F ID X1 Y1 X2 Y2 Vert Dir Font Background CharSpace Delay ASCII ■ / ID X1 Y1 X2 Y2 Vert Dir Font Background CharSpace Delay Designates a portion of the screen that can be easily updated with one line of text, often used to display variables. ID Byte Unique label identification number, value between 0 and 15. X1 Byte Leftmost coordinate. Y1 Byte Topmost coordinate. X2 Byte Rightmost coordinate. Y2 Byte Bottommost coordinate. Vert Byte Vertical justification of the label text; 0 for top, 1 for middle, or 2 for bottom. Dir Byte Direction of the scrolling behavior; 0 for left, 1 for right, or 2 for bounce. Font Short Unique font ID to use for this label, value between 0 and 1023. Background Byte State of the pixels in the label region that is not occupied by text; 0 for off or 1 for on. CharSpace Byte Spacing between characters to use for this label. Delay Short Time in milliseconds to elapse between characters printed. 2.11 Update Label Dec 254 46 ID Data Hex FE 2E ID Data ASCII ■ . ID Data Update a previously created label with new text. Send a null character (empty string) to clear a label. ID Byte Unique label to update, between 0 and 15. Data String Information to display in the label, must be terminated with a null (value of zero) byte. v8.3 2.12 Auto Scroll On Dec 254 81 v8.0 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.13 Auto Scroll Off Dec 254 82 v8.0 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. 6.3 Drawing 3.1 Set Drawing Colour Dec 254 99 Colour Hex FE 63 Colour ASCII ■ c Colour Set the colour to be used for all future drawing commands that do not implicitly specify colour. Colour Byte 0 for background or any other value for text colour. 22 Command Summary v8.0 3.2 Draw Pixel Dec 254 112 X Y Hex FE 70 X Y ASCII ■p X Y Draw a single pixel at the specified coordinate using the current drawing colour. X Byte Horizontal position of pixel to be drawn. Y Byte Vertical position of pixel to be drawn. v8.0 3.3 Draw a Line Dec 254 108 X1 Y1 X2 Y2 v8.0 Hex FE 6C X1 Y1 X2 Y2 ASCII ■ l X1 Y1 X2 Y2 Draw a line connecting two termini. Lines may be rendered differently when drawn right to left versus left to right. X1 Byte Horizontal coordinate of first terminus. Y1 Byte Vertical coordinate of first terminus. X2 Byte Horizontal coordinate of second terminus. Y2 Byte Vertical coordinate of second terminus. 3.4 Continue a Line Dec 254 101 X Y Hex FE 65 X Y ASCII ■e X Y Draw a line from the last point drawn to the coordinate specified using the current drawing colour. X Byte Left coordinate of terminus. Y Byte Top coordinate of terminus. v8.0 3.5 Draw a Rectangle Dec 254 114 Colour X1 Y1 X2 Y2 Hex FE 72 Colour X1 Y1 X2 Y2 ASCII ■ r Colour X1 Y1 X2 Y2 Draw a rectangular frame one pixel wide using the colour specified; current drawing colour is ignored. Colour Byte 0 for background or any other value for text colour. X1 Byte Leftmost coordinate. Y1 Byte Topmost coordinate. X2 Byte Rightmost coordinate. Y2 Byte Bottommost coordinate. v8.0 3.6 Draw a Filled Rectangle v8.0 Dec 254 120 Colour X1 Y1 X2 Y2 Hex FE 78 Colour X1 Y1 X2 Y2 ASCII ■ x Colour X1 Y1 X2 Y2 Draw a filled rectangle using the colour specified; current drawing colour is ignored. Colour Byte 0 for background or any other value for text colour. X1 Byte Leftmost coordinate. Y1 Byte Topmost coordinate. X2 Byte Rightmost coordinate. Y2 Byte Bottommost coordinate. Command Summary 23 3.7 Draw a Dec 254 128 X1 Y1 X2 Y2 Radius Rounded Hex FE 80 X1 Y1 X2 Y2 Radius Rectangle ASCII ■ Ç X1 Y1 X2 Y2 Radius Draw a rounded rectangular frame one pixel wide using the current drawing colour. X1 Byte Leftmost coordinate of the rectangle. Y1 Byte Topmost coordinate of the rectangle. X2 Byte Rightmost coordinate. Y2 Byte Bottommost coordinate. Radius Byte Radius of curvature of the rectangle corners. v8.3 3.8 Draw a Filled Dec 254 129 X1 Y1 X2 Y2 Radius Rounded Hex FE 81 X1 Y1 X2 Y2 Radius Rectangle ASCII ■ ü X1 Y1 X2 Y2 Radius Draw a filled rounded rectangle using the current drawing colour. X1 Byte Leftmost coordinate of the rectangle. Y1 Byte Topmost coordinate of the rectangle. X2 Byte Rightmost coordinate. Y2 Byte Bottommost coordinate. Radius Byte Radius of curvature of the rectangle corners. v8.3 3.9 Draw a Circle Dec 254 123 X Y Radius Hex FE 7B X Y Radius ASCII ■ { X Y Radius Draw a circular frame one pixel wide using the current drawing colour. X Byte Horizontal coordinate of the circle centre. Y Byte Vertical coordinate of the circle centre. Radius Byte Distance between the circle perimeter and centre. v8.3 3.10 Draw a Filled Circle Dec 254 124 X Y Radius Hex FE 7C X Y Radius ASCII ■ | X Y Radius Draw a filled circle using the current drawing colour. X Byte Horizontal coordinate of the circle centre. Y Byte Vertical coordinate of the circle centre. Radius Byte Distance between the circle perimeter and centre. v8.3 3.11 Draw an Ellipse v8.3 Dec 254 125 X Y XRadius YRadius Hex FE 7D X Y XRadius YRadius ASCII ■ } X Y XRadius YRadius Draw an elliptical frame one pixel wide using the current drawing colour. X Byte Horizontal coordinate of the ellipse centre, zero indexed from left. Y Byte Vertical coordinate of the ellipse centre, zero indexed from top. XRadius Byte Distance between the furthest horizontal point on the ellipse perimeter and centre. YRadius Byte Distance between the furthest vertical point on the ellipse perimeter and centre. 24 Command Summary 3.12 Draw a Filled Ellipse Dec 254 127 X Y XRadius YRadius Hex FE 7F X Y XRadius YRadius ■ DEL X Y XRadius YRadius ASCII Draw an ellipse using the current drawing colour. X Byte Horizontal coordinate of the ellipse centre, zero indexed from left. Y Byte Vertical coordinate of the ellipse centre, zero indexed from top. XRadius Byte Distance between the furthest horizontal point on the ellipse perimeter and centre. YRadius Byte Distance between the furthest vertical point on the ellipse perimeter and centre. v8.3 3.13 Scroll Screen v8.3 Dec 254 89 X1 Y1 X2 Y2 MoveX MoveY Hex FE 59 X1 Y1 X2 Y2 MoveX MoveY ASCII ■ Y X1 Y1 X2 Y2 MoveX MoveY Define and scroll the contents of a portion of the screen. X1 Byte Leftmost coordinate of the scroll window, zero indexed from left. Y1 Byte Topmost coordinate of the scroll window, zero indexed from top. X2 Byte Rightmost coordinate of the scroll window, zero indexed from left. Y2 Byte Bottommost coordinate of the scroll window, zero indexed from top. MoveX Signed Short Number of pixels to scroll horizontally. MoveY Signed Short Number of pixels to scroll vertically. 3.14 Initialize a Bar Graph Dec 254 103 ID Type X1 Y1 X2 Y2 v8.3 Hex FE 67 ID Type X1 Y1 X2 Y2 ASCII ■ g ID Type X1 Y1 X2 Y2 Initialize a bar graph in memory for later implementation. Graphs can be located anywhere on the screen, but overlapping may cause distortion. Graph should be filled using the Draw a Bar Graph command. ID Byte Unique bar identification number, between 0 and 255. Type Byte Graph style, see Bar Graph Types. X1 Byte Leftmost coordinate. Y1 Byte Topmost coordinate. X2 Byte Rightmost coordinate. Y2 Byte Bottommost coordinate. Table 19: Bar Graph Types Type 0 1 2 3 Direction Vertical Horizontal Vertical Horizontal Base Bottom Left Top Right Command Summary 25 3.15 Initialize 9Slice Bar Graph Dec 254 115 ID Type X1 Y1 X2 Y2 Fore 9Slice Back 9Slice v8.3 Hex FE 73 ID Type X1 Y1 X2 Y2 Fore 9Slice Back 9Slice ASCII ■ s ID Type X1 Y1 X2 Y2 Fore 9Slice Back 9Slice Initialize a 9-slice bar graph in memory for later implementation. 9-slice graphs are also be filled using the Draw a Bar Graph command and are allocated to the same memory as regular bitmaps. ID Byte Unique bar identification number, value between 0 and 255. Type Byte Graph style, see Bar Graph Types. X1 Byte Leftmost coordinate of the 9-slice bar, zero indexed from left. Y1 Byte Topmost coordinate of the 9-slice bar, zero indexed from top. X2 Byte Rightmost coordinate of the 9-slice bar, zero indexed from left. Y2 Byte Bottommost coordinate of the 9-slice bar, zero indexed from top. Fore 9Slice Short 9-slice used for the foreground. Back 9Slice Short 9-slice used for the background. 3.16 Draw a Bar Graph Dec 254 105 ID Value v8.3 Hex FE 69 ID Value ASCII ■ i ID Value Fill in a portion of a bar graph after initialization. Any old value will be overwritten by the new. Setting a value of zero before setting a new value will restore a graph should it become corrupted. ID Byte Unique bar identification number, between 0 and 255. Value Byte Portion of graph to fill in pixels, will not exceed display bounds. 3.17 Initialize a Strip Chart Dec 254 110 ID X1 Y1 X2 Y2 Min Max Step Style ID v8.3 Hex FE 6E ID X1 Y1 X2 Y2 Min Max Step Style ID ASCII ■ n ID X1 Y1 X2 Y2 Min Max Step Style ID Designate a portion of the screen for a chart. Visual changes will occur when the update command is issued. ID Byte Unique chart identification number, value between 0 and 7. X1 Byte Leftmost coordinate of the strip chart, zero indexed from left. Y1 Byte Topmost coordinate of the strip chart, zero indexed from top. X2 Byte Rightmost coordinate of the strip chart, zero indexed from left. Y2 Byte Bottommost coordinate of the strip chart, zero indexed from top. Min Short Minimum chart value. Max Short Maximum chart value. For line styles, make max-min at least one pixel less than chart height. Step Byte Scroll distance between updates, in pixels. Style Byte Chart style value which is an OR’d combination of type and direction, as per the tables below. ID Short 9-slice file ID, if a 9-slice style strip chart is not desired send any value for this parameter. Table 20: Strip Chart Directions (Bytes 7-4) Direction 0 32 64 96 128 160 192 224 26 Table 21: Strip Chart Types (Bytes 3-0) Description Bottom origin, left shift Left origin, upward shift Top origin, right shift Right origin, downward shift Bottom origin, right shift Left origin, downward shift Top origin, left shift Right origin, upward shift Command Summary Type 0 1 2 3 4 5 6 Description Bar Line Step Box 9-slice Separated Bar Separated Box 3.18 Update a Strip Chart Dec 254 111 ID Value Hex FE 6F ID Value ASCII ■ o ID Value Shift the specified strip chart and draw a new value. ID Byte Chart identification number, value between 0 and 7. Value Short Value to add to the chart. v8.3 6.4 Fonts 4.1 Upload a Font File Dec 254 36 ID Size Data v8.0 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 Transfer Protocol or XModem Transfer Protocol entries. Default font is ID 1. ID* Short Unique font identification number, value between 0 and 1023. Size* Integer Size of the entire font file. Data Byte(s) Font file data, see the Font File Creation example. *Note: ID and Size were changed from Byte and Short lengths respectively at firmware revision 8.1 4.2 Set the Current Font Dec 254 49 ID v8.0 Hex FE 31 ID ASCII ■ 1 ID Set the font in use by specifying a unique identification number. Characters sent after the command will appear in the font specified; previous text will not be affected. Default is 1. ID* Short Unique font identification number, value between 0 and 1023. *Note: ID was changed from a Byte length at firmware revision 8.5 4.3 Set Font Metrics Dec 254 50 LineMargin TopMargin CharSpace LineSpace Scroll v8.0 Hex FE 32 LineMargin TopMargin CharSpace LineSpace Scroll ASCII ■ 2 LineMargin TopMargin CharSpace LineSpace Scroll Set the font spacing, or metrics, used with the current font. Changes only appear in text sent after command. LineMargin Byte Space between left of display and first column of text. Default 0. TopMargin Byte Space between top of display area and first row of text. Default 0. CharSpace Byte Space between characters. Default 0. Line Space Byte Space between character rows. Default 1. Scroll Byte Point at which text scrolls up screen to display additional rows. Default 1. 4.4 Set Box Space Mode Dec 254 172 Switch Hex FE AC Switch ASCII ■ ¼ Switch Toggle box space on or off. When on, a character sized box is cleared from the screen before a character is written. This eliminates any text or bitmap remnants behind the character. Default is on. Switch Byte 1 for on or 0 for off. Command Summary v8.0 27 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 easiest way to create, add, or modify the fonts of any graphic display is through the MOGD# tool. This provides a simple graphic interface that hides the more complex intricacies of the font file. Table 22: Example Font File Header Maximum Width 5 Character Height 7 ASCII Start Value 104 ASCII End Value 106 The font file header contains four bytes: First, the number of columns in the widest character; usually ‘w’, second, the pixel height of each character, and finally, the start and end values of the character range. The range represents the values that must be sent to the display to trigger the characters to appear on the screen. In the example, the decimal values corresponding to the lowercase letters ‘h’ through ‘j’ will be used resulting in the range shown. Table 23: Example Character Table h i j MSB 0 0 0 LSB 13 18 21 Width 5 3 4 The character table contains information that allows the display to locate each individual character in a mass of character data. Each character has three bytes; two indicating it’s offset in the character data and one indicating its width. The offset takes into account the header and table bytes to point to the first byte of the character data it references. The first byte of the file, maximum width, has an offset of zero. The width byte of each character can be identical as in a fixed width font, or in our case, variable. The character table will become clearer after analyzing the final part of the font file, character data. Table 24: Character ‘h’ Bitmap 1 1 1 1 1 1 1 28 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 0 1 0 0 0 0 0 0 0 1 1 1 1 Table 25: Character ‘h’ Data 1 0 1 1 0 0 0 0 1 0 0 1 0 0 1 0 0 1 0 0 0 1 1 0 0 Command Summary 1 1 0 1 0 0 0 0 1 0 0 1 0 0 0 84 2D 98 C6 20 132 45 152 198 32 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. When all cells are accounted for, zeroes may be added to the last byte to complete it. A sample of an ‘h’ glyph is shown above. The data for the ‘i’ and ‘j’ characters will follow to complete the custom font file displayed below. Table 26: Example Font File Header Character Table Character Data 5 7 104 106 0 13 5 0 18 3 0 21 4 132 45 152 198 32 67 36 184 16 49 25 96 6.5 Bitmaps 5.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 Transfer Protocol or XModem Transfer Protocol entries. Start screen is ID 1. ID* Short Unique bitmap identification number, value between 0 and 1023. Size* Integer Size of the entire bitmap file. Data Byte(s) Bitmap file data, see the Bitmap File Creation example. *Note: ID and Size were changed from Byte and Short lengths respectively at firmware revision 8.1 v8.0 5.2 Upload a Bitmap Mask v8.3 Dec 254 92 5 ID Size Data Hex FE 5C 05 ID Size Data ASCII ■ \ ENQ ID Size Data Upload a bitmap mask that can clear areas of the screen before a bitmap is drawn. Programmatically, (bitmap&mask) | (screen&~mask) is shown when a bitmap is drawn. To create a mask see the Bitmap File Creation section, for upload protocol see the File Transfer Protocol or XModem Transfer Protocol entries. ID Short Unique bitmap mask identification number, value between 0 and 1023. Size Integer Size of the entire mask file. Data Byte(s) Bitmap mask file data, see the Bitmap File Creation example. Command Summary 29 5.3 Draw a Dec 254 98 ID X Y Bitmap from Hex FE 62 ID X Y Memory ASCII ■ b ID X Y Draw a previously uploaded bitmap from memory. Top left corner must be specified for drawing. ID* Short Unique bitmap identification number, value between 0 and 1023. X Byte Leftmost coordinate of bitmap. Y Byte Topmost coordinate of bitmap. *Note: ID and Size were changed from Byte and Short lengths respectively at firmware revision 8.1 v8.0 5.4 Draw a Partial Bitmap Dec 254 192 ID X Y XPart YPart Width Height Hex FE C0 ID X Y XPart YPart Width Height ASCII ■└ ID X Y XPart YPart Width Height Draw a portion of a previously uploaded bitmap confined to the width and height specified. ID Short Unique bitmap identification number, value between 0 and 1023. X Byte Leftmost coordinate of partial bitmap placement. Y Byte Topmost coordinate of partial bitmap placement. XPart Byte Rightmost coordinate of the bitmap portion to be drawn. YPart Byte Bottommost coordinate of the bitmap portion to be drawn. Width Byte Width of the bitmap portion to be drawn. Height Byte Width of the bitmap portion to be drawn. v8.6 5.5 Draw a Bitmap Directly v8.0 Dec 254 100 X1 Y1 Data Hex FE 64 X1 Y1 Data ASCII ■ d X1 Y1 Data Draw a bitmap directly to the graphic display without saving to memory. Cannot be implemented in a script. X1 Byte Leftmost coordinate of bitmap. Y1 Byte Topmost coordinate of bitmap. Data Byte(s) Bitmap file data, see the Bitmap File Creation example. 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 a single glyph, only a simple two byte header is required. First, one byte representing the bitmap width is sent, then one byte for the height. Each bitmap is merely encoded in binary fashion using a series of ones and zeroes. Again a grid can be created using the width and height specified in the upload command, populated in the manner above, and converted into byte values. A smiley face example is shown below to indicate the ultimate affect of the Matrix Orbital graphic stylization ability. 30 Command Summary Table 27: Smiley Face Bitmap 0 0 1 0 1 0 0 1 0 0 0 1 1 0 0 1 0 0 1 0 Table 28:Smiley Face Data 0 0 1 1 0 1 0 1 1 1 0 0 0 0 0 0 0 0 0 1 0 0 0 0 50 22 E0 80 34 224 Table 29: Example Bitmap File Header Bitmap Data 54 80 34 224 Bitmap Masking Like a regular bitmap, a mask can be loaded to the display and used to create a more polished result when drawing in populated areas. When defining a mask, all active values will clear any background information, while any inactive values will leave it untouched. This is best described with an example. Figure 18: Drawing with a Mask Figure 17: Drawing without a Mask 6.6 9-Slices 6.1 Upload a 9-Slice File Dec 254 92 3 ID Size Data Hex FE 5C 03 ID Size Data ASCII ■ \ ETX ID Size Data Upload a 9-slice file to a graphic display. To create a 9-slice see the 9-Slice File Creation section, for upload protocol see the File Transfer Protocol or XModem Transfer Protocol entries. ID Short Unique 9-slice identification number, value between 0 and 1023. Size Integer Size of the 9-slice file. Data Byte(s) 9-slice file data, see the 9-Slice File Creation example. v8.3 6.2 Upload a 9Slice Mask Dec 254 92 6 ID Size Data v8.3 Hex FE 5C 06 ID Size Data ASCII ■ \ ACK ID Size Data Upload a 9-slice mask that can clear areas of the screen before a 9-slice is drawn. Programmatically, (9slice&mask) | (screen&~mask) is shown when a bitmap is drawn. To create a mask see the 9-Slice File Creation section, for upload protocol see the File Transfer Protocol or XModem Transfer Protocol entries. ID Short Unique 9-slice mask identification number, value between 0 and 1023. Size Integer Size of the entire mask file. Data Byte(s) 9-slice mask file data, see the 9-Slice File Creation example. Command Summary 31 6.3 Display a 9-Slice Dec 254 91 ID X1 Y1 X2 Y2 Hex FE 5B ID X1 Y1 X2 Y2 ASCII ■ [ ID X1 Y1 X2 Y2 Displays a previously loaded 9-slice at the specified location. ID Short Unique 9-slice identification number, value between 0 and 1023. X1 Byte Leftmost coordinate of the 9-slice. Y1 Byte Topmost coordinate of the 9-slice. X2 Byte Rightmost coordinate of the 9-slice. Y2 Byte Bottommost coordinate of the 9-slice. 9-Slice File Creation A 9-slice file is a scalable graphic composed of nine different bitmap sections as shown below. Figure 19: Adobe 9-slice Representation The 9-slice file format requires that the bitmap dimensions and the locations of divisions be defined before a graphic is uploaded normally as shown in the Bitmap File Creation example. Table 30: 9-slice file format Width Height Top Bottom Left Right Bitmap Data 32 One byte representing the width of the entire bitmap. One byte representing the height of the entire bitmap. One byte specifying the height of the top row section of the 9-slice. One byte specifying the height of the bottom row section of the 9-slice. One byte specifying the width of the left column section of the 9-slice. One byte specifying the width of the right column section of the 9-slice. Data outlining the entire bitmap, as per the Bitmap File Creation example. Command Summary v8.3 6.7 Animations 7.1 Upload an Animation File Dec 254 92 4 File ID Size Data v8.3 Hex FE 5C 04 File ID Size Data ASCII ■ \ EOT File ID Size Data Upload an animation file to a graphic display. To create an animation see the Animation File Creation section, for upload protocol see the File Transfer Protocol or XModem Transfer Protocol entries. Up to16 animations can be displayed on the screen at one time, using the Display Animation command, but up to 1024 can be stored in memory for later use. Please note the total graphic memory size is 256KB. File ID Short Unique animation file identification number, value between 0 and 1023. Size Integer Size of the animation file. Data Byte(s) Animation file data, see the Animation File Creation example. 7.2 Display Animation Dec 254 193 ID File ID* X Y v8.3 Hex FE C1 ID File ID* X Y ■ ┴ ID File ID* X Y ASCII Load the first frame of the specified animation in its stopped state at the specified location. If an animation is already in use at that index it will be overwritten. Use the start animation command to play the displayed file. ID Byte Unique animation identification number, value between 0 and 15. File ID Short Unique animation file identification number, value between 0 and 1023. X Byte Leftmost coordinate of animation. Y Byte Topmost coordinate of animation. *Note: File ID short length variable was removed from this command at v8.4, and reintroduced at v8.5. 7.3 Delete Animation Dec 254 199 ID Hex FE C7 ID ■ ╟ ID ASCII Stop and delete the displayed animation specified. ID Byte Animation number to delete, value between 0 and 15. v8.3 7.4 Start/Stop Animation v8.3 Dec 254 194 ID Start Hex FE C2 ID Start ■ ┬ ID Start ASCII Start or stop an animation that has been displayed. ID Byte Animation number to start/stop, value between 0 and 15. Start Byte Any non-zero value will start the specified animation, 0 will stop it. 7.5 Set Dec 254 197 ID Frame v8.3 Animation Hex FE C5 ID Frame ■ ┼ ID Frame Frame ASCII Set the current frame of a displayed animation. If the frame exceeds the total number present, the animation will be set to the first frame. ID Byte Animation number to control, value between 0 and 15. Frame Byte Number of the frame to be displayed, value between 0 and 31. Command Summary 33 7.6 Get Dec 254 196 ID Animation Hex FE C4 ID Frame ASCII ■ ─ ID Get the current frame of a displayed animation. ID Byte Animation number to request frame number, value between 0 and 15. Response Byte Current frame number of the animation specified, value between 0 and 31. v8.3 Animation File Creation An animation file is a series of bitmaps, each displayed for a specified length of time within a continuous rotation. The file begins by specifying the number of frames, the offset of each block of bitmap information, and the time to display each frame. After which bitmap headers and data are transmitted for each frame, in the same manner as the Bitmap File Creation example. Table 31: Animation file format Total Frames Offsets Times Header 1 Bitmap 1 Data … Header 9 Bitmap 9 Data One byte representing the total number of frames in the animation One entry for each frame, 4 bytes indicating the start of the bitmap file. Maximum 32 frames. Two bytes for each frame representing the length of time (100ms) for which it is displayed. Two bytes, one representing the width and one the height of the first bitmap. The first bitmap data, as per the Bitmap File Creation example. … Two bytes, one representing the width and one the height of the last bitmap. The last bitmap data, as per the Bitmap File Creation example. 6.8 General Purpose Output 8.1 General Purpose Output On Dec 254 87 Number Hex FE 57 Number ASCII ■ W Number Turns the specified GPO on, sourcing current from an output of five volts. Number Byte GPO to be turned on. v8.0 8.2 General Purpose Output Off v8.0 Dec 254 86 Number Hex FE 56 Number ASCII ■ V Number Turns the specified GPO off, sinking current to an output of zero volts. Number Byte GPO to be turned off. 8.3 Set Start Up GPO State Dec 254 195 Number State v8.0 Hex FE C3 Number State ■ ├ Number State ASCII Sets and saves the start up state of the specified GPO in non volatile memory. Changes will be seen on start up. Number Byte GPO to be controlled. State Byte 1 for on or 0 for off. 34 Command Summary 6.9 Piezo Buzzer 9.1 Activate Piezo Buzzer* Dec 254 187 Frequency Time v8.0 Hex FE BB Frequency Time ■ ╗ Frequency Time ASCII Activates a buzz of specific frequency from the onboard piezo buzzer for a specified length of time. Frequency Short Frequency of buzz in hertz. Time Short *Duration of the beep in milliseconds. *Note: When a beep precedes a delay command, the duration of the beep must be shorter than that of the delay. 9.2 Set Default Buzzer Beep Dec 254 188 Frequency Duration Hex FE BC Frequency Duration ■ ╝ Frequency Duration ASCII Set the frequency and duration of the default beep transmitted when the bell character is transmitted. Frequency Short Frequency of the beep in Hertz, default 440Hz. Duration Short Duration of the beep in milliseconds, default 100ms. v8.3 9.3 Set Keypad Buzzer Beep Dec 254 182 Frequency Duration Hex FE B6 Frequency Duration ■ ╢ Frequency Duration ASCII Set the frequency and duration of the default beep transmitted when a key is pressed. Frequency Short Frequency of the beep in Hertz, default is 0 or off. Duration Short Duration of the beep in milliseconds, default is 0 or off. v8.4 9.4 Set Touch Buzzer Beep v8.4 Dec 254 182 Down Freq Up Freq Hex FE B6 Down Freq Up Freq ■ ╢ Down Freq Up Freq ASCII Set the frequency of the default beep transmitted when a touch event occurs. Duration of each is 50ms. Down Freq Short Frequency of the down event beep in Hertz, default is 0 or off. Up Freq Short Frequency of the up event beep in Hertz, default is 0 or off. 6.10 Keypad 10.1 Auto Dec 254 65 v8.0 Transmit Key Hex FE 41 Presses On ASCII ■A Key presses are automatically sent to the host when received by the display. Use this mode for I2C transactions. 10.2 Auto Dec 254 79 v8.0 Transmit Key Hex FE 4F Presses Off ASCII ■O Key presses are held in the 10 key buffer to be polled by the host using the Poll Key Press command. Default is Auto Transmit on. Command Summary 35 10.3 Poll Key Press Dec 254 38 v8.0 Hex FE 26 ASCII ■& Reads the last unread key press from the 10 key display buffer. If another key is stored in the buffer the MSb will be 1, the MSb will be 0 when the last key press is read. If there are no stored key presses a value of 0 will be 2 returned. Auto transmit key presses must be turned off for this command to be successful, do not use with I C. Response Byte Value of key pressed (MSb determines additional keys to be read). 10.4 Clear Key Buffer Dec 254 69 Hex FE 45 ASCII ■E Clears all key presses from the key buffer. v8.0 10.5 Set Debounce Time Dec 254 85 Time v8.0 Hex FE 55 Time ASCII ■ U Time Sets the time between a key press and a key read by the display. Most switches will bounce when pressed; the debounce time allows the switch to settle for an accurate read. Default is 8 representing approximately 52ms. Time Byte Debounce increment (debounce time = Time * 6.554ms). 10.6 Set Auto Repeat Mode Dec 254 126 Mode v8.0 Hex FE 7E Mode ■ DEL Mode ASCII Sets key press repeat mode to typematic or hold. In typematic mode if a key press is held, by default 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 Byte 1 for hold mode or 0 for typematic. 10.7 Auto Repeat Mode Off Dec 254 96 Hex FE 60 ASCII ■` Turns auto repeat mode off. Default is on (typematic). 36 Command Summary v8.0 10.8 Assign Keypad Codes Dec 254 213 Key Down Key Up v8.0 Hex FE D5 Key Down Key Up ■ ╒ Key Down Key Up ASCII Assigns the key down and key up values sent to the host when a key press is detected. A key up and key down value must be sent for every key, a value of 255 will leave the key unaltered. Defaults are shown below. Key Down Bytes [25] Key down values. Key Up Bytes [25] Key up values. Table 32: Default Key Down Values A(65) F(70) K(75) P(80) U(85) Key Down B(66) C(67) G(71) H(72) L(76) M(77) Q(81) R(82) V(86) W(87) D(68) I(73) N(78) S(83) X(88) Table 33: Default Key Up Values E(69) J(74) O(79) T(84) Y(89) a(97) f(102) k(107) p(112) u(117) b(98) g(103) l(108) q(113) v(118) Key Up c(99) h(104) m(109) r(114) w(119) d(100) i(105) n(110) s(115) x(120) e(101) j(106) o(111) t(116) y(121) 10.9 Set Dec 254 159 Delay Typematic Hex FE 9F Delay Delay ASCII ■ ƒ Delay Sets the delay between the first key press and first typematic report when a key is held in typematic mode. Delay Byte Time key must be held to trigger typematic reports, specified in 100ms, default is 10 (1s). v8.4 10.10 Set Dec 254 158 Interval Typematic Hex FE 9E Interval Interval ASCII ■ ₧ Interval Sets the interval between reported key presses when a key is held and the display is in typematic mode. Interval Byte Time between key reports, specified in 100ms increments, default is 2 (200ms). v8.4 6.11 Touchpad 11.1 Set Touch Mode Dec 254 135 Mode v8.0 Hex FE 87 Mode ■ ç Mode ASCII Sets the method used to return touch events. Region mode will return a single value for events in defined areas. Coordinate mode will return event, x position, and y position bytes for each press, drag, or release. Mode Byte Touch reporting mode, 0 for region or 1 for coordinate mode. Default is coordinate. Command Summary 37 11.2 Set Region Reporting Mode Dec 254 136 Mode v8.0 Hex FE 88 Mode ASCII ■ ê Mode Defines the events transmitted in region mode. Allows only events specified to return a value to the host. Key down values are transmitted for press and drag events, key up for release, and the value 255 for out of region. Mode Byte Defines the events reported, see Region Reporting Mode. Default reporting returns all events. Table 34: Region Reporting Mode Bit Event 7-4 Reserved 3 Out of Region 2 Drag 1 Release 0 Press 11.3 Set Touch Region Dec 254 132 ID X Y Width Height Key Down Key Up Hex FE 84 ID X Y Width Height Key Down Key Up ■ ä ID X Y Width Height Key Down Key Up ASCII Creates a region of the screen that responds when pressed and released with a defined single byte. ID Byte Unique region identification number, maximum 32 regions. Value between 0 and 31. X Byte Leftmost coordinate. Y Byte Topmost coordinate. Width Byte Width of region, must be within screen bounds. Height Byte Height of region, must be within screen bounds. Key Down Byte Value returned when region is pressed. Key Up Byte Value returned when region is released. v8.0 11.4 Delete a Touch Region v8.0 Dec 254 133 ID Hex FE 85 ID ■ à ID ASCII Deletes a previously created touch region. Events from undefined regions return the value 255 by default. ID Byte Unique region identification number. 11.5 Delete All Touch Regions Dec 254 134 v8.0 Hex FE 86 ■å ASCII Deletes all previously created touch regions. Recommended for use before dividing the screen into new regions. 38 Command Summary 11.6 Create a Slider Dec 254 186 ID Type X Y Width Height Control Width Min Max v8.3 Hex FE BA ID Type X Y Width Height Control Width Min Max ■ ║ ID Type X Y Width Height Control Width Min Max ASCII Draw a slider on the screen that responds visually and numerically when tapped or slid. Slider regions respond with a value of 83, their ID, then two byte length current X and Y coordinates when activated. ID Byte Unique slider identification number, maximum 32 regions/sliders. value between 0 and 31 Type Byte Defines slider direction and starting point for the control, as below. X Byte Leftmost coordinate. Y Byte Topmost coordinate. Width Short Width of slider. Height Short Height of slider. Control Width Byte Width of the slider control. Min Short Minimum slider value. Max Short Maximum slider value. Table 35: Slider Definition Value 16 17 32 33 64 65 Description Horizontal slider, starting at minimum position Vertical slider, starting at minimum position Horizontal slider, starting at maximum position Vertical slider, starting at maximum position Horizontal slider, starting at middle position Vertical slider, starting at middle position 11.7 Delete a Slider Dec 254 189 ID Hex FE BD ID ■ ╜ ID ASCII Deletes a previously created slider. Memory is shared with touch regions, this command will free space. ID Byte Unique region identification number. v8.3 11.8 Delete All Sliders v8.3 Dec 254 190 Hex FE BE ■╛ ASCII Deletes all previously created sliders. Does not remove touch regions. 11.9 Set Dec 254 137 Threshold v8.0 Dragging Hex FE 89 Threshold Threshold ASCII ■ ë Threshold Sets the distance a press is required to travel before a drag event is reported. Precision will vary inversely to data transmitted; care should be taken to find a suitable balance. Distance is calculated as∆𝑥 2 + ∆y 2 = 𝑑 2 . Threshold Byte Dragging threshold value. Default is 8. Command Summary 39 11.10 Set Dec 254 138 Threshold Pressure Hex FE 8A Threshold ■ è Threshold Threshold ASCII Sets the pressure required to trigger a touch event. Threshold Short Pressure threshold value. Default is 1000. v8.0 11.11 Run Dec 254 139 v8.0 Touchpad Hex FE 8B Calibration ASCII ■ï Triggers an interactive calibration of the touchpad. User will be required to touch various points on the screen during calibration. This command is recommended for use when environmental or user conditions change to ensure correct operation. Response Short Command byte 254, then 21 for success or 20 for failure. 6.12 Display Functions 12.1 Backlight On Dec 254 66 Minutes v8.0 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 Byte Number of minutes to leave backlight on, a value of 0 leaves the display on indefinitely. 12.2 Backlight 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. v8.0 12.3 Set Brightness v8.0 Dec 254 153 Brightness Hex FE 99 Brightness ASCII ■ Ö Brightness Immediately sets the backlight brightness. If an inverse display color is used this represents the text colour intensity instead. Default is 255. Brightness Byte Brightness level from 0(Dim) to 255(Bright). 12.4 Set and Save Brightness Dec 254 152 Brightness v8.0 Hex FE 98 Brightness ASCII ■ ÿ Brightness Immediately sets and saves the backlight brightness. Although brightness can be changed using the set command, it is reset to this saved value on start up. Default is 255. Brightness Byte Brightness level from 0(Dim) to 255(Bright). 40 Command Summary 12.5 Set Contrast Dec 254 80 Contrast v8.0 Hex FE 50 Contrast ASCII ■ P Contrast Immediately sets the contrast between background and text. If an inverse display color is used this also represents the text brightness. Default is 128. Contrast Byte Contrast level from 0(Light) to 255(Dark). 12.6 Set and Save Contrast Dec 254 145 Contrast v8.0 Hex FE 91 Contrast ASCII ■ æ 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 Byte Contrast level from 0(Light) to 255(Dark). 6.13 Scripting 13.1 Upload a Script File Dec 254 92 2 ID Length Data v8.3 Hex FE 5C 02 ID Length Data ASCII ■ \ STX ID Length Data Save a list of commands to be executed at a later time. Bytes are saved as if they are being sent by the host, for upload protocol see the File Transfer Protocol or XModem Transfer Protocol entries. ID Short Unique identification number of the script, value between 0 and 1023. Length Integer Length of the script in bytes. Data Byte(s) Data to be sent to the display when the script executes. 13.2 Set Scripted Key Dec 254 141 ID Row Column Down Script Up Script v8.4 Hex FE 8D ID Row Column Down Script Up Script ASCII ■ ì ID Row Column Down Script Up Script Create a key behaviour that responds to a press event by executing an uploaded script. ID Byte Unique key identification number, maximum based on number of keys available. Row Byte The row value of the key to be linked to the specified scripts. Column Byte The column value of the key to be linked to the specified scripts. Down Script Short Identification number of the script to run on a down event, value between 0 and 1023. Up Script Short Identification number of the script to run on an up event, value between 0 and 1023. *Note: The command number for Set Scripted Key is 142 at all firmware revisions less than 8.4. Command Summary 41 13.3 Set Scripted Button Dec 254 142 ID X Y Width Height Type Down Script Up Script v8.3 Hex FE 8E ID X Y Width Height Type Down Script Up Script ASCII ■ Ä ID X Y Width Height Type Down Script Up Script Create a button region that responds to a touch event by executing an uploaded script. ID Byte Identification number of the touch region, value between 0 and 31 X Byte Leftmost coordinate. Y Byte Topmost coordinate. Width Byte Width of touch region. Height Byte Height of touch region. Type Byte Type of touch region. Must be 1. Down Script Short Identification number of the script to run on a down event, value between 0 and 1023. Up Script Short Identification number of the script to run on an up event, value between 0 and 1023. 13.4 Run Script File Dec 254 93 ID Hex FE 5D ID ASCII ■ ] ID Execute a previously loaded script. Script 0 is loaded automatically on startup, unless in override mode. ID Short Identification number of the script to run, value between 0 and 1023. v8.3 6.14 Filesystem 14.1 Delete Filesystem Dec 254 33 89 33 v8.0 Hex FE 21 59 21 ASCII ■!Y! Completely erase all fonts and bitmaps from a graphic display. Extended length of the command is intended to prevent accidental execution. To ensure filesystem integrity, cycle power to the display after erasure. 14.2 Delete a File Dec 254 173 Type ID v8.0 Hex FE AD Type ID ASCII ■ ¡ Type ID Removes a single font or bitmap file given the type and unique identification number. Cycle power after deletion. Type Byte 0 for font or 1 for bitmap. ID* Short Unique identification number of font or bitmap to be deleted, value between 0 and 1023. *Note: ID was changed from a Byte length at firmware revision 8.1 14.3 Get Filesystem Space Dec 254 175 Hex FE AF ASCII ■» Returns the amount of space remaining in the display for font or bitmap uploads. Response Integer Number of bytes remaining in memory. 42 Command Summary v8.0 14.4 Get Filesystem Directory Dec 254 179 v8.0 Hex FE B3 ASCII ■│ Returns a directory to the contents of the filesystem. The total number and type of each entry will be provided. Response Short Number of entries. Byte(s) [8] 8 identification bytes for each entry. Table 36: Filesystem Identification Bytes Byte Description 7 Size(MSB) 6 Size 5 Size 4 Size(LSB) 3 Type(4)/ID(4) 2 ID (LSB) 1 Start Page (MSB) 0 Start Page (LSB) Table 37: Extended Byte Descriptions Size The complete file size. Type/ID First four bits designate file type, 0 for font or 1 for bitmap, remaining 12 bits indicate ID number. Start Page Memory start page, a value of 0 indicates entry is not in use. *Note: ID and Size were changed from Byte and Short lengths respectively at firmware revision 8.1 14.5 Filesystem Upload Dec 254 176 Size Data v8.0 Hex FE B0 Size Data ■ ░ Size Data ASCII This command will upload a filesystem image to the display. The size used is almost always the entire memory. Filesystem data can be uploaded LSB to MSB using the File Transfer Protocol. Size Integer Size of the filesystem to upload. Data Byte(s) Filesystem data to upload. 14.6 Filesystem Download Dec 254 48 Hex FE 30 ASCII ■0 Downloads complete filesystem containing all fonts and bitmaps stored in the display using the File Transfer Protocol. A veritable heap of data. Response Integer Size of the filesystem to download. Byte(s) Filesystem data to download. v8.0 14.7 File Download Dec 254 178 Type ID v8.0 Hex FE B2 Type ID ■ ▓ Type ID ASCII Downloads a single font or bitmap file from the display to the host using the File Transfer Protocol. Type Byte Variable length, see File Types . ID Short Unique identification number of font or bitmap to download, value between 0 and 1023. Response Integer File size. Byte(s) File data. *Note: ID was changed from a Byte length at firmware revision 8.1 Command Summary 43 14.8 File Move Dec 254 180 Old Type Old ID New Type New ID v8.0 Hex FE B4 Old Type Old ID New Type New ID ■ ┤ Old Type Old ID New Type New ID ASCII Used to move a single file and/or alter the type of an existing file. Old ID location must be valid and new ID empty. Old Type Byte Original file type, value between 0 and 1023, see File Types . Old ID Short Original unique file identification number, value between 0 and 1023. New Type Byte New file type, see File Types . New ID Short New unique file identification number. Table 38: File Types Font Bitmap Script 9-Slice 0 1 2 3 *Note: ID was changed from a Byte length at firmware revision 8.1 Animation 4 14.9 XModem Dec 254 219 133 6 48 Size Data v8.1 Filesystem Hex FE DB 85 6 30 Size Data Upload ASCII ■ █ à ACK 0 Size Data Upload a filesystem image to the display using the XModem protocol. The size used is almost always the entire memory. Filesystem data is uploaded LSB to MSB using the XModem Transfer Protocol. Size Integer Size of the filesystem to upload. Data Byte(s) Filesystem data to upload, must be padded to an even multiple of 256 bytes. 14.10 XModem Dec 254 222 133 6 48 v8.3 Filesystem Hex FE DE 85 6 30 Download ASCII ■ ▐ à ACK 0 Downloads the complete filesystem using the XModem Transfer Protocol. A veritable heap of data, transmitted at a decent pace. Response Integer Size of the filesystem to download. Byte(s) Filesystem data to download, an even multiple of 256 bytes. 14.11 XModem File Upload Dec 254 220 133 6 48 File ID Type Size Data v8.3 Hex FE DC 85 6 30 File ID Type Size Data ASCII ■ ▄ à ACK 0 File ID Type Size Data Uploads a single file to the display using the XModem Transfer Protocol. Unlike the standard protocol, there is one XModem upload command for all file types, see File Types for a complete list. File ID Short Unique identification number for the file to upload, value between 0 and 1023. Type Byte Type of file to upload, see File Types . Size Integer Size of the file to upload. Data Byte(s) File data to upload, must be padded to an even multiple of 128 bytes. 44 Command Summary 14.12 XModem File Download Dec 254 221 133 6 48 File ID Type v8.3 Hex FE DD 85 6 30 File ID Type ASCII ■ ▌ à ACK 0 File ID Type Downloads a single file from the display to the host using the XModem Transfer Protocol. File ID Short Unique identification number for the file to download, value between 0 and 1023. Type Byte Type of file to download, see File Types . Response Integer Size of the filesystem to download. Byte(s) Filesystem data to download, an even multiple of 128 bytes, may be padded with 255s. File Transfer 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. As is the case throughout the upload protocol, a response of 1 will indicate confirmation while an 8 corresponds to rejection and will terminate the session. Table 39: Upload Protocol Responses Value 1 8 Action Acknowledged Not Acknowledged Description Transfer successful, upload continues Transfer failed, abort upload Once a file is confirmed to fit within the display, the upload will begin. A protocol is used here to ensure each byte is uploaded successfully. After each byte is sent, the module will echo it back to the host. It should then be checked against the value originally sent before a confirmation byte of 1 is returned. If the transmitted and echoed values do not match the upload should be aborted by sending a value of 8 instead. The upload will continue in this manner as indicated by the examples below which utilize familiar font and bitmap files. Command Summary 45 Table 40: Font Upload Protocol Host 254 36 1 0 31 0 0 0 Display 1 5 5 1 7 ... 96 ... 96 1 Comments Command Prefix Upload Font File Command Reference ID LSB Reference ID MSB Font File Size LSB Font File Size Font File Size Font File MSB Acknowledge Size First Font Data Byte Echo Data Byte Acknowledge Data Byte Second Font Data Byte ... Last Font Data Byte Echo Data Byte Acknowledge Data Byte Table 41: Bitmap Upload Protocol Host 254 94 1 0 5 0 0 0 Display 1 5 5 1 4 ... 224 ... 224 1 Comments Command Prefix Upload Bitmap File Command Reference ID LSB Reference ID MSB Bitmap File Size LSB Bitmap File Size Bitmap File Size Bitmap File MSB Acknowledge Size First Bitmap Data Byte Echo Data Byte Acknowledge Data Byte Second Bitmap Data Byte ... Last Bitmap Data Byte Echo Data Byte Acknowledge Data Byte It should be noted that the display has a timeout setting of 2.1 seconds before it resets to prevent it from hanging during the upload process. Upon reset, the values 254 and 212 will be returned to indicate an error or lengthy delay has occurred in the upload process. If everything goes smoothly, the protocol will end with the host transmitting a final confirmation byte and the font will be stored in the display ready for any application. XModem Transfer 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 and using only a two byte CRC for error checking, greatly increasing throughput. To begin the upload, a series of command bytes are sent, a list of valid file type bytes is show in the File Types table. Once the command bytes are sent, the true size of the file is sent in four bytes, least significant byte first. At this point the display will respond with a C if the file fits or a NAK otherwise. Please note that these values are different than those of the original protocol as seen in the XModem Message Bytes table. 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, followed by a block count, in regular and inverted format, representing the number of 128 byte blocks remaining to be sent. The display will then check to make sure the block count value matches its own, if it doesn’t it will NAK. The host can then send a 128 byte block of data followed by that blocks high and low CRC16 bytes. The display then performs 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. Files may be padded with 255 values to reach an even multiple of 128 bytes in size, but the download command will always report true size. 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. 46 Command Summary Table 42: XModem File Upload Protocol Host 254 220 133 6 48 1 0 1 0 0 1 0 Display 67 1 128 127 30 71 … 4 6 … 6 Table 43: XModem File Download Protocol Comments Command Prefix XModem Upload Command Command Byte One Command Byte Two Command Byte Three File ID LSB File ID MSB File Type Size LSB Size Size Size MSB C (If file fits) Start of Header Block Count Inverted Block Count (255-Count) 128 Byte Data Block *CRC MSB *CRC LSB ACK (NAK if counts don’t match) … End of Transmission ACK (NAK if EOT is not expected) Host 254 221 133 6 48 1 0 1 Display 0 0 1 0 67 1 128 127 30 71 6 … … 4 6 Comments Command Prefix XModem Download Command Command Byte One Command Byte Two Command Byte Three File ID LSB File ID MSB File Type Size LSB (NAK if not found) Size Size Size MSB C Start of Header Block Count Inverted Block Count (255-Count) 128 Byte Data Block *CRC MSB *CRC LSB ACK (NAK if counts don’t match) … End of Transmission ACK (NAK if EOT is not expected) Table 44: XModem Message Bytes Value 1 4 6 21 67 Action Start of Header End of Transmission Acknowledged Not Acknowledged C Description Begin upload transfer End completed upload transfer Transfer successful, upload continues Transfer failed, upload aborted Confirmation that file will fit *Note: CRC bytes are calculated using the XMODEM CRC-CCITT algorithm available at: http://www.matrixorbital.ca/appnotes/XModem/ymodem.txt. Command Summary 47 6.15 Data Security 15.1 Set Remember Dec 254 147 Switch v8.0 Hex FE 93 Switch ASCII ■ ô 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 at least 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 Byte 1 for on or 0 for off. 15.2 Set Data Lock Dec 254 202 245 160 Level v8.0 Hex FE CA F5 A0 Level ASCII ■ ╩ ⌡ á Level Temporarily locks certain aspects of the display to ensure no inadvertent changes are made. The lock is released after a power cycle. A new level overrides the old, and levels can be combined. Default is 0. Level Byte Lock level, see Data Lock Bits table. Table 45: Data Lock Bits Display 7 Command 6 Filesystem 5 Setting 4 Address 3 Reserved 2 Reserved 1 Reserved 0 Table 46: Lock Parameters Reserved Address Setting Filesystem Command Display Place holders only, should be 0 Locks the Baud Rate and I2C address Locks all settings from being saved Locks all bitmaps and fonts Locks all commands, text can still be written Locks entire display, no new text can be displayed 15.3 Set and Save Data Lock Dec 254 203 245 160 Level v8.0 Hex FE CB F5 A0 Level ASCII ■ ╦ ⌡ á Level Locks certain aspects of the display to ensure no inadvertent changes are made. The lock is not affected by a power cycle. A new level overrides the old, and levels can be combined. Default is 0. Level Byte See Data Lock Bits table. 6.16 Miscellaneous 16.1 Write Customer Data Dec 254 52 Data v8.0 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 Byte [16] User defined data. 48 Command Summary 16.2 Read Customer Data Dec 254 53 v8.0 Hex FE 35 ASCII ■5 Reads data previously written to non-volatile memory. Data is only changed when written, surviving power cycles. Response Byte [16] Previously saved user defined data. 16.3 Write to Scratchpad Dec 254 204 Address Length Data Hex FE CC Address Length Data ■ ╠ Address Length Data ASCII Write information to a 256 byte volatile memory bank for later use. Address Short Address where data is to be saved in volatile memory. Value between 0 and 256. Length Short Length of data to be saved, in bytes. Value between 0 and 256, address limited. Data Byte(s) Data to be saved in volatile memory. v8.3 16.4 Read from Scratchpad Dec 254 205 Address Length Hex FE CD Address Length ■ ═ Address Length ASCII Read information previously saved in 256 byte volatile memory bank. Address Short Address where data is saved in volatile memory. Value between 0 and 256. Length Short Length of data to be read, in bytes. Value between 0 and 256, address limited. Response Byte(s) Data saved at the specified location in volatile memory. v8.3 16.5 Read Version Number Dec 254 54 Hex FE 36 ASCII ■6 Causes display to respond with its firmware version number. Test. Response Byte Convert to hexadecimal to view major and minor revision numbers. v8.0 16.6 Read Module Type v8.0 Dec 254 55 Hex FE 37 ASCII ■7 Causes display to respond with its module number. Response Byte Module number, see Sample Module Type Responses for a partial list. Table 47: Sample Module Type Responses 122 123 112 GLT240128 GLT240128-USB GLT240128-422 114 108 111 GLK240128-25 GLK240128-25-USB GLK240128-25-422 Command Summary 49 16.7 Read Screen Dec 254 184 Hex FE B8 ■╕ ASCII Return a two byte screen size, followed by the current commanded state of each pixel on the screen. Response Byte Width of the screen in pixels. Byte Height of the screen in pixels. Byte(s) Boolean values of each pixel on the screen, starting top left moving right then down. 50 Command Summary v8.1 7 Appendix 7.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 48: Communication Command Summary Name Change Baud Rate Change I2C Slave Address Transmission Protocol Select Set a Non-Standard Baud Rate Set Flow Control Mode Set Hardware Flow Control Trigger Level Turn Software Flow Control On Turn Software Flow Control Off Set Software Flow Control Response Echo Delay Software Reset Dec 57 51 160 164 63 62 58 59 60 255 251 253 Hex 39 33 A0 A4 3F 3E 3A 3B 3C FF FB FD ASCII 9 3 á ñ ? > : ; < √ ² Parameters Byte Byte Byte Integer Byte Byte Byte[2] None Byte[2] Short, Byte[] Short Byte[4] Response None None None None None None None None None Byte[] None Byte[2] Remembered Always Always Remember On Always Remember On Remember On Remember On Remember On Remember On Never Never Never Table 49: Text Command Summary Name Clear Screen Go Home Set Cursor Position Set Cursor Coordinate Initialize Text Window Set Text Window Clear Text Window Initialize Label Initialize Scrolling Label Update Label Auto Scroll On Auto Scroll Off Dec 88 72 71 121 43 42 44 45 47 46 81 82 Hex 58 48 47 79 2B 2A 2C 2D 2F 2E 51 52 ASCII X H G y + * , / . Q R Parameters None None Byte[2] Byte[2] Byte[5], Short, Byte[3] Byte Byte Byte[7], Short, Byte{2} Byte[7], Short, Byte[2], Short, Byte Byte, String None None Command Summary Response None None None None None None None None None None None None Remembered Never Never Never Never Remember On Never Never Remember On Remember On Never Remember On Remember On 51 Table 50: Drawing Command Summary Name Set Drawing Colour Draw Pixel Draw a Line Continue a Line Draw a Rectangle Draw a Filled Rectangle Draw a Rounded Rectangle Draw a Filled Rounded Rectangle Draw a Circle Draw a Filled Circle Draw an Ellipse Draw a Filled Ellipse Scroll Screen Initialize a Bar Graph Initialize 9-Slice Bar Graph Draw a Bar Graph Dec 99 112 108 101 114 120 128 129 123 124 125 127 89 103 115 105 Hex 63 70 6C 65 72 78 80 81 7B 7C 7D 7F 59 67 73 69 ASCII c p l e r x Ç ü { | } Initialize a Strip Chart 106 6A n Update a Strip Chart 107 6B o DEL Y g s i Parameters Byte Byte[2] Byte[4] Byte[2] Byte[5] Byte[5] Byte[5] Byte[5] Byte[3] Byte[3] Byte[4] Byte[4] Byte[4], Short[2] Byte[6] Byte[6], Short[2] Byte[2] Byte[5], Short[2], Byte[2], Short Byte, Short Response None None None None None None None None None None None None None None None None Remembered Remember On Never Never Never Never Never Never Never Never Never Never Never Never Remember On Remember On Never None Remember On None Never Table 51: Font Command Summary Name Upload a Font File Set the Current Font Set Font Metrics Set Box Space Mode Dec 36 49 50 172 Hex 24 31 32 AC ASCII $ 1 2 ¼ Parameters Short, Integer, Byte[] Short Byte[5] Byte Response See Font File Creation None None None Remembered Always Never Remember On Remember On Table 52: Bitmap Command Summary 52 Name Dec Hex ASCII Parameters Upload a Bitmap File 94 5E ^ Short, Integer, Byte[] Upload a Bitmap Mask 92 5 5C 05 \ ENQ Short, Integer, Byte[] Draw a Bitmap from Memory Draw a Partial Bitmap Draw a Bitmap Directly 98 192 100 62 C0 64 b └ d Short, Byte[2] Short, Byte[6] Byte[2], Byte[] Command Summary Response See Bitmap File Creation See Bitmap File Creation None None None Remembered Always Always Never Never Never Table 53: 9-Slice Command Summary Name Dec Hex ASCII Parameters Upload a 9-Slice File 92 3 5C 03 \ ETX Short, Integer, Byte[] Upload a 9-Slice Mask 92 6 5C 06 \ ACK Short, Integer, Byte[] Display a 9-Slice 91 5B [ Short, Byte[4] Response See 9-Slice File Creation See 9-Slice File Creation None Remembered Always Always Never Table 54: Animation Command Summary Name Dec Hex ASCII Parameters Upload an Animation File 92 4 5C 04 \ EOT Short, Integer, Byte[] Display Animation Delete Animation Start/Stop Animation Set Animation Frame Get Animation Frame 193 199 194 197 196 C1 C7 C2 C5 C4 ┴ ╟ ┬ ┼ ─ Byte[4], Byte[] Byte Byte[2] Byte[2] Byte Response See Animation File Creation None None None None Byte Remembered Always Never Always Never Never Never Table 55: General Purpose Output Command Summary Name General Purpose Output On General Purpose Output Off Set Start Up GPO State Dec 86 87 195 Hex 56 57 C3 ASCII V W ├ Parameters Byte Byte Byte[2] Response None None None Remembered Never Never Always Table 56: Piezo Buzzer Command Summary Name Activate Piezo Buzzer Set Default Buzzer Beep Set Keypad Buzzer Beep Set Touch Buzzer Beep Dec 187 188 182 182 Hex BB BC B6 B6 ASCII ╗ ╝ ╢ ╢ Parameters Short[2] Short[2] Short[2] Short[2] Command Summary Response None None None None Remembered Never Remember On Remember On Remember On 53 Table 57: Keypad Command Summary Name Auto Transmit Key Presses On Auto Transmit Key Presses Off Poll Key Press Clear Key Buffer Set Debounce Time Auto Repeat Mode Off Assign Keypad Codes Set Typematic Delay Set Typematic Interval Dec 65 79 38 69 85 96 213 159 158 Hex 41 4F 26 45 55 60 D5 9F 9E ASCII A ` & E U ` ╒ ƒ ₧ Parameters None None None None Byte None Byte[25], Byte[25] Byte Byte Response None None Byte None None None None None None Remembered Remember On Remember On Never Never Remember On Remember On Always Remember On Remember On Table 58: Touchpad Command Summary Name Set Touch Mode Set Region Reporting Mode Set Touch Region Delete a Touch Region Delete All Touch Regions Create a Slider Delete a Slider Delete All Sliders Set Dragging Threshold Set Pressure Threshold Run Touchpad Calibration Dec 135 136 132 133 134 186 189 190 137 138 139 Hex 87 88 84 85 86 BA BD BE 89 8A 8B ASCII ç ê ä à ║ ╝ ╜ ╛ ë è ï Parameters Byte Byte Byte[7] Byte None Byte[7], Short[2] Byte None Byte Short None Response None None None None None None None None None None Byte[2] Remembered Remember On Remember On Remember On Remember On Remember On Remember On Always Always Remember On Remember On Always Table 59: Display Functions Command Summary Name Backlight On Backlight Off Set Brightness Set and Save Brightness Set Contrast Set and Save Contrast Dec 66 70 153 152 80 145 Hex 42 46 99 98 50 91 ASCII B F Ö ÿ P æ Parameters Byte None Byte Byte Byte Byte Response None None None None None None Remembered Remember On Remember On Remember On Always Remember On Always Table 60: Scripting Functions Command Summary Name Upload a Script File Set Scripted Button Set Scripted Key Run Script File 54 Dec 92 2 142 141 93 Hex 5C 02 8E 8D 5D ASCII \ STX Ä ì ] Parameters Short, Integer, Byte[] Byte[3], Short[2], Byte, Short[2] Byte[3], Short[2] Short Command Summary Response None None None None Remembered Always Remember On Remember On Never Table 61: Filesystem Command Summary Name Delete Filesystem Delete a File Get Filesystem Space Get Filesystem Directory Filesystem Upload Filesystem Download File Download Dec 33, 89, 33 173 175 179 176 48 178 Hex 21, 59, 21 AD AF B3 B0 30 B2 ASCII !, Y, ! ¡ » │ ░ 0 ▓ File Move 180 B4 ┤ XModem Filesystem Upload XModem Filesystem Download 219, 133, 6, 48 222, 133, 6, 48 220, 133, 6, 48 221, 133, 6, 48 DB, 85, 6, 30 DE, 85, 6, 30 DC, 85, 6, 30 DD, 85, 6, 30 █, à, ACK, 0 ▐, à, ACK, 0 ▄, à, ACK, 0 ▌, à, ACK, 0 XModem File Upload XModem File Download Parameters None Byte, Short None None Integer, Byte[] None Byte, Short Byte, Integer, Byte, Integer Short, Byte, Integer, Byte[] Response None None Integer Byte[][8] None Integer, Byte[] Integer, Byte[] Remembered Always Always Never Never Always Never Never None Always None Always None Integer, Byte[] Never Short, Byte, Integer, Byte[] None Always Short, Byte Integer, Byte[] Never Table 62: Data Security Command Summary Name Set Remember Set Data Lock Set and Save Data Lock Dec 147 202, 245, 160 203, 245, 160 Hex 93 CA, F5, A0 CB, F5, A0 ASCII ô ╩, ⌡, á ╦, ⌡, á Parameters Byte Byte Byte Response None None None Remembered Always Remember On Always Table 63: Miscellaneous Command Summary Name Write Customer Data Read Customer Data Read Version Number Read Module Type Read Screen Write to Scratchpad Read from Scratchpad Dec 52 53 54 55 184 204 205 Hex 34 35 36 37 B8 CC CD ASCII 4 5 6 7 ╕ ╠ ═ Parameters Byte[16] None None None None Byte, Short, Byte[] Byte, Short Command Summary Response None Byte[16] Byte Byte Byte, Byte, Byte[] None Byte[] Remembered Always Never Never Never Never Never Never 55 7.1 Block Diagram Figure 20: Functional Diagram 7.2 Environmental Specifications Table 64: Environmental Limits Operating Temperature Storage Temperature Operating Relative Humidity Standard *Extended (-E) 0°C to +50°C -20°C to +70°C -10°C to +60°C -30°C to +80°C Maximum 90% non-condensing *Note: The Extended Temperature option is not available for any variant of the GLT240128. 7.3 Electrical Tolerances Current Consumption Table 65: Current Consumption Board 150mA + Backlight 80 to 265 mA + GPOs 20mA each maximum Table 66: Backlight Current Draw YG 265mA GW & WB 80mA Input Voltage Specifications Table 67: Voltage Specifications Standard 4.75-5.25V 56 Extended Wide Voltage (-VPT) 9.0-35.0V Command Summary 7.4 Dimensional Drawings Figure 21: Display Dimensional Drawing Figure 22: Standard Model Dimensional Drawing Command Summary 57 Figure 23: USB Model Dimensional Drawing Figure 24: RS422 Model Dimensional Drawing 58 Command Summary 7.1 Optical Characteristics Table 68: Display Optics Module Size 144.00 x 104.00 x 27.8 mm Viewing Area 114.0 x 64.0 mm Active Area 107.95 x 57.55 mm Pixel Size 0.40 x 0.40 mm Pixel Pitch 0.45 x 0.45 mm Viewing Direction 12 O’clock Viewing Angle -30 to +30 ° Contrast Ratio 3 Backlight Half-Life (YG) 50,000 Hours Backlight Half-Life (WB & GW) 20,000 Hours *Note: Backlight half-life is rated for normal operating conditions only: 25±10°C and 45±20% Relative Humidity. 8 Ordering 8.1 Part Numbering Scheme Table 69: Part Numbering Scheme GLT 1 -240128 2 3 -422 4 -WB 5 -VPT 6 -E 7 8.2 Options Table 70: Display Options # Designator 1 Product Type 2 Display Size 3 Keypad Size 4 Protocol 5 Colour 6 Voltage 7 Temperature Options GLK: Graphic Liquid Crystal Display with Keypad Input GLT: Graphic Liquid Crystal Display with Touchpad Input 240128: 240 pixel columns by 128 rows *NP: No keypad 25: 25 key maximum *NP: Standard Model -USB: USB Only Model **-422: RS422 Only Model *NP: Black Text with Yellow-Green Background FGW: Black Text with Grey-White Background WB: White Text with Blue Background *NP: Standard Voltage -VPT: Wide Voltage with Efficient Switching Power Supply *NP: Standard ***-E: Extended Temperature *Note: NP means No Populate; skip this designator in the part number and move to the next option. **Note: The RS422 model should only be powered from a local source, unless the –VPT variant is used. ***Note: Extended Temperature is available for keypad input units only; -E is not available for GLT models. Command Summary 59 8.3 Accessories Power Table 71: Power Accessories PCS Standard Power Cable Communication Table 72: Communication Accessories 60 CSS1FT 1 ft. Serial Cable CSS4FT 4 ft. Serial Cable EXTMUSB3FT Mini-USB Cable INTMUSB3FT Internal Mini-USB Cable ESCCPC5V Extended Serial Communication/5V Power Cable BBC Breadboard Cable Command Summary Peripherals Table 73: Peripheral Accessories KPP4x4 16 Button Keypad Command Summary 61 9 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. Byte: An unsigned data packet that is eight bits long. 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: A base 16 number system utilizing symbols 0 through F to represent the values 0-15. I2C: Inter-integrated circuit protocol uses clock and data lines to communicate short distances at slow speeds from a master to up to 128 addressable slave devices. A display is a slave device. Integer: An unsigned data packet that is thirty-two bits long, in little Endian format. LSB: Least significant bit or byte in a transmission, the rightmost when read. MSB: Most significant bit or byte in a transmission, the leftmost when read. RS232: Recommended standard 232, a common serial protocol. A low level is -30V, a high is +30V. RS422: Recommended standard 422, a more robust differential pair serial protocol. SDA: Serial data line used to transfer data in I2C protocol. This open drain line should be pulled high through a resistor. Nominal values are between 1K and 10K Ω. SCL: Serial clock line used to designate data bits in I2C protocol. This open drain line should be pulled high through a resistor. Nominal values are between 1K and 10K Ω. Short: An unsigned data packet that is sixteen bits long, in little Endian format. STN: Super-twisted nematic in reference to an LCD. In a relaxed or nematic state, crystals orientate themselves in the same direction and allow light to pass. In an excited state these crystals align to block light. Super-twisted crystals move from 180 to 270 degrees providing greater contrast than TN models. TTL: Transistor-transistor logic applied to serial protocol. Low level is 0V while high logic is 5V. 10 Contact Sales Support Online Phone: 403.229.2737 Phone: 403.204.3750 Purchasing: www.matrixorbital.com Email: sales@matrixorbital.ca Email: support@matrixorbital.ca Support: www.matrixorbital.ca 62 Command Summary