Oki PT340, PT341 Java POS Application Programmer's Guide

PT340/PT341

POSPrinter, CashDrawer Application Programmer's Guide of Java for Retail POS Driver for Serial/ USB Interface

Table of Contents

Preface........................................................................................................................................... 1

1. Outline ................................................................................................................................4

1.1. Subject Scope of this document........................................................................................4

1.2. JavaPOS Driver Outline....................................................................................................5

1.3. Restrictions.......................................................................................................................7

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

1.5. About install....................................................................................................................11

1.6. Setting Program Usage ...................................................................................................12

2. Using JavaPOS Driver...................................................................................................... 16

2.1. Common .........................................................................................................................16

2.2. POS Printer.....................................................................................................................16

2.3. Drawer ............................................................................................................................16

2.4. Notes...............................................................................................................................16

3. JavaPOS Interface Specifications (Printer)....................................................................... 17

3.1. List..................................................................................................................................17

3.2. Print Data

3.3. Common Properties ........................................................................................................ 30

CapCompareFirmwareVersion Property........................................................................ 30

CapPowerReporting Property........................................................................................ 30

CapStatisticsReporting Property.................................................................................... 31

CapUpdateFirmware Property ....................................................................................... 31

CapUpdateStatistics Property ........................................................................................ 31

CheckHealthText Property............................................................................................. 32

Claimed Property........................................................................................................... 32

DeviceControlDescription Property............................................................................... 32

DeviceControlVersion Property..................................................................................... 33

PhysicalDeviceDescription............................................................................................ 33

DeviceEnabled Property R/W........................................................................................ 34

PhysicalDeviceName Property ...................................................................................... 34

FreezeEvents Property R/W........................................................................................... 35

OutputID Property ......................................................................................................... 35

PowerNotify Property R/W............................................................................................ 36

PowerState Property....................................................................................................... 37

DeviceServiceDescription Property............................................................................... 37

DeviceServiceVersion Property ..................................................................................... 38

State Property................................................................................................................. 38

3.4. Common Method............................................................................................................39

checkHealth Method...................................................................................................... 39

claim Method................................................................................................................. 40

clearOutput Method....................................................................................................... 41

close Method.................................................................................................................. 41

compareFirmwareVersion Method................................................................................. 42

directIO Method............................................................................................................. 44

and Escape Sequences...................................................................................25

open Method .................................................................................................................. 45

release Method............................................................................................................... 45

resetStatistics Method.................................................................................................... 46

retrieveStatistics Method................................................................................................ 46

updateFirmwareMethod................................................................................................. 47

updateStatistics Method................................................................................................. 48

3.5. Specific Properties..........................................................................................................49

AsyncMode Property R/W............................................................................................. 49

CapCharacterSet Property.............................................................................................. 49

CapCoverSensor Property.............................................................................................. 50

CapMapCharacterSet Property ...................................................................................... 50

CapRec2Color Property................................................................................................. 50

CapRecBarCode Property.............................................................................................. 51

CapRecBitmap Property ................................................................................................ 51

CapRecBold Property .................................................................................................... 51

CapRecCartridgeSensor Property.................................................................................. 52

CapRecColor Property................................................................................................... 52

CapRecDhigh Property.................................................................................................. 52

CapRecDwide Property ................................................................................................. 53

CapRecDwideDhigh Property........................................................................................ 53

CapRecEmptySensor Property....................................................................................... 53

CapRecItalic Property.................................................................................................... 54

CapRecLeft90 Property ................................................................................................. 54

CapRecMarkFeed Property............................................................................................ 54

CapRecNearEndSensor Property................................................................................... 55

CapRecPageMode Property........................................................................................... 55

CapRecPapercut Property.............................................................................................. 55

CapRecRight90 Property ............................................................................................... 56

CapRecRotate180 Property............................................................................................ 56

CapRecStamp Property.................................................................................................. 56

CapRecUnderline Property............................................................................................ 57

CapTransaction Property................................................................................................ 57

CartridgeNotify Property R/W....................................................................................... 57

CharacterSet Property R/W............................................................................................ 58

CharacterSetList Property.............................................................................................. 59

CoverOpen Property ...................................................................................................... 59

ErrorLevel Property ....................................................................................................... 60

ErrorStation Property..................................................................................................... 60

ErrorString Property....................................................................................................... 61

FlagWhenIdle Property R/W ......................................................................................... 61

