Oki PT340, PT341 OPOS Application Programmer's Guide

PT340/PT341

POS Printer, Cash Drawer Application Programmer's Guide of OPOS-OCX Driver for Serial/ USB/ LAN Interface

Index

1. Outline ........................................................................................................................... 1

1.1. Subject Scope of this document........................................................................................1

1.2. OPOS Control Outline......................................................................................................2

1) OPOS Control Configuration Drawing...........................................................................2

2) Terminology....................................................................................................................4

1.3. Restrictions.......................................................................................................................5

1) POS Printer......................................................................................................................5

2) Drawer.............................................................................................................................6

3) Common Restrictions on POS Printer and Drawer.........................................................6

4) Restriction when Windows driver and OPOS driver are installed in the same system ...6

5) Setting of Apartment ="0" with connecting LAN interface cable...................................7

6) Setting of Apartment ="1" with connecting LAN interface cable...................................7

7) About the "Found New Hardware Wizard" in Windows.................................................8

1.4. Connection Way to POS Printer........................................................................................9

2. Installation ....................................................................................................................11

2.1. Installation Condition......................................................................................................11

2.2. Installation Media...........................................................................................................12

2.3. Installation Procedure.....................................................................................................13

Installation using installer.......................................................................................................... 13

Installation using batch file........................................................................................................17

2.4. Uninstallation Procedure.................................................................................................19

Uninstallation when installing it with installer (Setup32.exe or Setup64.exe) ..........................19

Uninstallation when OPOS is installed with batch file..............................................................21

2.5. Installation File List........................................................................................................22

2.6. Setting Program Usage ................................................................................................... 24

3. Using OPOS Control ................................................................................................... 38

3.1. Common..........................................................................................................................38

3.2. POS Printer.....................................................................................................................38

3.3. Drawer ............................................................................................................................38

3.4. How to Implement the OPOS Control............................................................................39

4. OPOS Interface Specifications (Printer)...................................................................... 46

4.1. List..................................................................................................................................46

4.2. Printing D

ata and Escape Sequence................................................................................ 56

4.3. Common Properties ........................................................................................................64

BinaryConversion Property R/ W...............................................................................................64

CapCompareFirmwareVersion Property....................................................................................67

CapPowerReporting Prope rt y....................................................................................................67

CapStatisticsReporting Property................................................................................................67

CapUpdateFirmware Property...................................................................................................68

CapUpdateStatistics Property ....................................................................................................68

CheckHealthText Property.........................................................................................................68

Claimed Property.......................................................................................................................69

ControlObjectDescription Property...........................................................................................69

ControlObjectVersion Property..................................................................................................70

DeviceDescription Property.......................................................................................................70

DeviceEnabled Property R/W....................................................................................................71

DeviceName Property................................................................................................................73

FreezeEvents Property R/W.......................................................................................................73

OpenResult Property..................................................................................................................74

OutputID Property.....................................................................................................................74

PowerNotify Property R/W .......................................................................................................75

PowerState Property ..................................................................................................................76

ResultCode Property..................................................................................................................77

ResultCodeExtended Property...................................................................................................78

ServiceObjectDescription Property ...........................................................................................80

ServiceObjectVersion Property..................................................................................................80

State Property.............................................................................................................................80

4.4. Common Methods...........................................................................................................81

CheckHealth Method.................................................................................................................81

ClaimDevice Method.................................................................................................................83

ClearOutput Method..................................................................................................................84

Close Method.............................................................................................................................84

CompareFirmwareVersion Method............................................................................................85

DirectIO Method........................................................................................................................87

Open Method.............................................................................................................................94

ReleaseDevice Method..............................................................................................................95

ResetStatistics Method...............................................................................................................95

RetrieveStatistics Method..........................................................................................................95

UpdateFirmwareMethod............................................................................................................96

UpdateStatistics Method............................................................................................................97

4.5. Specific Property.............................................................................................................98

AsyncMode Property R/W.........................................................................................................98

CapCharacterSet Property..........................................................................................................98

CapCoverSensor Property..........................................................................................................98

CapMapCharacterSet Property..................................................................................................99

CapRec2Color Property.............................................................................................................99

CapRecBarCode Property..........................................................................................................99

CapRecBitmap Property............................................................................................................99

CapRecBold Property..............................................................................................................100

CapRecCartridgeSensor Property............................................................................................100

CapRecColor Property.............................................................................................................100

CapRecDhigh Property............................................................................................................100

CapRecDwide Property...........................................................................................................101

CapRecDwideDhigh Property .................................................................................................101

CapRecEmptySensor Property ................................................................................................101

CapRecItalic Property..............................................................................................................101

CapRecLeft90 Property ...........................................................................................................102

