Epson TM Series User manual

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

Notes
(1) Reproduction of any part of this documentation by any means is prohibited.
(2) The contents of this documentation are subject to change without notice.
(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® and Visual C++® are
trademarks or registered trademarks of Microsoft Corporation in the United States and/or
other countries.
EPSON® and ESC/POS® are registered trademarks of Seiko Epson Corporation.
The Bluetooth® word mark and logos are registered trademarks owned by Bluetooth SIG,
Inc.
Other product and company names used herein are for identification purposes only and
may be trademarks or registered trademarks of their respective companies.
Copyright © 2000-2019 Seiko Epson Corporation

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
MICR (EPSON TM Series)
iii
Contents
Section 1. Introduction.......................................................................................................... 1
Section 2. Details on Settings .............................................................................................. 2
2.1 Device Information..................................................................................................2
2.2 References of Firmware Versions ..........................................................................3
2.3 Settings of DIP Switches and Hardware.................................................................3
2.4 Setting of Devices...................................................................................................3
2.5 Port Information......................................................................................................7
Section 3. Function Details................................................................................................... 9
3.1 CheckHealth Method..............................................................................................9
3.1.1 Internal Test .................................................................................................9
3.1.2 External Test................................................................................................9
3.1.3 Interactive Test.............................................................................................9
3.2 Property Set values and Default Values............................................................... 10
3.2.1 Capability Set Value...................................................................................10
3.3 Supplementary Explanation of Functions .............................................................11
3.3.1 Valid Headers.............................................................................................11
3.3.2 Check Digit.................................................................................................12
3.4 Device Statistics...................................................................................................12
3.5 Communication Compatibility...............................................................................12
Section 4. Expanded Functions......................................................................................... 13
4.1 DirectIO Function..................................................................................................13
4.1.1 DirectIO Method.........................................................................................13
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

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
MICR (EPSON TM Series)
iv
Section 6. Error Information............................................................................................... 19
6.1 ResultCode List....................................................................................................19
6.1.1 When Executing Properties........................................................................19
6.1.2 When A Method is executed.......................................................................20
6.1.3 Error Event.................................................................................................22
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

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
MICR (EPSON TM Series)
1
Section 1. Introduction
This manual describes the method of use and related items, including device-specific
precautions, when the 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.
Compatibility mode
The compatibility mode for upward compatibility was added in OPOS Ver2.60.
For the details of the compatibility mode, please refer to “EPSON OPOS ADK MANUAL
APPLICATION DEVELOPMENT GUIDE Compatibility Mode”.

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
MICR (EPSON TM Series)
2
Section 2. Details on Settings
This section describes connection configurations and how to make the settings for the
MICR devices.
2.1 Device Information
The DeviceDescription and DeviceName for each model are as follows.
Model Name I/F DeviceDescription DeviceName
S EPSON TM-U675 MICR TM-U675
P EPSON TM-U675P MICR TM-U675P
U EPSON TM-U675U MICR TM-U675U
TM-U675
E EPSON TM-U675E MICR TM-U675E
S EPSON TM-H5000II MICR TM-H5000II
P EPSON TM-H5000IIP MICR TM-H5000IIP
U EPSON TM-H5000IIU MICR TM-H5000IIU
TM-H5000II
E EPSON TM-H5000IIE MICR TM-H5000IIE
S EPSON TM-H6000III MICR TM-H6000III
P EPSON TM-H6000IIIP MICR TM-H6000IIIP
U EPSON TM-H6000IIIU MICR TM-H6000IIIU
TM-H6000III
E EPSON TM-H6000IIIE MICR TM-H6000IIIE
S EPSON TM-J7000 MICR TM-J7000
P EPSON TM-J7000P MICR TM-J7000P
U EPSON TM-J7000U MICR TM-J7000U
TM-J7000
E EPSON TM-J7000E MICR TM-J7000E
S EPSON TM-J7100 MICR TM-J7100
P EPSON TM-J7100P MICR TM-J7100P
U EPSON TM-J7100U MICR TM-J7100U
TM-J7100
E EPSON TM-J7100E MICR TM-J7100E
TM-U950 S EPSON TM-U950 MICR TM-U950
S EPSON TM-H2000 MICR TM-H2000
P EPSON TM-H2000P MICR TM-H2000P
U EPSON TM-H2000U MICR TM-H2000U
TM-H2000
E EPSON TM-H2000E MICR TM-H2000E
S EPSON TM-H6000IV MICR TM-H6000IV
P EPSON TM-H6000IVP MICR TM-H6000IVP
TM-H6000IV
U EPSON TM-H6000IVU MICR TM-H6000IVU

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
MICR (EPSON TM Series)
3
E EPSON TM-H6000IVE MICR TM-H6000IVE
S EPSON TM-H6000V MICR TM-H6000V
P EPSON TM-H6000VP MICR TM-H6000VP
U EPSON TM-H6000VU MICR TM-H6000VU
E EPSON TM-H6000VE MICR TM-H6000VE
TM-H6000V
B EPSON TM-H6000VB MICR TM-H6000VB
I/F indicate the connected interface.
The following is the list of the four connecting interfaces.
S: Serial
P: Parallel
U: USB
E: Ethernet
B: Bluetooth
2.2 References of Firmware Versions
Refer to the release notes (Relnote.txt).
2.3 Settings of DIP Switches and Hardware
There are no Dip Switch settings for the MICR. Refer to the manual of currently
used 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” appended to the end of the device name.
Example: TM-H6000IIIP

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
MICR (EPSON TM Series)
4
2) Setting of USB interface devices
When the SetupPOS utility is used to select the device when using an USB port,
select devices with “U” appended to the end of the device name.
Example: TM-H6000IIIU
3) Setting of Ethernet interface devices
When the SetupPOS utility is used to select the device when using an Ethernet
port, select devices with “E” appended to the end of the device name.
Example: TM-H6000IIIE
4) Setting of Bluetooth interface devices
When using a printer with Bluetooth I/F specifications,
Select the COM port of the Bluetooth device in the Create New window of
TMPORT.
Notes: Bluetooth interface only support TM-H6000V.
5) Device Specific Settings
MICR’s specific setting should be done after specifying the Device to use in
“Device Specific Settings” dialog box of SetupPOS Utility. The following items
are able to set in the dialog box.
yError handling options during Check insertion
yCheck Font
yRegarding how to set with “Device Specific Settings”, please refer to
“EPSON OPOS ADK MANUAL User's Manual (Installer/ SetupPOS/
TMUSB)”.
z“Error handling options during Check insertion setting.”
Sets how you want to be notified if an error is fired during Check insertion.
•“Issue an Error Event for every error occurrence during Check insertion.
(applicable for UPOS 1.7 and subsequent releases)” radio button
(here after, referred without (applicable for UPOS 1.7 and subsequent
releases))
Under the setting that this button is marked, EndInsertion method is
considered to be succeed when check insertion by execution of
EndInsertion method is done normally, regardless of whether the read
data is illegal.
The conditions of the read data and reading operation of MICR are

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
MICR (EPSON TM Series)
5
notified by events.
This operation is the UPOS Release 1.7 and subsequent releases
applied operation.
•“Issue an Error Event for specified error occurrence during Check
insertion.” radio button
Under the setting that this button is marked, EndInsertion method is
considered to be succeeded upon normal completion of analysis of the
data that is read from a check inserted by the method.
When the read data of MICR is normal or the data contains not
analyzable characters, these conditions are notified by events.
Whether the read data and reading operation of MICR are illegal are
indicated by the set value of ResultCode and ResultCodeExtended
properties.
This operation is the same as the default operation of UPOS Release
1.6 (previous versions of Ver. 2.30) applied operation.
Default setting of above radio buttons is ”Issue an Error Event for every error
occurrence during Check insertion.”.
Regarding the variety of events and values of ResultCode and
ResultCodeExtended are described, please refer to the Section 8 of this
manual.
z“Automatic check remove on read error” check box:
This check box setting can be done only when ”Issue an Error Event for
specified error occurrence during Check insertion.” radio button under “Error
handling options during Check insertion” is selected.
This check box is inapplicable when “Issue an Error Event for every error
occurrence during Check insertion.” is selected.
When a read data is in those conditions as below, the check is removed:
1.The entire data is incorrect. (Neither an incorrect insertion, nor an
incorrect sheet, etc.)
2.Longer than the prescribed length
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 “?”.

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
MICR (EPSON TM Series)
6
z“Fire ErrorEvent on check digit parity error” check box:
This check box setting can be done only when ”Issue an Error Event for
specified error occurrence during Check insertion.” radio button under “Error
handling options during Check insertion” is selected.
This check box is inapplicable when “Issue an Error Event for every error
occurrence during Check insertion.” is selected.
Judging whether a TransitNumber (nine digits number) is normal. If it is illegal,
then notified by the ErrorEvent (RCE = OPOS_EMICR_DIGITERROR).
It can be executed only when the whole data is read normally, and the
TransitNumber has nine digits number.
z“Check font”
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”.

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
MICR (EPSON TM Series)
7
2.5 Port Information
1) Port information when using serial port
The port information that can be set with the SetupPOS utility is as follows.
Setting Information Effective Setting Range
Baud rate 1200 *1, 2400 *2, 4800, 9600, 19200 *3, 38400 *4,
57600 *5, 115200 *6
Bit length 7 bits, 8 bits
Parity NONE, ODD, EVEN
Stop bit 1 bits
Handshake DTR/DSR
Input buffer length 32-8192
Output buffer length 32-1024
Output interval time 0-9999
Input sleep time 0-99
*1 The 1200-baud rate can only be set for TM- U950.
*2 The 2400-baud rate cannot be set for TM-H6000III.
*3 The 19200-baud rate cannot be set for TM-U950.
*4 The 38400-baud rate cannot be set for TM-H5000II, TM-U675, TM-U950.
*5 The 57600-baud rate can only be set for TM-J7000, TM-J7100, TM-H6000IV,
TM-H2000 and TM-H6000V.
*6 The 115200-baud rate can only be set for TM-J7000, TM-J7100,
TM-H6000IV, TM-H2000 and TM-H6000V.

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
MICR (EPSON TM Series)
8
The default settings are as shown in the following table.
Setting Information Set value
Baud rate 9600 *1, 19200, 38400*2
Bit length 8 bits
Parity NONE
Stop bit 1 bit
Handshake DTR/DSR
Input buffer length 1024
Output buffer length 1024
Output interval time 1000
Input sleep time 10
*1 The 9600-baud rate can only be set for TM-H5000II and TM-U950.
*2 The 38400 baud rate can only be set for TM-H6000V.
All MICR settings are exactly the same as the printer.
2) Port information when using parallel port
All MICR settings are exactly the same as the printer.
3) Port information when using USB port
All MICR settings are exactly the same as the printer.
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.

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
MICR (EPSON TM Series)
9
Section 3. Function Details
This section describes the functions of the MICR device in details. Supplementary
explanation of the parts not described in detail in UPOS is also given here.
3.1 CheckHealth Method
3.1.1 Internal Test
Checks whether the MICR can establish a communication and returns a result.
When the method is executed by OPOS_CH_INTERNAL, the character string of
the CheckHealthText property is as follows.
“Internal Hcheck: Complete” : CheckHealthText
After executing the CheckHealth method, be sure to confirm the return value. If
an error has occurred, there is no point in referring to the CheckHealthText
property. For details on the error, refer to the Section 6 of this manual.
3.1.2 External Test
Not supported
3.1.3 Interactive Test
Executes interactive CheckHealth test. When executed, the following dialog box
is displayed.
When the dialog box is displayed, press the [Read] button. If the Check is present,
please first remove and then set the check in slip station.
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.

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
MICR (EPSON TM Series)
10
The read data will be displayed as the RawData as follows:
RawData: xxxxxx xxxxxx
Confirm the contents.
When the method is executed by OPOS_CH_INTERACTIVE, the character
strings of the CheckHealthText property are as follows.
“Interactive Hcheck: Canceled” : When the [Close] button is pressed
without executing the [Read].
“Interactive Hcheck: Complete” : When the [Close] button is pressed after
executing the [Read].
After executing the CheckHealth method, be sure to confirm the returned value. If
an error has occurred, there is no point in referring to the CheckHealthText
property. For details on the error, refer to the Section 6 of this manual.
3.2 Property Set values and Default Values
3.2.1 Capability Set Value
Capability Name Set Value *1 Set Value
CapValidationDevice FALSE TRUE
CapPowerReporting See the table1.
*1 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
USB OPOS_PR_ADVANCED
Ethernet OPOS_PR_ADVANCED
Bluetooth OPOS_PR_STANDARD

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
MICR (EPSON TM Series)
11
3.3 Supplementary Explanation of Functions
3.3.1 Valid Headers
The MICR sets data read from a check in its properties. If a data read by the
check is invalid, the 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. The symbols shows in the below
explanations are substitute characters for numeric values, and property names
are fields that hold the substitute characters after the data is divided. For further
information about substitute characters, please consult the “MICR Character
Substitution” section of the “UPOS”.
Property Name Length Standard Settings Symbol
AccountNumber Over 6 A string parsed from the read MICR data.
It is defined the section between the TransitNumber
field and the On-Us Symbol.
If a Serial number can be parsed from this field, it is
removed.
o
Amount 10 Character string between two Amount symbols ‘a’ a
BankNumber 5 The 4th to 8th characters of the Transit field
CheckType If the Auxiliary On-Us field is not present,
MICR_CT_PERSONAL
If the Auxiliary On-Us field is present,
MICR_CT_BUSINESS
When no information is available,
MICR_CT_UNKNOWN
CountryCode If the check type is E-13B:
MICR_CC_UNKNOWN
If the check type is CMC-7:
MICR_CC_CMC7
EPC 1 When a TransitNumber is present, the number directly
preceding the TransitNumber. Spaces are ignored. a
SerialNumber If On-Us field is present the data from that field. If not,
the data in the On-Us field excluding the Account
Number data.
TransitNumber 9 All characters read between the Transit symbols t
RawData All data read in from the MICR
When desired data cannot be obtained from the data read into the various
properties, use the RawData property.

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
MICR (EPSON TM Series)
12
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
check is successfully read. If all check digits are not successfully read the Check
Digit test does not take place.
3.4 Device Statistics
The DeviceStatistics function is added in response to the compliance of the
"UPOS 1.8".
Please refer to the “EPSON OPOS ADK MANUAL APPLICATION GUIDE Device
Statistics” of a separate volume for the details of the Device Statistics.
3.5 Communication Compatibility
Use the “Communication Compatibility” setting of the SetupPOS utility if you want
to enable a compatibility relation to the serial connection in the device being used
by the USB connection.
For details, please refer to the "Section 5. SetupPOS Utility" of the "EPSON
OPOS ADK MANUAL User's Manual (Installer/ SetupPOS/ TMUSB)" manual.

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
MICR (EPSON TM Series)
13
Section 4. Expanded Functions
This section describes the expanded functions of the MICR device.
4.1 DirectIO Function
The usage of the DirectIO method and DirectIOEvent event is described in the
following.
4.1.1 DirectIO Method
Syntax DirectIO Command As Long, pData As Long, pString As
String
1) MICR_DI_CLEANING
Parameter Explanation
Command MICR_DI_CLEANING
pData Not used.
pString Not used. Null character string is entered.
Explanation Sends the MICR Cleaning command.
Returned value One of the following is returned and stored in the ResultCode
property.
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 a
function.
Requirement Open, Claim & Enable

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
MICR (EPSON TM Series)
14
2) MICR_DI_GETSTATUS
Parameter Explanation
Command MICR_DI_GETSTATUS
pData Not used.
pString Not used. Null character string is entered.
Explanation Transmits a command that obtains the MICR status. The
obtained status is notified by the DirectIOEvent.
Returned value One of the following is returned and stored in the ResultCode
property.
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 a
function.
The parameter is illegal.
Requirement Open, Claim & Enable
3) MICR_DI_RECOVER_ERROR
Parameter Explanation
Command MICR_DI_RECOVER_ERROR
pData Not used
pString Not used. Null character string is entered.
Explanation Recover from recoverable error.
When a printer is not in an error mode, the command has no
effect on the printer.
Returned value One of the following is returned and stored in the ResultCode
property.
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 The parameter is illegal.
Other Refer to the ResultCode item.
Requirement Open, Claim & Enable

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
MICR (EPSON TM Series)
15
4) MICR_DI_SELECT_CHECK_FONT
Parameter Explanation
Command MICR_DI_SELECT_CHECK_FONT
pData Font constant
pString Not used. Null character string is entered.
Explanation Changes the font setting of checks to be read.
The assignable values for the pData setting are as follows:
MICR_DI_MICR_CHECK_E13B: Sets the font to E-13B.
MICR_DI_MICR_CHECK_CMC7: Sets the font to CMC7.
This command is valid only in the following device. When the
inappropriate device is specified, OPOS_E_ILLEGAL
(OPOS_EX_NOTSUPPORTED) is returned.
TM-H6000II
TM-H6000III
TM-H2000
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

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
MICR (EPSON TM Series)
16
4.1.2 DirectIOEvent Event
Syntax DirectIOEvent EventNumber As Long, pData As
Long, pString As String
Parameter Explanation
EventNumber Not used.
pData Single byte data.
pString Not used.
Remarks This event is fired to send information that results from the running
of the DirectIO method. Data is stored in pData.
Prerequisites Open, Claim & Enable
4.2 List of Commands Usable with DirectIO
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.