FontTypefaceList Property............................................................................................. 62

MapCharacterSet Property............................................................................................. 62

MapMode Property R/W................................................................................................ 63

PageModeArea Property................................................................................................ 63

PageModeDescriptor Property....................................................................................... 64

PageModeHorizontalPosition Property.......................................................................... 64

PageModePrintArea Property........................................................................................ 64

PageModePrintDirection Property................................................................................. 65

PageModeStation Property ............................................................................................ 65

PageModeVerticalPosition Property.............................................................................. 65

RecBarCodeRotationList Property ................................................................................ 66

RecBitmapRotationList Property................................................................................... 66

RecCartridgeState Property............................................................................................ 67

RecCurrentCartridge Property R/W............................................................................... 67

RecEmpty Property........................................................................................................ 67

RecLetterQuality Property R/W..................................................................................... 68

RecLineChars Property R/W ......................................................................................... 69

RecLineCharsList Property............................................................................................ 70

RecLineHeight Property R/W........................................................................................ 71

RecLineSpacing Property R/W...................................................................................... 72

RecLinesToPaperCut Property....................................................................................... 72

RecLineWidth Property ................................................................................................. 73

RecNearEnd Property .................................................................................................... 73

RecSidewaysMaxChars Property................................................................................... 74

RecSidewaysMaxlLines Property.................................................................................. 75

RotateSpecial Property R/W.......................................................................................... 76

3.6. Specific Methods ............................................................................................................78

beginInsertion Method................................................................................................... 78

beginRemoval Method................................................................................................... 78

changePrintSide Method................................................................................................ 79

clearPrintArea Method................................................................................................... 79

cutPaper Method............................................................................................................ 80

endInsertion Method...................................................................................................... 81

endRemoval Method...................................................................................................... 81

markFeed Method.......................................................................................................... 82

pageModePrint Method ................................................................................................. 82

printBarCode Method .................................................................................................... 83

printBitmap Method....................................................................................................... 97

printImmediate Method ............................................................................................... 100

printMemoryBitmap Method....................................................................................... 102

printNormal Method .................................................................................................... 105

printTwoNormal Method ............................................................................................. 107

rotatePrint Method....................................................................................................... 108

setBitmap Method.........................................................................................................111

setLogo Method............................................................................................................113

transactionPrint Method................................................................................................114

validateData Method.....................................................................................................116

3.7. Event.............................................................................................................................118

DirectIOEvent Event.....................................................................................................118

ErrorEvent Event ..........................................................................................................119

OutputCompleteEvent Event ....................................................................................... 120

StatusUpdateEvent Event............................................................................................. 121

4. JavaPOS Interface Specifications (Drawer).................................................................... 122

4.1. List................................................................................................................................122

4.2. Common Properties ......................................................................................................125

CapCompareFirmwareVersion Property...................................................................... 125

CapPowerReporting Property...................................................................................... 125

CapStatisticsReporting Property.................................................................................. 126

CapUpdateFirmware Property ..................................................................................... 126

CapUpdateStatistics Property ...................................................................................... 126

CheckHealthText Property........................................................................................... 127

Claimed Property......................................................................................................... 127

DeviceControlDescription Property............................................................................. 127

DeviceControlVersion Property................................................................................... 128

PhysicalDeviceDescription Property ........................................................................... 128

DeviceEnabled Property R/W...................................................................................... 129

PhysicalDeviceName Property .................................................................................... 129

FreezeEvents Property R/W......................................................................................... 130

PowerNotify Property R/W.......................................................................................... 130

PowerState Property..................................................................................................... 131

DeviceServiceDescription Property............................................................................. 131

DeviceServiceVersion Property ................................................................................... 131

State Property............................................................................................................... 132

4.3. Common Methods.........................................................................................................133

checkHealth Method.................................................................................................... 133

claim Method............................................................................................................... 135

close Method................................................................................................................ 135

compareFirmwareVersion Method............................................................................... 136

directIO Method........................................................................................................... 136

open Method ................................................................................................................ 137

release Method............................................................................................................. 137

resetStatistics Method.................................................................................................. 138

retrieveStatistics Method.............................................................................................. 138

updateFirmwareMethod............................................................................................... 138

updateStatistics Method............................................................................................... 139

4.4. Specific Properties........................................................................................................140

CapStatus Property....................................................................................................... 140