CapRecMarkFeed Property......................................................................................................102

CapRecNearEndSensor Property.............................................................................................102

CapRecPageMode Property.....................................................................................................102

CapRecPapercut Property........................................................................................................103

CapRecPresent Property..........................................................................................................103

CapRecRight90 Property.........................................................................................................103

CapRecRotate180 Property......................................................................................................103

CapRecStamp Property............................................................................................................104

CapRecUnderline Property...................................................................................................... 104

CapTransaction Property .........................................................................................................104

CartridgeNotify Property R/W.................................................................................................105

CharacterSet Property R/W .....................................................................................................106

CharacterSetList Property........................................................................................................107

CoverOpen Property................................................................................................................107

ErrorLevel Property.................................................................................................................107

ErrorStation Propert y...............................................................................................................108

ErrorString Property................................................................................................................108

FlagWhenIdle Property R/W...................................................................................................109

FontTypefaceList Property ......................................................................................................109

MapCharacterSet Property.......................................................................................................109

MapMode Property R/W .........................................................................................................110

PageModeArea Property..........................................................................................................110

PageModeDescriptor Property.................................................................................................110

PageModeHorizontalPosition Property ................................................................................... 111

PageModePrintArea Property..................................................................................................111

PageModeStation Property......................................................................................................111

PageModeVerticalPosition Property........................................................................................111

RecBarCodeRotationList Property ..........................................................................................112

RecBitmapRotationList Property.............................................................................................112

RecCartridgeState Property .....................................................................................................113

RecCurrentCartridge Property R/W.........................................................................................113

RecEmpty Property..................................................................................................................113

RecLetterQuality Property R/W ..............................................................................................114

RecLineChars Property R/W................................................................................................... 115

RecLineCharsList Property......................................................................................................116

RecLineHeight Property R/W..................................................................................................117

RecLineSpacing Property R/W................................................................................................118

RecLinesToPaperCut Property.................................................................................................118

RecLineWidth Property...........................................................................................................119

RecNearEnd Property..............................................................................................................119

RecSidewaysMaxChars Property.............................................................................................120

RecSidewaysMaxlLines Property............................................................................................121

RotateSpecial Property R/W....................................................................................................121

4.6. Exclusive-Use Methods................................................................................................123

BeginInsertion Method............................................................................................................123

BeginRemoval Method............................................................................................................123

ChangePrintSide Method.........................................................................................................124

ClearPrintArea Method............................................................................................................124

CutPaper Method.....................................................................................................................124

EndInsertion Method...............................................................................................................126

EndRemoval Method...............................................................................................................126

MarkFeed Method ...................................................................................................................126

PageModePrint Method...........................................................................................................127

PrintBarCode Method..............................................................................................................127

PrintBitmap Method ................................................................................................................144

PrintImmediate Method...........................................................................................................147

PrintMemoryBitmap Method...................................................................................................149

PrintNormal Method................................................................................................................152

PrintTwoNormal Method.........................................................................................................153

RotatePrint Method..................................................................................................................154

SetBitmap Method...................................................................................................................157

SetLogo Method ......................................................................................................................159

TransactionPrint Method ......................................................................................................... 160

ValidateData Method ...............................................................................................................162

DrawRuled Line Method.........................................................................................................163

4.7. Event.............................................................................................................................164

DirectIOEvent Event ...............................................................................................................164

ErrorEvent Event .....................................................................................................................165

OutputCompleteEvent Event...................................................................................................166

StatusUpdateEvent Event ........................................................................................................166

5. OPOS Interface Specifications (Drawer)................................................................... 168

5.1. List................................................................................................................................168

5.2. Com

BinaryConversion Property R/ W.............................................................................................171

CapCompareFirmwareVersion Property..................................................................................172

CapPowerReporting Prope rt y..................................................................................................172

CapStatisticsReporting Property..............................................................................................172

CapUpdateFirmware Property.................................................................................................172

CapUpdateStatistics Property ..................................................................................................173

CheckHealthText Property.......................................................................................................173

Claimed Property.....................................................................................................................173

ControlObjectDescription Property.........................................................................................174

ControlObjectVersion Property................................................................................................174

DeviceDescription Property.....................................................................................................174

DeviceEnabled Property R/W..................................................................................................175

DeviceName Property..............................................................................................................176

FreezeEvents Property R/W.....................................................................................................176

OpenResult Property................................................................................................................177

mon Properties ......................................................................................................171

PowerNotify Property R/W .....................................................................................................178

PowerState Property ................................................................................................................178

ResultCode Property................................................................................................................179

ResultCodeExtended Property.................................................................................................180

ServiceObjectDescription Property .........................................................................................180

ServiceObjectVersion Property................................................................................................180

State Property...........................................................................................................................181

