Epson TM-H6000III Development Manual
Hide thumbs Also See for TM-H6000III:

Advertisement

Quick Links

EPSON OPOS ADK MANUAL
APPLICATION DEVELOPMENT
GUIDE
CheckScanner
Version 3.00 Feb. 2019

Advertisement

Table of Contents
loading

Summary of Contents for Epson TM-H6000III

  • Page 1 EPSON OPOS ADK MANUAL APPLICATION DEVELOPMENT GUIDE CheckScanner 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®, Visual Basic®...
  • Page 3: Table Of Contents

    Version 3.00 Feb. 2019 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......................
  • Page 4: Section 1. Introduction

    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.
  • Page 5: 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 DeviceDescription DeviceName TM-H6000III EPSON TM-H6000III Scanner TM-H6000III EPSON TM-H6000IIIP Scanner TM-H6000IIIP EPSON TM-H6000IIIU Scanner TM-H6000IIIU EPSON TM-H6000IIIE Scanner TM-H6000IIIE I/F indicate the connected interface.
  • Page 6: Setting Of Devices

    Version 3.00 Feb. 2019 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 7: Port Information

    Version 3.00 Feb. 2019 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...
  • Page 8: Section 3. Function Details

    Version 3.00 Feb. 2019 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.
  • Page 9 Version 3.00 Feb. 2019 When the dialog box is displayed, press the [Read] button. The checks to be read here read accordance with mode 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.
  • Page 10: Property Set Values And Default Values

    Version 3.00 Feb. 2019 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...
  • Page 11: Device Statistics

    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".
  • Page 12: Section 4. Expanded Functions

    Version 3.00 Feb. 2019 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...
  • Page 13 Version 3.00 Feb. 2019 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.
  • Page 14 Version 3.00 Feb. 2019 CHK_DI_EXTEND_READAREA 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.
  • Page 15 Version 3.00 Feb. 2019 This command is effective only for check scanner mode. During card scanner mode, this command is not available. When CHK_DI_SHARPNESS_IMAGE command 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.
  • Page 16 Version 3.00 Feb. 2019 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”.
  • Page 17 Version 3.00 Feb. 2019 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...
  • Page 18 Version 3.00 Feb. 2019 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.
  • Page 19 Version 3.00 Feb. 2019 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.
  • Page 20 Version 3.00 Feb. 2019 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.
  • Page 21 Version 3.00 Feb. 2019 7) CHK_DI_BORDER_COLOR Parameter Explanation Command CHK_DI_BORDER_COLOR pData Sets the threshold value. pString Not used. Null character string is entered. Explanation Sets the threshold value to read, using two values. The threshold value settings are as follows: Setting value Meaning Basic setting...
  • Page 22 Version 3.00 Feb. 2019 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...
  • Page 23 Version 3.00 Feb. 2019 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...
  • Page 24 Version 3.00 Feb. 2019 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...
  • Page 25 Version 3.00 Feb. 2019 (ResultCode) (ResultCodeExtended) OPOS_E_ILLEGAL OPOS_ECHK_TMSTORE_NOROOM OPOS_E_FAILURE OPOS_ECHK_TMSTORE_WRITE CHK_DI_ERRORMODE_CANCEL configuration recommended. b) pData: CHK_DI_ERRORMODE_RETRY When it is failed to store image to the device, the data is stored in the working buffer memory area. The result of the EndInsertion command becomes Error even the data are successfully stored in the working buffer memory area.
  • Page 26 Version 3.00 Feb. 2019 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...
  • Page 27 Version 3.00 Feb. 2019 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...
  • Page 28 Version 3.00 Feb. 2019 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...
  • Page 29 Version 3.00 Feb. 2019 When CHK_DI_SHARPNESS_ON is set, the settings of the CHK_DI_PRESCAN command CHK_DI_BORDER_COLOR command of DirectIO method are not reflected to read images. The default value is CHK_DI_SHARPNESS_OFF. Returned value One of the following is returned and stored in the ResultCode property.
  • Page 30 Version 3.00 Feb. 2019 14) CHK_DI_GET_SUPPORT_FUNCTION Parameter Explanation Command CHK_DI_GET_SUPPORT_FUNCTION pData Sets the value to indicate the functions of the device. pString Not used. Null character string is entered. Explanation The function information of currently used device is set in pData. When more than one function is loaded, logical OR of the following constant numbers is set.
  • Page 31 Version 3.00 Feb. 2019 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...
  • Page 32 Version 3.00 Feb. 2019 The setting information of a command is not reflected to Quality property, QualityList property, DocumentWidth property and DocumentHeight property. The setting that is specified by command becomes valid on execution of RetrieveImage or StoreImage. The default value is CHK_DI_200 x 200. Returned value One of the following is returned and stored in the ResultCode property.
  • Page 33: Directioevent Event

    Version 3.00 Feb. 2019 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.
  • Page 34: Section 5. Device Specific Programming

    Version 3.00 Feb. 2019 Section 5. Device Specific Programming This section describes device specific programming of the CheckScanner devices. 5.1 Specifying the Extended Function of EndInsertion In CheckScanner, you can set the extended function of EndInsertion using the DirectIO method. The following shows how to specify pre-scanning and filtering as the extended function setting of EndInsertion.
  • Page 35: Specifying The Reading Area

    Version 3.00 Feb. 2019 RC = CheckScanner1.DirectIO (Command, Data, Dummy) If RC = OPOS_SUCCESS Then ‘Success Else ‘Error End If 5.2 Specifying the Reading Area In CheckScanner, you can set the data area to read using EndInsertion. The sample program on extended function setting of EndInsertion is shown below.
  • Page 36: Section 6. Error Information

    Section 6. Error Information This section describes the error codes that may result from execution of CheckScanner methods. The common properties and methods are described in "EPSON OPOS ADK MANUAL APPLICATION DEVELOPMENT GUIDE GENERAL DEVELOPMENT". Please refer to this guide for more information.
  • Page 37: Executing The Method

    Version 3.00 Feb. 2019 6.2 Executing the Method The ResultCode and ResultCodeExtended when methods are executed are as follows. Method Name ResultCode ResultCodeExtended Meaning BeginInsertion OPOS_SUCCESS Refer to UPOS Specifications. OPOS_E_CLOSED Refer to UPOS Specifications. OPOS_E_DISABLED Refer to UPOS Specifications. OPOS_E_NOTCLAIMED Refer to UPOS Specifications.
  • Page 38 Version 3.00 Feb. 2019 Method Name ResultCode ResultCodeExtended Meaning EndInsertion OPOS_SUCCESS Refer to UPOS Specifications. OPOS_E_CLOSED Refer to UPOS Specifications. OPOS_E_DISABLED Refer to UPOS Specifications. OPOS_E_NOTCLAIMED Refer to UPOS Specifications. OPOS_E_CLAIMED Refer to UPOS Specifications. OPOS_E_BUSY Printer power is OFF. OPOS_E_ILLEGAL Refer to UPOS Specifications.
  • Page 39 Version 3.00 Feb. 2019 Method Name ResultCode ResultCodeExtended Meaning RetrieveImage OPOS_SUCCESS Refer to UPOS Specifications. OPOS_E_CLOSED Refer to UPOS Specifications. OPOS_E_DISABLED Refer to UPOS Specifications. OPOS_E_NOTCLAIMED Refer to UPOS Specifications. OPOS_E_CLAIMED Refer to UPOS Specifications. OPOS_E_ILLEGAL OPOS_EX_BADPARAM + 1 cropAreaID parameter is illegal. OPOS_EX_INVALIDMODE Cannot execute in the current mode.
  • Page 40 Version 3.00 Feb. 2019 ・OPOS_EPTR_REC_CARTRIDGE_REMOVED ・OPOS_EPTR_REC_CARTRIDGE_EMPTY ・OPOS_EPTR_REC_HEAD_CLEANING ・OPOS_EPTR_LABEL_JAM ・OPOS_EPTR_MECHANICAL ・OPOS_EPTR_CUTTER ・OPOS_EPTR_UNRECOVERABLE ・OPOS_EPTR_AUTORECOVERABLE APPLICATION DEVELOPMENT GUIDE CheckScanner...
  • Page 41: Remedial Actions For Principal Errors

    Version 3.00 Feb. 2019 6.3 Remedial Actions for Principal Errors ResultCodeExtended Remedy OPOS_EX_DEVBUSY If the power to the CheckScanner (TM Printer) is disconnected, it is OPOS_EX_TIMEOUT necessary to once apply Close and then invoke Open/Claim/Enable again. OPOS_EPTR_COVER_OPEN Confirm the status of the printer, and then execute the program and OPOS_EPTR_REC_EMPTY method again.
  • Page 42: Section 7. Warnings

    Section 7. Warnings The CheckScanner settings follow the same hydra connection settings as the master device EPSON TM series printer. Please refer to the Section 7 of "EPSON OPOS ADK MANUAL APPLICATION DEVELOPMENT GUIDE POSPrinter (TM Series)” for further information.
  • Page 43 Version 3.00 Feb. 2019 The following table indicates environmental aptitudes for scanning function. Image scanning Image scanning Image scanning with with with Environment Bi-tonal Gray scale Gray scale (Check) (Check) (Card) Serial (9,600 bps) Serial (19,200 bps) Serial (38,400 bps) Parallel (USB interface board for This printer;...
  • Page 44 The program specified for reading from Storage Memory of the device should be used for reading the stored image. Please refer to "EPSON OPOS ADK MANUAL TM Storage OCX MANUAL TM Storage OCX" for details. The file name of this manual is "TMStorage.pdf". It is placed in the "Manual"...
  • Page 45 Version 3.00 Feb. 2019 necessary. After the mode switching, card can be read with the same procedure as the check. • BeginInsertion, EndInsertion and CheckHealth methods are transacted corresponding to specified reading mode at the method execution. BeginRemoval and EndRemoval methods are transacted regardless of reading mode.

This manual is also suitable for:

Tm-h6000iiipTm-h6000iiiuTm-h6000iiie

Table of Contents