Epson ProofPlus TM-H6000III User manual

EPSON OPOS ADK MANUAL
APPLICATION DEVELOPMENT
GUIDE
CheckScanner
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®, 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.
Other product and company names used herein are for identification purposes only and
may be trademarks or registered trademarks of their respective companies.
Copyright (c) 2002-2019 Seiko Epson Corporation

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
CheckScanner
iii
Contents
SECTION 1. INTRODUCTION ............................................................................................1
SECTION 2. DETAILS ON SETTINGS...............................................................................2
2.1 Device Information .....................................................................................................2
2.2 References of Firmware Versions..............................................................................2
2.3 Settings of DIP Switches and Hardware.....................................................................2
2.4 Setting of Devices......................................................................................................3
2.5 Port Information..........................................................................................................4
SECTION 3. FUNCTION DETAILS.....................................................................................5
3.1 CheckHealth Method..................................................................................................5
3.1.1 Internal Test.........................................................................................................5
3.1.2 External Test .......................................................................................................5
3.1.3 Interactive Test....................................................................................................5
3.2 Property Set Values and Default Values....................................................................7
3.2.1 Capability Set Value ............................................................................................7
3.2.2 Other Information.................................................................................................7
3.3 Device Statistics.........................................................................................................8
3.4 Contrast......................................................................................................................8
SECTION 4. EXPANDED FUNCTIONS..............................................................................9
4.1 DirectIO Function.......................................................................................................9
4.2 DirectIO Method.........................................................................................................9
4.3 DirectIOEvent Event.................................................................................................30
SECTION 5. DEVICE SPECIFIC PROGRAMMING..........................................................31
5.1 Specifying the Extended Function of EndInsertion...................................................31
5.2 Specifying the Reading Area....................................................................................32
SECTION 6. ERROR INFORMATION...............................................................................33
6.1 Executing the Property.............................................................................................33
6.2 Executing the Method...............................................................................................34
6.3 Remedial Actions for Principal Errors.......................................................................38
SECTION 7. WARNINGS..................................................................................................39

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
CheckScanner
1
Section 1. Introduction
This manual describes the method of use and related items, including device-specific
precautions, when the CheckScanner device is used with EPSON OPOS ADK.
Before the CheckScanner 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 refer to the Section 2 of this manual.
This manual applies to the following devices.
EPSON TM-H6000III with Scanner
Hereafter, throughout This manual, the various model names will be referred to as
“TM-H6000III”.
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
CheckScanner
2
Section 2. Details on Settings
This section describes connection configurations and how to make the settings for the
CheckScanner devices.
2.1 Device Information
The DeviceDescription and DeviceName for each model are as follows.
Model Name I/F DeviceDescription DeviceName
S EPSON TM-H6000III Scanner TM-H6000III
P EPSON TM-H6000IIIP Scanner TM-H6000IIIP
U EPSON TM-H6000IIIU Scanner TM-H6000IIIU
TM-H6000III
E EPSON TM-H6000IIIE Scanner TM-H6000IIIE
I/F indicate the connected interface.
The following is the list of the four connecting interfaces.
S: Serial
P: Parallel
U: USB
E: Ethernet
2.2 References of Firmware Versions
Please refer to the release notes (Relnote.txt).
2.3 Settings of DIP Switches and Hardware
There are no Dip Switch settings for the CheckScanner. Please refer to the
settings of the Printer.

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
CheckScanner
3
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
2) Setting of USB interface devices
When the SetupPOS utility is used to select the device when using a 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) Device Specific Settings
Not applicable

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
CheckScanner
4
2.5 Port Information
This section explains the port information for each device.
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 4800, 9600, 19200, 38400
Bit length 7 bits, 8 bits
Parity NONE, ODD, EVEN
Stop bit 1 bit
Handshake DTR/DSR
Output buffer length 32-1024
Output interval time 0-9999
The default settings are as shown in the following table.
Setting Information Effective Setting Range
Baud rate 19200
Bit length 8 bits
Parity NONE
Stop bit 1 bit
Handshake DTR/DSR
Output buffer length 1024
Output interval time 2500
All CheckScanner settings are exactly the same as the printer.
2) Port information when using parallel port
All CheckScanner settings are exactly the same as the printer.
3) Port information when using USB port
All CheckScanner settings are exactly the same as the printer.
4) Port information when using Ethernet port
All CheckScanner settings are exactly the same as the printer.

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
CheckScanner
5
Section 3. Function Details
This section describes the functions of the CheckScanner 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
Confirms whether the CheckScanner 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, please refer to 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.

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
CheckScanner
6
When the dialog box is displayed, press the [Read] button. The checks to be
read here are read in accordance with the set mode by
CHK_DI_CHANGE_MODE of DirectIO. If the Check is present, please first
remove and then set the check in slip station. If a check or card is set correctly,
data will be read. If a check or card is not set, a message requesting for
inserting a check or card will be displayed. After inserting the check or card,
press the [Read] button. Then the check or card is read. Reading takes from a
few seconds to dozens of seconds. Confirm the reading state on the progress
bar. The read data appears as an image in the dialog box, and the image format
is fixed at bitmap. For CheckHealth, part of the image is read in and displayed.
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, please refer to Section 6 of this manual.

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
CheckScanner
7
3.2 Property Set Values and Default Values
3.2.1 Capability Set Value
Capability Name Check Scanner Mode Card Scanner Mode
CapAutoGenerateFileID FALSE FALSE
CapAutoGenerateImageTagData FALSE FALSE
CapAutoSize TRUE FALSE
CapColor CHK_CCL_MONO
CHK_CCL_GRAYSCALE CHK_CCL_GRAYSCALE
CapConcurrentMICR FALSE FALSE
CapDefineCropArea TRUE TRUE
CapImageFormat CHK_CIF_BMP | CHK_CIF_TIFF | CHK_CIF_JPEG
CapImageTagData TRUE TRUE
CapMICRDevice TRUE TRUE
CapStoreImageFiles TRUE TRUE
CapValidationDevice FALSE FALSE
CapAutoContrast FALSE FALSE
CapContrast TRUE TRUE
3.2.2 Other Information
Property Name Check Scanner Mode Card Scanner Mode
Color (*1) CHK_CL_MONO CHK_CL_GRAYSCALE
ImageFormat (*1) CHK_IF_TIFF CHK_IF_JPEG
MaxCropAreas (*2) 10
QualityList “200” “200”
*1 Indicates the setting information of default value.
*2 Does not change depending on reading mode.

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
CheckScanner
8
3.3 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” for the details of the Device Statistics.
3.4 Contrast
The Contrast function is added in response to the compliance of the "UPOS 1.9".
The brightness of the image can be adjusted by set value in the range of 0
through 100 of the Contrast property.*1 Please refer to UPOS for detail.
*1 The setting of the Contrast Property can only be effective when the Color property is set
to CHK_CL_GRAYSCALE.

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
CheckScanner
9
Section 4. Expanded Functions
This section describes the expanded functions of the CheckScanner device.
4.1 DirectIO Function
The usage of the DirectIO method and DirectIOEvent event is described in the
following.
4.2 DirectIO Method
Syntax DirectIO Command As Long, pData As Long, pString As String
1) CHK_DI_ENDINSERTION_EXTEND
Parameter Explanation
Command CHK_DI_ENDINSERTION_EXTEND
pData Specifies the following values indicating the extended
functions of EndInsertion.
CHK_DI_EXTEND_DEFAULT
CHK_DI_EXTEND_PRESCAN
CHK_DI_EXTEND_READAREA
CHK_DI_EXTEND_FILTER
CHK_DI_EXTEND_ATTACHED
CHK_DI_EXTEND_TMSTORE
pString Not used. Null character string is entered.
Explanation Expands the function of EndInsertion
When CHK_DI_EXTEND_DEFAULT is set, the EndInsertion
method inserts the paper and scans an image.
When CHK_DI_EXTEND_PRESCAN is set, the EndInsertion
method inserts the paper and then executes pre-scanning.
EndInsertion scans an image after pre-scanning.
When CHK_DI_EXTEND_READAREA is set, the EndInsertion
method scans an image after setting the reading area. Please

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
CheckScanner
10
refer to the CHK_DI_READ_AREA command reference
regarding the effective reading area.
When CHK_DI_EXTEND_FILTER is set, the EndInsertion
method scans an image after setting the filtering area. Please
refer to the CHK_DI_IMAGE_FILTER command reference
regarding the effective reading area.
When CHK_DI_EXTEND_FILTER is set, the EndInsertion
method scans an image after setting the filtering area. Please
refer to the CHK_DI_IMAGE_FILTER command reference
regarding the effective reading area.
When CHK_DI_EXTEND_ATTACHED is set, the EndInsertion
method sets an embedded character string to the header of the
read image data.
Please refer to the CHK_DI_ATTACHED_DATA command
reference regarding the embedded character string.
When CHK_DI_EXTEND_TMSTORE is set, the EndInsertion
method stores the image data in the Storage Memory of the
device. When the device does not have Storage Memory
function, this command is unable to use.
For Executing the EndInsertion method under the above flag, it
is required to number storing memory by using the
CHK_DI_TMSTORE_SET_INDEX command in advance.
Please refer to the CHK_DI_TMSTORE_SET_INDEX
command reference on how to set memory ID (number).
When storing image data in the Storage Memory is done
successfully, the Work Memory does not acquirer any data.
Therefore, the contents of the working buffer memory area are
not updated under the flag. When the data image storing is
failed, the action configured by the
CHK_DI_TMSTORE_ERRORMODE command occurs.
Please refer to the CHK_DI_TMSTORE_ERRORMODE
command reference for error reaction.
Values other than CHK_DI_EXTEND_DEFAULT can be
specified simultaneously using the OR operation.
The default value is CHK_DI_EXTEND_DEFAULT.
CHK_DI_EXTEND_PRESCAN,

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
CheckScanner
11
CHK_DI_EXTEND_READAREA and
CHK_DI_EXTEND_FILTER are effective only for check
scanner mode. Those flags can be set during card scanner
mode, but the settings are not reflected to card reading directly.
If those flags were set during card scanner mode, the flags
become effective after changing the mode to check scanner
mode.
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.
The device does not have Storage Memory
function.
Other Refer to the ResultCode item.
Requirement Open, Claim & Enable
2) CHK_DI_PRESCAN
Parameter Explanation
Command CHK_DI_PRESCAN
pData Not used. “0” is always entered.
pString Not used. Null character string is entered.
Explanation Executes pre-scanning.
Executes this command when the paper is inserted for
pre-scanning. If the paper is not inserted, or is inserted but
pre-scanning cannot be executed, an error occurs. When this
command is executed, control does not return until
pre-scanning is finished.

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
CheckScanner
12
This command is effective only for check scanner mode.
During card scanner mode, this command is not available.
When the CHK_DI_SHARPNESS_IMAGE command of
DirectIO method is set, the set value with this command is not
reflected to the read images.
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 and the pre-scanning cannot be
executed.
The current reading mode does not support
this command.
OPOS_E_EXTENDED The paper is not inserted.
Other Refer to the ResultCode item.
Requirement Open, Claim & Enable

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
CheckScanner
13
3) CHK_DI_READ_AREA
Parameter Explanation
Command CHK_DI_READ_AREA
pData Not used. “0” is always entered.
pString Character string to specify an area.
Explanation Specifies the reading area to set in pString.
Example: When you use the area of X = 0, Y = 500, CX = 1000,
CY = 1500,
specify pString = “0, 500, 1000, 1500”.
X is the X coordinate of the start of the specified area.
Y is the Y coordinate of the start of the specified area.
CX is the X coordinate of the end of the specified area.
CY is the Y coordinate of the end of the specified area.
The values specified here affect MapMode.
Use the null character string (“”) to cancel the specified area.
If the range of specified area exceeds the available range of the device,
it is reduced to within the effective range.
When you specify the reading area, you must set the size of check in the
DocumentWidth and DocumentHeight properties before executing the
EndInsertion method.
Be sure to specify the X coordinate of the end of the specified area.
Scanning fails if the length from the specified coordinates to the left end
of the paper is less than 50 mm. In this case, ECHK_PTRERROR is
notified as ErrorEvent.
Use the CHK_DI_ENDINSERTION_EXTEND command to enable the
setting. Please refer to CHK_DI_ENDINSERTION_EXTEND for details.
The settings with this command are effective only for check scanner
mode. Although during card scanner mode, a reading area can be set
by executing this command, the settings are not reflected to card
reading directly. If these settings are set during card scanner mode,
the settings become effective after changing the mode to check scanner
mode, and only for reading checks.

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
CheckScanner
14
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.
Other Refer to the ResultCode item.
Requirement Open, Claim & Enable
4) CHK_DI_IMAGE_FILTER
Parameter Explanation
Command CHK_DI_IMAGE_FILTER
pData Specifies an area number. The available value is 1 to 10.
pString Specifies an area to set.
Explanation Specifies an area to become effective after reading.
Example: When you use the area of X = 0, Y = 500, CX = 1000,
CY = 1500,
specify pString = “0, 500, 1000, 1500”.
Here,
X is the X coordinate of the start of the specified area.
Y is the Y coordinate of the start of the specified area.
CX is the X coordinate of the end of the specified area.
CY is the Y coordinate of the end of the specified area.
The values specified here affect MapMode.
Use the area number in pData and null character string (“”) in pString
to cancel the specified area. Specify “0” in pData to cancel all area.
When you set at least one effective reading area, images other than
the setting area is filled with white.
When you specify the effective reading area, you must set the size of

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
CheckScanner
15
check in the DocumentWidth and DocumentHeight properties before
executing the EndInsertion method.
Use the CHK_DI_ENDINSERTION_EXTEND command to enable the
setting.
Please refer to the CHK_DI_ENDINSERTION_EXTEND command
reference for details.
The settings with this command are effective only for check scanner
mode. Although during card scanner mode, a filtering area can be
set by executing this command, the settings are not reflected to card
reading directly. If these settings are set during card scanner mode,
the settings become effective after changing the mode to check
scanner mode, and only for reading checks.
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 and pre-scanning cannot be
executed.
OPOS_E_EXTENDED The paper is not inserted.
Other Refer to the ResultCode item.
Requirement Open, Claim & Enable

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
CheckScanner
16
5) CHK_DI_ATTACHED_DATA
Parameter Explanation
Command CHK_DI_ATTACHED_DATA
pData Not used. “0” is always entered.
pString Sets the character string to embed.
Explanation Sets the character string to embed at the header of an image
file.
The character string can be up to 1024 bytes.
Depending on the image format specified for reading,
sometimes you cannot embed the character string. However,
you can embed the character string in the TIFF and JPEG
image formats.
Use the CHK_DI_ENDINSERTION_EXTEND command to
enable the setting.
Please refer to the CHK_DI_ENDINSERTION_EXTEND
command reference for details.
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.
Other Refer to the ResultCode item.
Requirement Open, Claim & Enable

Version 3.00 Feb. 2019
APPLICATION DEVELOPMENT GUIDE
CheckScanner
17
6) CHK_DI_SIZE_OFFSET
Parameter Explanation
Command CHK_DI_SIZE_OFFSET
pData Sets the offset value.
pString Not used. Null character string is entered.
Explanation Sets offset value for auto sizing.
Cuts off the portion set by offset value from the top and bottom
of the check detected by SO. The MapMode property affects
the values specified here.
Use this function only when an unnecessary line remains on
the top and bottom of the read check. Do not use the function
for the other purposes.
The default value is “0”.
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