CapStatusMultiDrawerDetect Property ....................................................................... 140

DrawerOpened Property .............................................................................................. 141

4.5. Specific Methods ..........................................................................................................142

openDrawer Method .................................................................................................... 142

waitForDrawerClose Method....................................................................................... 142

4.6. Event.............................................................................................................................143

DirectIOEvent Event.................................................................................................... 143

StatusUpdateEvent Event............................................................................................. 143

5. Xml file Configuration.................................................................................................... 144

5.1. The explanation of XML items (POS Printer) ..............................................................144

5.2. The explanation of XML items (Drawer) .....................................................................148

6. Log Files......................................................................................................................... 150

7. Using Multiple Printers................................................................................................... 151

8. Replacement of printer.................................................................................................... 152

Preface

(1) OS being targeted by this driver

This JavaPOS driver targets the following operating systems.

- Microsoft(R) Windows Server(TM) 2003

- Microsoft(R) Windows Server(TM) 2003 x64 Edition

- Microsoft(R) Windows(R) XP

- Microsoft(R) Windows(R) XP x64 Edition

- Microsoft(R) Windows(R) Embedded for Point of Service

- Microsoft(R) Windows Server(TM) 2008

- Microsoft(R) Windows Server(TM) 2008 x64 Edition

- Microsoft(R) Windows Vista(TM)

- Microsoft(R) Windows Vista(TM) x64 Edition

- Microsoft(R) Windows Server(TM) 2008R2 x64 Edition

- Microsoft(R) Windows 7

- Microsoft(R) Windows 7 x64 Edition

- Microsoft(R) Windows Server(TM) 2012 x64 Edition

- Microsoft(R) Windows 8

- Microsoft(R) Windows 8 x64 Edition

(2) Interface being supported by this driver

This JavaPOS driver is supporting the printer connection by the following interfaces.

- Windows : RS232C , USB

(3) Supplementation concerning '5. XML file Con

An initial value of the serial and USB interface of JavaPOS driver configuration file ‘jpos.xml’ is different in Windows.

- Windows logicalName = "PT340-341SERPRT" portName = "COM1" LogFile = "*/Okidata/PT/log/PT340-341serprt%g.log" logicalName = "PT340-341SER2PRT" portName = "COM2" LogFile = "*/Okidata/PT/log/PT340-341ser2prt%g.log" logicalName = "PT340-341USBPRT" LogFile = "*/Okidata/PT/log/PT340-341usbprt%g.log" logicalName = "PT340-341USB2PRT" LogFile = "*/Okidata/PT/log/PT340-341usb2prt%g.log"

(5) About the balloon message when the Java application is started on Windows Vista / 2008 / Windows7 / 2008R2

When you start the Java application when the operating system is Windows Vista / 2008 / Windows7 / 2008R2, and the Aero function is effective, balloon message "The color scheme has been changed" might be displayed. There is no influence in the operation of the application though the Aero function temporarily becomes invalid when this message is displayed. Please click the balloon, and check "Don’t show me this again." when you do not want to make this message be displayed from next time.

figuration '

(6) About the arrangement of Jav

Please put the Java application in the same hard disk drive as the JavaPOS driver. Please copy the following file in the JavaPOS driver storage folder (The example: \JavaPOS\Okidata\PT) to the following folder of J2SDK and use it when you put the Java application in a drive different from the JavaPOS driver.

win32com.dll : [J2SDK folder]\jre\bin LibIoOP.dll : [J2SDK folder]\jre\bin comm.jar : [J2SDK folder]\jre\lib\ext

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

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

For Windows 8 / Server 2012

1. "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].

aPOS driver and Java application in Windows.

1. Outline

POS Printer JavaPOS Driver and Drawer JavaPOS Driver that control POS Printer ("PT340-341") and Drawer connected to the printer are JavaPOS Driver conforming to JavaPOS Driver 1.10 POS Printer Devise and Drawer Device. When using this JavaPOS Driver, refer to "UifiedPOS Specification Version 1.10 Version", as well.

1.1. Subject Scope of this document

These instructions (Interface Instructions) aim for the main reference of programmers who develop the application for the use of this JavaPOS Driver, and describe the following conten ts necessary for that.

· Installation way of this JavaPOS Driver

Please refer to the installation text being bundled by the driver for the installation method. Windows : "opinstall_win.txt"

· Restrictions of this JavaPOS Driver

