Epson TM Series Development Manual

Epson TM Series Development Manual

Hide thumbs Also See for TM Series:

Advertisement

Quick Links

EPSON OPOS ADK MANUAL
APPLICATION DEVELOPMENT
GUIDE
MICR (EPSON TM Series)
Version 3.00 Feb. 2019

Advertisement

Table of Contents
loading

Summary of Contents for Epson TM Series

  • Page 1 EPSON OPOS ADK MANUAL APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series) Version 3.00 Feb. 2019...
  • Page 2 (3) Comments and notification of any mistakes in this documentation are gratefully accepted. (4) This software cannot be used with other equipment that the specified. (5) EPSON will not be responsible for any consequences resulting from the use of any information in this documentation. Trademarks Microsoft®, Windows®, Windows Server®, Visual Basic®...
  • Page 3: Table Of Contents

    4.1.2 DirectIOEvent Event................... 16 4.2 List of Commands Usable with DirectIO ............... 16 Section 5. Device Specific Programming ................. 17 5.1 Obtaining MICR Status in Real Time..............17 5.2 Cleaning the MICR ....................18 APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 4 6.2 Remedial Actions for Principal Errors ..............23 Section 7. Warnings......................24 Section 8. Appendix......................25 8.1 Changes for Corresponding UPOS Release 1.7 ..........25 8.1.1 Return Values..................... 25 8.1.2 MICR Operations by Specific Settings of Devices........26 APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 5: Section 1. Introduction

    MICR device is used with EPSON OPOS ADK. Before the MICR can be used, the EPSON OPOS ADK should be installed and the devices to be used should be set using the SetupPOS utility. For setting methods, please see the Section 2.
  • Page 6: Section 2. Details On Settings

    EPSON TM-U950 MICR TM-U950 TM-H2000 EPSON TM-H2000 MICR TM-H2000 EPSON TM-H2000P MICR TM-H2000P EPSON TM-H2000U MICR TM-H2000U EPSON TM-H2000E MICR TM-H2000E TM-H6000IV EPSON TM-H6000IV MICR TM-H6000IV EPSON TM-H6000IVP MICR TM-H6000IVP EPSON TM-H6000IVU MICR TM-H6000IVU APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 7: References Of Firmware Versions

    Printer for settings of the Printer. 2.4 Setting of Devices The SetupPOS utility should be used for setting devices. Regarding how to use the SetupPOS utility, please refer to the "EPSON OPOS ADK MANUAL User's Manual (Installer/ SetupPOS/ TMUSB)". 1) Setting of Parallel interface devices When the SetupPOS utility is used to select the device when using a Parallel port, select devices with “P”...
  • Page 8 Error handling options during Check insertion Check Font Regarding how to set with “Device Specific Settings”, please refer to “EPSON OPOS ADK MANUAL User's Manual (Installer/ SetupPOS/ TMUSB)”. “Error handling options during Check insertion setting.” Sets how you want to be notified if an error is fired during Check insertion.
  • Page 9 3. Blank check sheet If one of the data is read as “?”, the check will not be removed. For the EPSON TM-U950, this setting is the default and cannot be changed. The TM-U950 cannot translate error data as “?”.
  • Page 10 Sets the read font for reading checks. Selects a type of the check to be used. Reads checks and analyzes the read data, then sets them to its properties. • “E-13B” radio button • “CMC7” radio button Default setting is ”E-13B”. APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 11: Port Information

    The 38400-baud rate cannot be set for TM-H5000II, TM-U675, TM-U950. The 57600-baud rate can only be set for TM-J7000, TM-J7100, TM-H6000IV, TM-H2000 and TM-H6000V. The 115200-baud rate can only be set for TM-J7000, TM-J7100, TM-H6000IV, TM-H2000 and TM-H6000V. APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 12 4) Port information when Ethernet port is used All MICR settings are exactly the same as the printer. 5) Port information when Bluetooth port is used All MICR settings are exactly the same as the printer. APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 13: Section 3. Function Details

    If a check has been set correctly, data will be read. If a check is not set, a message requesting for inserting a check will be displayed. After inserting the check, press the [OK] button. Then the check is read. APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 14: Property Set Values And Default Values

    FALSE TRUE CapPowerReporting See the table1. For TM-U675 and the TM-H6000II/ TM-H6000III/ TM-H6000IV/ TM-H6000V/ TM-J7000/ TM-J7100 (EndorsUnit unsupported) only. Table 1 Port Type CapPowerReporting Serial OPOS_PR_STANDARD Parallel OPOS_PR_ADVANCED OPOS_PR_ADVANCED Ethernet OPOS_PR_ADVANCED Bluetooth OPOS_PR_STANDARD APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 15: Supplementary Explanation Of Functions

    NULL is set in the property. Property that has a NULL value is an invalid data. The EPSON TM series supports the following properties for E-13B and CMC7 type checks. The check type to read is set with the SetupPOS utility; dynamic changing of check type is not supported.
  • Page 16: Check Digit

    Version 3.00 Feb. 2019 3.3.2 Check Digit The EPSON OPOS ADK has ability to check the parity of the MICR string with the check’s check digit. This functionality is enabled/disabled with the SetupPOS utility. When enabled, the error checking equation as outlined by the American Bankers Association (ABA) is used to check the check’s validity whenever a...
  • Page 17: Section 4. Expanded Functions

    Value Meaning OPOS_SUCCESS DirectIO succeeded. OPOS_E_CLOSED The device is closed. OPOS_E_NOTCLAIMED The device is not claimed. OPOS_E_DISABLED The device is disabled. OPOS_E_ILLEGAL Specifies command number without function. Requirement Open, Claim & Enable APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 18 DirectIO succeeded. OPOS_E_CLOSED The device is closed. OPOS_E_NOTCLAIMED The device is not claimed. OPOS_E_DISABLED The device is disabled. OPOS_E_ILLEGAL The parameter is illegal. Other Refer to the ResultCode item. Requirement Open, Claim & Enable APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 19 TM-H6000IV TM-H6000V Returned value One of the following is returned and stored in the ResultCode property. Value Meaning OPOS_E_CLOSED The device is closed. OPOS_E_ILLEGAL The parameter is illegal. Requirement Open, Claim & Enable APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 20: Directioevent Event

    The commands usable with the DirectIO are as follows. Other commands cannot be used Command Meaning DLE EOT BS Request for real time status FS c Clean the MICR hardware See the product manual for the details of the commands. APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 21: Section 5. Device Specific Programming

    DIEFlag = 0 RC = OposMicr1.DirectIO (MICR_DI_GETSTATUS ‘Command number Dummy, ‘Not used Data) ‘Not used If RC = OPOS_SUCCESS Then ‘Success Else ‘Error End If While( DIEFlag = 0 ) DoEvents Wend Status = DIEData APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 22: Cleaning The Micr

    Dim Dummy As Long Dim Data As String Dummy = 0 Data = “” RC = OposMicr1.DirectIO (MICR_DI_CLEANING, ‘Command number Dummy, ‘Not used Data) ‘Not used If RC = OPOS_SUCCESS Then ‘Success Else ‘Error End If APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 23: Section 6. Error Information

    Section 6. Error Information This section describes the error codes that may result from execution of MICR methods. The common properties and methods are described in "EPSON OPOS ADK MANUAL APPLICATION DEVELOPMENT GUIDE GENERAL DEVELOPMENT". Refer to this guide for more information.
  • Page 24: When A Method Is Executed

    Too many digits were detected in the check data. OPOS_EMICR_BADDATA The read data contained not analyzable data. OPOS_EX_DISPOSE_ERRORE The event processing is not VENT complete yet. OPOS_E_EXTENDED OPOS_EMICR_NOCHECK A check is not present in the device. APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 25 Output result is not returned within timeout period. OPOS_EX_NOASB Could not get ASB. OPOS_E_EXTENDED OPOS_EMICR_CHECK A check is present in the device. The POSPrinter condition errors are as follows: ・OPOS_EPTR_COVER_OPEN ・OPOS_EPTR_JRN_EMPTY ・OPOS_EPTR_REC_EMPTY ・OPOS_EPTR_REC_CARTRIDGE_REMOVED ・OPOS_EPTR_REC_CARTRIDGE_EMPTY ・OPOS_EPTR_REC_HEAD_CLEANING APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 26: Error Event

    A check is not present in the device. OPOS_E_ILLEGAL OPOS_EX_TIMEOUT Output result is not returned within timeout period. OPOS_E_OFFLINE Refer to UPOS Specifications. OPOS_E_NOHARDWARE Power is OFF or unconnected. Unsupported by the TM-U950. APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 27: Remedial Actions For Principal Errors

    OPOS_EMICR_CHECK OPOS_EMICR_BADDATA Check data error. Once remove it, then insert again, or use a proper check. OPOS_EMICR_DATAERROR OPOS_EMICR_BADSIZE OPOS_EMICR_NODATA OPOS_EX_DISPOSE_ERROREVENT The event processing is not complete yet. Execute the event processing. APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 28: Section 7. Warnings

    Version 3.00 Feb. 2019 Section 7. Warnings All EPSON TM series MICR settings follow the same hydra connection settings as the master device EPSON TM series printer. Please read the Section "EPSON OPOS MANUAL/APPLICATION DEVELOPMENT GUIDE/ POSPrinter (TM Series)” for further information.
  • Page 29: Section 8. Appendix

    By marking “Issue an Error Event for specified error occurrence during Check insertion.” radio button of “Error handling options during Check insertion setting.” in “Device Specific Settings” dialog box, the errors are notified by error events. APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 30: Micr Operations By Specific Settings Of Devices

    RC: OPOS_E_ILLEGAL RCE: 0 RCE: OPOS_EMICR_BADSIZE The result of data analysis is There is no notification by event. notified by ErrorEvent. RC and RCE of the ErrorEvent are as follows: RC: OPOS_E_EXTENDED RCE: OPOS_EMICR_BADSIZE APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 31 RC: OPOS_E_OFFLINE RCE: 0 RCE: 0 The result of data analysis is There is no notification by event. notified by ErrorEvent. RC and RCE of the ErrorEvent are as follows: RC: OPOS_E_EXTENDED RCE: OPOS_EMICR_JAM APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)
  • Page 32 RC: OPOS_E_ILLEGAL; RCE: 0 RCE: OPOS_EX_TIMEOUT The result of data analysis is There is no notification by event. notified by ErrorEvent. RC and RCE of the ErrorEvent are as follows: RC: OPOS_E_ILLEGAL; RCE: OPOS_EX_TIMEOUT APPLICATION DEVELOPMENT GUIDE MICR (EPSON TM Series)

Table of Contents