30058

LK204-25 Technical Manual Revision: 2.0 Contents Contents 1 Getting Started 1.1 Display Options Available 1.2 Accessories . . . . . . . . 1.3 Features . . . . . . . . . . 1.4 Connecting to a PC . . . . 1.5 Installing the Software . . 1.5.1 uProject . . . . . . ii . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1 2 6 7 8 8 2 Hardware Information 2.1 DB-9 Connector . . . . . . . . . . . . 2.1.1 Power Through DB-9 Jumper 2.2 Power/Data Connector . . . . . . . . 2.3 Protocol Select Jumpers . . . . . . . . 2.4 General Purpose Outputs . . . . . . . 2.5 Dallas 1-Wire Bridge . . . . . . . . . 2.6 Manual Override . . . . . . . . . . . 2.7 Keypad Interface Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 9 10 10 11 12 13 13 14 3 Troubleshooting 3.1 The display does not turn on when power is applied. . . . . . . . . . . . . . . . . . . . . . . 3.2 The display module is not communicating. . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.3 The display module is communicating, however text cannot be displayed. . . . . . . . . . . 15 15 16 16 4 Communications 4.1 Introduction . . . . . . . . . . . . 4.1.1 I2 C Communication . . . 4.1.2 Serial Communication . . 4.2 Changing the I2 C Slave Address . 4.3 Changing the Baud Rate . . . . . 4.4 Setting a Non-Standard Baud Rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 16 16 17 17 18 18 5 Text 5.1 Introduction . . . . . . . . . 5.1.1 Character Set . . . . 5.1.2 Control Characters . 5.2 Auto Scroll On . . . . . . . 5.3 Auto Scroll Off . . . . . . . 5.4 Clear Screen . . . . . . . . . 5.5 Changing the Startup Screen 5.6 Set Auto Line Wrap On . . . 5.7 Set Auto Line Wrap Off . . . 5.8 Set Cursor Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 20 20 21 21 21 21 22 22 23 23 Matrix Orbital . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . LK204-25 ii 5.9 5.10 5.11 5.12 5.13 5.14 5.15 Go Home . . . . . . . . . Move Cursor Back . . . . Move Cursor Forward . . . Underline Cursor On . . . Underline Cursor Off . . . Blinking Block Cursor On Blinking Block Cursor Off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 24 24 25 25 25 25 6 Special Characters 6.1 Introduction . . . . . . . . . . . . . . . 6.2 Creating a Custom Character . . . . . . 6.3 Saving Custom Characters . . . . . . . 6.4 Loading Custom Characters . . . . . . 6.5 Save Startup Screen Custom Characters 6.6 Initialize Medium Number . . . . . . . 6.7 Place Medium Numbers . . . . . . . . 6.8 Initialize Large Numbers . . . . . . . . 6.9 Place Large Number . . . . . . . . . . 6.10 Initialize Horizontal Bar . . . . . . . . 6.11 Place Horizontal Bar Graph . . . . . . . 6.12 Initialize Narrow Vertical Bar . . . . . . 6.13 Initialize Wide Vertical Bar . . . . . . . 6.14 Place Vertical Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 26 26 27 28 28 29 29 30 30 31 31 32 32 32 7 General Purpose Output 7.1 Introduction . . . . . . . . . 7.2 General Purpose Output Off 7.3 General Purpose Output On . 7.4 Set Startup GPO state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 33 33 34 34 8 Dallas 1-Wire 8.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8.2 Search for a 1-Wire Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8.3 Dallas 1-Wire Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 35 35 36 9 Keypad 9.1 Introduction . . . . . . . . . . 9.2 Auto Transmit Key Presses On 9.3 Auto Transmit Key Presses Off 9.4 Poll Key Press . . . . . . . . . 9.5 Clear Key Buffer . . . . . . . 9.6 Set Debounce Time . . . . . . 9.7 Set Auto Repeat Mode . . . . 9.8 Auto Repeat Mode Off . . . . 9.9 Assign Keypad Codes . . . . . 37 37 38 38 38 39 39 40 41 41 Matrix Orbital . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . LK204-25 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii 10 Display Functions 10.1 Introduction . . . . . . . 10.2 Display On . . . . . . . 10.3 Display Off . . . . . . . 10.4 Set Brightness . . . . . . 10.5 Set and Save Brightness . 10.6 Set Contrast . . . . . . . 10.7 Set and Save Contrast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 42 42 43 43 43 44 44 11 Data Security 11.1 Introduction . . . . . . 11.2 Set Remember . . . . . 11.3 Data Lock . . . . . . . 11.4 Set and Save Data Lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 45 45 46 47 12 Miscellaneous 12.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12.2 Read Version Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12.3 Read Module Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 48 48 49 13 Command Summary 13.1 Communications . . . . 13.2 Text . . . . . . . . . . . 13.3 Special Characters . . . 13.4 General Purpose Output . 13.5 Dallas 1-Wire . . . . . . 13.6 Keypad . . . . . . . . . 13.7 Display Functions . . . . 13.8 Data Security . . . . . . 13.9 Miscellaneous . . . . . . 13.10Command By Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 49 50 51 52 53 53 54 55 55 55 14 Appendix 14.1 Specifications . . . . . . . 14.1.1 Environmental . . 14.1.2 Electrical . . . . . 14.2 Optical Characteristics . . 14.3 Physical Layout . . . . . . 14.4 Definitions . . . . . . . . . 14.5 Contacting Matrix Orbital . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 57 57 57 58 59 60 60 Matrix Orbital LK204-25 iv 1 Getting Started The LK204-25 is an intelligent LCD display designed to decrease development time by providing an instant solution to any project. With the ability to communicate via serial RS-232/TTL and I2 C protocols, the versatile LK204-25 can be used with virtually any controller. The ease of use is further enhanced by an intuitive command structure to allow display settings such as backlight brightness, contrast and baud rate to be software controlled. Additionally, up to thirty-two custom charaters such as character sets for bar graphs, medium and large numbers may be stored in the non-volitile memory to be easily recalled and displayed at any time. 1.1 Display Options Available The LK204-25 comes in a wide variety of colors including the standard yellow/green or inverse yellow, the popular blue/white and the crisp white/grey as well as inverse red which is excellent for viewing at night. Extended voltage, and temperature options are also available, to allow you to select the display which will best fit your project needs. Figure 1: LK204-25 Options Matrix Orbital LK204-25 1 1.2 Accessories NOTE Matrix Orbital provides all the interface accessories needed to get your display up and running. You will find these accessories and others on our e-commerce website at http://www.matrixorbital.com. To contact a sales associate see Section 14.5 on page 60 for contact information. Figure 2: 5V Power Cable Adapter Figure 3: 12V Power Cable Adapter (V/VPT Models) Matrix Orbital LK204-25 2 Figure 4: Breadboard Cable Figure 5: Serial Cable 4FT Matrix Orbital LK204-25 3 Figure 6: Communication and 5V Power Cable Figure 7: Aluminum Mountings Matrix Orbital LK204-25 4 Figure 8: Keypad Mountings Figure 9: Mounting Kits Matrix Orbital LK204-25 5 Figure 10: 4X4 Keypad 1.3 Features • • • • • • • • • • • • • • • • • • 20 column by 4 line alphanumeric liquid crystal display Selectable communication protocol, RS-232 or I2 C One-wire interface Six, 5V -20mA, general purpose outputs for a variety of applications Lightning fast communication speeds, up to 57.6 kbps for RS-232 and 400 kbps for I2 C Default 19.2 kbps serial communication speed Extended temperature available for extreme environments of -20C to 70C Extended voltage and efficient power supply available Built in font with provision for up to 8 user defined characters Use of up to 127 modules on the same 2 wire I2 C interface 1-wire bus that is capable of communicating with up to 32 devices over a single bus Fully buffered so that no delays in transmission are ever necessary Ability to add a customized splash / startup screen Software controlled contrast and brightness with configurable time-out setting up to 90 minutes Use of up to a 25 key keypad with a 10 key buffer Horizontal or vertical bar graphs Extended temperature option Fits Matrix Orbital’s mountings without any modifications Matrix Orbital LK204-25 6 1.4 Connecting to a PC The LK204-25 connects seamlessly to a PC and it is an excellent means of testing the functionality. To connect your display to a PC, you will require a standard RS-232 9-pin serial cable such as the one pictured in figure 5 on page 3, as well as a modified 5V power adapter such as the one pictured in figure 2 on page 2. In order to connect your display to a personal computer follow these easy instructions: 1. Plug the serial cable into the com port you wish to use. 2. Connect the modified 5V power adapter to a power lead from your PC power supply (you will have to open your computer case). 3. Connect the serial cable to the DB-9 connector on the back of the display. 4. Connect the 5V power adapter to the 4-pin connector on the back of the display. WARNING DO NOT use the standard floppy drive power connector, as this will not provide you with the correct voltage and will damage the display module. Figure 11: PC vs Matrix Orbital Display Module Wiring Matrix Orbital LK204-25 7 1.5 Installing the Software 1.5.1 uProject uProject was designed by Matrix Orbital to provide a simple and easy to use interface that will allow you to test all of the features of our alpha numeric displays. To install uProject from the Matrix Orbital CD, follow the following steps: 1. 2. 3. 4. Insert the Matrix Orbital CD-ROM into the CD drive Locate the file, uProject.exe, which should be in the “CD-drive:\Download” directory. Copy uProject.exe to a directory that you wish to run it from. Double click on "uProject.exe" Be sure to check the information selected in the COM Setup the first time uProject is run. Once this information is entered correctly the program can be used to control all functions of the graphic display. Comport The serial port the display is plugged in to. Baudrate The communication speed the display module is set to. (Default 19,200) Figure 12: uProject Settings NOTES • uProject and other alphanumeric software may also be downloaded from Matrix Orbital’s support site at http://www.matrixorbital.ca/software/software_alpha/ Matrix Orbital LK204-25 8 2 Hardware Information Refer to the following diagram for this chapter: 1 DB-9 Connector 2 Power Through DB9 Jumper 3 GPOs 4 Manual Override 5 Power / Data Connector 6 Keypad Interface 7 Protocol Select Jumpers 8 Dallas 1-Wire Bridge Figure 13: LK204-25 2.1 DB-9 Connector The LK204-25 provides a DB-9 Connector to readily interface with serial devices which use the EIA232 standard signal levels of ±12V to ±12V. 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. However, in order to accomplish this you must set the Power Through DB-9 Jumper. Matrix Orbital LK204-25 9 Pin 2 Pin 3 Pin 5 Pin 9 Rx \ SCL (I2 C clock) Tx \ SDA (I2 C data) GND PWR (Must solder Power Through DB9 Jumper. See table 1 on the next page for power requirements.) Figure 14: RS-232 Pin out 2.1.1 Power Through DB-9 Jumper In order to provide power through pin 9 of the DB-9 Connector you must place a solder jumper on the Power through DB-9 Jumper pictured in figure 15 below. The LK204-25 allows all voltage models to use the power through DB-9 option, see table 1 on the following page for display module voltage requirements. Figure 15: Power Through DB-9 Jumper WARNING Do not apply voltage through pin 9 of the DB-9 connector AND through the Power/Data Connector at the same time. 2.2 Power/Data Connector The Power/Data Connector provides a standard connector for powering the display module. The LK20425 requires five volts for the standard display module, between nine to fifteen for the wide voltage (V) and between nine to thirty-five volts for the wide voltage with efficient power supply module (VPT). The voltage is applied through pins one and four of the four pin Power/Data connector. Pins two and three are reserved for serial transmission, using either the RS-232/TTL or the I2 C protocol, depending on what has been selected by the Protocol Select Jumpers. Pins two and three may be reversed by changing the Legacy Matrix Orbital LK204-25 10 Connector Jumpers in order to be compatible with previous PCB revisions. Pin 1 Pin 2 Pin 3 Pin 4 PWR (See table 1) Rx \ SCL (I2 C clock) Tx \ SDA (I2 C data) GND Figure 16: Power Connector and Pin out Table 1: Power Requirements Supply Voltage Backlight On Backlight Off Supply Standard +5Vdc ±0.25V -V +9V to +15V 110 mA typical 40 mA -VPT +9V to +35V WARNINGS • Do not apply any power with reversed polarization. • Do not apply any voltage other than the specified voltage. 2.3 Protocol Select Jumpers The Protocol Select Jumpers, pictured below in figure 17, provide the means necessary to toggle the display module between RS-232, TTL and I2 C protocols. As a default, the jumpers are set to RS-232 mode with solder jumps on the 232 jumpers. In order to place the display module in I2 C mode you must first remove the solder jumps from the 232 jumpers and then place them on the I2C jumpers. The display will now be in I2 C mode and have a default slave address of 0x50 unless it has been changed. Similarly, in order to change the display to TTL mode, simply remove the zero ohm resistors from the 232 or I2 C jumpers and solder them to the TTL jumpers. Matrix Orbital LK204-25 11 Figure 17: Protocol Select Jumpers 2.4 General Purpose Outputs A unique feature of the LK204-25 is the ability to control relays and other external devices using a General Purpose Output, which can provide up to 20 mA of current and +5Vdc from the positive side of the GPO. This is limited by a 240 ohm resistor which is located to the above right of the GPOs as pictured below in figure 21. If the device, which is being driven by a GPO, requires a relatively high current (such as a relay) and has an internal resistance of its own greater than 250 ohms, then the 240 ohm resistor may be removed and replaced with a Jumper. - GND + MAX: 20 mA, +5Vdc Figure 18: General Purpose Output WARNING 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. Matrix Orbital LK204-25 12 2.5 Dallas 1-Wire Bridge In addition to the six general purpose outputs the LK204-25 offers a Dallas 1-wire bridge, to allow for an aditional thirty two 1-wire devices to be connected to the display. See Section 8.1 on page 35. Figure 19: Dallas 1-Wire Bridge 2.6 Manual Override The Manual Override is provided to allow the LK204-25 to be reset to factory defaults. This can be particularly helpful if the display module has been set to an unknown baud rate or I2 C Slave Address and you are no longer able to communicate with it. If you wish to return the module to its default settings you must: 1. Power off the display module. 2. Place a Jumper on the Manual Override pins. 3. Power up the display module. 4. The display module is now set to its default values listed below in table 2. 5. Edit and save settings. Matrix Orbital LK204-25 13 Figure 20: Manual Override Jumper Table 2: Default Values Brightness Baud Rate I2 C Slave Address Data Lock RS232AutoTransmitData 255 19.2 kbps 0x50 False True NOTE The display module will revert back to the old settings once turned off, unless the settings are saved. 2.7 Keypad Interface Connector The LK204-25 provides a Keypad Interface Connector which allows for up to a five by five matrix style keypad to be directly connected to the display module. Key presses are generated when a short is detected between a row and a column. When a key press is generated a character, which is associated with the particular key press, is automatically sent on the Tx communication line. If the display module is running in I2 C mode, the “Auto Transmit Keypress” function may be turned off, to allow the key presses to remain Matrix Orbital LK204-25 14 in the buffer so that they may be polled. The character that is associated with each key press may also be altered using the “Assign Key Codes” command, for more detailed information see the Keypad Section, on page 37. Figure 21: Keypad Interface Connector NOTE The Ground / +5V pin is toggled by the jumper to the right of the keypad connector. Jump 1 & 2 for +5V or 2 & 3 for GND. 3 Troubleshooting 3.1 The display does not turn on when power is applied. • First, you will want to make sure that you are using the correct power connector. Standard floppy drive power cables from your PC power supply may fit on the Power/Data Connector however they do not have the correct pin out as can be seen in figure 11 on page 7. Matrix Orbital supplies power cable adapters for connecting to a PC, which can be found in the Accessories Section on page 2. • The next step is to check the power cable which you are using for continuity. If you don’t have an ohm meter, try using a different power cable, if this does not help try using a different power supply. • The last step will be to check the Power / Data Connector on the LK204-25. If the Power / Data Connector has become loose, or you are unable to resolve the issue, please contact Matrix Orbital, Matrix Orbital LK204-25 15 see 14.5 on page 60 for contact information. 3.2 The display module is not communicating. • First, check the communication cable for continuity. If you don’t have an ohm meter, try using a different communication cable. If you are using a PC try using a different Com Port. • Second, please ensure that the display module is set to communicate on the protocol that you are using, by checking the Protocol Select Jumpers. To change the protocol used by the display module see Section 2.3 on page 11. • Third, ensure that the host system and display module are both communicating on the same baud rate. The default baud rate for the display module is 19200 bps. • If you are communicating to the display via I2 C please ensure that the data is being sent to the correct address. The default slave address for the display module is 0x50. NOTE I2 C communication will always require pull up resistors. • Finally, you may reset the display to it’s default settings using the Manual Override Jumper, see Section 2.6 on page 13. 3.3 The display module is communicating, however text cannot be displayed. • A common cause may be that the contrast settings have been set to low. The solution to this problem is to adjust the contrast settings. The default setting that will work in most environments is 128. NOTE Optimal contrast settings may vary according to factors such as temperature, viewing angle and lighting conditions. If you are unable to resolve any issue please contact Matrix Orbital. See 14.5 on page 60 for contact information. 4 Communications 4.1 Introduction The commands listed in this chapter describe how to configure data flow on the RS232/TTL and I2 C port. 4.1.1 I2 C Communication The LK204-25 is capable of communicating at 400 Kbps in I2 C mode, with 127 units addressable on a single I2 C communication line. However, in order to communicate via I2 C you must first set the Protocol Matrix Orbital LK204-25 16 Select Jumpers as can be seen in Section 2.3 and ensure that pull up resistors, with a nominal value of 1K to 10K, are placed on the SCL SDA communication lines coming from pins two and three of the Data / Power Connector respectively. The LK204-25 uses 8-bit addressing, with the 8th bit designated as the read write bit, a 0 designates a write address and a 1 designates a read address. The default read address of the display module will be 0x51, whereas the write address is 0x50 by default, to change the I2 C address see section 8.2.1. When communicating in I2 C the LK204-25 will send an ACK on the 9th clock cycle when addressed. When writing to the display module, the display will respond with a ACK when the write has successfully been completed. However if the buffer has been filled, or the module is too busy processing data it will respond with a NAK. When performing a multiple byte read within one I2 C transaction, each byte read from the slave should be followed by an ACK to indicate that the master still needs data, and a NAK to indicate that the transmission is over. 4.1.2 Serial Communication In addition to being able to communicate via I2 C the LK204-25 communicates natively through the RS232 protocol at a default baud rate of 19,200 bps and is capable of standard baud rates from 1200 to 57600 bps. Furthmore the LK204-25 is also capable of reproducing any non-standard baud rate in between using values entered into our baud rate generation algorithm and set through command 164 (0xA4). The display module communicates at standard voltage levels of ±12V to ±12V or at TTL levels of 0 to +5V by setting the Protocol Select Jumpers to TTL. 4.2 Changing the I2 C Slave Address Syntax Hexadecimal Decimal ASCII Parameters Parameter adr Description 0xFE 0x33 [adr] 254 51 [adr] 254 “3” [adr] Length 1 Description The new I2 C write address (0x00 0xFF). This command sets the I2 C write address of the module between 0x00 and 0xFF. The I2 C write address must be an even number and the read address is automatically set to one higher. For example if the I2 C write address is set to 0x50, then the read address is 0x51. NOTE The change in address is immediate. Remembered Matrix Orbital Always LK204-25 17 Factory Default 0x50 4.3 Changing the Baud Rate Syntax Hexadecimal Decimal ASCII Parameters Parameter speed Description 0xFE 0x39 [speed] 254 57 [speed] 254 “9” [speed] Length 1 Description Hex value corrisponding to a baud rate. This command sets the RS-232 port to the specified [speed]. The change takes place immediately. [speed] is a single byte specifying the desired port speed. Valid speeds are shown in the table below. The display module can be manually reset to 19,200 baud in the event of an error during transmission, including transmitting a value not listed below, by setting the manual override jumper during power up. However, it should be noted that this command will be ignored until the manual override jumper is removed again. Hex Value 53 29 CF 67 33 22 19 10 Remembered Always Factory Default 19,200 bps Baud Rate 1200 2400 4800 9600 19200 28800 38400 57600 4.4 Setting a Non-Standard Baud Rate Matrix Orbital LK204-25 18 Syntax Hexadecimal Decimal Parameters Parameter speed 0xFE 0xA4 [speed] 254 164 [speed] Length 2 Description Inputed LSB MSB from baud rate formula (12-2047). Description This command sets the RS-232 port to a non-standard baud rate. The command accepts a two byte parameter that goes directly into the modCrystalSpeed ules baud generator. Use the formula, speed = 8×DesiredBaud − 1 to calculate the [speed] for any baud rate setting. The speed can be anywhere from 12 to 2047 which corresponds to a baud range of 977 to 153,800 baud. Setting the baud rate out of this range could cause the display to stop working properly and require the Manual Override jumper to be set. Remembered Always Examples Crystal Speed 8 Mhz speed = crystalspeed −1 8 ∗ DesiredBaud speed = 74.07 − 1 speed = 8, 000, 000 −1 8 ∗ 13, 500 speed = 73.07 • LSB = 0x4A (rounded) • MSB = 0x00 • Inteded Baud Rate: 13,500 baud Actual Baud Rate: 8,000,000 =13,675 Percent Difference: 1.8% 8(73+1) NOTES • Results from the formula are rounded down to the nearest whole number (73.07 = 73). • This formula becomes less acurate as baud rates increase, due to rounding. • Place the speed result backwards into the formula to receive the actual baud rate. (Baud = CrystalSpeed 8(speed+1) ) • The actual baud rate must be within 3% of the intended baud rate for the device to communicate. Matrix Orbital LK204-25 19 5 Text 5.1 Introduction The LK204-25 is an intelligent display module, designed to reduce the amount of code necessary to begin displaying data. This means that it is able to display all characters and strings that are sent to it, which are defined in the current character set. The display module will begin displaying text at the top left corner of the display area, known as home, and continue to print to the display as if it was a page on a typewriter. When the text reaches the bottom right row, it is able to automatically scroll all of the lines up and continue to display text, with the auto scroll option set to on. 5.1.1 Character Set Figure 22: Character Set Matrix Orbital LK204-25 20 5.1.2 Control Characters 0x08 Backspace 0x0C Clear screen / New page 0x0D Carriage return 0x0A Line feed / New line 5.2 Auto Scroll On Syntax Hexadecimal Decimal ASCII 0xFE 0x51 254 81 254 “Q” Description When auto scrolling is on, it causes the display to shift the entire display’s contents up to make room for a new line of text when the text reaches the end of the last row. Remembered Yes Factory Default On 5.3 Auto Scroll Off Syntax Hexadecimal Decimal ASCII 0xFE 0x52 254 82 254 “R” Description When auto scrolling is disabled the text will wrap to the top left corner of the display area when the text reaches the end of last row. Remembered Yes 5.4 Clear Screen Matrix Orbital LK204-25 21 Syntax Hexadecimal Decimal ASCII 0xFE 0x58 254 88 254 “X” Description This command will immediately clear all of the contents of the display. Remembered No 5.5 Changing the Startup Screen Syntax Hexadecimal Decimal ASCII Parameters Parameter chars 0xFE 0x40 [chars] 254 64 [chars] 254 “@” [chars] Length 80 Description Characters to display for the startup screen. Description In order to change the text that is displayed by the LK204-25 when it starts up simply send the command bytes 254 64 followed by the characters that you wish to display, starting from the top left. This command will automatically line wrap the characters that are sent to it. Remembered Yes 5.6 Set Auto Line Wrap On Syntax Description Hexadecimal Decimal ASCII 0xFE 0x43 254 67 254 “C” Enabling Auto Line Wrap will allow the cursor to automatically wrap over to the next line when the current line is full. NOTE Line wraps may occur in the middle of a word. Matrix Orbital LK204-25 22 Remembered Yes 5.7 Set Auto Line Wrap Off Syntax Description Hexadecimal Decimal ASCII 0xFE 0x44 254 68 254 “D” Disabling Auto Line Wrap will allow you to have full control over the cursor position. This means that once the cursor has advanced to the end of a line, it will not wrap over to the next line, unless given the ’Set Cursor Position’ Command. NOTE All characters written to the display past the end of a line will be lost. Remembered Yes 5.8 Set Cursor Position Syntax Hexadecimal Decimal ASCII Parameters Parameter col row Description 0xFE 0x47 [col] [row] 254 71 [col] [row] 254 “G” [col] [row] Length 1 1 Description Column Row This command will allow you to manually set the cursor position, which controls the text insertion point, by specifying the [col] and [row] of the new proposed cursor position. NOTE If the cursor position is set past the end of a line it will wrap to the beginning of the next line. Remembered Matrix Orbital No LK204-25 23 5.9 Go Home Syntax Hexadecimal Decimal ASCII 0xFE 0x48 254 72 254 “H” Description This command will return the cursor to the top left corner of the display area, identified as row one, column one. Remembered No 5.10 Move Cursor Back Syntax Hexadecimal Decimal ASCII 0xFE 0x4C 254 76 254 “L” Description This command will move the cursor back one space. If this command is sent when the cursor is at the home position the cursor will wrap to the last row / column position if line wrap is on. Sending this command will not effect the text displayed on the module, however any characters that are sent will over write the current characters that are being displayed. Remembered No 5.11 Move Cursor Forward Syntax Hexadecimal Decimal ASCII 0xFE 0x4D 254 77 254 “M” Description This command will move the cursor forward one space. If this command is sent when the cursor is at the bottom right position the cursor will wrap back to the home position if line wrap is on. Sending this command will not effect the text displayed on the module, however any characters that are sent will over write the current characters that are being displayed. Remembered No Matrix Orbital LK204-25 24 5.12 Underline Cursor On Syntax Hexadecimal Decimal ASCII 0xFE 0x4A 254 74 254 “J” Description This command will cause the LK204-25 to display an underline cursor at the current text insertion point. Remembered Yes 5.13 Underline Cursor Off Syntax Hexadecimal Decimal ASCII 0xFE 0x4B 254 75 254 “K” Description This command will turn the the underline cursor off. Remembered Yes 5.14 Blinking Block Cursor On Syntax Hexadecimal Decimal ASCII 0xFE 0x53 254 83 254 “S” Description This command will cause the LK204-25 to display an underline cursor at the current text insertion point. Remembered Yes 5.15 Blinking Block Cursor Off Matrix Orbital LK204-25 25 Hexadecimal Decimal ASCII Syntax 0xFE 0x54 254 84 254 “T” Description This command will turn the block cursor off. Remembered Yes 6 Special Characters 6.1 Introduction 6.2 Creating a Custom Character Syntax Hexadecimal Decimal ASCII Parameters Parameter refID data Matrix Orbital 0xFE 0x4E [refID] [data] 254 78 [refID] [data] 254 “N” [refID] [data] Length 1 8 LK204-25 Description Character reference ID (0-7). Character data. 26 Description The LK204-25 allows for up to eight custom defined characters to be added onto the the character set. A custom character is a five by eight pixel matrix with each row represented by a byte value. For example: 1 1 1 1 1 1 1 1 Custom Character ’h’ 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 Decimal 16 16 16 16 22 25 17 17 Hex 0x10 0x10 0x10 0x10 0x16 0x19 0x11 0x11 Each bit value of one, in the table, represents an on pixel, whereas a value of zero represents a pixel that is turned off. Therefore in order to define custom character ’h’ you would send the command byte prefix 254 followed by the command 78. Next, you will have to select the memory location in which you wish to save the character in. The available memory locations for this command are zero through to seven. After sending the memory location, or [refID], you may then send the eight byte custom character data in sequence from the top to the bottom. Once you have defined a custom character you may display it by sending the display module the [refID]. For example if a custom character was saved in position one, the command to display the custom character, at the current cursor position, would be simply to send the number one to the display module without quotes. Remembered No 6.3 Saving Custom Characters Syntax Hexadecimal Decimal Parameters Parameter Bank ID Data Matrix Orbital 0xFE 0xC1 [Bank] [ID] [Data] 254 193 [Bank] [ID] [Data] Length 1 1 8 LK204-25 Description Memory bank to save to (0-4). Character ID (0-7) Character Definition 27 Description New to the LK204-25 has added five non-volatile memory banks for custom character storage. This is intended to allow you to create your own custom bar graphs, medium/large numbers and startup screen. However, each memory bank may be used to store a set of any eight custom characters; with the only provision being that memory bank zero contains the characters that will be used in the startup screen. By default the memory banks will be loaded as follows: [Bank] 0 1 2 3 4 Description Startup screen characters. Horizontal bars Vertical bars Medium numbers Large numbers In order to save new custom characters into a memory bank, follow the same process as you would for creating a custom character, see Section 6.2 on page 26, only use 254 193 [Bank Number] before sending the [ID] and character [Data]. Remembered Yes 6.4 Loading Custom Characters Syntax Hexadecimal Decimal Parameters Parameter Bank 0xFE 0xC0 [Bank] 254 192 [Bank] Length 1 Description Memory bank to save to (0-4). Description This command is used to load the custom characters into the volatile memory so that they may be used. If custom bar graph or number characters are stored in the memory banks, this command may be used instead of initializing the bar graph / number. To use this command send the command bytes followed by the [Bank] that contains the custom character data that you want to retrieve. Remembered No 6.5 Save Startup Screen Custom Characters Matrix Orbital LK204-25 28 Syntax Hexadecimal Decimal Parameters Parameter refID data Description 0xFE 0xC2 [refID] [data] 254 194 [refID] [data] Length 1 8 Description Character reference ID (0-7). Character data. Using this command you may create the custom characters. that will be stored in memory bank zero, which will be used in the startup screen. For more information about creating custom characters see Section 6.2 on page 26. NOTES • Changes only take place once the power has been cycled. • This command is the same as sending CMD 254 / 193 / 0 / [ID] / [DATA] Remembered Yes 6.6 Initialize Medium Number Syntax Hexadecimal Decimal ASCII 0xFE 0x6D 254 109 254 “m” Description This command will load the default medium number characters into the volatile memory. If you have stored your own custom medium numbers, use the ’Load Custom Characters’ command to load your custom character data into the volatile memory. This command will allow you to use the ’Place Medium Numbers’ command. Remembered No 6.7 Place Medium Numbers Matrix Orbital LK204-25 29 Syntax Hexadecimal Decimal ASCII Parameters Parameter Row Col Digit 0xFE 0x6F [Row] [Col] [Digit] 254 111 [Row] [Col] [Digit] 254 “o” [Row] [Col] [Digit] Length 1 1 1 Description The row number. The column number. Medium number to place (0-9). Description This command will place a medium number (two columns high) at the [row] and [col] specified. Remembered No 6.8 Initialize Large Numbers Syntax Hexadecimal Decimal ASCII 0xFE 0x6E 254 110 254 “n” Description This command will load the default large number characters into the volatile memory. If you have stored your own custom large numbers, use the ’Load Custom Characters’ command instead to load your custom character data into the volatile memory. This command will allow you to use the ’Place Large Numbers’ command. Remembered No 6.9 Place Large Number Syntax Hexadecimal Decimal ASCII Parameters Parameter Col Digit Matrix Orbital 0xFE 0x23 [Col] [Digit] 254 35 [Col] [Digit] 254 “#” [Col] [Digit] Length 1 1 LK204-25 Description The column number. Large number to place (0-9). 30 Description This command will place a large number (four columns high) at the [row] and [col] specified. Remembered No 6.10 Initialize Horizontal Bar Syntax Hexadecimal Decimal ASCII 0xFE 0x68 254 104 254 “h” Description This command will load the default horizontal bar characters into the volatile memory. If you have stored your own custom horizontal bar data, use the ’Load Custom Characters’ command instead to load your custom bar data into the volatile memory. This command will allow you to use the ’Place Horizontal Bar’ command. Remembered No 6.11 Place Horizontal Bar Graph Syntax Hexadecimal Decimal ASCII Parameters Parameter Col Row Dir Length Description 0xFE 0x7C [Col] [Row] [Dir] [Length] 254 124 [Col] [Row] [Dir] [Length] 254 “|” [Col] [Row] [Dir] [Length] Length 1 1 1 1 Description The column number. The row number. The direction of the bar data (0 or 1). The length of the bar data. This command will place a bar graph at [row], [column]. A [Dir] value of zero will cause the bar to go right, and one will cause the bar to go left. The [Length] is the size in pixels of the bar graph. NOTE Bar graphs may be one directional only. Matrix Orbital LK204-25 31 Remembered No 6.12 Initialize Narrow Vertical Bar Syntax Description Hexadecimal Decimal ASCII 0xFE 0x73 254 115 254 “s” This command will load the narrow vertical bar characters into the volatile memory. If you have stored your own custom vertical bar data, use the ’Load Custom Characters’ command instead to load your custom bar data into the volatile memory. This command will allow you to use the ’Place Vertical Bar’ command. NOTE Narrow bars have a width of two pixels. Remembered No 6.13 Initialize Wide Vertical Bar Syntax Description Hexadecimal Decimal ASCII 0xFE 0x76 254 118 254 “v” This command will load the wide vertical bar characters into the volatile memory. If you have stored your own custom vertical bar data, use the ’Load Custom Characters’ command instead to load your custom bar data into the volatile memory. This command will allow you to use the ’Place Vertical Bar’ command. NOTE Wide bars have a width of five pixels. Remembered Matrix Orbital No LK204-25 32 6.14 Place Vertical Bar Syntax Hexadecimal Decimal ASCII Parameters Parameter Column Length Description 0xFE 0x3D [Column] [Length] 254 61 [Column] [Length] 254 “=” [Column] [Length] Length 1 1 Description The column number. The length of the bar data. This command will place a bar graph at the specified [Column] with the specified [Length]. The [Length] is the size in pixels of the bar graph. NOTE Bar graphs may be one directional only. Remembered No 7 General Purpose Output 7.1 Introduction General purpose outputs allow you to connect devices, such as LEDs, to the LK204-25 and supply them with up to 20mA of current at 5V. The LK204-25 has 6 GPOs which are software controlled, with functions to turn them on/off and set the power state for the next startup. 7.2 General Purpose Output Off Syntax Hexadecimal Decimal ASCII Parameters Parameter Num Matrix Orbital 0xFE 0x56 [Num] 254 86 [Num] 254 “V” [Num] Length 1 LK204-25 Description GPO number. 33 Description This command turns OFF general purpose output [num]. NOTE OFF means that the output is ground. Remembered Yes 7.3 General Purpose Output On Syntax Hexadecimal Decimal ASCII Parameters Parameter Num Description 0xFE 0x57 [Num] 254 87 [Num] 254 “W” [Num] Length 1 Description GPO number. This command turns ON general purpose output [num]. The standard GPO’s on the LK204-25 output 20mA of current at 5V. NOTE The output is pulled high. Remembered Yes 7.4 Set Startup GPO state Syntax Hexadecimal Decimal Parameters Parameter Num state Matrix Orbital 0xFE 0xC3 [Num] [state] 254 195 [Num] [state] Length 1 1 LK204-25 Description GPO number. Startup state (0: Off, 1: On) 34 Description This command will set the startup state for the GPO on the next power up. A value of one will cause the GPO to be off on the next startup while a value of one will cause the GPO to be on. NOTE This command does not affect the current state of the GPO. Remembered Always 8 Dallas 1-Wire 8.1 Introduction Another convenient feature of the LK204-25 is that it provides a Dallas 1-wire interface in order to readily communicate with up to thirty two 1-wire devices on a single bus. 1-wire communication is begun by discovering the address of the device that you wish to communicate with. To do this you must send the “Search for a 1-Wire Device’ command. After you have established the address of the device that you wish to communicate with, you may begin a transaction with the device 8.2 Search for a 1-Wire Device Syntax Matrix Orbital Hexadecimal Decimal 0xFE 0xC8 0x2 254 200 2 LK204-25 35 Description This command will allow you to begin communicating with the devices on the 1-wire bus by returning a packet containing device information for each 1-wire device on the bus in the form of: Search Return Packet Offset (Bytes) 0 Offset (Bytes) 2 Description 0x232A Preamble 2 1 0x8A Packet is 10 bytes long, another address will follow 0x0A Packet is 10 bytes long, this is the last address 3 4 5 13 1 1 8 1 0x31 - 1-Wire Packet Type Error Code (0x00 for success) 1-Wire Address CRC8 0x00 means the last address was valid Remembered No 8.3 Dallas 1-Wire Transaction Syntax Matrix Orbital Hexadecimal Decimal 0xFE 0xC8 0x1 [flags] [SndBits] [RcvBits] [Data] 254 200 1 [flags] [SndBits] [RcvBits] [Data] LK204-25 36 Parameters Parameter flags SndBits 1 RcvBits 1 Data Description Length 1 Description Flags to control optional components of the transaction. The number of bits you will be transmitting on the bus. The number of bits you will be reading on the bus. Data to be transmitted, LSB to MSB. variable This command will perform a single transaction on the 1-wire bus in this order: 1. Bus Reset. 2. Transmit data onto the bus. 3. Receive data from the bus. The number of bits to be transmitted and read must be specified for this command to be successful. NOTE To determine what functions the device will respond to, consult the devices’ data sheet. 1-Wire Flags Bit 7 6 5 4 3 2 1 0 Description Unused (0 for future compatibility) Add a CRC8 to the end of the transmitted data (0 for future compatibility) Assume last received byte is a CRC8 and validate it Reset bus before transaction 1-Wire Error Codes Code 0x00 0x01 0x02 0x03 Remembered Matrix Orbital Description Success Unknown 1-Wire Command No devices on the bus Fatal search error No LK204-25 37 9 Keypad 9.1 Introduction The LK204-25 supports up to a 25 key, matrix style, keypad and may be configured to allow key presses to be automatically transmitted via RS-232 or polled through I2 C. The LK204-25 also allows for autorepeating key presses, and remapping of all keypad character codes. 9.2 Auto Transmit Key Presses On Syntax Hexadecimal Decimal ASCII 0xFE 0x41 254 65 254 “A” Description In this mode, all key presses are sent immediately to the host system without the use of the poll keypad command. This is the default mode on power up. Remembered Yes Factory Default On 9.3 Auto Transmit Key Presses Off Syntax Hexadecimal Decimal ASCII 0xFE 0x4F 254 79 254 “O” Description In this mode, up to 10 key presses are buffered until the unit is polled by the host system, via the poll keypad command 254 38. Issuing this command places the unit in polled mode. Remembered Yes 9.4 Poll Key Press Matrix Orbital LK204-25 38 Syntax Hexadecimal Decimal ASCII 0xFE 0x26 254 38 254 “&” Description This command returns any buffered key presses via the RS-232 interface. The host system must be set up to receive key codes. When the display receives this command, it will immediately return any buffered key presses which may have not been read already. If there is more than one key press buffered, then the high order bit (MSB) of the returned key code will be set (1). If this is the only buffered key press, then the MSB will be cleared (0). If there are no buffered key presses, then the returned code will be 0x00. Please note that to make use of this command, the “Auto Transmit Key Presses” mode should be off. Remembered No 9.5 Clear Key Buffer Syntax Hexadecimal Decimal ASCII 0xFE 0x45 254 69 254 “E” Description This command clears any unread key presses. In a menu application, if the user presses a key which changes the menu context, any following key presses may be inaccurate and can be cleared out of the buffer between menu changes to prevent jumping around the menu tree. It may also be used, in effect, to reset the keypad in case the host application resets for whatever reason. Remembered No 9.6 Set Debounce Time Syntax Matrix Orbital Hexadecimal Decimal ASCII 0xFE 0x55 [time] 254 85 [time] 254 “U” [time] LK204-25 39 Parameter time Parameters Length 1 Description Debounce time in increments of 6.554ms (0 - 255). Description This command sets the time between key press and key read. All key types with the exception of latched piezo switches will ’bounce’ for a varying time, depending on their physical characteristics. The [time] value is in increments of 6.554ms. The default debounce time for the module is 8 (about 52ms), which is adequate for most membrane keypads. Remembered Yes Factory Default 8 9.7 Set Auto Repeat Mode Syntax Hexadecimal Decimal ASCII Parameters Parameter mode Matrix Orbital 0xFE 0x7E [mode] 254 126 [mode] 254 “~” [mode] Length 1 LK204-25 Description Auto Repeat Mode (0: Resend Key , 1: Key Up/Down) 40 Description Two auto repeat modes are available and are set via the same command: • Resend Key Mode: 0x00 • Key Up/Down Mode: 0x01 Resend Key Mode This mode is similar to the action of a keyboard on a PC. In this mode, when a key is held down, the key code is transmitted immediately followed by a 1/2 second delay. After this delay, key codes will be sent via the RS-232 interface at a rate of about 5 codes per second. This mode has no effect if polling or if using the I2 C interface. Key Up/Down Mode This mode may be used when the typematic parameters of the “Resend Key Code” mode are unacceptable or if the unit is being operated in polled mode. The host system detects the press of a key and simulates an auto repeat inside the host system until the key release is detected. In this mode, when a key is held down, the key code is transmitted immediately and no other codes will be sent until the key is released. On the release of the key, the key release code transmitted will be a value equal to the key down code plus 20 hex. Remembered Yes Examples When the key code associated with key ’P’ (0x50) is pressed, the release code is ’p’ (0x70). In RS-232 polled mode or via the I2 C, the “Key Down / Key Up” codes are used; however, the user should be careful of timing details. If the poll rate is slower than the simulated auto-repeat it is possible that polling for a key up code will be delayed long enough for an unwanted key repeat to be generated. 9.8 Auto Repeat Mode Off Syntax Hexadecimal Decimal ASCII 0xFE 0x60 254 96 254 “‘” Description This command turns auto repeat mode off. See Set Auto Repeat Mode. Remembered No Matrix Orbital LK204-25 41 9.9 Assign Keypad Codes Syntax Hexadecimal Decimal Parameters Parameter KDown KUp Description Length 25 25 Description Key down codes Key up codes This command will allow you to reassign the key codes that correspond to the key presses on the matrix style key pad. The first 25 bytes that are transmitted will be used for the key down codes and the next 25 bytes that are transmitted will be used for the key up codes. The default values of the key down codes are ’A-Y’ in order, and for the key up codes the values are ’a-y’ in order. 1 2 3 4 5 Remembered 0xFE 0xD5 [KDown] [KUp] 254 213 [KDown] [KUp] 1 A F K P U Key Down 2 3 B C G H L M Q R V W 4 D I N S X 5 E J O T Y 1 2 3 4 5 1 a f k p u Key Up 2 3 b c g h l m q r v w 4 d i n s x 5 e j o t y Always 10 Display Functions 10.1 Introduction The LK204-25 employs software controlled display settings, which allow for control over, clearing the screen, changing the brightness and contrast or setting timers for turning it on or off. The combination of these allow you complete software control over your display’s appearance. 10.2 Display On Matrix Orbital LK204-25 42 Syntax Hexadecimal Decimal ASCII Parameters Parameter min 0xFE 0x42 [min] 254 66 [min] 254 “B” [min] Length 1 Description Minutes before turning the display on (0 to 100). Description This command turns the display on after the [minutes] timer has expired , with a one-hundred minute maximum timer. A time of 0 specifies that the display should turn on immediately and stay on. When this command is sent while the remember function is on, the timer will reset and begin after power up. Remembered Yes Factory Default 0 10.3 Display Off Syntax Hexadecimal Decimal ASCII 0xFE 0x46 254 70 254 “F” Description This command turns the display off immediately. The display will remain off until a ’Display On’ command has been received. Remembered Yes 10.4 Set Brightness Syntax Hexadecimal Decimal Parameters Parameter brightness Matrix Orbital 0xFE 0x99 [brightness] 254 153 [brightness] Length 1 LK204-25 Description Display brightness setting (0 to 255). 43 Description This command sets the display [brightness]. If the remember function is on, this command acts the same as ’Set and Save Brightness’. Remembered Yes Factory Default 255 10.5 Set and Save Brightness Syntax Hexadecimal Decimal Parameters Parameter brightness 0xFE 0x98 [brightness] 254 152 [brightness] Length 1 Description Backlight setting (0 to 255). Description This command sets and saves the display [brightness] as default. Remembered Always 10.6 Set Contrast Syntax Hexadecimal Decimal ASCII Parameters Parameter contrast Matrix Orbital 0xFE 0x50 [contrast] 254 80 [contrast] 254 “P” [contrast] Length 1 LK204-25 Description Contrast value (0 to 255). 44 Description This command sets the display’s contrast to [contrast], where [contrast] is a value between 0x00 and 0xFF (between 0 to 255). Lower values cause ‘on’ elements in the display area to appear lighter, while higher values cause ‘on’ elements to appear darker. Lighting and temperature conditions will affect the actual value used for optimal viewing. Individual display modules will also differ slightly from each other in appearance. In addition, values for optimal viewing while the display backlight is on may differ from values used when backlight is off. This command does not save the [contrast] value, and is lost after power down; but this command has the option of remembering the settings when issued with the Remember function ‘on’ . When this is the case, this command is the same as the Set and Save Contrast command. Remembered Yes Factory Default 128 10.7 Set and Save Contrast Syntax Hexadecimal Decimal Parameters Parameter contrast Description 0xFE 0x91 [contrast] 254 145 [contrast] Length 1 Description Contrast value (0 to 255). This command sets the display’s contrast to [contrast], where [contrast] is a value between 0x00 and 0xFF (between 0 to 255). Lower values cause ‘on’ elements in the display area to appear lighter, while higher values cause ‘on’ elements to appear darker. Lighting conditions will affect the actual value used for optimal viewing. Individual display modules will also differ slightly from each other in appearance. In addition, values for optimal viewing while the display backlight is on may differ from values used when backlight is off. NOTE This command saves the [contrast] value so that it is not lost after power down. Remembered Matrix Orbital Yes LK204-25 45 Factory Default 128 11 Data Security 11.1 Introduction Ensuring that your LK204-25 display’s exactly what you want it to can be the difference between a projects success and failure. This is why we incorporate features such as Data Lock into the LK204-25 With this new feature you now are in control over of how and when settings will be changed so there is no need to worry about the module acting exactly like you expected it to because all the settings may be locked and remembered for the next power up. 11.2 Set Remember Syntax Hexadecimal Decimal Parameters Parameter switch Matrix Orbital 0xFE 0x93 [switch] 254 147 [switch] Length 1 LK204-25 Description 0: Do not remember, 1: Remember 46 Description This command allows you to switch the remember function on and off. To use the remember function, set remember to on, then set all of the settings that you wish to save, settings that are listed as ’Remember: Yes’ support being saved into the non-volatile memory. After you have set all of the commands that you wish to save, you may then cycle the power and check the display settings to ensure that all the settings have been saved. If you wish to use remember again after cycling the power, you must set it to on again. NOTES • Writing to non-volatile memory is time consuming and slows down the operation of the display. • Non-volatile memory has a ‘write limit’ and may only be changed approximately 100,000 times. Remembered No Factory Default Do not remember 11.3 Data Lock Syntax Hexadecimal Decimal Parameters Parameter level Matrix Orbital 0xFE 0xCA 0xF5 0xA0 [level] 254 202 245 160 [level] Length 1 LK204-25 Description Sets the data lock level 47 Description Data lock, originally known as paranoia, allows you to lock the module from displaying information, as well as enables the protection of the filesystem and module settings. Each bit corresponds corresponds to a different lock level, while sending a zero will unlock your display as the following tables explains: Bit 0 1-4 5 6 7 8 Data Lock Level Unlock Description Sending a zero will cause the display to unlock. (0) Reserved These bits are used as place holders and should not be omitted. (0000) Setting Lock Locks the display settings such as backlight, contrast and GPO settings. (10000) Reserved for graphical displays. (000000) Command Lock Locks all commands but the data lock command. (1000000) Display Lock Locks the module from displaying any new information. (10000000) NOTES • Sending a new data lock level will override the previous data lock level. • Data lock levels may be combined. Remembered Always Factory Default 0 Examples Hex 0x00 0x50 Dec 0 80 Binary 0 01010000 Description Unlock Setting and Command Lock 11.4 Set and Save Data Lock Matrix Orbital LK204-25 48 Syntax Hexadecimal Decimal Parameters Parameter level 0xFE 0xCB 0xF5 0xA0 [level] 254 203 245 160 [level] Length 1 Description Sets the data lock level Description This command will set and save the data lock level. See the Data Lock section for more information. Remembered Always Factory Default 0 12 Miscellaneous 12.1 Introduction This chapter covers the ’Report Version Number’ and ’Read Module Type’ commands. These commands can be particularly useful to find out more information about the display module before contacting technical support. 12.2 Read Version Number Syntax Description Hexadecimal Decimal ASCII 0xFE 0x36 254 54 254 “6” This command will return a byte representing the version of the module, see the following table as an example: Hex Value 0x10 0x20 0x42 Remembered Matrix Orbital Version Number Version 1.0 Version 2.0 Version 4.2 No LK204-25 49 12.3 Read Module Type Syntax Description Hexadecimal Decimal ASCII This command will return a hex value corresponding to the the model number of the module see the following table: Hex 1 2 5 6 7 8 9 A B C D E F 10 13 15 22 24 31 32 33 34 35 Remembered 0xFE 0x37 254 55 254 “7” Product ID LCD0821 LCD2021 VK202-25 LCD4021 LCD4041 LK202-25 LK204-25 LK404-55 VFD2021 VFD2041 VFD4021 VK202-25 VK204-25 GLC12232 GLC24064 GLK24064-25 GLK12232-25-WBL GLK12232-25-SM LK404-AT MOS-AV-162A LK402-12 LK162-12 LK204-25PC Hex 36 37 38 39 3A 3B 3C 3D 3E 40 41 42 43 44 45 46 47 48 49 4A 4B 4C Product ID LK202-24-USB VK202-24-USB LK204-24-USB VK204-24-USB PK162-12 VK162-12 MOS-AP-162A PK202-25 MOS-AL-162A MOS-AV-202A MOS-AP-202A PK202-24-USB MOS-AL-082 MOS-AL-204 MOS-AV-204 MOS-AL-402 MOS-AV-402 LK082-12 VK402-12 VK404-55 LK402-25 VK402-25 No 13 Command Summary 13.1 Communications Matrix Orbital LK204-25 50 Description Changing the I2 C Slave Address Syntax Hexadecimal Decimal ASCII 0xFE 0x33 [adr] 254 51 [adr] 254 “3” [adr] Changing the Baud Rate Hexadecimal Decimal ASCII 0xFE 0x39 [speed] 254 57 [speed] 254 “9” [speed] 18 Setting a Non-Standard Baud Rate Hexadecimal Decimal 0xFE 0xA4 [speed] 254 164 [speed] 18 Description Auto Scroll On Syntax Hexadecimal Decimal ASCII 0xFE 0x51 254 81 254 “Q” Auto Scroll Off Hexadecimal Decimal ASCII 0xFE 0x52 254 82 254 “R” 21 Clear Screen Hexadecimal Decimal ASCII 0xFE 0x58 254 88 254 “X” 21 Changing the Startup Screen Hexadecimal Decimal ASCII 0xFE 0x40 [chars] 254 64 [chars] 254 “@” [chars] 22 Set Auto Line Wrap On Hexadecimal Decimal ASCII 0xFE 0x43 254 67 254 “C” 22 Set Auto Line Wrap Off Hexadecimal Decimal ASCII 0xFE 0x44 254 68 254 “D” 23 Set Cursor Position Hexadecimal Decimal ASCII 0xFE 0x47 [col] [row] 254 71 [col] [row] 254 “G” [col] [row] 23 Page 17 13.2 Text Matrix Orbital LK204-25 Page 21 51 Description Go Home Syntax Hexadecimal Decimal ASCII 0xFE 0x48 254 72 254 “H” Move Cursor Back Hexadecimal Decimal ASCII 0xFE 0x4C 254 76 254 “L” 24 Move Cursor Forward Hexadecimal Decimal ASCII 0xFE 0x4D 254 77 254 “M” 24 Underline Cursor On Hexadecimal Decimal ASCII 0xFE 0x4A 254 74 254 “J” 25 Underline Cursor Off Hexadecimal Decimal ASCII 0xFE 0x4B 254 75 254 “K” 25 Blinking Block Cursor On Hexadecimal Decimal ASCII 0xFE 0x53 254 83 254 “S” 25 Blinking Block Cursor Off Hexadecimal Decimal ASCII 0xFE 0x54 254 84 254 “T” 25 Page 24 13.3 Special Characters Description Creating a Custom Character Syntax Hexadecimal Decimal ASCII 0xFE 0x4E [refID] [data] 254 78 [refID] [data] 254 “N” [refID] [data] Saving Custom Characters Hexadecimal Decimal 0xFE 0xC1 [Bank] [ID] [Data] 254 193 [Bank] [ID] [Data] 27 Loading Custom Characters Hexadecimal Decimal 0xFE 0xC0 [Bank] 254 192 [Bank] 28 Matrix Orbital LK204-25 Page 26 52 Description Save Startup Screen Custom Characters Syntax Hexadecimal Decimal 0xFE 0xC2 [refID] [data] 254 194 [refID] [data] Initialize Medium Number Hexadecimal Decimal ASCII 0xFE 0x6D 254 109 254 “m” 29 Place Medium Numbers Hexadecimal Decimal ASCII 0xFE 0x6F [Row] [Col] [Digit] 254 111 [Row] [Col] [Digit] 254 “o” [Row] [Col] [Digit] 29 Initialize Large Numbers Hexadecimal Decimal ASCII 0xFE 0x6E 254 110 254 “n” 30 Place Large Number Hexadecimal Decimal ASCII 0xFE 0x23 [Col] [Digit] 254 35 [Col] [Digit] 254 “#” [Col] [Digit] 30 Initialize Horizontal Bar Hexadecimal Decimal ASCII 0xFE 0x68 254 104 254 “h” 31 Place Horizontal Bar Graph Hexadecimal Decimal ASCII 0xFE 0x7C [Col] [Row] [Dir] [Length] 254 124 [Col] [Row] [Dir] [Length] 254 “|” [Col] [Row] [Dir] [Length] 31 Initialize Narrow Vertical Bar Hexadecimal Decimal ASCII 0xFE 0x73 254 115 254 “s” 32 Initialize Wide Vertical Bar Hexadecimal Decimal ASCII 0xFE 0x76 254 118 254 “v” 32 Place Vertical Bar Hexadecimal Decimal ASCII 0xFE 0x3D [Column] [Length] 254 61 [Column] [Length] 254 “=” [Column] [Length] 32 Page 28 13.4 General Purpose Output Matrix Orbital LK204-25 53 Description General Purpose Output Off Syntax Hexadecimal Decimal ASCII 0xFE 0x56 [Num] 254 86 [Num] 254 “V” [Num] General Purpose Output On Hexadecimal Decimal ASCII 0xFE 0x57 [Num] 254 87 [Num] 254 “W” [Num] 34 Set Startup GPO state Hexadecimal Decimal 0xFE 0xC3 [Num] [state] 254 195 [Num] [state] 34 Description Search for a 1-Wire Device Syntax Hexadecimal Decimal 0xFE 0xC8 0x2 254 200 2 Dallas 1-Wire Transaction Hexadecimal Decimal 0xFE 0xC8 0x1 [flags] [SndBits] [RcvBits] [Data] 36 254 200 1 [flags] [SndBits] [RcvBits] [Data] Description Auto Transmit Key Presses On Syntax Hexadecimal Decimal ASCII 0xFE 0x41 254 65 254 “A” Auto Transmit Key Presses Off Hexadecimal Decimal ASCII 0xFE 0x4F 254 79 254 “O” 38 Poll Key Press Hexadecimal Decimal ASCII 0xFE 0x26 254 38 254 “&” 38 Clear Key Buffer Hexadecimal Decimal ASCII 0xFE 0x45 254 69 254 “E” 39 Page 33 13.5 Dallas 1-Wire Page 35 13.6 Keypad Matrix Orbital LK204-25 Page 38 54 Description Set Debounce Time Syntax Hexadecimal Decimal ASCII 0xFE 0x55 [time] 254 85 [time] 254 “U” [time] Set Auto Repeat Mode Hexadecimal Decimal ASCII 0xFE 0x7E [mode] 254 126 [mode] 254 “~” [mode] 40 Auto Repeat Mode Off Hexadecimal Decimal ASCII 0xFE 0x60 254 96 254 “‘” 41 Assign Keypad Codes Hexadecimal Decimal 0xFE 0xD5 [KDown] [KUp] 254 213 [KDown] [KUp] 41 Page 39 13.7 Display Functions Description Display On Syntax Hexadecimal Decimal ASCII 0xFE 0x42 [min] 254 66 [min] 254 “B” [min] Display Off Hexadecimal Decimal ASCII 0xFE 0x46 254 70 254 “F” 43 Set Brightness Hexadecimal Decimal 0xFE 0x99 [brightness] 254 153 [brightness] 43 Set and Save Brightness Hexadecimal Decimal 0xFE 0x98 [brightness] 254 152 [brightness] 43 Set Contrast Hexadecimal Decimal ASCII 0xFE 0x50 [contrast] 254 80 [contrast] 254 “P” [contrast] 44 Set and Save Contrast Hexadecimal Decimal 0xFE 0x91 [contrast] 254 145 [contrast] 44 Matrix Orbital LK204-25 Page 42 55 13.8 Data Security Description Set Remember Syntax Hexadecimal Decimal 0xFE 0x93 [switch] 254 147 [switch] Data Lock Hexadecimal Decimal 0xFE 0xCA 0xF5 0xA0 [level] 254 202 245 160 [level] 46 Set and Save Data Lock Hexadecimal Decimal 0xFE 0xCB 0xF5 0xA0 [level] 254 203 245 160 [level] 47 Description Read Version Number Syntax Hexadecimal Decimal ASCII 0xFE 0x36 254 54 254 “6” Read Module Type Hexadecimal Decimal ASCII 0xFE 0x37 254 55 254 “7” Page 45 13.9 Miscellaneous Page 48 49 13.10 Command By Number Command Hex 0x23 0x26 0x33 0x36 0x37 0x39 0x3D 0x40 0x41 0x42 0x43 0x44 Matrix Orbital Description Dec 35 38 51 54 55 57 61 64 65 66 67 68 ASCII “#” “&” “3” “6” “7” “9” “=” “@” “A” “B” “C” “D” Place Large Number Poll Key Press Changing the I2 C Slave Address Read Version Number Read Module Type Changing the Baud Rate Place Vertical Bar Changing the Startup Screen Auto Transmit Key Presses On Display On Set Auto Line Wrap On Set Auto Line Wrap Off LK204-25 Page 30 38 17 48 49 18 32 22 38 42 22 23 56 Command Hex 0x45 0x46 0x47 0x48 0x4A 0x4B 0x4C 0x4D 0x4E 0x4F 0x50 0x51 0x52 0x53 0x54 0x55 0x56 0x57 0x58 0x60 0x68 0x6D 0x6E 0x6F 0x73 0x76 0x7C 0x7E 0x91 0x93 0x98 0x99 0xA4 0xC0 0xC1 0xC2 Dec 69 70 71 72 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 96 104 109 110 111 115 118 124 126 145 147 152 153 164 192 193 194 0xC3 0xC8 0xCA 195 200 202 Matrix Orbital Description ASCII “E” “F” “G” “H” “J” “K” “L” “M” “N” “O” “P” “Q” “R” “S” “T” “U” “V” “W” “X” “‘” “h” “m” “n” “o” “s” “v” “|” “~” Clear Key Buffer Display Off Set Cursor Position Go Home Underline Cursor On Underline Cursor Off Move Cursor Back Move Cursor Forward Creating a Custom Character Auto Transmit Key Presses Off Set Contrast Auto Scroll On Auto Scroll Off Blinking Block Cursor On Blinking Block Cursor Off Set Debounce Time General Purpose Output Off General Purpose Output On Clear Screen Auto Repeat Mode Off Initialize Horizontal Bar Initialize Medium Number Initialize Large Numbers Place Medium Numbers Initialize Narrow Vertical Bar Initialize Wide Vertical Bar Place Horizontal Bar Graph Set Auto Repeat Mode Set and Save Contrast Set Remember Set and Save Brightness Set Brightness Setting a Non-Standard Baud Rate Loading Custom Characters Saving Custom Characters Save Startup Screen Custom Characters Set Startup GPO state Dallas 1-Wire Transaction Data Lock LK204-25 Page 39 43 23 24 25 25 24 24 26 38 44 21 21 25 25 39 33 34 21 41 31 29 30 29 32 32 31 40 44 45 43 43 18 28 27 28 34 36 46 57 14 Appendix 14.1 Specifications 14.1.1 Environmental Table 67: Environmental Specifications Operating Temperature Storage Temperature Operating Relative Humidity Vibration (Operating) Vibration (Non-Operating) Shock (Operating) Shock (Non-Operating) Standard Temperature Extended Temperature 0◦ C to +50◦ C -20◦ C to +70◦ C ◦ ◦ -20 C to +70 C -30◦ C to +80◦ C 90% max non-condensing 4.9 m/s2 XYZ directions 19.6 m/s2 XYZ directions 29.4 m/s2 XYZ directions 490 m/s2 XYZ directions 14.1.2 Electrical Table 68: Electrical Specifications Standard Supply Voltage Backlight On Backlight Off Supply Matrix Orbital +5Vdc ±0.25V Wide Voltage (V) Wide Voltage with Efficient Switching Power Supply (VPT) +9V to +15V +9V to +35V 110 mA typical 40 mA LK204-25 58 14.2 Optical Characteristics Table 69: Optical Characteristics Character x Lines Module Size Character Size Display Size LED Backlight Life Matrix Orbital 20 columns x 2 rows 98.00 mm x 60.00 mm x 30.63 mm 3.20 mm x 5.55 mm 76.30 mm x 25.00 mm 100, 000 hours typical LK204-25 59 14.3 Physical Layout Figure 23: Physical Diagram Matrix Orbital LK204-25 60 14.4 Definitions E Extended Temperature (-20C to 70C) VPT Wide Voltage with Efficient Switching Power Supply (+9 to +35Vdc) V Wide Voltage (+9 to +15Vdc) GW Grey Text / White Background WB White Text / Blue Background R Inverse Red IY Inverse Yellow MSB Most Significant Byte LSB Least Significant Byte 14.5 Contacting Matrix Orbital Telephone Sales and Support: 1(403)229-2737 On The Web Sales: http://www.MatrixOrbital.com Support: http://www.MatrixOrbital.ca Forums: http://www.lcdforums.com Matrix Orbital LK204-25 61