5.3. Common Methods.........................................................................................................182

CheckHealth Method...............................................................................................................182

ClaimDevice Method...............................................................................................................183

Close Method...........................................................................................................................184

CompareFirmwareVersion Method..........................................................................................184

DirectIO Method......................................................................................................................184

Open Method...........................................................................................................................185

ReleaseDevice Method............................................................................................................186

ResetStatistics Method.............................................................................................................186

RetrieveStatistics Method........................................................................................................186

UpdateFirmwareMethod..........................................................................................................187

UpdateStatistics Method..........................................................................................................187

5.4. Specific Property...........................................................................................................188

CapStatus Property ..................................................................................................................188

CapStatusMultiDrawerDetect Property ...................................................................................188

DrawerOpend Property............................................................................................................189

5.5. Specific Method............................................................................................................190

OpenDrawer Method...............................................................................................................190

WaitForDrawerClose Method..................................................................................................190

5.6. Event.............................................................................................................................191

DirectIOEvent Event ...............................................................................................................191

StatusUpdateEvent Event ........................................................................................................191

6. Registry Used by OCX .............................................................................................. 192

6.1. POS Printer (Serial Interface).......................................................................................193

6.2. POS Printer (USB Interface).........................................................................................195

6.3. POS Printer (LAN Interface) ........................................................................................197

6.4. The explanation of the registry item (POS Printer) ......................................................198

6.5. Drawer ..........................................................................................................................202

6.6. The explanation of the registry item (Drawer)..............................................................205

7. Log Files.................................................................................................................... 206

8. Using Multiple Printers.............................................................................................. 208

9. Replacement of printer............................................................................................... 209

Revision History ....................................................................................................................... 210

1. Outline

POS Printer OPOS Control and Drawer OPOS Control that control POS Printer ("PT340-341") and Drawer connected to the printer are OPOS Controls conforming to OPOS 1.13 POS Printer Devise and Drawer Device. When using OPOS Control, refer to "OLE for Retail POS Application Programmer's Guide Instructions The 1.13 Version" (OPOS-APG V1.13), too. In this guide, "OPOS Control" means same as "OPOS OCX".

1.1. Subject Scope of this document

These instructions (Application Programmer's Guide) aim for the main reference of programmers who develop the application for the use of OPOS Control, and describe the following contents necessary for that.

- Installation way of OPOS Control

- Usage of OPOS Control

- Restrictions of OPOS Control

- Interface (Property/Method/Event) Remarks of OPOS Control

- Item Setting Remarks of OPOS Control

1.2. OPOS Control Outline

1) OPOS Control Configuration Drawing

OPOS Contro

l conforms to ActiveX specifications and provides Property, Method, and Event to application. Control cannot be seen on UI in application execution. Only application, which uses it, requests to process through Method and Property. Application receives processing result through Method return value, parameter, Property, and Event. This OPOS Control is implemented as in-process server.

<Serial, USB Interface>

Application

POSPrinter Control Object

CashDrawer Control Object

POSPrinter Service Object

CashDrawer Service Object

OPSharedPort.exe

OS / Device Drive

Printer Drawer

Serial Interface

USB Interface

POSPrinter Control Object

POSPrinter Service Object

ftfpcp.dll

Applicatio

OS / Device Driver

DLL used to communicate with printer in LAN

*This

OPOS Driver supports the c

*Multiple numbers of interface and printers can be set to the driver. For details, refer to

Chapter 8 "Using Multiple Printers."

* In case of LAN Interface, OPOS Driver doesn’t support drawer connection.

*This OCX works with Thread Model of STA(Single, Thread or Apartment). To work with

several processes, the setting value of "Apartment" in Registry should be set as "1".

*Regarding LAN interface, Network Connection corresponds to 10Base-T, 100Base-T.

LAN Interface（10Base-T, 100Base-T）

Printer

ontrol of Serial/USB/LAN Interface Printer.

2) Terminology a. Control Obj

According to each device class, it provides application with the set of Property, Method, and Event. This Document explains these API.

b. Service Object (Service Object; SO) It executes the function which is called from Control Object and which is prescribed by OPOS for each device.

ect (Control Object; CO)

1.3. Restrictions

Followings are restrictions.

1) POS Printer

[Restriction

restrictions.

s on OPOS specifications]

All the interfaces of OPOS POS Printer Device are provided, but there are the following

a. It does not support property setting concerning journal printing and journal. b. It does not support property setting concerning slip printing and slip. c. It does not support functions of Italic, custom color, shading printing, and cartridge. d. It does not support change of receipt printing character font. (Printing font change) e. The following methods always return OPOS_E_ILLEGAL(106) after enabling.

