Table of Contents

Advertisement

GENOVATION
MiniTermPro
User Guide
Release 7.80
Fall 2017

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the MiniTermPro Series and is the answer not in the manual?

Questions and answers

Summary of Contents for Genovation MiniTermPro Series

  • Page 1 GENOVATION MiniTermPro User Guide Release 7.80 Fall 2017...
  • Page 2 Genovation, Inc. MiniTermPro...
  • Page 3 Your sole remedy and Genovation's entire liability for this product will be repair or replacement as provided for above, or at Genovation's option, the refund of your purchase price. A RETURN MATERIAL AUTHORIZATION (RMA) number is absolutely required before returning a product.
  • Page 4 FAX or E-MAIL and a representative will respond typically within 24 hours. VOICE NUMBER: (949) 833-3355 ext. 112 FAX NUMBER: (949) 833-0322 EMAIL: support@genovation.com WEB: http://www.genovation.com FORUM: http://www.genovation.com/forum Genovation, Inc. MiniTermPro...
  • Page 5: Table Of Contents

    1: MiniTermPro Installation and Quick Start Guide ..............7 Install Software ........................7 Install Hardware ........................10 Select Virtual COM Port (Genovation USB Virtual Serial mode) .......... 10 Test Keypads ........................13 Where to Go from Here ......................15 Un-Installing and Re-Installing ....................15 2: Using MacroMaster9xx ......................
  • Page 6 MiniTerm 905/906/907 ......................64 MiniTerm 910 ........................65 Appendix G: Advanced Topics ....................66 MiniTermPro Background ..................... 66 Additional Fault Tolerant Features ..................67 Driverless Operation ......................67 For Software Developers ...................... 67 Customization Is Standard ....................68 Genovation, Inc. MiniTermPro...
  • Page 7: 1: Minitermpro Installation And Quick Start Guide

    Any OS in RS232 and HID modes. o Any OS that supports USB CDC class virtual com ports. o Genovation’s proprietary virtual serial mode works with Windows. The MiniTermPro configuration software is designed to work with computers running Microsoft Windows XP / Vista / Windows 7 / Windows 8 / Windows 10 operating systems.
  • Page 8 If you do plan to download custom settings to your MiniTerm, then select NORMAL Installation. o If you don’t plan on downloading custom settings to your MiniTerm, then select SIMPLIFIED Installation. The SIMPLIFIED installation omits MacroMaster9xx.exe and its example files. Genovation, Inc. MiniTermPro...
  • Page 9 Continue clicking Next until you see an “Install” button. Then click Install. You may be prompted to install the Windows CDC Driver, if so, click Next and then when that completes, click Finish. Finally, the setup completes. Genovation, Inc. MiniTermPro...
  • Page 10: Install Hardware

    Check the “Launch Genovation MiniTermPro” box if you want to run the application immediately. Click Finish to complete the installation. The Setup procedure will create an item in the Startup folder that automatically starts MiniTermPro every time you start your computer.
  • Page 11 For convenience, the keypad version is shown for any attached keypads and the keypad itself will display the keypad # and port on its LCD. Once you assign a port, it will appear in the Port Assigned column. Genovation, Inc. MiniTermPro...
  • Page 12 USB Keyboard menu item allows you to test HID MiniTerms. RS232 (DB9) MiniTerms are shown for convenience; they are connected to the PC’s hardware COM port subsystem. MiniTermPro does not manage them, but you can use the other menu items with them (see next page). Genovation, Inc. MiniTermPro...
  • Page 13: Test Keypads

    Test USB Keyboard (HID). In the case of Serial, then SST.exe (Simple Serial Tester) will open already connected to your MiniTerm(s). Enter data on the MiniTerm keypad to verify correct operation (press some number keys and then hit Enter). Genovation, Inc. MiniTermPro...
  • Page 14 Close SST when you are finished with it. Similarly, for the case of HID (PC keyboard) MiniTerms, KeyTest.exe opens: Congratulations, your installation is complete! Your PC will connect to your USB MiniTerm(s) automatically whenever you start your computer. Genovation, Inc. MiniTermPro...
  • Page 15: Where To Go From Here

    Where to Go from Here If you plan to use your MiniTerm hardware in its current configuration you can start to work with it right away. The example files are located in the Genovation MiniTermPro folder created in the Public Documents area.
  • Page 16: 2: Using Macromaster9Xx

    To program the ASCII key codes or change the keypad properties, for the Mini- Term9xx keypad, click on the following (assumes default installation directories): Start >> Program Files (x86) >> Genovation >> MiniTermPro >> MacroMaster9xx The top row of buttons access the major functions of the program. At the center left of the screen are a series of gray squares that represent the keys on the actual keypad hardware.
  • Page 17: Locating Your Keypad Port

    9xxLoad.ini. This file is used by the downloader utility (9xxLoad.exe). You can manually edit this file with Notepad to change the ComPort settings (instead of clicking on Set Port). MacroMaster9xx will notice the change the next time it runs. Genovation, Inc. MiniTermPro...
  • Page 18: Loading A Custom Keypad Definition (Ckd) File

    Testing the Definition File Click the Test Serial/Virtual Serial button. Just as in Section 1 Test Keypads, this will launch the SST (Simple Serial Test) program. Review page 11 for further information regarding the SST.exe serial test application. Genovation, Inc. MiniTermPro...
  • Page 19: Editing Keypad Properties

    No internal buffering is done. The host application must control any messages sent to the LCD display, and any optional serial in-line commands (see the Host Command Set section). Genovation, Inc. MiniTermPro...
  • Page 20 “Enter” key is pressed. The MiniTerm will send the key data as a packet followed by the Tail Character. The Tail Character is a carriage return code (0Dh) <CR> by default. Line Edit Mode Genovation, Inc. MiniTermPro...
  • Page 21 Download Delay: This property is similar to the above “Character Pacing” property. This property controls the time delayed between each byte sent to the MiniTerm but only during a download. This value need only be adjusted if errors occur during the 9xxLoad download process. Genovation, Inc. MiniTermPro...
  • Page 22 MiniTerm with a START character and an END character if needed. Both START and END characters are single byte ASCII values that can be set to any value desired or disabled completely if not needed. Genovation, Inc. MiniTermPro...
  • Page 23: Editing Key Data

    ASCII code as a decimal or hexadecimal value. This is done using the Enter Data Manually box. You can view the codes as either ASCII (the default) or hex. Right click anywhere on the macro data cells grid. Genovation, Inc. MiniTermPro...
  • Page 24: Advanced Key Data Editing (True Terminal Mode)

    Mini-Terminal 9xx into level 2 until the level toggle key is pressed and released again. o Alpha Toggle: An Alpha shift key can be used to allow for alpha-numeric text entry in a similar manner to early cell phone texting. Genovation, Inc. MiniTermPro...
  • Page 25: Advanced Key Data Editing (Line Edit Mode)

    If you would like to have special keys bypass the buffer and go straight to the host computer, then click on the “Transmit this key” checkbox. If the user presses one of those keys then the ASCII data is sent immediately to the host and the line edit buffer is unaffected. Genovation, Inc. MiniTermPro...
  • Page 26: Led Operation

    LED is visible. If you are using separate keys to turn the LED on and off, then no delay is required. The LED’s toggle briefly when a card is read using a barcode or magnetic card reader. Genovation, Inc. MiniTermPro...
  • Page 27: Multimedia Keys

    Choose Insert Multimedia key and then insert the key(s) of your choice. In HID K2 mode, the MiniTerm reserves ASCII codes 0x80 through 0x97 for the Multimedia codes as shown in Appendix B: USB HID Key Codes. Genovation, Inc. MiniTermPro...
  • Page 28: Saving A Keypad Definition File

    LCD prompt you must follow to erase the User data. Follow the instructions on the LCD. Alternatively, on units with firmware version 4.0 and higher you can use the Erase User button in 9xxLoad. Genovation, Inc. MiniTermPro...
  • Page 29: 3: Host Command Set

    0x07 = beep o BS 0x08 = LCD backspace o CR 0x0D = LCD carriage return o LF 0x0A = LCD line feed CR “homes” the cursor to the start of the current line. LF clears the LCD. Genovation, Inc. MiniTermPro...
  • Page 30: Command Index Summary

    Get firmware version byte ^I / 0x09 Get platform # word (LCD size) ^J / 0x0A Get card reader type byte ^M / 0x0D Get and Clear status word All other factory control values are reserved. Do not use. Genovation, Inc. MiniTermPro...
  • Page 31: E' - 45H - Turn Echo On/Off

    The slowest rate is 11111b and is equivalent to approximately 2 characters per second. The default power-on value for this parameter is ‘l’ (lowercase L) which is (6Ch). This provides a delay of 1 second and a repeat rate of 10 characters/second. Genovation, Inc. MiniTermPro...
  • Page 32: B' - 42H - Beep

    Red LED Example: Flash the green LED (2 decimal = 10 binary) and turn the red LED on (1 decimal = 01 binary). Parameter to transmit then equals 0000 1001. Prefix Command Type Param ASCII: Dec: Hex: Genovation, Inc. MiniTermPro...
  • Page 33: D' - 43H - Set Lcd Display Mode

    Using both scroll and wrap is undefined. The parameter byte: Scroll Wrap On/Off On/Off Example: Enable scroll (scroll = 1, wrap = 0). Prefix Command Type Param ASCII: Dec: Hex: Genovation, Inc. MiniTermPro...
  • Page 34: C' - 43H - Clear Lcd

    Example: Turn PIN-masking on. Prefix Command Type Param ASCII: Dec: Hex: The default masking value is set by the value from the Keypad Properties panel. If the MiniTerm has been downloaded to. The factory default setting is OFF. Genovation, Inc. MiniTermPro...
  • Page 35: K' - 4Bh - Next User Key Press Clears Lcd (Line Edit Mode Only)

    The prompt string is “@CEnter ID Number:@K” (@C command, “Enter ID Number:” string, @K command). Enter ID Number: The user presses the 1 key. The LCD is cleared automatically and the 1 character appears. 1_______________ Example: Prefix Command Type ASCII: Dec: Hex: Genovation, Inc. MiniTermPro...
  • Page 36: R' - 52H - Preset Lcd Rotation String (V4.10 And Greater)

    (Next User Key Press Clears LCD). This allows for longer prompts for the user such as “Press ENTER to continue… “. Example 1: Show and rotate the pre-loaded string at 2 characters per second. Prefix Command Type Param ASCII: Dec: Hex: Genovation, Inc. MiniTermPro...
  • Page 37: G' - 47H - Graph Value (V4.10 And Greater)

    LCD you have allotted for your bar graph. This function uses the ASCII characters 01h through 05h that have been customized by Genovation for this purpose. See Appendix A for the complete LCD character set.
  • Page 38: U' - 55H - Create User-Defined Lcd Character (V4.20 And Greater)

    Example: Pre-load the character shown above in the first user char location. Prefix Char Data Data Data Data Data Data Data Data Type ASCII: Dec: Hex: Note: To then see the character on the LCD you should send 0x18 (^X) to the keypad. Genovation, Inc. MiniTermPro...
  • Page 39: F' - 46H - Show Firmware Version On The Lcd (V4.20 And Later)

    After the MiniTerm receives the 0xFE byte, the next byte will be sent directly to the LCD control register. This allows the programmer direct access to the LCD without using the Genovation command set. This also maps the 8 user-defined (custom) LCD characters to the legacy positions (in decimal) 176, 158, 131, 132, 133, 134, 135 and 136 as well as preferred locations 0x18 through 0x1F.
  • Page 40: B' - 62H - Lcd Backlight Brightness (V6.00 And Later)

    FEh compatibility mode since the device switches over to compatibility mode on detection of the FEh. To get back to the Genovation command set, issue one of the @ commands. To show an @ on the LCD and stay in compatibility mode, send value 0xA0 (decimal 160).
  • Page 41: S' - 73H - Scanner/Gpio Mode (V6.00 And Later)

    0x00 and 0x04. Scanner off: Prefix Command Type Param ASCII: Dec: Hex: Scanner on again: Prefix Command Type Param ASCII: Dec: Hex: You may also use ASCII values 0x30 (‘0’) to 0x39 (‘9’) for the parameter. Genovation, Inc. MiniTermPro...
  • Page 42 I is the command. Address byte is any value from 0 to 255 (decimal). Data byte to write is any value from 0 to 255 (decimal). Example: Write value 0x34 to location 0x56. Prefix Command Address Data ASCII: Dec: Hex: Genovation, Inc. MiniTermPro...
  • Page 43: O' - 4Fh - Data Out From Eeprom (V4.20 And Later)

    Example: Read the byte stored in user-definable EEPROM location 0x56. Prefix Command Type Param ASCII: Dec: Hex: The MiniTerm responds with a single byte value. Assume the response to the above example is 0x34: Response ASCII: Dec: Hex: Genovation, Inc. MiniTermPro...
  • Page 44: D - 04H - Restart Firmware

    Unlike other Virtual COM Port technologies, Genovation’s MiniTermPro will restore the COM port connection for you. There is no need to close and reopen the COM port in your software. ^E – 05h – Get Connected Port Type Issuing this command will prompt the MiniTerm to respond with an ASCII byte representing how the MiniTerm is connected to the PC/host.
  • Page 45: F - 06H - Get Version String

    This message may be as long as the longest LCD option (32 characters). Example: Get the user version string. Prefix Command Type ASCII: Dec: Hex: A sample response might be “Screen Demo: 905------ ----- ---”. There is no terminating null. Genovation, Inc. MiniTermPro...
  • Page 46: H - 08H - Get Firmware Version Byte

    Current valid responses are 0x0905 for devices with a 2 x 16 LCD and 0x0904 for a 1 x 16 LCD. Although similar to the product model number, this value can only be used to determine the LCD size. Response Response ASCII: Dec: Hex: Genovation, Inc. MiniTermPro...
  • Page 47: J - 0Ah - Get Card Reader Type

    0x01 indicates an internal barcode, magnetic for RFID card reader. o 0x02 indicates an externally wedged RS232 device. An internal card reader is normally packet-delimited and would generate the following response. Response ASCII: Alt+0129 Dec: Hex: Genovation, Inc. MiniTermPro...
  • Page 48: M - 0Dh - Get And Clear Status Word

    A typical response to a request for the status word would generate: Response Response Response Response ASCII: Dec: Hex: This indicates that the device User and ROM areas have not been customized (the status word is then zeroed internally). Genovation, Inc. MiniTermPro...
  • Page 49: Appendix A: Ascii Character Sets

    Appendix A: ASCII Character Sets Standard ASCII Character Set (rotated) LCD Character Set (firmware v4.20 and greater) Genovation, Inc. MiniTermPro...
  • Page 50: Appendix B: Usb Hid Key Codes

    Semi colon 0x3C < Shift + 0x36 0x3D 0x2E 0x3E > Shift + 0x37 0x3F Shift + 0x38 0x40 Shift + 0x1F 0x41 Shift + 0x04 0x42 Shift + 0x05 0x43 Shift + 0x06 0x44 Shift + 0x07 Genovation, Inc. MiniTermPro...
  • Page 51 0x08 0x66 0x09 0x67 0x0A 0x68 0x0B 0x69 0x0C 0x6A 0x0D 0x6B 0x0E 0x6C 0x0F 0x6D 0x10 0x6E 0x11 0x6F 0x12 0x70 0x13 0x71 0x14 0x72 0x15 0x73 0x16 0x74 0x17 0x75 0x18 0x76 0x19 0x77 0x1A Genovation, Inc. MiniTermPro...
  • Page 52 0x9F 0x48 Pause/Break *** 0xA0 0x39 CapsLock** 0xA1 0x3A F1** 0xA2 0x3B F2** 0xA3 0x3C F3** 0xA4 0x3D F4** 0xA5 0x3E F5** 0xA6 0x3F F6** 0xA7 0x40 F7** 0xA8 0x41 F8** 0xA9 0x42 F9** 0xAA 0x43 F10** Genovation, Inc. MiniTermPro...
  • Page 53 * Please note that the Multi-Media values are only available with MiniTerms v5.00 or higher that are programmed for Multimedia (K2). ** These values require MiniTerm firmware version 5.40 or higher. *** These values require MiniTerm firmware version 5.41 or higher. Genovation, Inc. MiniTermPro...
  • Page 54: Appendix C: Implementation Use Cases

    Serial MiniTerm is using factory defaults. MacroMaster232.exe RSLoad.exe PC application accessing physical COM Port RS-232 DB-9 Cable RS-232 Serial MiniTerm 9xx Implementation 1b: Same as Implementation 1a except MiniTerm has been customized using MacroMaster9xx (and downloaded using 9xxLoad). Genovation, Inc. MiniTermPro...
  • Page 55 MiniTermPro application creates the virtual COM port. MacroMaster232.exe RSLoad.exe PC application accessing (virtual) COM port USB Cable MiniTermPro.exe MiniTerm 9xx-U Implementation 2b: Same as Implementation 2a except MiniTerm has been customized using MacroMaster9xx (and downloaded using 9xxLoad). Genovation, Inc. MiniTermPro...
  • Page 56 PC Keyboard (HID), hence the –K in the diagram above. MacroMaster232.exe RSLoad.exe PC application uses keyboard input USB Cable USB HID MiniTerm 9xx-K Implementation 3b: Same as Implementation 3a except MiniTerm has been further customized using MacroMaster9xx (and downloaded using 9xxLoad). Genovation, Inc. MiniTermPro...
  • Page 57: Appendix D: Host Modes In Detail

    The faster HID MultiMedia type allows for more features (the MultiMedia keys).  More USB low speed host types were added in v6.15 to allow for very long USB cables. The choices shown to the user in MacroMaster9xx are: Genovation, Inc. MiniTermPro...
  • Page 58 Normally, unless you have a specific reason to choose otherwise, it’s best to select either “Default” or if you prefer, USB CDC Virtual COM Port. If you need help, or wish to order the Ethernet (or WiFi) versions of the MiniTerm, contact Genovation directly. Genovation, Inc. MiniTermPro...
  • Page 59: Appendix E: Usb Cdc Virtual Com Host Mode

    COM port device to software applications running on those OS’s. It’s very similar to the standard Genovation MiniTermPro virtual COM port method, but with some differences: o The USB CDC class driver is available and built-in on most PC OS’s (Windows, Linux, Apple).
  • Page 60: Configuring A Cdc Miniterm Keypad

    Devices you can see what all the COM port (driver) designations are, whether the devices are plugged in or not. There is also a Power-On-Self-Test mode of selecting the operating mode of the keypad, but you cannot alter the USB serial number that way. Genovation, Inc. MiniTermPro...
  • Page 61 To change the port settings for a CDC device, right-click on the Device Manager entry for it and the click on Properties. A new panel will open. Click on the Port Settings tab and then Advanced. Here you can change the COM port if desired. Genovation, Inc. MiniTermPro...
  • Page 62: Appendix F: Technical Specifications

    RJ-45 to DB-9 female Interface: USB Type USB 1.1 & 2.0 compliant bus powered Cable Length 6ft (2.0m) (Detachable via RJ-45 connection) Connection RJ-45 to USB standard Type A Classes Supported HID, HID Multimedia, CDC ACM, Vendor Defined Genovation, Inc. MiniTermPro...
  • Page 63: Miniterm 904Rj

    USB 1.1 & 2.0 compliant bus powered Cable Length 6ft (2.0m) (Detachable via RJ-45 connection) Connection RJ-45 to USB standard Type A Classes Supported HID, HID Multimedia, CDC ACM, Vendor Defined Ordering Information Part Number Description 904RJ MiniTerm 904 Genovation, Inc. MiniTermPro...
  • Page 64: Miniterm 905/906/907

    For reading ATM, credit cards, and magnetic cards RFID Card / Label Reader Reads RFID cards and RFID Labels Fingerprint ID Reader Scans and encodes fingerprints into usable data RS232 Ext. Wedge Device Allows external RS232 serial device sharing Genovation, Inc. MiniTermPro...
  • Page 65 For reading ATM, credit cards, and magnetic cards RFID Card / Label Reader Reads RFID cards and RFID Labels Fingerprint ID Reader Scans and encodes fingerprints into usable data RS232 Ext. Wedge Device Allows external RS232 serial device sharing Genovation, Inc. MiniTermPro...
  • Page 66: Appendix G: Advanced Topics

    When the PC re-enumerates all of the USB devices, local keyboard and mouse functions cease for a brief moment but (non-Genovation) virtual COM ports and other connections can be orphaned completely. MiniTermPro.exe takes care of this through four major functions: 1.
  • Page 67: Additional Fault Tolerant Features

    Windows Win32 API functions. For more information contact Genovation and consult our “MiniTerm HID Low-Level Programming” document. Although we have no additional support for it, similar techniques to those described in the document can by used to interface with the MiniTerm over Linux or other operating systems.
  • Page 68: Customization Is Standard

    Customization Is Standard The MiniTerm product line has been designed with customization in mind. Contact our sales or technical support staff for full-custom or semi-custom variations of our products. Genovation, Inc. MiniTermPro...

Table of Contents