· Useage of this JavaPOS printer setup tool

· Usage of this JavaPOS Driver

· Restrictions of this JavaPOS Driver

· Interface (Property/Method/Event) Remarks of this JavaPOS Driver

· Item Setting Remarks of this JavaPOS Driver

1.2. JavaPOS Driver Outline

1) JavaPOS Driver Configuration Drawing

JavaPOS Driver provides the properties, methods and events to the application. The driver is invisible on UI during application execution. Only the application, which uses it, requests to process through the method and property. The application receives the processing result through the parameter, property, event and error.

*This JavaPOS Driver supports to control connected to on

*Multiple numbers of interface and printers can be set to the driver. For details, refer to Chapter 7 "Using Multiple Printers."

e printer.

POSPrinter Device Control

POSPrinter Device Service

Printer Drawer

Serial Interface

the Serial and USB Interface Printer and of at most two drawers each,

Application

CashDrawer Device Control

CashDrawer Device Service

Java VM

OS / Device Driver

Printer Drawer

USB Interface

2) Terminology

a. Device Control (DC)

According This Document explains these API.

b. Device Service (Device Service; DS)

It executes the function which is called from Device Control and which is prescribed by JavaPOS for each device.

to each device class, it provides application with the set of the properties, methods, and events.

1.3. Restrictions

The following restrictions are applied:

1) POS Printer

[Restrictions on JavaPOS specifications]

1. All interface of the JavaPOS POS Printer Device are provided, but there are the following restrictions: 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 JPOS_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

2. For USB Interface connection, there are the following restrictions:

· The behavior to set the DeviceEnabled property = true to the same printer from the application

running on other VM is not supported.

3. The behavior after recovering from Suspend/Stand by is not supported.

The Suspend/Stand by mode should not be used.

2) Drawer

[Restrictions of JPOS specifications JavaPOS]

1. All the interfaces of JPOS Drawer Device are provided, but there are the following restrictions.

a. PowerNotify Property (Power source notifying function setting)

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

b. PowerState Property (Power source state)

Only JPOS_PS_UNKNOWN(2000)(Unclear) is set.

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

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

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

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

e. DirectIOEvent Event

It is not supported.

f. DrawerOpened Property, StatusUpdateEvent Event

Status notification of the Drawer is available only when CapStatus is true and the driver 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.

2. For USB Interface connection, there are the following restrictions:

· The behavior to set the DeviceEnabled property = true to the same printer from the application

running on other VM is not supported.

3. The behavior after recovering from Suspend/Stand by is not supported.

The Suspend/Stand by mode should not be used.

[Restriction of Drawer Hardware Specifications] It does not support the function to notify the drawer power source condition.

3) Restriction when Windows driver and JavaPOS driver are installed in the same system

Problems such as failure to print correctly from the JavaPOS driver may occur if the Windows driver and JavaPOS driver are both installed in the same system.

In this case, it is recommended that you uninstall the driver that is not being used.

(Particular- to-Device event)

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 setting file attached with jpos.xml or the installer.

Memory Swith 1

No. Setting Item Setting Contents