PrintTwoNormal Method BeginInsertion Method EndInsertion Method BeginRemoval Method EndRemoval Method ChangePrintSide Method MarkFeed Method ResetStatistics Method RetrieveStatistics Method UpdateStatistics Method

(Limitation of Cable disconnection and connection) There are conditions for disconnection and connection of LAN cable under printer "enable" status:

1)When LAN cable is disconnected from PC, printer cannot support any actions. When the cable is disconnected during "enable" status, OCX may fail to be "enable" even though the application restarts.

2)When LAN cable is disconnected from Printer, and while OCX and printer is connecting, printer cannot support any actions even if "disable" is sent. If "disable" is sent in above situation, even though the application is restarted, OCX may fail to enable. When the LAN cable is disconnected, connect the LAN cable again, and switch off and on the power of Printer.

2) Drawer

[Restrictions o

f OPOS specifications OPOS] All the interfaces of OPOS Drawer Device are provided, but there are the following restrictions. a. PowerNotify Property (Power source notifying function setting)

Setting is only for OPOS_PN_DISABLED(0) (Impossible to notify)and unchangeable.

b. PowerState Property (Power source state)

Only OPOS_PS_UNKNOWN(2000)(Unclear) is set.

c. DirectIO Method (Particular-to-Device function)

It is not supported. After enabling, it always returns OPOS_E_ILLEGAL(106).

d. WaitForDrawerClose Method (Waiting for the drawer to close)

It is not supported. After enabling, it always returns OPOS_E_ILLEGAL(106).

e. DirectIOEvent Event (Particular- to-Device event)

It is not supported.

f. DrawerOpened Property, StatusUpdateEvent Event

Status notification of the Drawer is available only when CapStatus is TRUE and Printer OCX is enabled (DeviceEnabled=TRUE) for the printer connected to the drawer. In case these conditions are not met, the status of the drawer is not notified.

[Restriction of Drawer Hardware Specifications]

It does not support notifying function of drawer power source condition.

3) Common Restrictions on POS Printer and Drawer

The OPOS Control is not t

hread-safe. When the method or property is accessed from the different thread, unexpected result may occur. In the multithread environment, implementation of exclusive processing for the critical sections is required for accessing the property and executing the method in order to avoid the method and prop erty ar e executed at the same time.

4) Restriction when Windows driver and OPOS driver are installed in the same system

Problems such as failure to print correctly from the OPOS driver may occur if the Windows driver and OPOS driver are both installed in the same system. In this case, it is recommended that you uninstall the driver that is not being used.

5) Setting of Apartment ="0" with connecting LAN interface cable

Apartment is set as "0" in Registry setting, one process can control several printers. But the several processes do "Open" OCX (LAN Interface) at the same time, unexpected results may happen.

6) Setting of Apartment ="1" with connecting LAN interface cable

Apartment is set as " In this case, the number of printers (LAN interface) should be guaranteed that one process should be less than one unit. If more than 2 printers per one process were used, unexpected results might occur. The following chart shows the examples of the case that Apartment ="1" can work, and the case that Apartment ="1" cannot work. (OCX uses LAN interface.)

examples of the case that Apartment ="1" can work

ProcessA---PrinterOCX ProcessB---PrinterOCX

examples of the case that Apartment ="1" cannot work---1

ProcessA---PrinterOCX, PrinterOCX ProcessB---PrinterOCX (Two PrinterOCX exist in ProcessA.)

0" in Registry setting, several processes can control printers.

7) About the "Found New Hardware Wizard" in Windows

When the printer is connected to PC in USB or Parallel interface and "Found New Hardware Wizard" was displayed, set it in the following procedures.

For Windows 8 / Server 2012

"Device Setup" in the task bar is displayed, but no operation is required.

For Windows 7 / Server 2008 R2

1. The message "Installing device driver software" is displayed in a balloon(lower right corner of the screen).

2. After a while, the message "Device driver software was not successfully installed" is displayed.

This is not a problem.

For Windows Vista / Server 2008

1. The "Found New Hardware" is displayed, select [Don't show this message again for this device]. * When "User Account Control" screen is displayed, select [Continue].

For Windows XP / Server 2003 / WEPOS / WEPOS2009

1. The "Found New Hardware Wizard" screen is displayed. Select [No, not this time] and then click [Next].

2. When "What do you want the wizard to do?" is displayed, select [Install from a list or specific location] and then click [Next].

3. Select [Search for the best driver in these locations], clear all checkboxes and then

click [Next].

4. When "Cannot Install this Hardware" is displayed, click [Don't prompt me again to install this software] and then click [Finish].

1.4. Connection Way to POS Printer

Set the POS Printer to the following settings (in gray highlight). Rest of the values can be set in the registry or the setting program attached with installer. Memory Swith 1