1 Power On Status *Set form the registry 2 Receive Buffer 4 KB 3 Busy Condition Bufferfull 4 Receive Error ? Print 5 Auto LF Disable 6 DSR (#6) RESET Disable 7 USB Soft Reset Enable

Memory Swith 2

No. Setting Item Setting Contents

1 Cover Open Error Auto Recovery 2 Error Recovery by CMND 3 Batch (COM IF) Disable 4 Batch (Other IF) Disable 5 Serial Number Enable 6 ASB Enable 7 Font-B Mode1

No. Setting Item Setting Contents

1 Paper Width *Set from the setting program 2 Max Speed *Set from the setting program 3 Print Density *Set from the setting program

Hardware

No. Setting Item Setting Contents

1 Error Alert *Set from the setting program 2 Buzzer Interval *Set from the setting program 3 Buzzer Repetition *Set from the setting program 4 User NV Memory 192KB 5 Graphic Memory 384KB 6 Cut at CoverClose *Set from the setting program 7 PNE Detect *Set from the setting program

Interface

No. Setting Item Setting Contents

1 Protocol XON/XOFF 2 USB Printer

1.5. About install

For Windows: See the "opinstall_win.txt" and install the JavaPOS according to it.

1.6. Setting Program Usage

Operation Conditions

This Java-POS must be installed.

Screen and function

Setting Program is executed as the following procedure.

1. Compile >javac Setup.java

2. Execution >java Setup

The following screen is displayed.

<< Serial interface setting screen >>

<< USB interf

Selec

t serial num (Refer to "9. Serial number confirm method of printer" for serial number of printer.) OK button becomes effective by selecting serial number.

When the Reload button is pushed, the serial number of the connected printer is reread, and displayed in “Serial Number".

ber of printer from "Serial Number".

ace setting screen >>

When an error occurred with OK button pushed, the following messages are display Confirm an error factor, and setup again.

- A cable is not connected.

- The printer is not switched on.

- A cover opens.

- There is not paper.

- A port is already used in others.

- A communication condition does not accord with a printer. (Serial connection)

- Serial number input is wrong. (USB connection)

hen the printer

After confirming the setting, execute the setting program, and then follow the procedure again.

status is "error" and this setting program is executed, the setting is not reflected in the printer.

ed.

In case the "jpos.xml Select the "jpos.xml" file from this dialog.

" file cannot be located when the setting program is executed, the following dialog is displayed.

2. Using JavaPOS Driver

2.1. Common

The application uses the OPOS control in the steps as follows:

1. open method: Called to link the control object to the service object.

2. claim method: Called to enable exclusive access to the device. For the device of exclusive use, this method is

required, and foe the device of sharable use, it is optional.

3. DeviceEnabled property: Set to true to operate the device.

4. Use the device. (Each property, method, event)

5. DeviceEnabled property: Set to false to disable the device.

6. release method: Called to clear exclusive access to the device.

7. close method: Called to release the service object from t h e control object.

2.2. POS Printer

The POS printer supports only "Receipt." For the methods and properties of other than that (Journal or Slip), interface is supplied but behavior is not supported.

According to the general output model, synchronous and asynchronous output is available for the POS printer. The POS printer is the device to be used exclusively.

2.3. Drawer

The Drawer can be used in the same way as the POS printer, but all features are executable without executing the

claim method. However, when exclusive permission is acquired for particular application by the claim method, the openDevice method cannot be executed by the application enabled with the same name. If there is no application

with exclusive permission, this is not the case.

2.4. Notes

- When the application using this JavaPOS driver is started, you should set the New area of the memory to 10MBy te

or more. ( java command option -Xmn10m). When the New area is a little, the memory utilization might increase because a large amount of object generated with the communication is not liberated for a long term.

- If the JPOS_E_TIMEOUT is returned when you enable the application, increase and adjust the value of

ResetTimeout of jpos.xml (Refer to Chapter 5.3).

3. JavaPOS Interface Specifications (Printer)

3.1. List

Properties

Common Type Access May Use After Initial Value, Conditions

CapCompareFirmwareVersion boolean R open true CapPowerReporting int R open JPOS_PR_STANDARD (1) CapStatisticsReporting boolean R open false CapUpdateFirmware boolean R open true CapUpdateStatistics boolean R open false CheckHealthText String R open "" Claimed boolean R open false DeviceEnabled boolean R/W open & claim false FreezeEvents boolean R/W

open

OutputID int R open 1 PowerNotify int R/W open JPOS_PN_DISABLED (0)

PowerState int R open JPOS_PS_UNKNOWN

State int R --- 1 DeviceControlDescription String R --- "POS Printer JavaPOS

DeviceControlVersion int R --- 1010XXX DeviceServiceDescription String R open "POS Printer JavaPOS

DeviceServiceVersion int R open 1010XXX PhysicalDeviceDescription String R open "OP 1 Station Thermal

PhysicalDeviceName String R open "OP 1 Station Thermal

false open

false Made writable after open.

Made writable after open, and unwritable after enabled.

(2000)

Device Control"

Device Service"

POSPrinter"

POSPrinter "

Specific

CapCharacterSet int R open PTR_CCS_KANJI (11) CapConcurrentJrnRec boolean R open false CapConcurrentJrnSlp boolean R open false CapConcurrentPageMode boolean R open false CapConcurrentRecSlp boolean R open false CapCoverSensor boolean R open true CapMapCharacterSet boolean R open true CapTransaction boolean R open true

CapJrnPresent boolean R open false CapJrn2Color boolean R open false CapJrnBold boolean R open false CapJrnDhigh boolean R open false CapJrnDwide boolean R open false CapJrnDwideDhigh boolean R open false CapJrnEmptySensor boolean R open false CapJrnItalic boolean R open false CapJrnNearEndSensor boolean R open false CapJrnUnderline boolean R open false CapJrnCartridgeSensor int R open 0 CapJrnColor int R open 0

Type Access May Use After

Initial Value, Conditions

Type Access May Use After Initial Value, ConditionSpecific

CapRecPresent boolean R open true CapRec2Color boolean R open The initial value may vary

according to the contents of jpos.xml.

CapRecBarCode boolean R open true CapRecBitmap boolean R open true CapRecBold boolean R open true CapRecDhigh boolean R open true CapRecDwide boolean R open true CapRecDwideDhigh boolean R open true CapRecEmptySensor boolean R open true CapRecItalic boolean R open false CapRecLeft90 boolean R open true

CapRecMarkFeed int

R open 0

Type Access May Use After Initial Value, ConditionSpecific

CapRecNearEndSensor boolean R open The initial value may vary

according to the contents of jpos.xml.

CapRecPapercut boolean R open true CapRecRight90 boolean R open true CapRecRotate180 boolean R open true CapRecStamp boolean R open false CapRecUnderline boolean R open true CapRecCartridgeSensor int R open 0 CapRecColor

CapRecMarkFeed CapRecPageMode boolean R open false

int int

R open 0 R open 0

Type Access May Use After Initial Value, ConditionSpecific

CapSlpPresent boolean R open false CapSlpFullslip boolean R open false CapSlp2Color boolean R open false CapSlpBarCode boolean R open false CapSlpBitmap boolean R open false CapSlpBold boolean R open false CapSlpDhigh boolean R open false CapSlpDwide boolean R open false CapSlpDwideDhigh boolean R open false CapSlpEmptySensor boolean R open false CapSlpItalic boolean R open false CapSlpLeft90 boolean R open false CapSlpNearEndSensor boolean R open false CapSlpRight90 boolean R open false CapSlpRotate180 boolean R open false CapSlpUnderline boolean R open false

CapSlpBothSidesPrint boolean R open false CapSlpCartridgeSensor int R open 0 CapSlpColor int R open 0

CapSlpPageMode boolean R open false

Type Access May Use After Initial Value, Condition Specific

AsyncMode boolean R/W

open

CartridgeNotify int R/W open PTR_CN_DISABLED (0)

CharacterSet int R/W open, claim

CharacterSetList String R open "101,102,103,437,850,851,852

CoverOpen boolean R open, claim

ErrorLevel int R open 1 ErrorStation int R open 0 ErrorString String R open "" FontTypefaceList String R open "" FlagWhenIdle boolean R/W open false

MapCharacterSet boolean R/W open true MapMode int R/W open PTR_MM_DOTS (1)

PageModeArea String R open "" PageModeDescriptor int R open 0 PageModeHorizontalPosition int R open 0 PageModePrintArea String R/W open "" PageModePrintDirection int R/W open 0 PageModeStation int R/W open 0 PageModeVerticalPosition int R/W open 0 RotateSpecial int R/W open PTR_RP_NORMAL (1)

false open

& Enable

false Made writable after enabled

Unwritable 998

Made writable after enabled

,857,858,860,863,864, 865,866,869,932,998,1252,28 592,28597"

false

Made writable after enabled

Made writable after open

Specific Type Access May Use After Initial Value, Condition

JrnLineChars int R/W open, claim

& Enable

JrnLineCharsList String R open "" JrnLineHeight int R open, claim

& Enable

JrnLineSpacing int R/W open, claim

& Enable

0 Unwritable

Specific Type Access May Use After Initial Value, Condition

JrnLineWidth int R open, claim

& Enable

JrnLetterQuality boolean R/W open, claim

& Enable

JrnEmpty boolean R open, claim

& Enable

JrnNearEnd boolean R open, claim

& Enable

JrnCartridgeState int R open, claim

& Enable

JrnCurrentCartridge int R/W open, claim

& Enable

false Unwritable

false

0 Unwritable

Specific Type Access May Use After Initial Value, Condition

RecLineChars int R/W open, claim

& Enable

RecLineCharsList String R open The initial value may vary

RecLineHeight int R/W open, claim

& Enable

RecLineSpacing int R/W

RecLineWidth int R open, claim

RecLetterQuality boolean R/W open, claim

RecEmpty boolean R open, claim

RecNearEnd boolean R open, claim

RecSidewaysMaxLines int R open, claim

RecSidewaysMaxChars int R open, claim The initial value may vary

open, claim & Enable

& Enable

The initial value may vary according to the jpos.xml contents.

Made writable after open.

according to the jpos.xml contents.

The initial value may vary according to the jpos.xml contents.

Unwritable The initial value may vary

according to the jpos.xml contents.

Made writable after open. The initial value may vary

according to the jpos.xml contents.

true Made writable after open.

false

The initial value may vary according to the jpos.xml contents.

Specific Type Access May Use After Initial Value, Condition

& Enable according to the jpos.xml

contents.

RecLinesToPaperCut int R open, claim

& Enable

RecBarCodeRotationList String R open "0,R90,L90,180" RecCartridgeState int R open 268435456 RecCurrentCartridge int R/W open 0

RecBitmapRotationList String R open "0"

The initial value may vary according to the jpos.xml contents.

Unwritable

Specific Type Access May Use After Initial Value, Condition

SlpLineChars int R/W open 0

Unwritable

SlpLineCharsList String R open, claim

& Enable

SlpLineHeight int R/W open, claim

& Enable

SlpLineSpacing int R/W

open

SlpLineWidth int R open, claim

SlpLetterQuality boolean R/W open, claim

SlpEmpty boolean R open, claim

SlpNearEnd boolean R open, claim

SlpSidewaysMaxLines int R open, claim

SlpSidewaysMaxChars int R open, claim

SlpMaxLines int R open, claim

SlpLinesNearEndToEnd int R open, claim

SlpBarCodeRotationList String R open "" SlpPrintSide int R open, claim

open, claim & Enable

& Enable

0 Unwritable

false Unwritable

false

Specific Type Access May Use After Initial Value, Condition

SlpCartridgeState int R open, claim

& Enable

SlpCurrentCartridge int R/W open, claim

& Enable

SlpBitmapRotationList String R open ""

* In the Access column, R indicates Read-Only, R/W indicates Read/Write. The item in May Use After is the method and property required for initialization, open indicates the open method, claim indicates the claim method and Enable indicates setting the DeviceEnabled property to true. If required procedure is not executed, JposException may be notified. For the property with open & claim or open, claim & Enable in May Use After, it is available for acquisition after the open method is executed, but the value may not be initialized until all open, claim & Enable are executed. To acquire such property, access it after the conditions are met.

Methods

PTR_CART_UNKNOWN (268435456)

0 Unwritable

Common Initialization

open none close open claim open release open & claim clearOutput open, claim & Enable checkHealth open, claim & Enable compareFirmwareVersion open, claim & Enable directIO open, claim & Enable resetStatistics open, claim & Enable retrieveStatistics open, claim & Enable updateFirmware open, claim & Enable updateStatistics open, claim & Enable

Specific Initialization

printNormal open, claim & Enable printTwoNormal open, claim & Enable printImmediate open, claim & Enable

beginInsertion open, claim & Enable endInsertion open, claim & Enable beginRemoval open, claim & Enable endRemoval open, claim & Enable

Specific Initialization

cutPaper open, claim & Enable rotatePrint open, claim & Enable printBarcode open, claim & Enable printBitmap open, claim & Enable transactionPrint open, claim & Enable validateData open, claim & Enable

setBitmap open, claim & Enable setLogo open, claim & Enable

changePrintSide open, claim & Enable markFeed open, claim & Enable clearPrintArea open, claim & Enable pageModePrint open, claim & Enable printMemoryBitmap open, claim & Enable

Events

Event Initialization

DirectIOEvent open, claim & Enable ErrorEvent open, claim & Enable OutputCompleteEvent open, claim & Enable StatusUpdateEvent open, claim & Enable

+ 132 hidden pages

Oki PT340, PT341 Java POS Application Programmer's Guide

Specifications and Main Features

Frequently Asked Questions

User Manual

Preface

1. Outline

1.1. Subject Scope of this document

1.2. JavaPOS Driver Outline

1.3. Restrictions

1.4. Connection Way to POS Printer

1.5. About install

1.6. Setting Program Usage

2. Using JavaPOS Driver

2.1. Common

2.2. POS Printer

2.3. Drawer

2.4. Notes

3. JavaPOS Interface Specifications (Printer)

3.1. List