Toshiba Global Commerce Solutions

Point-of-Sale Subsystem

UnifiedPOS User's Guide, Keyboards,

and Code Pages
1.14.9

GC30-4078-31
1

Note:
Before using this information and the product it supports, be sure to read Safety Information-Read This First, Warranty
Information, Uninterruptible Power Supply Information, and the information under “Notices” on page 593.

November 2021
This edition applies to Version 1.14.9 of the UnifiedPOS subsystem and to all subsequent releases and modifications until
otherwise indicated in new editions.
This edition replaces GC30-4078-30.
If you send information to Toshiba Global Commerce Solutions (TGCS), you grant Toshiba a nonexclusive right to use or
distribute whatever information you supply in any way it believes appropriate without incurring any obligation to you.
© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021
Contents
Figures.....................................................11 Toshiba SurePoint Display (4820) touch support ....... 48
USB device access....................................................................48
Tables...................................................... 13 Linux.................................................................................. 48
Safety........................................................................................ 19 Network configuration tool............................................ 49
OPOS configuration................................................................49
Network device communication....................................49
About this guide..................................... 21 Using the OPOS Configuration utility.......................... 50
Who should read this guide.................................................. 21 Configuring devices.........................................................52
Where to find more information...........................................21 Testing connectivity......................................................... 54
UnifiedPOS publications........................................................21 Removing devices............................................................ 57
Notice statements....................................................................21 Deploying OPOS device configurations....................... 57
Summary of changes............................................................. 23 Toshiba SurePoint Display (4820) touch support........ 58

Part I. User's guide................................. 25 Chapter 4. Problem determination........ 59

JavaPOS problems...................................................................59
Tracing for Linux..............................................................59
Chapter 1. Introduction.......................... 27 Tracing for Javax.usb for Linux......................................60
System requirements.............................................................. 27 Tracing for Windows....................................................... 61
Hardware environment...................................................27 OPOS problems....................................................................... 62
Software environment..................................................... 28 Tracing............................................................................... 62
Getting help............................................................................. 63
Support website................................................................63
Chapter 2. Installing UnifiedPOS.......... 29 Reporting problems......................................................... 64
Installation for Windows....................................................... 29
Interactive installation..................................................... 29
USB system attached POS keyboard Part II. Programming reference............. 65
configuration for Windows.............................................30
Silent installation.............................................................. 31
Upgrade............................................................................. 32 Chapter 5. Common settings and
Installation for SUSE Linux Enterprise................................ 33
Resources for SUSE Linux Enterprise 11 SP3/SP4....... 33
configuration options.............................67
JavaPOS.................................................................................... 67
Resources for SUSE Linux Enterprise 12 SP2...............34
Configuration options......................................................67
Installation package contents................................................ 35
USB firmware update files for JPOS..............................70
Package dependencies..................................................... 36
EIA-232 PosPrinter device detection............................. 72
JavaPOS installation............................................................... 36
OPOS.........................................................................................73
JavaPOS components....................................................... 37
Accessing multiple devices............................................. 73
javax.usb components......................................................37
Configuration options......................................................73
Installing Toshiba point of sale kernel mode drivers..37
USB firmware update files for OPOS............................ 74
Systems Management installation........................................ 39
Modifying USB, RS-485, and PS/2 device behavior.....75
Systems Management support for Toshiba POS
My new topic.................................................................... 76
peripherals.........................................................................39
Ignoring USB devices.......................................................76
Installing on SLE 11 SP3/SP4.......................................... 40
Network device connectivity..........................................76
Validating Systems Management.................................. 40
USB system attached keyboard...................................... 77
Uninstallation of UPOS Systems Management............41
Common Extended Result Codes.................................. 77

Chapter 3. Configuring devices............ 43 Chapter 6. Cash drawer......................... 81

JavaPOS configuration........................................................... 43
Cash drawer supported devices........................................... 81
Locating sample jpos.xml files....................................... 43
Supported properties and methods..................................... 81
Creating the jpos.xml file................................................ 43
JavaPOS configuration........................................................... 83
Changing the logical name of JposEntry...................... 44
CashDrawer.OpenDrawerRetries.................................. 83
Device configuration........................................................44
CashDrawer.OpenTimeOut............................................84
POS Control Center utility.............................................. 48

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 3

signalsReversed................................................................ 84 Device sensing................................................................ 125
deviceNumber.................................................................. 84 Fiscal Printer configuration for Turkey.......................126
CashDrawer.CheckOpenStatus......................................85 OPOS DirectIO calls..............................................................127
CashDrawer.DisableCDStatus..................................... 85 Fiscal information command........................................ 128
Pulse Width....................................................................... 85 Fiscal read command..................................................... 128
Additional JavaPOS information..........................................86 Fiscal write command....................................................128
4610 printer-attached cash drawer................................ 86 Fiscal notify command.................................................. 129
Loading the cash drawer driver for Linux................... 86 OPOS DirectIO events.......................................................... 129
waitForDrawerClose method......................................... 87 Fiscal error event............................................................ 129
USB drawer enumeration................................................87 Fiscal status event...........................................................130
Cash drawer firmware update..............................................87 Fiscal data available event............................................ 130
Automatic update.............................................................87 Fiscal raw status event...................................................131
JavaPOS DirectIO calls........................................................... 88 Fiscal IPL end status event............................................131
Cash Drawer get serial number command...................88 Additional OPOS information............................................ 132
OPOS configuration................................................................89 Suspended fiscal transaction........................................ 132
Additional OPOS information.............................................. 90 Display device sensing.................................................. 132
OEM cash drawer support..............................................90 OPOS getData method (fiscal printer: Italy).............. 135
USB cash drawer support................................................90 OPOS getData method (fiscal printer: Greece).......... 139
OPOS DirectIO calls................................................................91 OPOS getTotalizer method (fiscal printer: Greece)...143
Cash Drawer get serial number command...................91 Fiscal Printer Configuration for Turkey......................145
Supported properties and methods (cash drawer
attached fiscal printer: Italy)..................................................91
Chapter 9. Hard totals.......................... 147
Hard totals supported devices............................................ 147
Chapter 7. Check scanner..................... 95 Supported properties and methods................................... 147
Check scanner supported devices........................................ 95 OPOS configuration..............................................................149
Supported properties and methods..................................... 95
JavaPOS DirectIO calls........................................................... 99
Scanner calibration command........................................ 99 Chapter 10. Keylock............................. 151
Print scanned image command...................................... 99 Supported devices.................................................................151
Set check side command............................................... 100 Two-position (devices 1, 2, 3, 4, 5, 6, 20, 21, 22, 23,
Get check side command...............................................100 27)......................................................................................152
Scanner image quality command.................................101 Two-position (devices 7, 25)......................................... 153
Additional OPOS information............................................ 101 Three-position keylock (devices 8, 12)........................ 153
Multiple devices............................................................. 101 Four-position (devices 9, 10, 11, 14, 15, 16, 17, 19).....154
Four-position (devices 20, 21, 22).................................154
Five-position (device 13)............................................... 155
Chapter 8. Fiscal printer...................... 103 Six-position (device 18)..................................................155
Fiscal printer supported devices.........................................103 Electronic keylock (iButton)..........................................156
Supported properties and methods................................... 104 Supported properties and methods................................... 156
Supported properties and methods (fiscal printer: JavaPOS configuration......................................................... 158
Italy)........................................................................................ 110 PositionCount................................................................. 158
Supported properties and methods (fiscal printer: OPOS configuration..............................................................159
Greece).................................................................................... 114 Additional OPOS information............................................ 160
Power management support for RS-232 fiscal printers...121 Two-position keylock.................................................... 160
JavaPOS configuration......................................................... 121 Position count................................................................. 161
Monitor detection........................................................... 121
JavaPOS DirectIO calls......................................................... 121
Fiscal information command........................................ 121 Chapter 11. Line display...................... 163
Fiscal read command..................................................... 122 Supported devices.................................................................163
Fiscal write command....................................................122 Supported properties and methods................................... 163
Fiscal notify command.................................................. 123 Supported properties and methods (line display
JavaPOS DirectIO events......................................................123 attached fiscal printer: Italy)................................................169
Fiscal error event............................................................ 123 JavaPOS configuration......................................................... 173
Fiscal status event...........................................................124 CharacterSetASCIIBehavior..........................................173
Fiscal data available event............................................ 124 CharacterSet.................................................................... 173
Fiscal raw status event...................................................125 CursorState...................................................................... 173
Fiscal IPL end status event............................................125 lineDisplayId...................................................................173
Additional JavaPOS information........................................125 NumberOfRows............................................................. 173

4 UnifiedPOS User's Guide

JavaPOS DirectIO calls......................................................... 174 SureOne/SurePOS 100 MSR limitations...................... 211
Select cursor type command.........................................174
Select number of rows command.................................174
Select rotate text 180 command.................................... 174 Chapter 15. POS keyboard.................. 213
Additional JavaPOS information........................................175 POS keyboard supported devices.......................................213
Descriptors...................................................................... 175 Supported properties and methods................................... 214
Capability definitions.................................................... 175 CANPOS keyboard........................................................ 216
Property definitions....................................................... 176 Installing USB system-attached keyboard in
Character sets supported in JavaPOS..........................176 Windows..........................................................................216
USB APA font download.............................................. 178 JavaPOS configuration......................................................... 217
OPOS configuration..............................................................179 Click..................................................................................217
OPOS DirectIO calls..............................................................180 FatFingerTimeout........................................................... 217
Set number of APA rows...............................................180 ExtendedKeyMapping...................................................217
Additional OPOS information............................................ 181 KbdScanning................................................................... 218
USB APA font download.............................................. 181 KeyTranslationFile......................................................... 218
Character sets supported in OPOS.............................. 181 Typematic........................................................................ 218
TypematicDelay..............................................................219
TypematicRate................................................................ 219
Chapter 12. Magnetic Ink Character JavaPOS DirectIO calls......................................................... 220
Recognition........................................... 185 Get keyboard light status command........................... 220
Supported devices.................................................................185 Set keyboard light on command.................................. 221
Supported properties and methods................................... 185 Set keyboard light off command.................................. 222
Magnetic Ink Character Recognition data.................. 187 Additional JavaPOS information........................................222
JavaPOS configuration......................................................... 188 Firmware Update........................................................... 222
MinMicrSignalLevel.......................................................188 Configuration file update..............................................223
CheckTypeAutodetection............................................. 188 Keyboard definition file................................................ 224
stripAccountDashes....................................................... 188 USB System attached keyboard on Linux ..................226
stripTransitDashes......................................................... 189 OPOS configuration..............................................................226
switchTransitDashToSpace...........................................189 OPOS DirectIO calls..............................................................227
Additional JavaPOS information........................................189 Get keyboard light status.............................................. 227
MICR exception tables...................................................189 Set keyboard light on..................................................... 228
OPOS configuration..............................................................192 Set keyboard light off.....................................................228
OPOS DirectIO calls..............................................................193 Additional OPOS information............................................ 228
Add new MICR exception.............................................193 Firmware Update........................................................... 229
Additional OPOS information............................................ 193 Configuration file update..............................................229
MICR exception file........................................................193 Configuring the Alphanumeric Point of Sale
keyboard.......................................................................... 230
SureOne/SurePOS 100 keyboard..................................231
Mapping POS keys.........................................................231
Chapter 13. Motion sensor.................. 197
Motion sensor supported devices.......................................197
Supported properties and methods................................... 197
Additional JavaPOS information........................................198 Chapter 16. POS printer....................... 235
Supported devices.................................................................235
Supported properties and methods................................... 236
JavaPOS configuration......................................................... 255
Chapter 14. Magnetic stripe reader.....201 Arabic code page support............................................. 255
Supported devices.................................................................201
AddLineFeed.................................................................. 256
Supported properties and methods................................... 202
Bitmap quality................................................................ 257
Configuration file update.................................................... 206
Color support.................................................................. 257
JavaPOS configuration......................................................... 206
Default8LPI..................................................................... 258
enableOnlineWatcher.................................................... 206
DefaultCharacterSet....................................................... 258
msrID ...............................................................................206
DefaultLargeFont........................................................... 258
TracksToRead................................................................. 207
DocAdvance.................................................................... 258
ErrorReportingType.......................................................207
DoubleHighAndDoubleWideIsQuad......................... 259
JavaPOS DirectIO calls......................................................... 207
Enable or Disable Partial Cut Detection......................259
MSR write data command............................................ 207
Enable or Disable Paper Motion Sensing....................259
Additional JavaPOS information........................................208
Enable or Disable Low Paper Detection..................... 260
SureOne MSR..................................................................208
Enable or Disable Low Paper LED.............................. 260
OPOS configuration..............................................................208
NoSetBitmap................................................................... 261
Additional OPOS information............................................ 211

Contents 5
OptimizedBaudRate.......................................................261 4610 printer firmware update.......................................327
PDF417AspectHeight.....................................................262 4610/6145 printer font download................................. 329
PDF417AspectWidth......................................................262 4689 printer font download ......................................... 334
PDF417ECCLevel........................................................... 262 Model 4 printer font download ...................................335
PDF417Truncation..........................................................263 Barcode printing............................................................. 338
ProportionalFontFixedWidth....................................... 263 QR code printing............................................................ 339
QRCODEEncodingMode.............................................. 263 Rotated printing..............................................................341
QRCODEErrorCorrectionLevel....................................264 DBCS support................................................................. 341
QRCodeECIValue...........................................................264 Color printing................................................................. 341
QR Barcode Usage..........................................................266 User-defined fonts..........................................................341
RecLineCharsFont.......................................................... 267 Proportional font support............................................. 342
SetCompatibilityMode...................................................268 Device sharing................................................................ 342
SlpLineSpacing............................................................... 268 Code 128 A/B/C support................................................342
SureOneVersion..............................................................268 SureOne/SurePOS 100 DBCS printer limitations.......343
TranslateCharacter......................................................... 269 Improving printer performance................................... 343
Watermark.......................................................................269 Character sets supported by POSPrinter devices
JavaPOS DirectIO calls......................................................... 270 for OPOS.......................................................................... 344
Download DBCS Font ID Command.......................... 270
Download Non-Proportional Font ID Command..... 271
Download Prop Font ID Command............................ 272 Chapter 17. Scanner (bar code
FontInfo Object............................................................... 273
Get Font Info ID Command.......................................... 274
reader)................................................... 347
Supported devices.................................................................347
Additional JavaPOS information........................................274
Supported properties and methods................................... 347
Calibration for low paper sense................................... 274
JavaPOS configuration......................................................... 349
4610 printer firmware update.......................................275
enableLaserOnOffSwitch.............................................. 352
4610 printers font download.........................................277
enableProgrammingViaBarcodes................................ 353
6145 Printer font download.......................................... 277
enableSwitchControlledVolumeAdjust ..................... 353
6145 printer firmware and configuration update......278
setBarCodes1...................................................................353
Using POSPrinter's MICR device.................................279
setBarCodes2...................................................................354
Handling invalid characters......................................... 279
setBarCodes3...................................................................354
Escape sequence handling............................................ 280
setBarCodes4...................................................................355
Line wrapping on the slip station using
setBeeperDuration..........................................................355
rotatePrint method(PTR_RP_LEFT90)........................ 281
setBeeperFrequency....................................................... 355
Bar Code GS1 Databar information............................. 281
setBeeperVolume............................................................356
Bitmap printing.............................................................. 283
setCheckModulo.............................................................356
Enable DBCS character compression on SLIP
setCode128ScansPerRead..............................................356
(Impact) station...............................................................285
setCode39ScansPerRead................................................357
Check flipping support..................................................285
setDecodeAlgorithm...................................................... 357
PageMode support......................................................... 285
setDoubleReadTimeOut................................................ 357
Paper saving mode.........................................................290
setDTouchMode............................................................. 358
Concurrent MICR/full-image scan...............................291
setEAN13ScansPerRead................................................ 358
Character sets supported by POSPrinter devices
setEAN8ScansPerRead.................................................. 359
for JavaPOS..................................................................... 291
setEnable_2_DigitSupplementals.................................359
OPOS configuration..............................................................295
setEnable_5_DigitSupplementals.................................359
Vietnamese code page support.................................... 296
setEnableCodabar...........................................................360
Thai code page support................................................. 297
setEnableCode128.......................................................... 360
Arabic code page support............................................. 297
setEnableCode128Supplementals................................ 360
Unsupported settings.................................................... 298
setEnableCODE39.......................................................... 360
Supported settings......................................................... 302
setEnableCode39CheckDigit........................................ 360
OPOS DirectIO calls..............................................................310
setEnableCode93............................................................ 361
Miscellaneous..................................................................310
setEnableEAN_JAN_TwoLabelDecoding.................. 361
Flash memory................................................................. 312
setEnableCompositeCC_A ...........................................361
Check scanning support................................................ 315
setEnableCompositeCC_B.............................................361
Page Mode printing....................................................... 321
setEnableCompositeCC_C............................................ 362
OPOS DirectIO events.......................................................... 324
setEnableGoodReadBeep.............................................. 362
NVRAM data.................................................................. 324
setEnableInterleaved2of5.............................................. 362
NVRAM error................................................................. 324
setEnableITFCheckDigit................................................362
OPOS extended result codes............................................... 325
setEnablePDF417............................................................ 362
Additional OPOS information............................................ 326
setEnableMicroPDF417..................................................363
6145 printer firmware and configuration update......326

6 UnifiedPOS User's Guide

setEnableRSS14 (deprecated)........................................363 WeighMode.....................................................................390
setEnableGS1Databar.....................................................363 Additional JavaPOS information........................................391
setEnableRSS_Expanded (deprecated)........................363 Known scale issues.........................................................391
setEnableGS1Databar_Expanded................................ 363 ScaleMaxWeightTolerance............................................391
setEnableStandard2of5.................................................. 364 OPOS configuration..............................................................392
setEnableUCC_EAN128................................................ 364
setEnableUPC_A_CheckDigit...................................... 364
setEnableUPC_A_To_EAN13Expansion.................... 364 Chapter 19. Tone indicator.................. 395
setEnableUPC_E_CheckDigit....................................... 364 Supported devices.................................................................395
setEnableUPC_E_To_EAN13Expansion..................... 365 Supported properties and methods................................... 396
setEnableUPC_E_To_UPC_AExpansion.................... 365 OPOS configuration..............................................................398
setEnableUPCAE_EANJAN813................................... 365 Additional JavaPOS configuration..................................... 399
setEnableUPCD1D5....................................................... 365 Enable or disable ELO tone interface.......................... 399
setEnableVerificationUPC_A_EAN13_fiveDigit....... 365 JavaPOS ELO tone interface configuration.................399
setEnableVerificationUPC_A_EAN13_fourDigit...... 366
setITFLength1................................................................. 366
setITFLength2................................................................. 366 Chapter 20. Lights................................ 401
setITFLengths..................................................................367 Supported devices.................................................................401
setITFLengthSpecifiedTwo........................................... 367 Supported properties and methods................................... 401
setITFScansPerRead....................................................... 367 JavaPOS Cofiguration......................................................... 404
setLaserTimeOut............................................................ 367 Color.<Color Name> (Guidance Lights SwitchOn)...404
setLED_GoodRead_Duration....................................... 368 JavaPOS DirectIO calls......................................................... 405
setMotorTimeOut........................................................... 369 DirectIO.LGT_IO_START_SCRIPT............................. 405
setSecurityLevelForInStore........................................... 369 Additional JavaPOS information........................................407
setSTFLength1.................................................................370 Install driver Windows..................................................407
setSTFLength2.................................................................370 Install driver Linux........................................................ 407
setSTFLengths................................................................. 370 Configure Lights device using POS Control Center. 407
setStoreScansPerRead.................................................... 371
setSupplementals............................................................371
setSupplementalsSecurityLevel................................... 371
setTransmitScannerPrefixAndSuffix........................... 371
Part III. Keyboards and code pages.... 411
setUPCAScansPerRead..................................................372
setUPCDScansPerRead..................................................372
setUPCEScansPerRead.................................................. 372 Chapter 21. POS keyboard layouts
Additional JavaPOS information........................................373 and scan codes.....................................413
Toshiba 4697 Point of Sale Scanner Configuration....373 Understanding scan codes...................................................413
USB OEM Scanner and scale configuration............... 373 Checkout Keyboards Layout (50-key and Modular 67
Known scanner issues....................................................376 Key) ........................................................................................ 413
OPOS configuration..............................................................376 50-Key Modifiable Layout Keyboard.......................... 413
Scanner programming................................................... 376 50-Key Modifiable Layout Keyboard and
Scanner Programming (AnyPlace Kiosk)................... 379 Operator Display............................................................ 414
Additional OPOS information............................................ 381 Retail Point of Sale Keyboard Layout......................... 414
Scanner detection........................................................... 381 Retail Point of Sale Keyboard with Card Reader
Known scanner issues....................................................382 and Display..................................................................... 414
JavaPOS DirectIO calls......................................................... 382 Point of Sale Keyboard VI Layout............................... 415
Scanner command.......................................................... 382 Modular 67-Key Keyboard Layout .............................415
Modular 67-Key Keyboard with Display Layout...... 416
Checkout Keyboards PS/2 or USB (System
Chapter 18. Scale..................................385 Keyboard) scan code set................................................ 416
Supported devices.................................................................385 Checkout keyboards RS-485/USB scan code set........ 419
Supported properties and methods................................... 385 Modifiable-layout keyboard with card reader layout
Power management support for RS-232 fiscal printers...388 (133-key)................................................................................. 423
JavaPOS configuration......................................................... 388 Modifiable layout keyboard with card reader
CenterOfZero.................................................................. 388 RS-485/USB scan code set..............................................423
DisplayRequired.............................................................389 Alphanumeric Point of Sale keyboards............................. 428
EnforceZeroReturn.........................................................389 PC Point of Sale keyboard with card reader
FiveDigitWeight (USB OEM only)...............................389 (ANKPOS)....................................................................... 428
OperationMode.............................................................. 390 Retail Alphanumeric Point of Sale Keyboard
VibrationSensitivity....................................................... 390 with card reader (NANPOS)........................................ 428

Contents 7
Modular Alphanumeric POS Keyboard .................... 430 Brazil-Portuguese keyboard layout............................. 484
Modular Compact Alphanumeric Point of Sale Canadian French keyboard layout...............................484
Keyboard......................................................................... 430 Danish keyboard layout................................................ 485
RS-485/USB scan code set for Retail Alphanumeric French keyboard layout.................................................485
Point of Sale Keyboard (NANPOS), PC Point of Sale German keyboard layout.............................................. 486
Keyboard (ANKPOS), USB scan code set for Italian keyboard layout................................................. 486
Modular Alphanumeric Point of Sale Keyboard .............431 Norwegian keyboard layout.........................................487
USB scan code set for the Modular Compact Spanish keyboard layout...............................................487
Alphanumeric Point of Sale Keyboard........................437 Swedish and Finnish keyboard layout........................488
Retail Alphanumeric Point of Sale keyboard with U.K. English keyboard layout...................................... 488
card reader (PS/2 or USB system attached)....................... 442 U.S. English keyboard layout....................................... 489
Retail Alphanumeric Point of Sale with card Compact Alphanumeric Point-of-Sale (CANPOS)
reader or PC Point of Sale keyboard (ANKPOS) keyboard.................................................................................489
layout keyboard..............................................................442 CANPOS keyboards by country.................................. 489
Retail Alphanumeric Point of Sale with card CANPOS country-dependent keyboards................... 492
reader (NANPOS) layout keyboard............................ 442
Modular Alphanumeric Point of Sale Keyboard ...... 444
Compact Alphanumeric Point of Sale (CANPOS) Chapter 22. Character sets for
layout keyboard..............................................................444
Modular Compact Alphanumeric Point of Sale
terminal printers and displays............ 495
Code Page 101........................................................................498
Keyboard Layout ...........................................................445
Code Page 437........................................................................499
PS/2 or USB (System Attached) scan code set for
Code Page 737........................................................................500
Retail Alphanumeric Point of Sale Keyboard
Code Page 775........................................................................501
(NANPOS), Modular Alphanumeric Point of Sale
Code Page 808........................................................................502
Keyboard, PC Point of Sale Keyboard (ANKPOS)....446
Code Page 813........................................................................503
PS/2 scan code set for the Compact
Code Page 819........................................................................504
Alphanumeric Point of Sale Keyboard
Code Page 848........................................................................505
(CANPOS), PS/2 / USB (System Attached)
Code Page 850........................................................................506
Modular Compact Alphanumeric Point of Sale
Code Page 852........................................................................507
Keyboard ........................................................................ 454
Code Page 855........................................................................508
Point of Sale Keyboard V..................................................... 462
Code Page 857........................................................................509
Keyboard V scan codes..................................................463
Code Page 858........................................................................510
PLU Keyboard and Display III............................................463
Code Page 860........................................................................511
4674 Point of Sale Keyboard (built-in)............................... 464
Code Page 861........................................................................512
4674 POS Keyboard (built-in) scan codes................... 464
Code Page 862........................................................................513
4685 keyboards...................................................................... 465
Code Page 863........................................................................514
4685 Point of Sale Keyboard Model K01.....................465
Code Page 864........................................................................515
4685 Keyboard K02 Ultra 7 (four-position keylock)..466
Code Page 865........................................................................516
4685 Keyboard Model K02 Ultra 7 with MSR/E
Code Page 866........................................................................517
(four or six position keylock)........................................467
Code Page 867........................................................................518
4685 Keyboard Model KC1........................................... 468
Code Page 869........................................................................519
4685 Keyboard Model K03............................................ 469
Code Page 872........................................................................520
4820 Toshiba SurePoint Solution Keypad......................... 470
Code Page 874........................................................................521
4820 Toshiba SurePoint Solution Keypad (system-
Code Page 912........................................................................522
attached)................................................................................. 472
Code Page 914........................................................................523
SureOne model 4614/4615 and SurePOS 100 model
Code Page 915........................................................................524
4613 keyboard (built-in)....................................................... 473
Code Page 921........................................................................525
SureOne model 4614/4615 and SurePOS 100
Code Page 1116......................................................................526
model 4613 keyboard (built-in) scan codes................ 474
Code Page 1117......................................................................527
Alphanumeric Point-of-Sale (NANPOS) country-
Code Page 1118......................................................................528
dependent keyboards........................................................... 481
Code Page 1250......................................................................529
Canadian French keyboard layout...............................481
Code Page 1251......................................................................530
French keyboard layout.................................................481
Code Page 1252......................................................................531
German keyboard layout.............................................. 482
Code Page 1253......................................................................532
Italian keyboard layout................................................. 482
Code Page 1254......................................................................533
Spanish keyboard layout...............................................482
Code Page 1255......................................................................534
U.K. English keyboard layout...................................... 483
Code Page 1256......................................................................535
U.S. English keyboard layout....................................... 483
Code Page 1257......................................................................536
Retail Alphanumeric Point of Sale country
Code Page 1258......................................................................537
dependent keyboards........................................................... 483

8 UnifiedPOS User's Guide

Code Page 932........................................................................538 TCxWave USB to RS-232 adapter................................ 590
Code Page 936........................................................................539 USB device access..................................................................590
Code Page 949........................................................................540 SLE 11 without Service Pack and newer SLE 11
Code Page 950........................................................................541 versions............................................................................ 590
Code Page 951........................................................................542 PS/2 keyboard configuration............................................... 591
Code Page 1381......................................................................554 USB system attached POS keyboard configuration......... 591
Touch device configuration.................................................592
Notices....................................................................................593
Appendix A. JavaPOS support for Telecommunication regulatory statement........................ 594
Electronic emission notices..................................................594
UnifiedPOS device statistics Federal Communications Commission (FCC) statement594
properties.............................................. 555 FCC Radiation Exposure Statement................................... 595
Common properties..............................................................555 Industry Canada Statement / Règlement d’Industry
Cash drawer...........................................................................555 Canada....................................................................................595
Check scanner........................................................................557 Industry Canada Radiation Exposure Statement.............595
Fiscal printer.......................................................................... 559 Aviso para los usuarios de México.....................................595
Hard totals............................................................................. 561 European Union Electromagnetic Compatibility
Keylock................................................................................... 561 (EMC) Directive Conformance Statement.........................596
Line display............................................................................563 United Kingdom Electromagnetic Compatibility
MICR.......................................................................................565 (EMC) Directive Conformance Statement.........................596
Motion sensor........................................................................ 566 Germany Class A statement................................................ 597
MSR......................................................................................... 567 Australia and New Zealand Class A statement............... 598
POS keyboard........................................................................ 570 Brasil INFORMAÇÕES REGULAMENTARES:............... 598
POS printer.............................................................................572 People's Republic of China Class A electronic
Scale.........................................................................................576 emission statement................................................................598
Scanner................................................................................... 577 Russian Electromagnetic Interference (EMI) Class A
Tone indicator........................................................................578 statement................................................................................ 599
Japanese Electrical Appliance and Material Safety
Law statement....................................................................... 599
Appendix B. Java Web Start Japanese power line harmonics compliance statement...599
configuration to access the POS Japan Voluntary Control Council for Interference
Class A statement..................................................................599
Control Center...................................... 581 Japan Electronics and Information Technology
Install Java Development Kit and JavaPOS driver...........581 Industries Association (JEITA) statement......................... 600
Create a KeyStore..................................................................581 Korean communications statement.................................... 600
Create a self-signed certificate.............................................581 Taiwan Class A compliance statement.............................. 601
Create jpos.xml...................................................................... 582 Taiwan contact information................................................ 601
Create the resource JAR....................................................... 582 Cable ferrite requirement.....................................................601
Sign the all JARs file with the test certificate.................... 583 Electrostatic discharge (ESD).............................................. 601
Run JNLP file......................................................................... 583 Product recycling and disposal...........................................602
Battery safety......................................................................... 603
Battery return program........................................................ 603
Appendix C. Additional information For Taiwan:............................................................................ 603
for SUSE Linux Enterprise (SLE)........ 585 For the European Union:......................................................604
USB Alphanumeric POS Keyboard does not receive For California:........................................................................605
scan codes...............................................................................585 Flat panel displays................................................................ 605
Known GUI issues................................................................ 585 Monitors and workstations..................................................605
Power management.............................................................. 586 Trademarks............................................................................ 605
SLE 11 and PM Utils package.......................................586
SLE 12...............................................................................586
Glossary................................................ 607

Appendix D. JavaPOS device

configuration for Linux........................ 587
Serial ports configuration.................................................... 587
Serial port enumeration utility..................................... 587
Toshiba systems and COM port assignments
reference...........................................................................587
Serial port access.............................................................589

Contents 9
10 UnifiedPOS User's Guide
Figures
1. Features dialog OPOS........................................................ 29 43. Toshiba POS Control Center Application................... 408
2. Features dialog JavaPOS.................................................... 30 44. Save auto-detected devices in jpos.xml....................... 408
3. Upgrade Window............................................................... 32 45. Save jpos.xml file.............................................................408
4. OPOS Configuration utility window............................... 51 46. Layout for 50-Key Modifiable Keyboard.....................413
5. Device properties dialog (RS-485/USB)........................... 53 47. Layout for 50-Key Modifiable Keyboard and
Operator Display ..................................................................414
6. Device properties dialog (EIA-232).................................. 53
48. Layout for Retail Point of Sale Keyboard ................... 414
7. Results of connectivity test................................................ 54
49. Layout for Retail Point of Sale Keyboard with
8. Device Demo/Info Button.................................................. 55 Card Reader and Display ....................................................415
9. Demo Tab ............................................................................ 56 50. Layout for Point of Sale Keyboard VI ......................... 415
10. Print Test Receipt Button................................................. 57 51. Layout for Modular 67 Key Keyboard ........................416
11. Selecting devices to export.............................................. 58 52. Layout for Retail Point of Sale 67-Key Keyboard
12. Trace Configuration..........................................................60 with Display ..........................................................................416
13. Trace Configuration for Windows................................. 62 53. Modifiable layout keyboard with card reader............423
14. POS tracing facility........................................................... 63 54. PC Point of Sale keyboard layout................................. 428
15. Two-position keylock..................................................... 152 55. Layout and Assigned Switch Numbers....................... 429
16. 4820 Two-position keylock............................................ 153 56. Layout and Assigned Switch Numbers for
Modular Alphanumeric POS Keyboard ........................... 430
17. SureOne three-position keylock....................................153
57. Layout and Assigned Switch Numbers for the
18. SurePOS 100 three-position keylock............................ 153 Modular Compact Alphanumeric POS Keyboard .......... 431
19. Four-position keylock.....................................................154 58. PC Point of Sale keyboard layout................................. 442
20. Four-position keylock.....................................................154 59. Layout and assigned switch numbers......................... 443
21. Five-position keylock..................................................... 155 60. Layout and Assigned Switch Numbers for
22. Six-position keylock........................................................155 Modular ANPOS Keyboard ............................................... 444
23. Two-position keylock..................................................... 160 61. Layout and assigned switch numbers for
CANPOS keyboard...............................................................445
24. 4820 Two-position keylock............................................ 160
62. Modular CANPOS Keyboard Layout and
25. Three-six position keylock properties..........................161 Assigned Switch Numbers ................................................. 446
26. Data parsing: Example 1................................................ 195 63. Point of Sale Keyboard V layout...................................463
27. Data parsing: Example 2................................................ 195 64. Keyboard-V scan code set..............................................463
28. Keyboard properties dialog...........................................231 65. PLU Keyboard and Display-III layout.........................464
29. Sample POS keyboard mapping dialog.......................232 66. 4674 Point of Sale Keyboard (built-in)......................... 464
30. Example of adding a keyboard mapping entry..........232 67. Scan codes for 4674 built-in keyboard......................... 465
31. Editing a keyboard mapping entry.............................. 233 68. 4685 Point of Sale Keyboard Model K01 layout......... 465
32. Partial image, no position setting................................. 286 69. 4685 Keyboard Model K01 scan code set.....................466
33. Setting position properties for printing....................... 287 70. 4685 Keyboard K02 Ultra 7 with 4-position keylock. 466
34. Setting image position for printing.............................. 288 71. 4685 Keyboard K02 Ultra 7 scan codes........................ 467
35. Printing text..................................................................... 288 72. 4685 Keyboard K02 Ultra 7 with MSR/E (4 or 6
36. Image follows text...........................................................289 position keylock)................................................................... 467
37. Second image beside first image...................................289 73. 4685 Keyboard K02 Ultra 7 with MSR/E scan codes..468
38. Scanned image organization......................................... 320 74. 4685 Model KC1.............................................................. 468
39. AnyPlace Kiosk Scanner................................................ 380 75. Scan codes for Model 4685-KC1....................................469
40. Scanner Properties.......................................................... 380 76. 4685 Keyboard Model K03 layout................................ 469
41. Default script definitions............................................... 405 77. 4685 Keyboard Model K03 scan codes.........................470
42. First array element light zones......................................406 78. 4820 Keypad key-switch layout.................................... 470

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 11

79. 4820 Keypad (system-attached) key-switch layout....472
80. SureOne/SurePOS 100 keyboard (built-in)
keyboard layout.................................................................... 474
81. SureOne/SurePOS 100 101-key keyboard switches... 475
82. SurePOS 100 102-key keyboard switches.................... 476
83. SurePOS 100 103-key keyboard switches.................... 477
84. Code page 101 chart........................................................498
85. Code page 775 chart........................................................501
86. Code page 808 chart........................................................502
87. Code page 819 chart........................................................504
88. Code page 848 chart........................................................505
89. Code page 867 chart........................................................518
90. Code page 872 chart........................................................520
91. Code page 874 chart........................................................521
92. Code page 1116 chart......................................................526
93. Code page 1117 chart......................................................527
94. Code page 1118 chart......................................................528
95. Code page 1250 chart......................................................529
96. Code page 1251 chart......................................................530
97. Code page 1252 chart......................................................531
98. Code page 1253 chart......................................................532
99. Code page 1254 chart......................................................533
100. Code page 1255 chart....................................................534
101. Code page 1256 chart....................................................535
102. Code page 1257 chart....................................................536
103. Code page 932 chart......................................................538
104. Code page 936 chart......................................................539
105. Code page 949 chart......................................................540
106. Code page 950 chart......................................................541
107. Special Symbols
Alphanumeric⁄Numerics⁄Jamo⁄Hiragana⁄Hanja (1 of 3).. 542
108. Special Symbols
Alphanumeric⁄Numerics⁄Jamo⁄Hiragana⁄Hanja (2 of 3).. 543
109. Special Symbols
Alphanumeric⁄Numerics⁄Jamo⁄Hiragana⁄Hanja (3 of 3).. 544
110. Hangeul (1 of 10)........................................................... 545
111. Hangeul (2 of 10)........................................................... 546
112. Hangeul (3 of 10)........................................................... 547
113. Hangeul (4 of 10)........................................................... 548
114. Hangeul (5 of 10)........................................................... 549
115. Hangeul (6 of 10)........................................................... 550
116. Hangeul (7 of 10)........................................................... 551
117. Hangeul (8 of 10)........................................................... 552
118. Hangeul (9 of 10)........................................................... 553
119. Hangeul (10 of 10)......................................................... 553
120. Code page 1381 chart....................................................554

12 UnifiedPOS User's Guide

Tables
1. Supported POS terminals.................................................. 27 37. Check scanner specific methods..................................... 98
2. Software environment for UnifiedPOS............................28 38. Check scanner events....................................................... 98
3. Command line parameters................................................ 31 39. CHK_DIO_SCANNER_CALIBRATION_CMD
information.............................................................................. 99
4. Resources for SUSE Linux Enterprise 11 SP3/SP4
(SLE11 SP3/SP4).......................................................................33 40. CHK_DIO_PRINT_SCANNED_IMAGE_CMD
information.............................................................................. 99
5. Resources for SUSE Linux Enterprise 12 SP2
(SLE12 SP2).............................................................................. 34 41. CHK_DIO_SET_CHECK_SIDE_CMD information...100
6. Toshiba JavaPOS Supported Environment on SLE 42. CHK_DIO_GET_CHECK_SIDE_CMD information..100
11 SP3/SP4................................................................................ 36
43. CHK_DIO_SCANNER_IMAGE_QUALITY_CMD
7. Driver details....................................................................... 39 information............................................................................ 101
8. EIA-232 device communication properties..................... 45 44. Fiscal printer supported devices...................................103
9. Specific values for EIA-232 devices in JavaPOS............. 46 45. Fiscal printer common properties.................................104
10. Device status types........................................................... 51 46. Fiscal printer specific properties...................................105
11. Alternate property names used in OPOS...................... 67 47. Fiscal printer common methods................................... 108
12. JavaPOS Firmware Update..............................................70 48. Fiscal printer specific methods......................................109
13. Service Object settings for non EIA-232 devices...........73 49. Fiscal printer (DirectIO) events.....................................109
14. Service Object settings for EIA-232 devices.................. 74 50. Fiscal printer (Italy) specific properties....................... 110
15. OPOS Firmware Update.................................................. 74 51. Fiscal printer (Italy) common methods........................110
16. Ignoring USB devices....................................................... 76 52. Fiscal printer (Italy) specific methods..........................111
17. Ethernet/Wireless printer offline monitoring timer.....77 53. Fiscal printer (Italy) events............................................ 113
18. Errors.................................................................................. 78 54. Fiscal printer (Greece) common properties.................114
19. Cash drawer supported devices..................................... 81 55. Fiscal printer (Greece) specific properties................... 114
20. Cash drawer common properties................................... 81 56. Fiscal printer (Greece) common methods................... 118
21. Cash drawer specific properties..................................... 82 57. Fiscal printer (Greece) specific methods......................118
22. Cash drawer common methods......................................82 58. Fiscal printer (Greece) events........................................ 120
23. Cash drawer specific methods........................................ 83 59. Parameters for FISCAL_INFORMATION
subcommand......................................................................... 122
24. Cash drawer events.......................................................... 83
60. Parameters for FISCAL_READ subcommand............ 122
25. DEVICE_INFORMATION_CMD information.............88
61. Parameters for FISCAL_WRITE subcommand.......... 122
26. Service Object settings for cash drawer......................... 89
62. Parameters for FISCAL_NOTIFY subcommand........ 123
27. USB cash drawer support................................................ 90
63. Parameters for the FISCAL_ERROR event..................123
28. Parameters for
DIRECTIO_DEVICE_INFORMATION_CMD 64. Error codes for FISCAL_ERROR event........................123
subcommand........................................................................... 91
65. Parameters for the FISCAL_STATUS event................124
29. Common properties (cash drawer attached fiscal
printer: Italy)............................................................................91 66. Parameters for the FISCAL_DATA_AVAIL event.... 124

30. Specific properties (cash drawer attached fiscal 67. Parameters for the FISCAL_IPL_END_STATUS
printer: Italy)............................................................................92 event........................................................................................125

31. Common methods (cash drawer attached fiscal 68. Parameters for ................................................................ 128
printer: Italy)............................................................................92 69. Parameters for FISCAL_READ subcommand............ 128
32. Cash drawer attached fiscal printer (Italy) specific 70. Parameters for FISCAL_WRITE subcommand.......... 128
methods.................................................................................... 93
71. Parameters for FISCAL_NOTIFY subcommand........ 129
33. Check scanner supported devices.................................. 95
72. Parameters for the FISCAL_ERROR event..................129
34. Check scanner common properties................................ 95
73. Error codes for FISCAL_ERROR event........................129
35. Check scanner specific properties.................................. 96
74. Parameters for the FISCAL_STATUS event................130
36. Check scanner common methods...................................97
75. Parameters for the FISCAL_DATA_AVAIL event.... 131

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 13

76. Parameters for the FISCAL_RAW_STATUS event.... 131 114. Service Object settings for RS-485/USB line display 179
77. Parameters for the FISCAL_IPL_END_STATUS 115. Service object settings for EIA-232 line display........180
event........................................................................................131
116. Set number of APA rows............................................. 180
78. Supported display devices............................................ 133
117. Character sets supported by line display in OPOS..182
79. Parameter support status and value for fiscal
printer getData method (Italy)............................................ 135 118. Magnetic Ink Character Recognition (MICR)
supported devices................................................................. 185
80. Parameter support status and value for fiscal
printer getData method (Greece)........................................139 119. Magnetic Ink Character Recognition (MICR)
common properties...............................................................185
81. Parameter support status and value for fiscal
printer getTotalizer method (Greece)................................ 143 120. Magnetic Ink Character Recognition (MICR)
specific properties................................................................. 186
82. Hard totals supported devices...................................... 147
121. Magnetic Ink Character Recognition (MICR)
83. Hard totals common properties....................................147 common methods..................................................................186
84. Hard totals specific properties...................................... 148 122. Magnetic Ink Character Recognition (MICR)
specific methods....................................................................187
85. Hard totals common methods.......................................148
123. Magnetic Ink Character Recognition (MICR)
86. Hard totals specific methods.........................................149 events...................................................................................... 187
87. Hard totals events........................................................... 149 124. MICR exception table fields for format 2.................. 191
88. Service object settings for hard totals...........................150 125. Format 3 Exception Table (sample data)................... 192
89. Keylock supported devices............................................151 126. Service object settings for MICR................................. 192
90. UnifiedPOS keylock standards..................................... 152 127. Add new MICR exception........................................... 193
91. Keylock common properties......................................... 156 128. Exception configuration properties for MICR
92. Keylock specific properties............................................157 processing: Example 1.......................................................... 194
93. Keylock common methods............................................ 157 129. Exception configuration properties for MICR
processing: Example 2.......................................................... 195
94. Keylock specific methods.............................................. 158
130. Motion sensor supported devices...............................197
95. Keylock events.................................................................158
131. Motion sensor common properties............................ 197
96. Service Object settings for keylock............................... 159
132. Motion sensor specific properties...............................198
97. Line display supported devices.................................... 163
133. Motion sensor common methods............................... 198
98. Line display common properties..................................163
134. Motion sensor specific methods..................................198
99. Line display specific properties.................................... 164
135. Motion sensor events....................................................198
100. Line display common methods...................................167
136. Magnetic stripe reader (MSR) supported devices....201
101. Line display specific methods..................................... 168
137. MSR common properties............................................. 202
102. Line display events....................................................... 169
138. MSR specific properties................................................203
103. CapCursor Type and Cursor Type Properties..........169
139. MSR common methods................................................ 205
104. Common properties (line display attached fiscal
printer: Italy)..........................................................................169 140. MSR specific methods.................................................. 205
105. Specific properties (line display attached fiscal 141. MSR events.....................................................................205
printer: Italy)..........................................................................170 142. MSR Configuration (Device 34, 35)............................ 206
106. Common methods (line display attached fiscal 143. Parameters for
printer: Italy)..........................................................................172 DirectIO.MSR_WRITE_DATA_CMD................................ 208
107. Specific methods (line display attached fiscal 144. UposExceptionException error code property......... 208
printer: Italy)..........................................................................172
145. Service object settings for EIA-232 MSR.................... 209
108. Parameters for
DirectIO.SELECT_APA_VFD_CURSOR_TYPE............... 174 146. Service object settings for ALL MSR.......................... 209
109. Parameters for 147. POS keyboard supported devices...............................213
DirectIO.SELECT_APA_NUMBER_OF_ROWS...............174
148. POS keyboard common properties............................ 214
110. Parameters for the
DirectIO.SELECT_ROTATE_TEXT_180............................ 174 149. POS keyboard specific properties...............................215

111. ErrorCode property for 150. POS keyboard common methods............................... 215
DirectIO.SELECT_ROTATE_TEXT_180............................ 175 151. POS keyboard events....................................................216
112. Character sets supported by line display in 152. DirectIO.GET_KBD_LIGHT_STATUS_CMD........... 220
JavaPOS.................................................................................. 176
153. DirectIO.GET_KBD_LIGHT_STATUS_CMD bit
113. Font File Summary........................................................178 representation........................................................................221

14 UnifiedPOS User's Guide

154. DirectIO.TURN_KBD_LIGHT_ON_CMD bit 197. Double-byte character sets supported by
representation........................................................................221 POSPrinter devices for JavaPOS......................................... 294
155. DirectIO.TURN_KBD_LIGHT_OFF_CMD............... 222 198. Service object settings for SureOne devices (POS
printer)....................................................................................295
156. Modular Keyboards (Device 22, 23, 24, 25)............... 222
199. Service Object settings for POS printer device,
157. Compact Alphanumeric Keyboard (Device 9)......... 223 unsupported.......................................................................... 298
158. Modular Keyboards (Device 22, 23, 24, 25, 26, 27)... 223 200. Service Object settings for SureMark devices
159. Settings for POS keyboard........................................... 226 (POS printer), supported......................................................303
160. Service Object settings for POS keyboard................. 227 201. Flip check........................................................................310
161. Get keyboard light status.............................................227 202. Print downloaded bitmap............................................310
162. Byte information............................................................228 203. Print downloaded message......................................... 310
163. Set keyboard light on....................................................228 204. Read MICR data............................................................ 311
164. Set keyboard light off................................................... 228 205. Reset printer object....................................................... 311
165. OPOS Modular Keyboards (Device 22, 23, 24)......... 229 206. Check for errors.............................................................311
166. Compact Alphanumeric Keyboard (Device 9)......... 229 207. Set double strike mode.................................................312
167. Modular Keyboards (Device 22, 23, 24)..................... 230 208. Flash memory................................................................ 312
168. POS printer supported devices................................... 235 209. Read flash memory....................................................... 313
169. POS printer common properties.................................236 210. Query flash size............................................................. 313
170. POS printer specific properties................................... 237 211. Query max records....................................................... 314
171. POS printer common methods....................................245 212. Set record length........................................................... 314
172. POS printer specific methods...................................... 247 213. Erase flash memory...................................................... 314
173. POS printer events........................................................ 248 214. Get record length.......................................................... 315
174. POS printer BarCode symbologies supported..........251 215. Micro read with scan.................................................... 315
175. POS printer escape sequences..................................... 253 216. Compression format..................................................... 315
176. Characters to be encoded.............................................264 217. Scan document.............................................................. 316
177. Supported CharactersSets as defined on the 218. Store document..............................................................316
Extended Channel Interpretations standard:....................264 219. Retrieve by index.......................................................... 317
178. Accepted argument values.......................................... 267 220. Retrieve by tagname..................................................... 317
179. SureOne Version property values.............................. 268 221. Erase storage.................................................................. 318
180. DirectIO.DOWNLOAD_DBCS_FONT_ID................270 222. Clear print area..............................................................321
181. UposException error codes..........................................271 223. Page mode print............................................................ 321
182. DirectIO.DOWNLOAD_NON_PROP_FONT_ID....271 224. Horizontal and vertical position.................................322
183. UposException error codes..........................................272 225. Page area........................................................................ 322
184. DirectIO.DOWNLOAD_PROP_FONT_ID................272 226. Page mode station.........................................................323
185. User-defined (UD) character sets................................272 227. Print area........................................................................ 323
186. UposException error codes..........................................273 228. Print direction................................................................324
187. DirectIOFontInfo object structure...............................273 229. NVRAM data................................................................. 324
188. DirectIO.GET_FONT_INFO_ID..................................274 230. NVRAM error................................................................324
189. Firmware update information for 6145 POS 231. Extended result codes...................................................325
printers....................................................................................275
232. 6145 POS Printer............................................................327
190. Firmware update information for 4610 POS
printers....................................................................................275 233. Toshiba 4610 printer firmware update...................... 328
191. Toshiba 4610 printer firmware update...................... 276 234. Parameter setting for AIPFLD46.................................328
192. 6145 POS Printer............................................................278 235. 4610/6145 font file names and descriptions...............330
193. Handling invalid characters........................................ 279 236. Details............................................................................. 331
194. Accepted Argument Values........................................ 281 237. Details............................................................................. 333
195. Bitmap printing............................................................. 284 238. Creating registry entries...............................................339
196. Single-byte character sets supported by 239. Accepted argument values.......................................... 340
POSPrinter devices for JavaPOS......................................... 291
240. Code 128 character sets................................................ 343

Tables 15
241. Code 128 special character encoding......................... 343 283. RS-485 Scan Codes – Modifiable Layout
Keyboard with Card Reader................................................428
242. Single-byte character sets supported by
POSPrinter devices for OPOS............................................. 344 284. RS-485/USB scan code set............................................ 431
243. Double-byte character sets supported by 285. Point of Sale Scan Codes for Retail
POSPrinter devices for OPOS............................................. 346 Alphanumeric Point of Sale Keyboard with Card
Reader .................................................................................... 437
244. Scanner supported devices.......................................... 347
286. Serial I/O Scan Codes– PC Point of Sale
245. Scanner common properties........................................347 Keyboard (ANKPOS) Keyboard ........................................ 437
246. Scanner specific properties.......................................... 348 287. USB scan codes for Modular Compact
247. Scanner common methods...........................................348 Alphanumeric POS Keyboard ............................................437
248. Scanner events............................................................... 349 288. PS⁄2 or USB (system attached) scan codes................. 446
249. Supported symbologies for Toshiba scanners.......... 350 289. PS/2 or USB scan codes for CANPOS keyboard.......454
250. Scanner configurable parameters............................... 351 290. 4820 RS-485/USB Toshiba SurePoint Solution
keypad scan codes................................................................ 471
251. setBarCodes1 values..................................................... 353
291. 4820 Toshiba SurePoint Solution Keypad
252. OEM Scanners............................................................... 373 (system-attached) scan codes.............................................. 472
253. USB OEM Devices.........................................................374 292. SureOne/SurePOS 100 keyboard scan codes.............477
254. Handheld scanners....................................................... 377 293. Single-byte character set: ............................................ 495
255. Flatbed scanners............................................................ 377 294. Double-byte character set:........................................... 496
256. AnyPlace Scanner Properties...................................... 381 295. Codepages......................................................................497
257. SCANNER_ID information......................................... 382 296. Description of common properties.............................555
258. Scale supported devices............................................... 385 297. Cash drawer...................................................................555
259. Scale common properties.............................................385 298. Cash drawer common properties............................... 556
260. Scale specific properties............................................... 386 299. Cash drawer specific properties................................. 557
261. Scale common methods................................................387 300. Check scanner................................................................558
262. Scale specific methods.................................................. 387 301. Check scanner common properties............................ 558
263. Scale events.................................................................... 388 302. Check scanner manufacturer properties................... 558
264. Scale configuration options......................................... 388 303. Fiscal printer.................................................................. 559
265. Service Object settings for scale.................................. 392 304. Fiscal printer common properties...............................559
266. Tone indicator supported devices.............................. 395 305. Fiscal printer specific properties.................................560
267. Tone indicator common properties............................ 396 306. Hard Totals.................................................................... 561
268. Tone indicator specific properties.............................. 397 307. Hard totals common properties..................................561
269. Tone indicator common methods...............................397 308. Keylock........................................................................... 561
270. Tone indicator specific methods................................. 398 309. Keylock common properties....................................... 562
271. Tone indicator events................................................... 398 310. Keylock manufacturer properties table..................... 563
272. Service Object settings for tone indicator.................. 398 311. Keylock specific properties..........................................563
273. Supported devices.........................................................401 312. Line display....................................................................563
274. Common properties......................................................401 313. Line Display common properties............................... 564
275. Specific properties.........................................................402 314. Line Display specific properties..................................565
276. Lights common methods............................................. 402 315. Line Display manufacturer properties.......................565
277. Lights specific methods................................................402 316. MICR...............................................................................565
278. Light zone descriptions................................................ 406 317. MICR common properties........................................... 565
279. PS/2 or USB (System Keyboard) scan codes for 318. MICR specific properties............................................. 566
Modular 67 Key Keyboard ................................................. 417
319. MICR manufacturer properties...................................566
280. Checkout keyboards RS-485/USB scan code set....... 420
320. Motion sensor................................................................ 566
281. RS-485⁄USB scan codes for the Retail Point of
Sale Keyboards...................................................................... 422 321. Motion sensor common properties............................ 566
282. Modifiable layout keyboard RS-485/USB scan 322. Motion Sensor specific properties.............................. 567
code set................................................................................... 423 323. MSR................................................................................. 567
324. MSR common properties............................................. 568

16 UnifiedPOS User's Guide

325. MSR manufacturer properties table........................... 569
326. MSR specific properties................................................569
327. POS keyboard................................................................ 570
328. POS Keyboard common properties............................571
329. POS keyboard manufacturer properties table.......... 572
330. POS Keyboard specific properties.............................. 572
331. POS printer.....................................................................572
332. POS printer common properties.................................573
333. POS printer specific properties................................... 574
334. POS printer manufacturer properties........................ 575
335. Scale.................................................................................576
336. Scale common properties.............................................576
337. Scale specific properties............................................... 576
338. Scanner........................................................................... 577
339. Scanner common properties........................................577
340. Scanner specific properties.......................................... 578
341. Tone indicator................................................................578
342. Tone indicator common properties............................ 579
343. Tone Indicator manufacturer properties table..........580
344. Tone indicator specific properties.............................. 580
345. Mapping of additional COM ports.............................587

Tables 17
18 UnifiedPOS User's Guide
Safety
Before installing this product, read Safety Information.

Antes de instalar este produto, leia as Informações de Segurança.

Pred instalací tohoto produktu si prectete prírucku bezpecnostních instrukcí.

Læs sikkerhedsforskrifterne, før du installerer dette produkt.
Lees voordat u dit product installeert eerst de veiligheidsvoorschriften.
Ennen kuin asennat tämän tuotteen, lue turvaohjeet kohdasta Safety Information.
Avant d'installer ce produit, lisez les consignes de sécurité.
Vor der Installation dieses Produkts die Sicherheitshinweise lesen.

Prima di installare questo prodotto, leggere le Informazioni sulla Sicurezza.

Les sikkerhetsinformasjonen (Safety Information) før du installerer dette produktet.

Antes de instalar este produto, leia as Informações sobre Segurança.

Antes de instalar este producto, lea la información de seguridad.

Läs säkerhetsinformationen innan du installerar den här produkten.
Пре инсталирања овог производа, прочитајте Безбедносне информације.
Перш ніж встановлювати продукт, прочитайте Інформацію про безпеку.

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 19

20 UnifiedPOS User's Guide
About this guide
This guide contains reference information for Unified Point of Service (UnifiedPOS)
implementations. This guide also includes information about keyboards and code pages.

Who should read this guide

This guide is intended for use by point-of-sale application developers who need to access
Toshiba point-of-sale hardware using UnifiedPOS.

Where to find more information

The most current versions of the Toshiba publications are available on the Toshiba
Global Commerce Solutions website at https://commerce.toshiba.com/support/publications. The
publications listed under the General tab are available to the public.
Note: Access to the product publications require valid user credentials. For information on
obtaining a user ID and password, click About us, and then FAQs.
To access a specific Toshiba product publication:
1. Go to https://commerce.toshiba.com/support/publications.
2. Click the appropriate product category (for example, Hardware).
3. Scroll down and select the desired product.
4. Scroll down and select the appropriate manual listed under the Publications header, and
the PDF will be downloaded to your computer.

Accessing the TGCS Knowledgebase site

Toshiba Global Commerce Solutions has developed a variety of Knowledgebase articles to assist
you in using the Toshiba product set. To access the TGCS Knowledgebase articles:
1. Login to the Toshiba Global Commerce Solutions web site at https://
commerce.toshiba.com/.
2. Click Support.
3. Select a product from the Hardware or Software drop-down menu to display the product
page.
4. Scroll down and select Read more under Knowledgebase.

UnifiedPOS publications
Unified Point of Service (UnifiedPOS) Retail Peripheral Architecture publications can be
found at https://www.omg.org/retail/unified-pos.htm.

Notice statements
Notices in this guide are defined as follows:

Note
These notices provide important tips, guidance, or advice.

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 21

Important
These notices provide information or advice that might help you avoid inconvenient or
problem situations.

Attention
These notices indicate potential damage to programs, devices, or data. An attention notice
is placed just before the instruction or situation in which damage could occur.

CAUTION
These statements indicate situations that can be potentially hazardous to you. A caution
statement is placed just before the description of a potentially hazardous procedure step
or situation.

DANGER
These statements indicate situations that can be potentially lethal or extremely hazardous
to you. A danger statement is placed just before the description of a potentially lethal or
extremely hazardous procedure step or situation.

22 UnifiedPOS User's Guide

Summary of changes
November 2021
This edition of UPOS 1.14.9 includes the following:
• Fixes for field defects
• Support for new systems:
• TCx® 810
• TCx® 810E
• SLE 15 Enablement for JavaPOS
• Updates to I/O firmware

June 2021
This edition of UPOS 1.14.8 includes the following:
• Fixes for field defects.
• Enhancements:
• JavaPOS
• Cash Drawer settings updates for CheckOpenStatus and DisableCDStatus.
• POS Printer settings updates for PrintSpeedValue
• OPOS
• Updates to build libraries.
• Updates to I/O firmware

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 23

24 UnifiedPOS User's Guide
Part I. User's guide
User's guide

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 25

26 UnifiedPOS User's Guide
Chapter 1. Introduction
Introduction

Unified Point of Service (UnifiedPOS) is an architectural specification developed by the

Association for Retail Technology Standards (ARTS), of which Toshiba is a member. UnifiedPOS
provides a standard application programming interface (API) specification for point-of-service
devices that are used in the retail environment. The specification standard is independent of
a specific operating system and language, and defines a set of retail device behaviors that are
sufficient to support a range of point-of-service solutions.
The Toshiba UnifiedPOS implementation of the ARTS UnifiedPOS architectural specification
includes JavaPOS and Object Linking and Embedding (OLE) for Retail Point of Sale (OPOS):
• JavaPOS is an implementation of the UnifiedPOS specification written in Java® for the
support of Java applications.
• OPOS is an implementation of the UnifiedPOS specification for Microsoft® Windows®
systems. The drivers are implemented using COM, and are delivered as ActiveX controls.

System requirements
This section contains information on the hardware, software, disk space, and memory
requirements for the UnifiedPOS 1.14.1 Subsystem.

Hardware environment
The following table lists the point-of-sale terminals that are supported by the UnifiedPOS
implementation.
Not all models of all terminal types are supported. For details on specific model types, check the
End of Engineering Support announcements on the Support News page, which can be found at
https://commerce.toshiba.com/support.

Table 1. Supported POS terminals

Terminal Models
SurePOS 300 Series All
SurePOS 500/600 Series All
SurePOS 700 Series All
TCxWave All
TCx 300 Series All
TCx 700 Series All
TCx 800 Series All
4750-D10 All

Attention: Hot-plugging a powered peripheral device can cause damage to the device and/or the
terminal and is not recommended or supported. This includes, but is not limited to, RS-485, USB,
PS/2, and powered EIA-232 devices.

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 27

Software environment
The UnifiedPOS system requires the following software environment:

Table 2. Software environment for UnifiedPOS

Operating system One of the following:
64-bit operating systems:
• Microsoft Windows 8.1
• Microsoft Windows 10
• Microsoft Windows 10 LTSB 2015
• Microsoft Windows 10 LTSB 2016
• Microsoft Windows 10 CBB
• Microsoft Windows 10 IoT Enterprise LTSB 2016
• Microsoft Windows 10 IoT Enterprise LTSC 2019
• Microsoft Windows 10 IoT Enterprise SAC
• SUSE Linux Enterprise Desktop 12 (SLED 12) Service Pack 2
• SUSE Linux Enterprise Server 12 (SLES 12) Service Pack 2
• Linux Kernel V4.4 Enablement

Java Virtual Machine Java Runtime environment (JRE)

(JVM)
Control Objects OPOS common control objects are required to run the
Toshiba OLE for Retail Subsystem. The control objects are
installed automatically or they can be obtained from: http://
www.monroecs.com/oposccos.htm.

28 UnifiedPOS User's Guide

Chapter 2. Installing UnifiedPOS
Installing UnifiedPOS

This chapter contains information on the UnifiedPOS installation for Windows and SUSE Linux
Enterprise (SLE).

Installation for Windows

There are two options for installing the UnifiedPOS for Retail POS Suite: interactive installation
and silent installation.

Interactive installation
1. Run the Setup.exe file and follow the directions on each panel. The prompt to install
Microsoft .Net Framework might appear.
2. In the Features dialog, choose one of the following features:
• OPOS Device Support (Figure 1)
• JavaPOS Device Support (Figure 2)
The system unit information is displayed to the user if the system is recognized.

Figure 1. Features dialog OPOS

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 29

Figure 2. Features dialog JavaPOS
3. After the installation is complete, restart the system so that the configuration changes take
effect.
Note:
1. If you select OPOS Common Control Objects during OPOS installation, the installation will
override any existing OPOS Common Control Objects on the system.
2. It is your responsibility to re-register the OPOS Common Control Objects if UnifiedPOS is
uninstalled.
3. In JavaPOS, a Java Communication API is needed for the use of RS232 devices. IBM
JavaComm is no longer included in UPOS drivers. If you want to install the Comm libraries
included, select JavaComm libraries (RxTx).
4. Using Virtual COM Port Driver for Printer option should be selected when coexistence
with Toshiba VCP Drivers is required. The VCP driver emulates a standard PC serial port
such that the USB device may be communicated with as a standard RS232 device.

USB system attached POS keyboard configuration for Windows

By default, the Modular POS USB Keyboard will be installed as a Windows system keyboard.
In this case, the keyboard will function as standard keyboard and also the Magnetic Stripe
Reader(MSR) data will be retuned as keyboard data, which is also termed as wedge mode.
Therefore, the keyboard and MSR will not available for use with JavaPOS or OPOS applications
as a POS Keyboard and MSR device respectively.
To use the POS Keyboard and MSR through JavaPOS or OPOS drivers, the following option
must be selected during installation.

30 UnifiedPOS User's Guide

• Select Yes for "Do you want to use POS Keyboard via OPOS/JavaPOS Drivers?"
• Select Universal Serial Bus (USB) option in the same dialog box.
Caution:
1. Don’t select the option to enable the POS Keyboard as a wake device. It is a checkbox
option called Allow this device to wake the computer. It is available under the Power
Management tab in Device Manager for USB Point of Sale Keyboard. Doing so, may
cause unpredictable results if POS Keyboard is hot-plugged. If this occurs, recommended
action is de-select(uncheck) the above mentioned option, and reboot the system.
2. The default behavior of the POS keyboard is to wake the system when any key is pressed
after system goes into sleep mode. Therefore, no additional configuration is necessary.

Silent installation
UnifiedPOS can be installed and updated silently (unattended) using a response file. The
response file C:\UposSetup.iss is created during the initial installation of the package on
a POS system. This response file can then be used to perform an unattended install or update on
other systems.
Beginning with the UnifiedPOS 1.14.5 release, the command line parameters used for the install
process were changed.
To complete an install or uninstall process, execute setup.exe and add the relevant parameters
from Table 3.
If you are attempting an install where setup.exe requires command line parameters (such
as /s), the command prompt or batch file that you use must also be executed with administrator
privileges (logging in as someone with Administrator privileges is not enough).
For more information see https://docs.microsoft.com/en-us/windows/security/identity-
protection/user-account-control/how-user-account-control-works.

Table 3. Command line parameters

Action you want to perform Command line parameter to add
To do something silently (unattended) /s
Uninstall /Uninstall
Collect a log of the process /l "c:\msilog.txt"
Do not restart the operating system when the /norestart
process is finished
Use an .ISS file from a different location USEINI="C:\a\b\c\UposSetup.iss"
Remove the .ISS file when the process is REMOVEINI=1
finished

Changes for Version 1.14.5 and newer:

All previous command line parameters, unless explicitly listed above, are no longer supported.
This includes the following:
• /v
• /qn
• /qb

Chapter 2. Installing UnifiedPOS 31

• REBOOT=R

Windows 7
If you are logged in as the default “Administrator” account in Windows 7, then you may not be
able to remove the UnifiedPOS for Windows product through the Control Panel Programs and
Features method. To resolve this problem, do one of the following two solutions:
• Create a second user account with administrator privileges. Use this account to uninstall the
product.
• Double-click setup.exe and click Remove to uninstall the product.

Upgrade
Beginning with the UnifiedPOS 1.13.3 release, the installation process can perform an upgrade
over a previously installed UnifiedPOS product on the system. The installation process
uninstalls the previous version and then installs the new version automatically.
Note: Depending on the system/device configurations, the operating system may prompt for
two reboots to fully load the device drivers for the inputs/outputs. This is true specifically for
system-attached PS2/USB keyboards.

Upgrade for interactive installation

When the UnifiedPOS installation detects a previous version of the product, the installation
process displays an upgrade window:

Figure 3. Upgrade Window

1. Click Yes to continue the installation process as if it is a new installation. See “Interactive
installation” on page 29.

32 UnifiedPOS User's Guide

2. Click No to abort the installation without affecting the previously installed product on the
system. In this case, you can manually uninstall the previous product and reinstall the new
product.

Upgrade for silent installation

To perform a silent upgrade, create a response file for the new product as described in “Silent
installation” on page 31.
The response file must match the product version that is being installed or the installation will be
aborted.

Installation for SUSE Linux Enterprise

This section provides installation instructions for the Toshiba JavaPOS on Linux distributions.
The Toshiba JavaPOS is tested and supported on the SUSE Linux Enterprise Family:
• SLED 11 SP3, SLES 11 SP3, SLEPOS 11 SP3, SLES 11 SP4, SLED 12 SP2, SLES 12 SP2
Note: The instructions provided in this document are based on the SUSE Linux file structure.
The Toshiba JavaPOS installation can be easily adapted to other Linux distributions.
For support related to other Linux distributions, please contact your Toshiba representative or
visit the Toshiba Global Commerce Solutions support website at to submit a Techline question.

Resources for SUSE Linux Enterprise 11 SP3/SP4

The following table provides the resources for setting up the SUSE Linux Enterprise family.

Note: You must install the Toshiba POS kernel mode drivers. They are required for Toshiba
JavaPOS support.

Table 4. Resources for SUSE Linux Enterprise 11 SP3/SP4 (SLE11 SP3/SP4)

Name Description or Resource Link
Kernel version • 3.0.70-0.9-default (SLEPOS11-SP3 via Kiwi image creator)
of SLED/SLES11 • 3.0.70-0.9-pae (SLED/SLES11-SP3)
SP3/SP4 and
SLEPOS11 SP3 tested • 3.0.101-63-pae (SLES 11 SP4)
and supported by
Toshiba JavaPOS
Toshiba POS Kernel https://drivers.suse.com/Toshiba/tgcs/pos/sle11sp3-i586/2.0/
Mode Drivers
required for JavaPOS You only need to install the following RPM that contains Toshiba POS
kernel mode drivers required by JavaPOS. The OS kernel will determine
support
exactly which RPM to install.
For Kernel Version: 3.0.<version>-default
• toshiba-poss-suse11-kmp-
default-11.0_<version>.i586.rpm
• toshiba-sleep-prot-suse11-kmp-default-
<version>.i586.rpm

Chapter 2. Installing UnifiedPOS 33

Name Description or Resource Link

For Kernel Version: 3.0.<version>-pae

• toshiba-poss-suse11-kmp-pae-11.0_<version>.i586.rpm
• toshiba-sleep-prot-suse11-kmp-pae-
<version>.i586.rpm

SLEPOS 11 SP3 http://www-01.ibm.com/support/docview.wss?

Quick Installation rs=220&uid=pos1R1004407
Guide
Creating Image http://www-01.ibm.com/support/docview.wss?rs=0&uid=pos1R1004460
with JavaPOS (Pre-
requisite: SLEPOS11-
SP3/SP4 Quick
Installation Guide)
Toshiba POS Linux https://tgcs04.toshibacommerce.com/cs/idcplg?
Configuration Guide IdcService=FLD_BROWSE&path=%2fpublications%2fSW%2fOS%2fLin
ux%2fSLE11SP3&doMarkSubscribed=1
• Describes Toshiba POS Systems supported on SLE 11 SP3/SP4
• Provides installation and configuration information

SLEPOS 11 SP3/SP4 http://www-01.ibm.com/support/docview.wss?

Tools and Utilities rs=220&uid=pos1R1004421
Toshiba Systems Refer to the document included in this package:
Management for
POS peripherals Toshiba UnifiedPOS Management Services.pdf

Toshiba UnifiedPOS www.toshibacommerce.com

Programming
1. Click Support and select Publications.
Reference,
Keyboards, and 2. Click the Hardware tab.
Code pages 3. Click the POS Drivers & Common Packages.
4. Click Restricted Content.
5. Click UPOS User's Guide.

Resources for SUSE Linux Enterprise 12 SP2

The following table provides the resources for setting up the SUSE Linux Enterprise family.

Note: You must install the Toshiba POS kernel mode drivers. They are required for Toshiba
JavaPOS support.

Table 5. Resources for SUSE Linux Enterprise 12 SP2 (SLE12 SP2)

Name Description or Resource Link
Kernel version kernel-default-4.4.74-92.38-default
of SLED/SLES12
SP1/SP2 tested
and supported by
Toshiba JavaPOS

34 UnifiedPOS User's Guide

Name Description or Resource Link
Toshiba POS Kernel https://drivers.suse.com/Toshiba/tgcs/pos/sle12sp2/x86_64/2.0/
Mode Drivers
required for JavaPOS You only need to install the following RPM that contains Toshiba POS
kernel mode drivers required by JavaPOS. The OS kernel will determine
support
exactly which RPM to install.
For Kernel Version: 4.4.<version>-default, install the following RPM:
toshiba-poss-suse12-kmp-default-11.3.0_k4.4.21_69-17.1.x86_64.rpm

POS Refer to the Toshiba POS Linux Configuration Guide:

Systems supported/
Configuration https://tgcs04.toshibacommerce.com/cs/idcplg?
IdcService=GET_FILE&fldFile=fFileGUID:A125C751BF52C0FF4D08A12
7C1AAD21F&fldBrowsingMode=contribution

Installation package contents

The main installation package can be downloaded from the Toshiba Global Commerce Solutions
website: https://commerce.toshiba.com
The following is a list of RPMs that are necessary to install the Toshiba JavaPOS product.
Depending on the JVM architecture used, <arch> = i386

JavaPOS
• toshiba-javapos-<version>-<build>.<arch>.rpm
• toshiba-javapos_libs-32bits-<version>-<build>.<arch>.rpm
• toshibaposs-gcc43<version>-<build>.<arch>.rpm

JVM
JVM is not provided.

JavaxUsb
• javax-usb-1.0.2-1.i386.rpm
• javax-usb-ri-1.0.2-1.i386.rpm
• javax-usb-ri-linux-1.0.5-2.i386.rpm

RXTX
RxTx rpms are required for JavaPOS drivers to support RS232 devices. Refer to the /opt/
tgcs/javapos/rxtx/README.txt file accompanying rpm for more details.
rxtx-2.2-pre2.x86_64.rpm
rxtx-2.2-pre2.i586.rpm

Systems Management for POS Peripherals

• toshiba_upos_sblim-cmpi-upos-server-sled-<version>.i586.rpm
• posIBM_XML4C-<version>.i586.rpm
• Toshiba UnifiedPOS Management Services.pdf

Chapter 2. Installing UnifiedPOS 35

Toshiba POS kernel mode driver source for other Linux distributions
• pos_kernel_drivers_other_linux / toshibaposs-kernel-
<version>.rpm

Package dependencies
During the operating system installation, you must select the following RPMs which will install
necessary libraries required for the JavaPOS product:

SLE 11 SP3/SP4
JVM libraries: additional libraries may be needed. An example is shown below.
From Development C/C++ compiler and tools, select and install libstdc++.so.5 library
from libstdc++33 RPM.

Toshiba JavaPOS Supported Environment on SLE 11 SP3/SP4

Table 6. Toshiba JavaPOS Supported Environment on SLE 11 SP3/SP4

Component Version
Kernel Version 3.0.70-0.9-default
3.0.70-0.9-pae
Available on SLED11- SP3/SLEPOS11- SP3
3.0.101-63-pae
Available on SLES- SP4

System Management of Small Footprint CIM Broker (SFCB)

Toshiba POS Peripherals sblim-sfcb-1.3.11-0.19.1.i586.rpm (SLE11 SP3)
sblim-sfcb-1.3.11-0.23.2.i586.rpm (SLES11 SP4)

POS Systems supported / Refer to the Toshiba POS Linux Operating Systems
Configuration Configuration Guide located on the Toshiba support site (https://
commerce.toshiba.com/support.

JavaPOS installation

The instructions in this section assume the following:

• The user has root privileges
• % represents a console command prompt
The JavaPOS driver installation includes several components which must be installed separately.
You must be root to install the files and perform many of the steps contained in the following
sections.

36 UnifiedPOS User's Guide

JavaPOS components
The JavaPOS RPMs are required to support Toshiba JavaPOS and RS-485 devices.

To install:
% rpm -ivh toshibaposs-gcc43<version>-<build>.<arch>.rpm
% rpm -ivh toshiba-javapos-<version>-<build level>.<arch>.rpm
To uninstall:
% rpm -e toshibaposs-gcc43
% rpm -e toshiba-javapos
For 32-bit Java Virtual Machines running on 64-bit Operating systems only:
To install
% rpm -ivh toshiba-javapos_libs-32bits-<version>-<build>.i386.rpm
To uninstall
% rpm -e toshiba-javapos_libs-32bits-<version>-<build>.i386.rpm

javax.usb components
The javax.usb RPMs are required to support Toshiba USB peripheral devices.

To install:
% rpm -ivh javax-usb-<version>.i386.rpm
% rpm -ivh javax-usb-ri-<version>.i386.rpm
% rpm -ivh javax-usb-ri-linux<version>.i386.rpm
To uninstall:
% rpm -e javax-usb
% rpm -e javax-usb-ri
% rpm -e javax-usb-ri-linux

Installing Toshiba point of sale kernel mode drivers

The Toshiba JavaPOS requires several kernel mode drivers which must be installed on target
systems.

For SLE 11 SP3/SP4, SUSE distributes Toshiba point of sale (POS) kernel mode drivers in the
form of binaries as well as source RPMs. See “Installing Toshiba POS kernel mode drivers for
SLE 11 SP3/SP4 Linux” on page 38 for more information.

Chapter 2. Installing UnifiedPOS 37

For non-SLE distributions, the Toshiba POS kernel mode drivers must be compiled and installed
on the target OS. The driver source RPM is included in this package. See “Installing Toshiba POS
kernel mode drivers for other Linux distributions” on page 38 for more information.

Installing Toshiba POS kernel mode drivers for SLE 11 SP3/SP4

Linux
For SLE 11 SP3/SP4, the Toshiba POS kernel mode drivers can be obtained and installed directly
from SUSE’s website:
1. Navigate to: https://drivers.suse.com/Toshiba/tgcs/pos/sle11sp3-i586/2.0.
2. Run uname -a to determine the kernel of your system (default or pae).
• If the kernel version is “3.0.<version>-default” then download:
toshiba-poss-suse11-kmp-default-10.0.0_3.0.70_0.9-35.i586.rpm or higher version
toshiba-sleep-prot-suse11-kmp-default-1.0_3.0.13_0.27-0.i586.rpm or higher version
• If the kernel version is “3.0<version>-pae” then download:
toshiba--poss-suse11-kmp-pae-10.0.0_3.0.70_0.9-35.i586.rpm or higher version
toshiba-sleep-prot-suse11-kmp-pae-1.0_3.0.13_0.27-0.i586.rpm or higher version
3. Install the RPM (this example uses default):
rpm - ivh toshiba-poss-suse11-kmp-default-8.0.0_3.0.13_0.9-12.1.i586.rpm
4. Toshiba POS kernel mode drivers location:
/lib/modules/3.0.version>/updates/Toshiba/pos/aipbcd.ko
/lib/modules/3.0.version>/updates/Toshiba/pos/aipdcs.ko
/lib/modules/3.0.version>/updates/Toshiba/pos/aipikbps.ko
/lib/modules/3.0.version>/updates/Toshiba/pos/aipmtn.ko
/lib/modules/3.0.version>/updates/Toshiba/pos/aipsocdkl.ko
/lib/modules/3.0.version>/updates/Toshiba/pos/aipsokbps.ko
/lib/modules/3.0.version>/updates/sleep-prot.ko

Installing Toshiba POS kernel mode drivers for other Linux

distributions
For other Linux distributions, the Toshiba POS kernel mode drivers must be compiled on the
specific kernel version.

The source code for the Toshiba POS kernel mode driver is included in:
toshibaposs-kernel-<version>-<build>.<arch>.rpm
This RPM is located under the pos_kernel_drivers_other-linux directory within the
JavaPOS driver package.
Install kernel source (prerequisite)
To compile Toshiba drivers successfully, the kernel source code must be installed first. The
kernel source is available on the installation CD or from the location where you obtained the
kernel. If the kernel source does not exist, the Toshiba drivers will not compile successfully.

38 UnifiedPOS User's Guide

Extract Toshiba POS driver source
% rpm -i toshibaposs-kernel-<version><build>.<arch>.rpm
This extracts the driver source files into two separate directories:
• /usr/src/<kernel-version>//kernel-modules/toshiba/dcs/
• /usr/src/<kernel-version>//kernel-modules/toshiba/kbd/
Build and install Toshiba POS drivers
Note: Before proceeding with building Toshiba drivers, ensure that you have installed Linux
kernel sources.
1. Build and install drivers in the dcs directory:
• % cd /usr/src/<kernel-version>//kernel-modules/toshiba/dcs
• % make (to compile drivers)
• % make install (to install drivers)
• % depmod –ae (this must be done to satisfy module dependency in modules.def file)
2. Build and install drivers in the kbd directory:
• % cd /usr/src/<kernel-version>//kernel-modules/toshiba/kbd
• % make (to compile drivers)
• % make install (to install drivers)
• % depmod –ae (this must be done to satisfy module dependency in modules.def file)
Toshiba driver installation location
The drivers are installed in the following locations:
/lib/modules/<kernel-version>/kernel/drivers/char/dcs
/lib/modules/<kernel-version>/kernel/drivers/input/keyboard

Table 7. Driver details

Driver Name Description
aipdcs.ko Core driver for RS-485 devices, NVRAM, PCI Cash Drawer
aipbcd.ko Cash Drawer driver for SP300
aipmtn.ko Motion sensor driver for AnyPlace Kiosk
aipikbps.ko PS/2 keyboard driver for Toshiba POS Keyboard
aipsocdkl.ko SurePOS 100/SureOne: Cash Drawer and Keylock driver
aipsops.ko SurePOS100/SureOne: keyboard driver

Systems Management installation

Systems Management support for Toshiba POS peripherals

The Toshiba JavaPOS supports Systems Management capability for Toshiba POS peripherals.
Refer to the following documents and information included in the package:
• Toshiba UnifiedPOS Management Services.pdf
• Minimum version of SFCB RPM is 1.3.13-3.1.2

Chapter 2. Installing UnifiedPOS 39

• RMA information can be found with the Retail Mananagement documentation on the
Toshiba support site (https://commerce.toshiba.com/support).

Installing on SLE 11 SP3/SP4

The Toshiba UnifiedPOS support for Systems Management is supported through the Small
Footprint CIM Broker (SFCB). This RPM is available on the SUSE installation DVD or from
the SUSE repository: http://ftp5.gwdg.de/pub/opensuse/discontinued/distribution/12.1/repo/oss/
suse/i586/sblim-sfcb-1.3.13-3.1.2.i586.rpm.
Note: You must be a root user to install and configure the Systems Management components.
1. Install posIBM_XML4C-5.7.1-1.i586.rpm.
rpm -ivh posIBM_XML4C-5.7.1-2.i586.rpm
2. Install SFCB RPM from the SUSE installation DVD or SUSE repository.
a. rpm -ivh sblim-sfcb- 1.3.13-3.1.2.i586.rpm
b. Edit /etc/sfcb/sfcb.cfg to allow http communication and authentication.
For example, edit the following two properties (refer to http://sblim.sourceforge.net/
wiki/index.php/Sfcb for more details):
enableHttp: true
doBasicAuth: false
c. Start SFCB with /etc/init.d/sfcb start
Note: Known issue: These instructions do not work with SFCB 1.3.11-0.19.1 version and
before due to an issue with the SFCB server. This problem was fixed in newer versions.
3. Install toshiba_upos_sblim-cmpi-upos-server-sled-<version>.<arch>.rpm:
rpm -ivh toshiba_upos_sblim-cmpi-upos-server-sled-
<version>.<arch>.rpm
4. Install the wbemcli utility from the SLE 11 SP3/SP4 DVD.
rpm -ivh sblim-wbemcli-1.6.1-1.1.84.i586.rpm
Note: This utility is also available for download from: http://sblim.sourceforge.net/wiki/
index.php/Wbemcli

Validating Systems Management

To view the Systems Management properties for a device, the device must be opened and
claimed.

To open, claim, or enable a device in JavaPOS, start the POS Control Center utility:
1. Open a terminal window.
2. Issue: POSControlCenter.
3. To configure devices, click AutoDetect and save jpos.xml to the default location.
4. Select an online device and click the Systems Management tab.
5. Click Start Statistics Test. This displays the Systems Management properties of the device
and will keep the device in an open/claim/enable state.

40 UnifiedPOS User's Guide

6. Get Systems Management properties for a given device by issuing the wbemcli command.
For example, for a POSPrinter device:
wbemcli ei http://localhost:5988/root/cimv2:UPOS_POSPrinter

Uninstallation of UPOS Systems Management

1. Remove toshiba_upos_sblim-cmpi-upos-server-sled-<version>.i586.rpm
rpm -e toshiba_upos_sblim-cmpi-upos-server-sled-<version>-<build>
2. Remove SFCB RPM.
rpm -e sblim-sfcb
3. Remove posIBM_XML4C RPM.
rpm -e posIBM_XML4C

Chapter 2. Installing UnifiedPOS 41

42 UnifiedPOS User's Guide
Chapter 3. Configuring devices
Configuring devices

This chapter contains information on the configuration process for JavaPOS devices, OPOS
devices, and USB access.

JavaPOS configuration
JavaPOS devices are configured using the jpos.xml file. This section details how to create a
jpos.xml file and provides information necessary to configure certain devices.

Locating sample jpos.xml files

During installation, a sample XML file is installed on your system. The sample file is named
jposSample.xml.
This file can be found in the following folders:
• Linux: /opt/tgcs/javapos/config
• Windows: C:\pos\javapos\docs
The sample XML files contain JPOS entries for all JavaPOS-supported devices.

Creating the jpos.xml file

The jpos.xml file can be created using one of the following two methods.

Using a text editor

To create a jpos.xml file using a text editor, follow these steps:
1. Create an empty jpos.xml file.
2. Copy the header information from the sample XML file into the new jpos.xml file.
3. Copy only those JposEntries that correspond to devices on the target system from the
sample XML file into the jpos.xml file.
4. Change the Logical Name in each JposEntry so that it matches the Logical Name for that
device in the JavaPOS application.
5. Save the jpos.xml to the pos\javapos\config directory in Windows, or to the /opt/
tgcs/javapos/etc directory in Linux. Update the CLASSPATH if the jpos.xml file is
saved to another location.
6. In the new jpos.xml file, keep only those JposEntries that correspond to devices on the
target system.

Using the JavaPOS Configuration Editor

Create a jpos.xml file using the JavaPOS Configuration Editor by following these steps:
1. Copy the sample XML file to the jpos.xml file.

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 43

2. Change the directory to the location of the jpos.xml file.
3. Open the JavaPOS Configuration Editor by typing:

java jpos.config.simple.editor.JposEntryEditor

Note: The JavaPOS Configuration Editor can also be accessed from Programs > Toshiba
JavaPOS > JavaPOS Configuration Editor.
4. Change the Logical Name in each JposEntry to match the Logical Name for that device in
the JavaPOS application.
5. In the new jpos.xml file, keep only those JposEntries that correspond to devices on the
target system.

Changing the logical name of JposEntry

Follow these steps to change the logical name of JposEntry:
1. Select a device entry.
2. Click Edit and select Copy.
3. Enter a new Logical Name in the JposEntry dialog box. Click OK.
4. Click Yes to delete the old entry.
5. For each device that is not on the target machine, perform the following steps:
a. Click the JposEntry for that device.
b. Click Edit and select Delete.
6. Click File and select Save JposEntryRegistry As... to save the changes to jpos.xml.

Device configuration
Devices are configured based on the entries in the jpos.xml file. Because JposEntries consume
resources, it is recommended that jpos.xml contain only those JposEntries that correspond to
devices on the target system. For example, if you are working with only EIA-232 devices, the
jpos.xml should not include entries for RS-485 or USB devices.
The logical name used for a given device during open must match the LogicalName specified in
the JposEntry in the jpos.xml file for that device.
The entries in the jpos.xml file are organized by device type.

Network device communication

The network devices for JavaPOS need to be configured in two places using this order:
1. In the network configuration file.
2. In the jpos.xml file.
The DeviceAddress or DeviceName used for a given device must match the
com.ibm.posj.bus.network.hostName property specified in the JposEntry in the
jpos.xml file for that device.
Device Support: 4610 2xR/1NR and 6145 2TN/1TN Ethernet/Wireless models only.
The JavaPOS network devices can be configured using the following information:

44 UnifiedPOS User's Guide

1. To add a network POSPrinter to the drivers configuration, copy the
ethernetPrinterSample.efg file to the configuration folder:
• Linux:
• From: /opt/tgcs/javapos/config
• To: /usr/share/pos/config/
• Windows:
• From: C:\POS\doc
• To: C:\POS\Config
2. Edit the file to add the DeviceAddress or DeviceName property of your network device.
For example:
• To configure one printer with device address:

[4610Printer]
DeviceAddress: 169.254.100.10

• To configure one printer with device name:

[4610Printer]
DeviceName: devicename.domain.com

• To configure two printers with device address and device name:

[4610Printer]
DeviceAddress: 169.254.100.10
[4610Printer]
DeviceName: devicename.domain.com

• To configure two printers with 2 different device addresses:

[4610Printer]
169.254.100.10
[4610Printer]
169.254.100.15

3. Optional: Rename the ethernetPrinterSample.efg file to your preferred name, such

as posprinter.efg. The file should contain the .efg extension.
4. Configure your jpos.xml file. See “Creating the jpos.xml file” on page 43.
5. To broadcast this configuration to other systems, transfer the posprinter.efg and
jpos.xml files to clients.

EIA-232 device communication

Entries for the EIA-232 devices in the jpos.xml file include the EIA-232 communication
configuration properties. Acceptable values for each EIA-232 communication property are
documented in Table 8.

Table 8. EIA-232 device communication properties

JCL property name Type Possible values (typical values) Default Value
portName String Valid port name such as: "COM1" "" (empty string)
baudRate String "2400", "4800", "7200", "9600", "14400", "9600"
"19200", "38400", "57600", "115200"

Chapter 3. Configuring devices 45

JCL property name Type Possible values (typical values) Default Value
dataBits String "4", "5", "6", "7", "8" "8"
parity String "Even", "Odd", "None", "Mark", "Space" "None"
stopBits String "1", "1.5", "2" "1"
flowControl String "Xon/Xoff", "Hardware", "None" "None"

Note:
1. The value for the portName depends on the POS system to which the device is attached.
All the ports start with the letters "COM"; a number is appended to identify the port, for
example: "COM2".
2. In Linux, the designations COM1 and COM2 are still used instead of the standard Linux
terminology.

Device-specific EIA-232 configuration

Possible values for the device communication properties for specific EIA-232 devices are shown
in Table 9. The dataBits, parity and stopBits properties are omitted from the table and from
jpos.xml entries.
Note:
1. Values different than those described here will cause the device to fail.
2. In the following table, Not required means that the user does not have to type these
values into the XML.
3. For embedded devices in the 4610 Printer such as magnetic ink character recognition
(MICR) and CheckScanner, the jpos.xml must include the JposEntry for the 4610 Printer
and the embedded devices.

Table 9. Specific values for EIA-232 devices in JavaPOS

Device portName baudRate flowControl
CashDrawer 4610-A Port where the printer is "9600" Only "Xon/Xoff" or
attached "Hardware"
CashDrawer 4610-B "19200"
"COM1" (default) (Must match printer
"115200"
configuration)
(Must match printer
configuration)

CashDrawer SurePOS "COM4" (default) Not required Not required

500/600-A
CashDrawer SurePOS
500/600-B

CheckScanner 4610-TI8/TI9 Port where the printer is "9600" Only "Xon/Xoff" or

attached "Hardware"
"19200"
Default: "COM1"
(Must match printer
configuration)

46 UnifiedPOS User's Guide

Device portName baudRate flowControl

Fiscal Printer 4610-Kx3 Port where the printer is "9600" Only "None"
Fiscal Printer 4610-Kx4 attached "19200"
Fiscal Printer 4610-Kx5/Kx6 "28800" (Windows only)
Fiscal Printer 4610-Gx3 Default: "COM1"
Fiscal Printer 4610-Gx4
Fiscal Printer 4610-Gx5

Fiscal Printer 4610-Sx6 Port where the printer is "115200" Only "None"
attached
Default: "COM1"

Line Display APA Default: "COM4" "9600" "Hardware"

Line Display SureOne/ Default: "COM4" Not required Not required
SurePOS 100/300/500/600 VFD
Line Display SureOne/
SurePOS 100/300/500/600 LED

MICR 4610 TI2/4/8/9 2CR Port where the printer is "9600" Only "Xon/Xoff" or
attached "Hardware"
"19200"
Default: "COM1"
(Must match printer
configuration)

MSR 4820/AnyPlace Kiosk/ Default: "COM3" "19200" Not required

SurePOS 500/600 ISO
MSR 4820/AnyPlace Kiosk/
SurePOS 500/600 JUCC

POSPrinter 4610 Port where the printer is "9600" Only "Xon/Xoff" or

TI1/2/3/4/5/8/9 TM/F 6/7 attached "Hardware"
"19200"
2xR/1NR
Default: "COM1"
(Must match printer
configuration)

POSPrinter SureOne Only "COM3" "9600" Only "Xon/Xoff"

Toshiba Anyplace Kiosk Line Default: "COM4" "19200" Not required
Scanner
Toshiba Anyplace Kiosk Omni Default: "COM4" "9600" Not required
Scanner
Tone Indicator 4610 TM/TF6/7 Port where the printer is "9600" Only "Xon/Xoff" or
1NR attached "Hardware"
"19200"
Default: "COM1"
(Must match printer
configuration)

Chapter 3. Configuring devices 47

POS Control Center utility
The POS Control Center displays information for devices found on the system and from
device entries from the jpos.xml file. For multiple, identical devices such as cash drawers
and displays, the deviceNumber property becomes important. For a given device, the device
number displayed in the Device Information section of the POS Control Center must match the
deviceNumber in the JposEntry.
To access the Toshiba POS Control Center:
• In Windows, click Programs > Toshiba JavaPOS > POS Control Center.
• In Linux, enter POSControlCenter.
• From a command prompt in either operating system, enter:
java com.ibm.jpos.tools.sdicc.ControlCenterApp

Toshiba SurePoint Display (4820) touch support

Touch support is not provided for the following:
1. Toshiba SurePoint Display (4820) RS-485 device in Windows Vista.

USB device access

Linux
The Toshiba JavaPOS drivers use the javax.usb subsystem to access the USB POS devices
connected to the system. The javax.usb subsystem on Linux uses the USB filesystem,
usbfs, to access the USB devices directly. The permissions on this filesystem default to
access by the root user only. This security model prevents unauthorized users from accessing
USB devices connected to the system. However, if the JavaPOS application (for example, JVM) is
running as a non-root user, the usbfs permissions must be changed to allow non-root access.
To allow non-root access:
• The mount parameters for usbfs must be changed. Complete one of these two methods:
• Edit the /etc/fstab file to modify the mount parameters for usbfs (fourth field).
• Manually remount usbfs, specifying the required parameters on the mount command.
The most secure way to accomplish non-root access to the USB device nodes is to change the
ownership of the USB device nodes to the userid which is running the JavaPOS application. To
do this:
• Mount usbfs with the parameter, devuid=n, where n is the numeric ID of the JavaPOS
application's user.
• For example, if the JavaPOS application is running as user javaposapp, and
javaposapp has a User ID (uid) of 1000, then specify devuid=1000 when mounting
usbfs. The user running the JavaPOS application must be considered a privileged user
because this user can directly access all USB devices.
• Users who do not need to run the JavaPOS application or the JavaPOS drivers should use
a different login.

48 UnifiedPOS User's Guide

A less secure way to accomplish non-root access to the USBdevice nodes is to create a special
group for the users who run JavaPOS applications. Two parameters must be used in mounting
usbfs: devgid=n, where n is the numeric group id for the JavaPOS application group, and
devmode=0664, which changes the permissions of the USB device nodes to read/write by owner
and group. The group given permission to access the USB devices should be considered a
privileged group and handled the same as a privileged user. Only those users that need to run
JavaPOS applications and drivers should be made part of that group.
See the Linux manual pages for useradd, usermod, groupadd, and groupmod for
information about creating and modifying users and groups.

Network configuration tool

The discovery feature of the network device configuration dialog in JPOS Control Center
requires the network to be configured in the following way to work correctly:
• The network configuration (switch/router, etc.) should allow UDP broadcast.
• Each terminal should have any potential firewall software configured to listen for UDP
broadcasts, and to allow access to UDP port 9100.
• The printer, and each terminal that is used for network discovery, needs the same class of IP
address and the same network subnet mask.

OPOS configuration
Toshiba OPOS drivers must be configured to access the point-of-sale devices attached to the
system. OPOS provides defaults for all resources associated with supported devices. This section
contains information on how the application can configure a device to use a value different from
the assigned default and how to specify some resource values.
To locate the Configuration Utility:
• Select Programs > Toshiba UnifiedPOS for Windows > OLE for Retail Point of Sale >
Configuration Utility.

Network device communication

To configure network devices for OPOS, the network configuration file must be properly
configured and set up at the correct location.
Device Support: 4610 2xR/1NR and 6145 2Tx/1TN Ethernet/Wireless models only.
The OPOS network devices are configured in the following way:
1. To add a network POSPrinter to the driver configuration, copy the
ethernetPrinterSample.efg file to the configuration folder.
From: C:\POS\doc
To: C:\POS\Config
2. Edit the file and add the DeviceAddress or DeviceName property of your network device.
For example:

To configure one printer with device address:

[4610Printer]
DeviceAddress: 169.254.100.10
PossPortNumber: 1

Chapter 3. Configuring devices 49

To configure two printers with 2 device addresses:
[4610Printer]
DeviceAddress: 169.254.100.10
PossPortNumber: 1
[4610Printer]
DeviceAddress: 169.254.100.15
PossPortNumber: 2

To configure one printer with device name:

[4610Printer]
DeviceName: devicename.domain.com
PossPortNumber: 1

To configure two printers with device address and device name:

[4610Printer]
DeviceAddress: 169.254.100.10
PossPortNumber: 1
[4610Printer]
DeviceName: devicename.domain.com
PossPortNumber: 2
Optional: Rename the ethernetPrinterSample.efg to your preferred name, such as
"posprinter.efg". The file should contain the .efg extension.
Note: After the file is renamed, you must restart the service or reboot the computer in order for
the .efg to take effect.

Using the OPOS Configuration utility

The OPOS configuration window has a separate tab for each of the four POS Terminal types
supported by the Toshiba OPOS package (see Figure 4).

50 UnifiedPOS User's Guide

Figure 4. OPOS Configuration utility window

Each tab contains a list of devices that are supported on the POS Terminal. Each device entry
contains descriptive information and the current status of the device. The status shows what
level of configuration is completed using a status description. Table 10 explains the meaning of
each status type.

Table 10. Device status types

Status Color Description
Available Black The device is supported on the selected POS Terminal. It can only be
used to add a new configuration. Its settings will not be modified. No
device name is given.
Online Red The device is supported on the selected POS Terminal, and is detected
to be online and available on the current system. It can only be used to
add a new configuration. Its settings will not be modified. No device
name is given.
Configure Blue The device is supported on the selected POS Terminal and has a
d configuration entry in the registry. It can be modified, tested for
connectivity, or removed.
Ready Green The device is supported on the selected POS Terminal and is ready to
use. It is online and has a configuration entry in the registry. It can be
modified, tested for connectivity, or removed.

RS-485, PS/2, and USB devices are automatically detected and listed as Online. The system tone
and HardTotals are always listed as Online. Other devices can be listed as Online after testing.

Chapter 3. Configuring devices 51

Navigation
To find specific device entries, a column can be sorted by clicking its heading. The column is
sorted in ascending order first; click again to sort in descending order. The current sort order is
indicated by the up or down arrow in the column heading.
Note: The order is based on ASCII values and only one column can be sorted at a time. For
example, a baud rate of 19200 is listed before 9600 when the column is sorted in ascending order.

Configuring devices
To configure a device, perform the following steps:
1. Select an entry in the device list.
2. Click the Configure button to display the configuration dialog for the selected device. The
dialog differs depending on the POS Terminal type and the device type. Figure 5 shows the
configuration dialog for an RS-485 or USB device; Figure 6 shows the configuration dialog
for an EIA-232 device.
3. Enter a name for the device.
4. For USB, RS-485, and System devices, select the correct slot and port for the device (see
Figure 5). The slot can have the following values:

Slot Description
0 System devices (keyboard, NVRAM)
1 Most RS-485 devices
2 Some RS-485 devices (4674 devices)
4 Network devices
8 USB devices

The port can have the following values:

Port (hex) Description

0 System devices (keyboard)
11 Most RS-485 devices
22 RS-485 devices (46x3 Model 2)

Note: The device number cannot be modified. That number is specific to the type of device,
and changing it could change the device type.

52 UnifiedPOS User's Guide

Figure 5. Device properties dialog (RS-485/USB)

For EIA-232, select the correct Com Port, Baud Rate, and Flow Control for the device (See
Figure 6).

Figure 6. Device properties dialog (EIA-232)

5. Click OK. The entry is added to the device configuration list.
Note:
1. Devices that are not attached can still be configured.

Chapter 3. Configuring devices 53

2. For RS-485 and USB devices, Slot and Port should not have to be changed.
3. RS-232 devices will not show as Online in the OPOS configuration tool until they are
configured.
4. For more information about Slot, Port, and Device numbers, see the Point of Sale Subsystem:
Programming Reference and User's Guide.

Testing connectivity
Selecting a Configured or Ready device enables the Test, Remove, and Configure buttons.
Clicking on the Test button tests the connectivity and configuration of the device. While the
device does not need to be attached to configure or remove a configuration entry, it must be
attached for a successful test. The Test button uses OPOS to open, claim when necessary, and
enable the device. It then performs a CheckHealth method. The CheckHealth level is set from the
menu.
If all of these steps are completed successfully, then the test is considered successful. If the
device configuration entry is not yet marked as Ready, it is updated as such.
The list box at the bottom of the window is updated with the test results (see Figure 7).

Figure 7. Results of connectivity test

By selecting a configured device, additional tests can be performed. Additional device

information can also be obtained by clicking the Device Demo/Info button. For example, a
sample receipt can be printed by using the following steps:
1. Click the Device Demo/Info button while selecting a configured POS Printer.

54 UnifiedPOS User's Guide

Figure 8. Device Demo/Info Button
2. Click the Device Demo Tab.

Chapter 3. Configuring devices 55

Figure 9. Demo Tab
3. Click the Print Test Receipt button. This prints a sample receipt.

56 UnifiedPOS User's Guide

Figure 10. Print Test Receipt Button

Removing devices
It is possible to delete entries during configuration. The results are displayed in the list box at the
bottom.

Deploying OPOS device configurations

The OPOS Configuration utility is used to import and export configuration information to and
from an OPOS Device Registry (ODR) file. These options are available on the File menu.
To export configuration information, perform the following steps:
1. On each tab, select the devices that are to be exported. Use the Shift and Ctrl keys to select
more than one. (See Figure 11.)

Chapter 3. Configuring devices 57

Figure 11. Selecting devices to export
2. Select File > Export. The configuration information is exported.
Only configured entries with device names are exported. This enables the creation of files for
different configurations, or for deploying new configurations to stores.
To import configuration information, perform the following steps:
1. Select File > Import. A file dialog window is displayed.
2. Select an ODR file and click Open. The configuration information is imported and the
device listing and registry information are updated.

Toshiba SurePoint Display (4820) touch support

Touch support is not provided for the Toshiba SurePoint Display (4820) RS-485 device on
Windows Vista.

58 UnifiedPOS User's Guide

Chapter 4. Problem determination
Problem determination

This chapter contains information on the logging files that record device events. These events
allow you to determine and resolve problems.

JavaPOS problems

Tracing for Linux

For Toshiba JavaPOS device drivers, the following two methods are used to gather trace
information:
• Using the aiptrace.cfg::
1. Create the aiptrace.cfg file at /usr/share/pos/config/ folder.
2. Rename the aiptrace.cfg.allEnabled to aiptrace.cfg.
3. For minimum tracing functionality, the following properties should be set:
Enable: On
StartupMode: Enabled
<Tracer name>: On

4. Output log file default location is /var/log/tgcspostrc.log

• Using the TraceConfigTool:
1. Using a command line prompt, type in TraceConfigTool. The Trace Configuration
window appears:

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 59

Figure 12. Trace Configuration
2. Choose the items requested for tracing.
3. When trace configuration is complete, click Enable and then click Save.

Tracing for Javax.usb for Linux

The Linux implementation of javax.usb has JNI tracing only. To change the settings for JNI
tracing, edit the javaxusb.properties file. The available settings are:
• #com.ibm.jusb.os.linux.LinuxUsbServices.JNI.tracing = true
A value of false disables tracing entirely; a value of true enables some amount of tracing.
• #com.ibm.jusb.os.linux.LinuxUsbServices.JNI.trace_output = 2
This defines where the JNI tracing output is sent. The default is stderr file mode. Note that
if append mode is used, the trace file will grow larger every time javax.usb is run; its size
should be managed. In file mode, the file size is not managed or limited by javax.usb.
• 1 - stdout
• 2 - stderr
• 3 - file (truncate mode)
• 4 - file (append mode)
• #com.ibm.jusb.os.linux.LinuxUsbServices.JNI.trace_filename =
This is the filename to trace to, if trace_output is set to file tracing. There is no default. It must
be set if trace_output is set to file tracing.
• #com.ibm.jusb.os.linux.LinuxUsbServices.JNI.trace_level = 0

60 UnifiedPOS User's Guide

This sets the tracing level. Higher levels mean more tracing. This level applies to ALL tracers.
See each tracer for their levels.
• #com.ibm.jusb.os.linux.LinuxUsbServices.JNI.trace_default = true
This enables or disables default tracing. This is the most used tracer. The trace_data must also
be enabled. The levels for this tracer are:
• 0 - CRITICAL
• 1 - ERROR
• 2 - INFO
• 3 - FUNCTION
• 4 - DEBUG
• 5 - OTHER
• #com.ibm.jusb.os.linux.LinuxUsbServices.JNI.trace_hotplug = true
This enables or disables hotplug tracing. The trace_data must also be enabled. These are the
levels for this tracer:
• 0 - CRITICAL
• 1 - ERROR
• 2 - CHANGE
• 3 - DEVICE
• 4 - OTHER
• #com.ibm.jusb.os.linux.LinuxUsbServices.JNI.trace_xfer = true
This enables or disables xfer tracing. The trace_data must also be enabled. These are the levels
for this tracer:
• 0 - CRITICAL
• 1 - ERROR
• 2 - REQUEST
• 3 - METADATA
• 4 - DATA
• 5 - OTHER
• #com.ibm.jusb.os.linux.LinuxUsbServices.JNI.trace_urb = false
This enables or disables URB tracing. The trace_data must also be enabled. These are the
levels for this tracer:
• 2 - METADATA
• 3 - DATA
Note: DATA-level tracing will generate a LOT of output.
The default settings are tracing enabled at level 0. The level should be increased to the desired
level. Also, the output can be changed from stdout to a file or stderr. Finally, the default is not to
trace actual URB data due to the large amount of trace information involved. If URB data should
be traced, the trace_urb must be changed to "true" (and uncommented).

Tracing for Windows

For Toshiba JavaPOS device drivers, the following steps are used to gather trace information.
1. Using a command line prompt, type in AIPTRCCFG. The Trace Configuration application
appears:

Chapter 4. Problem determination 61

Figure 13. Trace Configuration for Windows
2. Choose the items requested for tracing.
3. When trace configuration is complete, click Save and then click Enable.

OPOS problems

Tracing
For Toshiba OPOS device drivers, the following steps are used to gather trace information.
1. Using a command line prompt, type in AIPTRCCFG. The Trace Configuration application
window appears.

62 UnifiedPOS User's Guide

Figure 14. POS tracing facility
2. Choose the items requested for tracing.
Note:
1. When diagnosing printer problems, it is normally recommended to enable tracing
for all logical printer devices (cash drawer, check scanner, MICR, POS Printer, Tone
Indicator).
2. When diagnosing OPOS problems, remember to check the Communications Ports
checkbox (for EIA-232 devices) or Devices checkbox (for USB and RS-485 devices).
3. The Maximum File Size is measured in bytes; 0 implies no maximum.
3. When trace configuration is complete, click Save and then click Enable.

Getting help

Support website
The Toshiba Global Commerce Solutions Web site contains the latest information on
Toshiba point-of-sale hardware, the newest versions of Toshiba point-of-sale software, and a
knowledgebase containing hints, tips, and fixes for known issues/problems with Toshiba point-
of-sale products.
The URL for the Toshiba Global Commerce Solutions support web site is: https://
commerce.toshiba.com/support.
If you have general pre-sale or usage questions about drivers that are not answered in the
publications and you are a Toshiba Business Partner, you can submit questions to the Partnerline
team from our Knowledgebase page.

Chapter 4. Problem determination 63

Reporting problems
To report problems, visit the Toshiba Global Commerce Solutions support website: .

64 UnifiedPOS User's Guide

Part II. Programming reference
Programming reference

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 65

66 UnifiedPOS User's Guide
Chapter 5. Common settings and configuration options
Common settings and configuration options

This chapter contains information on the implementation and support of UnifiedPOS. For
each device type, there is a list of the specific devices that are supported and a list of the
UnifiedPOS properties, methods, and events that are supported. For some devices, there is
additional information specific to the JavaPOS and OPOS implementations, including additional
configuration options as well as DirectIO documentation.
The following properties are used only in OPOS:
• BinaryConversion
• OpenResult
• ResultCode
• ResultCodeExtended
Some properties have different names in OPOS. Table 11 lists the UnifiedPOS and OPOS names
for these properties.

Table 11. Alternate property names used in OPOS

UnifiedPOS name OPOS name
DeviceControlDescription ControlObjectDescription
DeviceControlVersion ControlObjectVersion
DeviceServiceDescription ServiceObjectDescription
DeviceServiceVersion ServiceObjectVersion
PhysicalDeviceDescription DeviceDescription
PhysicalDeviceName DeviceName
claim ClaimDevice
release ReleaseDevice

JavaPOS

Configuration options

baudRate

<prop name="baudRate" type="String" value="9600"/>

Determines the baud rate to use for the EIA-232 device. The value to use depends on the device.
Some hardware devices cannot have their flow control value changed.
Refer to the hardware manual for the device to determine the correct value.

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 67

deviceBus

<prop name="deviceBus" type="String" value="RS232"/>

The deviceBus property determines how the device is physically attached to the POS terminal.
It can be one of the following values:
• Proprietary
• RS232
• RS485
• HID

flowControl

<prop name="flowControl" type="String" value="Xon/Xoff"/>

Determines the flow control used for EIA-232 devices. The value to use depends on the device.
Some hardware devices cannot have their flow control value changed.
It can be one of the following values:
• Xon/Xoff
• None
• Hardware

impClass

<prop name="impClass" type="String"

value="com.ibm.jpos.services.sdi.ToneIndicatorServiceImp"/>

The impClass specifies the name of the Java class that is responsible for implementing
the UnifiedPOS specification for a particular device. It uses the Java class specified in the
abstractionClass entry to communicate with the physical hardware.
The abstractionClass and impClass are a matched pair of configuration entries that together
determine how an application using JavaPOS communicates with a specific device.
Current XML entries should have an impClass entry that contains one of the following values:
com.ibm.jpos.services.sdi.CashDrawerServiceImp
com.ibm.jpos.services.sdi.CashDrawer4610ServiceImp
com.ibm.jpos.services.sdi.CheckScannerServiceImp
com.ibm.jpos.services.sdi.FiscalPrinterServiceImp
com.ibm.jpos.services.sdi.HardTotalsServiceImp
com.ibm.jpos.services.poss.IBMHardTotalsImp
com.ibm.jpos.services.sdi.KeylockServiceImp
com.ibm.jpos.services.sdi.LineDisplayAPAServiceImp
com.ibm.jpos.services.sdi.LineDisplayVFDServiceImp
com.ibm.jpos.services.poss.LineDisplayAnop0Imp
com.ibm.jpos.services.poss.LineDisplayShopperImp
com.ibm.jpos.services.sdi.LineDisplayServiceImp

68 UnifiedPOS User's Guide

com.ibm.jpos.services.sdi.MICRServiceImp
com.ibm.jpos.services.poss.IBMMICRImp
com.ibm.jpos.services.sdi.MotionSensorServiceImp
com.ibm.jpos.services.sdi.MSRServiceImp
com.ibm.jpos.services.sdi.POSKeyboardServiceImp
com.ibm.jpos.services.sdi.IBM4610PrinterServiceImp
com.ibm.jpos.services.sdi.IBMSureonePrinterServiceImp
com.ibm.jpos.services.sdi.IBM4689PrinterServiceImp
com.ibm.jpos.services.poss.POSPrinter4Imp
com.ibm.jpos.services.sdi.ScaleServiceImp
com.ibm.jpos.services.sdi.ScannerServiceImp
com.ibm.jpos.services.sdi.ToneIndicatorServiceImp

Note: You should not need to manually change this value.

portName

<prop name="portName" type="String" value="COM1"/>

Determines the port to use for EIA-232 devices.

Valid port names are determined by how many ports the POS terminal physically has.
Port names are the same format on Windows and Linux (COMx).

ProprietaryBusSubType

<prop name="com.ibm.posj.bus.ProprietaryBusSubType" type="String"

value="Embedded"/>

For system devices (those having a deviceBus value of Proprietary), this determines whether the
device is connected via PS/2 (keylock, tone indicator, MSR, POS Keyboard) or is physically built
into the terminal (hard totals, motion sensor, keylock, cash drawer).
It can be one of the following values:
• Embedded
• PosKbd

sioDeviceNumber

<prop name="com.ibm.posj.bus.rs485.sioDeviceNumber" type="String"

value="0x54"/>

A unique number that indicates the type of device.

Since RS-485 devices are detected automatically by the driver, it should not be necessary to
manually change this value.

Chapter 5. Common settings and configuration options 69

sioPortNumber

<prop name="com.ibm.posj.bus.rs485.sioPortNumber" type="String"

value="0x11"/>

Determines the logical port number for RS-485 peripheral devices.

Valid values are:
• 0x11: RS-485 devices attached to the primary controller
• 0x22: RS-485 devices attached to the secondary controller
Since RS-485 devices are detected automatically by the driver, it should not be not necessary to
manually change this value.

sioSlotNumber

<prop name="com.ibm.posj.bus.rs485.sioSlotNumber" type="String"

value="0x01"/>

Determines the logical slot number for RS-485 peripheral devices.

• 1: RS-485 devices attached via the ISA or PCI bus
• 5: RS-485 devices attached via the micro-channel bus
Since RS-485 devices are detected automatically by the driver, it should not be necessary to
manually change this value.

USB firmware update files for JPOS

All Toshiba USB peripheral devices contain firmware to control the USB bus, in addition to the
firmware that controls the device itself.
Depending on the device, the firmware for the USB can be packaged in a number of different
ways:
1. Separate from the main device firmware (IE, 4610 Tx3/4/5/6/7)
2. Contains the USB bus firmware embedded in the main device firmware (IE 4610 Tx8/9)
3. Contains the main device firmware embedded with the USB bus firmware (IE, USB 2x20
display)
The JavaPOS driver automatically updates the firmware, if necessary, when the terminal first
boots. It will not update the firmware if a device is hot-plugged while the terminal is running.
New firmware files may be downloaded from the and placed into the relevant folder on the
terminal.

Table 12. JavaPOS Firmware Update

Device Bus File Name Copy files to:

Cash Drawer USB aip455*.dat Windows:

C:\pos\javapos\res\flash\usb

70 UnifiedPOS User's Guide

Device Bus File Name Copy files to:

Linux: /opt/tgcs/javapos/
flash/usb

Electronic Keylock USB aip4502.dat Windows:

C:\pos\javapos\res\flash\usb
Linux: /opt/tgcs/javapos/
flash/usb

Modular Keyboards USB aip460x3.dat Windows: C:\pos\usb

Linux: /usr/share/pos/usb

Modular Keyboards PS/2 aip46043.dat Windows: c:\pos\usb

Linux: /usr/share/pos/usb

TCxDisplay 32-key USB aip467c.dat Windows:

Keypad C:\pos\javapos\res\flash\usb
Linux: /opt/tgcs/javapos/
flash/usb

2x20 Line Displays USB aip452*.dat Windows:

C:\pos\javapos\res\flash\usb
Linux: /opt/tgcs/javapos/
flash/usb

Printer RS485 aip*.hex Windows: C:\pos\firmware

Linux: /usr/share/pos/firmware

Printer 4610/6145 RS232 aip*.hex Windows:

C:\pos\javapos\res\flash\rs4
85
Linux: /opt/tgcs/javapos/
flash/rs485

Printer 4610 USB aip*.hex Windows:

C:\pos\javapos\res\flash\rs4
85
Linux: /opt/tgcs/javapos/
flash/rs485

Printer 6145 USB aip*.dat Windows:

C:\pos\javapos\res\flash\usb
Linux: /opt/tgcs/javapos/
flash/usb

TCxDisplay 32-key USB aip467e.dat Windows:

Keypad C:\pos\javapos\res\flash\usb

Chapter 5. Common settings and configuration options 71

Device Bus File Name Copy files to:

Linux: /opt/tgcs/javapos/
flash/usb

2x20 Line Displays USB aip452*.dat Windows:

C:\pos\javapos\res\flash\usb
Linux: /opt/tgcs/javapos/
flash/usb

Printer RS485 aip*. hex Windows: C:\pos\firmware

Linux: /usr/share/pos/firmware

Printer 4610/6145 RS232 aip*.hex Windows:

C:\pos\javapos\res\flash\rs4
85
Linux: /opt/tgcs/javapos/
flash/rs485

Printer 4610 USB aip*.hex Windows:

C:\pos\javapos\res\flash\rs4
85
Linux: /opt/tgcs/javapos/
flash/rs485

Printer 6145 USB aip*.dat Windows:

C:\pos\javapos\res\flash\usb
Linux: /opt/tgcs/javapos/
flash/usb

Hub (Base) IO Card USB aip455a_00.dat Windows:

C:\pos\javapos\res\flash\usb
Linux: /opt/tgcs/javapos/
flash/usb

Hub (Base) Power USB aip455a_02.dat Windows:

Delivery C:\pos\javapos\res\flash\usb
Linux: /opt/tgcs/javapos/
flash/usb

USB and RS232 RS232/USB aip4559.dat Windows:

Head IO Card FW C:\pos\javapos\res\flash\usb
Linux: /opt/tgcs/javapos/
flash/usb

EIA-232 PosPrinter device detection

When a logical device is in use on an EIA-232 attached printer, the jpos.xml file must contain
an entry for that device (for example, MICR) and an entry for the printer itself.

72 UnifiedPOS User's Guide

If the jpos.xml file does not contain an entry for the printer, then you will be unable to use the
logical device.

OPOS

Accessing multiple devices

One physical device, such as a SureMark printer, can contain multiple logical OPOS devices
(for example, a printer, tone indicator, MICR, and cash drawer). If multiple logical devices
are accessed in one physical device at the same time, as many POS applications do, then you
must access all of the logical devices from the same executable program. Different executable
programs cannot be used to control each single logical device.

Configuration options
OPOS configuration settings are stored in the registry per the UnifiedPOS specification.
The settings in Table 13 apply to PS/2, RS-485 and USB devices. Used in combination, they
uniquely identify a peripheral device.
Because the devices are detected automatically by the driver, it should not be necessary to
change any of the values.
The settings in Table 14 apply to EIA-232 devices. Devices attached via EIA-232 cannot be
automatically detected by the driver and will have to be configured manually.
In order to apply the configurations shown below, create the keyword of the specified type into
the following windows registry:
-
HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\DeviceCategory\Log
icalName
Note: For 32 bits Application running on 64 bits Windows, use the following path instead:
-
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\OLEforRetail\ServiceOPOS\Device
Category\LogicalName
"LogicalName" refers to the actual device logical name given by end user at configuration time.

Table 13. Service Object settings for non EIA-232 devices

Keyword Type Description
slotNumber String Logical slot (0-8) to which the device is connected.
Typical values are:
0 - System devices
1 - RS-485 devices attached via the ISA or PCI bus
4 - Network devices
5 - RS-485 devices attached via the micro-channel bus
8 - USB devices

portNumber String Logical port to which the device is connected.

Typical values are:

Chapter 5. Common settings and configuration options 73

Keyword Type Description

0 - System devices
X'11' - RS-485 devices attached to the primary controller
X'22' - RS-485 devices attached to the secondary controller

deviceNumber String Unique number that indicates the type of device. For valid values, refer to
Toshiba Point of Sale Subsystem Programming Reference and User's Guide.

Table 14. Service Object settings for EIA-232 devices

Keyword Type Description
ComPort String Serial port that the device is attached to. Valid values are determined by the
operating system.
BaudRate String Baud rate used for serial port. Valid values are determined by the specific
peripheral device. Typical values are 9600, 19200 and 115200.
ControlFlow String Control flow for serial device. Valid values are DTR/DSR or XON/XOFF.

USB firmware update files for OPOS

All Toshiba USB peripheral devices contain firmware to control the USB bus, in addition to the
firmware that controls the device itself.
Depending on the device, the firmware for the USB can be packaged in a number of different
ways:
1. Separate from the main device firmware (IE, 4610 Tx3/4/5/6/7)
2. Contains the USB bus firmware embedded in the main device firmware (IE 4610 Tx8/9)
3. Contains the main device firmware embedded with the USB bus firmware (IE, USB 2x20
display)
If necessary, the OPOS driver will automatically update the firmware when the terminal first
boots. It will not update the firmware if a device is hot-plugged while the terminal is running.
New firmware files may be downloaded from the Toshiba website and placed into the
\POS\USB folder on the terminal. The status of the USB firmware can be checked by viewing
\POS\LOG\AIPFLASH.LOG

Table 15. OPOS Firmware Update

Device Bus File Name Copy files to:

Cash Drawer USB aip455*.dat C:\pos\usb

Electronic Keylock USB aip4502.dat C:\pos\usb

Modular Keyboards USB aip460x3.dat C:\pos\usb

Modular Keyboards PS/2 aip46043.dat C:\pos\usb

TCxDisplay 32-key USB aip467c.dat C:\pos\usb

Keypad

74 UnifiedPOS User's Guide

Device Bus File Name Copy files to:

2x20 Line Displays USB aip452*.dat C:\pos\usb

Printer RS485 aip*.hex C:\pos\firmware

Printer 4610/6145 RS232 aip*.hex C:\pos\firmware

Printer 4610 USB aip*.hex C:\pos\firmware

Printer 6145 USB aip*.dat C:\pos\usb

Cash Drawer USB aip455*.dat C:\pos\usb

Electronic Keylock USB aip4502*.dat C:\pos\usb

Modular Keyboards USB aip4502*.dat C:\pos\usb

TCx 800 Hub (base) USB aip455a_00.dat C:\pos\usb

Power Delivery

TCx 800 USB and RS232/U aip45592.dat C:\pos\usb

RS232 Head I/O card SB

TCx 800 Hub (base) USB aip455a_00.dat C:\pos\usb

I/O Card

Modifying USB, RS-485, and PS/2 device behavior

For USB, RS-485, and PS/2 devices, additional device configuration can be done through the
resource file: aipsys.res. Use of this file is documented in Point of Sale Subsystem: Programming
Reference and User’s Guide (SC30-3560). For general information about using aipsys.res, see
Chapter 3, Customizing the Toshiba Point Of Sale Subsystem. For device-specific resources that can
be specified in aipsys.res, see Chapter 21, Resource Sets.
Note:
1. Resource names and values are case sensitive.
2. Resource names appear in the documentation as PosNxxxXxxx. However, when specifying
resources names in the aipsys.res file, the PosN prefix must be removed.
3. Defined macros for resource values are documented as PosXXXX_XXXX. However, when
using these macros in the aipsys.res file, the Pos prefix must be removed.
4. Changes to the aipsys.res file will not take effect until the system is rebooted.
5. In Windows, aipsys.res is located in the default install directory C:\POS.
6. On Linux systems, aipsys.res is located in the /etc directory.

Chapter 5. Common settings and configuration options 75

My new topic

Ignoring USB devices

In some cases, it might be necessary to configure OPOS to ignore certain USB devices. This can
be accomplished by creating a String value, specified below:
Location: HKLM\SOFTWARE\Toshiba\Point of Sale Subsystem

Table 16. Ignoring USB devices

Keyword Type Description
DisableNonIbmUSB String This property provides a mechanism for
disabling all non-Toshiba USB devices
from Toshiba OPOS drivers.
True: All OEM USB devices, such
as Symbol scanner/scale devices are
ignored.
False (default): The USB OEM devices
are supported through Toshiba OPOS
drivers.

DisableUSB String This property provides a mechanism

for disabling USB devices from Toshiba
OPOS drivers.
True: Toshiba OPOS drivers will NOT
claim all USB devices supported by
Toshiba OPOS.
False (default): Toshiba OPOS drivers
will claim all USB devices supported by
Toshiba OPOS.
To selectively disable devices from being
claimed by Toshiba OPOS drivers, you
can specify a list of VendorID:ProductID
pairs separated by ‘ ’ (space).
For example: DisableUSB="04b3:4604
04b3:4535 05e0:0200" will disable the
Toshiba NANPOS USB Keyboard, the
Toshiba 4610 Printer, and a Symbol
Scanner.

Network device connectivity

The Ethernet/Wireless connection for network devices may be disrupted or broken due to
network issues or power interruption. While the driver attempts to reconnect to network devices

76 UnifiedPOS User's Guide

when the connection is recovered, successful reconnection is not guaranteed. If the device is
claimed by another system during reconnection, the device will be released automatically at
the current system. Network devices have a keep-alive time of one minute before breaking the
connection with the system.
By default, the OPOS driver does not monitor the connectivity of network devices. To enable the
offline status monitoring of network devices, the following registry needs to be set:

Table 17. Ethernet/Wireless printer offline monitoring timer

Keyword Type Description
EthernetPrinterWatchdogTimeout DWORD This property sets the offline status
monitoring timer (milliseconds) to
verify network printer is still
available.
Values:

0 (Default)
Disables the monitoring of the
printer.

non-zero
Milliseconds to sleep between
checks and the milliseconds to
check for a response from the
printer.
Note: Wait time for notification is
potentially up to twice the indicated
value. If no property is found, the
default value is used. If the property
is present but it has an invalid
value, then the default value is
used. It is recommended to set the
value to something larger than 60,000
milliseconds to minimize the network
traffic.

USB system attached keyboard

The Toshiba alphanumeric keyboard requires a device-specific kernel mode driver
(aipkbpos.sys)
Example of a typical error: “The file 'aipkbpos.sys' on Toshiba POS HID Keyboard Install Disk is
needed.”

Common Extended Result Codes

In certain situations the OPOS driver will return extended result codes that originate from the
underlying Point of Sale Subsystem driver, which controls access to USB and RS-485 devices.

Chapter 5. Common settings and configuration options 77

Resolution of these errors is out of the control of the application programmer, so they are listed
here for informational purposes only. Consult your Toshiba support representative for more
information if you receive one of the errors listed below.

Table 18. Errors

Error Number Description
301 The Toshiba Point of Sale Subsystem received an operating system error.

302 The application has not performed a successful PosInitialize() subroutine

call. An application must successfully issue the PosInitialize() subroutine call
before issuing any other Toshiba Point of Sale Subsystem subroutine calls.

303 The device descriptor parameter is not a valid device descriptor. Only device
descriptors returned by PosOpen() can be used.

304 The application has already successfully processed the PosInitialize()

subroutine.

305 The Toshiba Point of Sale Subsystem has not been able to acquire the memory
it requires to operate.

306 The Toshiba Point of Sale Subsystem has detected an error with one of the
devices, or other hardware attached to the system.

307 A specific device could not be determined from the information given to the
PosOpen() subroutine.

308 The value for the PosNqueueHandle resource is not valid.

309 The Toshiba Point of Sale Subsystem limit for device descriptors for each
process has already been reached. The Toshiba Point of Sale Subsystem cannot
start any more devices for this process until one or more devices are closed.

311 The application has requested a function that is not supported for the device
descriptor. See the Related Information section of the individual device
chapters for the valid subroutine calls for the device.

312 This error can occur when issuing a PosRead() subroutine call. The application
specified a length value that was too small for the data being read. When this
error occurs, data is not put into the application’s buffer.

313 The application issued a POS_SYS_ACQUIRE_DEVICE PosIOCtl() request in

order to acquire device connection, but another device descriptor has already
acquired the device connection. The acquired device connection must be
released before this POS_SYS_ACQUIRE_DEVICE PosIOCtl() request can be
successful.

314 The application is trying to acquire a device connection that it has already
acquired.

78 UnifiedPOS User's Guide

Error Number Description
315 The application issued a subroutine call that requires an acquired
device connection. The application must first successfully issue the
POS_SYS_ACQUIRE_DEVICE PosIOCtl() request.

316 The request parameter of the PosIOCtl() subroutine is not valid for the device
associated with the device descriptor.

317 The device is not currently connected to the system unit. The device may have
gone offline since the application initialized the device.

318 The application specified an incorrect value for nbyte when it issued a
PosWrite() subroutine call.

319 The values of the class parameter and the PosNdeviceNumber resource given
to the PosOpen() subroutine were both valid individually, but not valid in
combination with each other.

320 A device was closed when data was available. The data is discarded. The data
is not logged.

321 The Toshiba Point of Sale Subsystem has discovered an internal logic error.

325 The parameter is a negative number. It must be 0 (zero), or a positive number.

326 An incorrect value was specified for the PosNslotNumber resource.

327 The PosNslotNumber resource specified a slot containing an unsupported

adapter.

328 An incorrect value was specified for the PosNportNumber resource.

329 The timeout specified by the PosNreadTimeout resource has expired while
waiting for input from the Toshiba Point of Sale Subsystem input queue. Data
did not become available for reading from the input queue before the timeout
expired.

330 The length of the name parameter was 0 (zero) or was too long.

331 The class parameter given to the PosOpen() subroutine is not valid.

332 A system call was interrupted, or could not be completed for one of the
following reasons:
1. The application called the PosRead() subroutine for the Toshiba Point of
Sale Subsystem input queue (device descriptor zero) and was waiting for
input to become available (the value of the PosNreadTimeout resource
was non-zero). While the thread was waiting, an exception occurred, such
as the user pressing Ctrl-Break.

Chapter 5. Common settings and configuration options 79

Error Number Description

2. The application called the PosRead() subroutine for the Toshiba Point of
Sale Subsystem input queue (device descriptor zero) and was waiting for
input to become available (the value of the PosNreadTimeout resource
was non-zero). While the thread was waiting, another thread in the same
process called the PosRead(), or PosIOCtl() subroutines for the input
queue. In this case, the input queue was already busy and could not
process the request.

334 The Toshiba Point of Sale Subsystem detected an address that is not valid. This
error is set if the buffer, the control block, or the string pointed to is not valid,
or if the process does not have access to the entire length of the control block,
or buffer.
The entire length of structures of known sizes are validated before being used.
If the structure is an output parameter, then the structure is verified to be
writeable. If the structure is of an unknown size, only the first byte of the
structure is validated.

335 The application issued a PosRead() subroutine call when the target device is in
a locked state and there is no data available to be returned.

336 The file parameter given to the PosInitialize() subroutine is not valid. The
problem might be that the length of the file parameter is 0 (zero), or is too
long.

337 The Toshiba Point of Sale Subsystem for Windows is not running.

80 UnifiedPOS User's Guide

Chapter 6. Cash drawer
Cash drawer

Cash drawer supported devices

Table 19. Cash drawer supported devices
Device Connectivity
1. Toshiba Cash Drawer USB
2. SurePOS 500/600 family built-in cash drawer EIA-232
3. SurePOS 700 family built-in cash drawer Integrated
4. 4694 family built-in cash drawer RS-485
5. 4610 printer built-in cash drawer EIA-232, RS-485, USB, Network
6. SurePOS 300 family Integrated
7. SureOne family built-in cash drawer (OPOS) Integrated
8. TCx 700 USB, RS485
9. 6145 printer built-in cash drawer USB
10. TCx 800 USB, RS485
11. TCx 300 Embedded
12. 4750-D10 Embedded
13. TCx 810 USB

Supported properties and methods

Table 20. Cash drawer common properties
Property JavaPOS OPOS
AutoDisable Not supported
BinaryConversion Not supported
CapCompareFirmwareVersion False
All support STANDARD except
SurePOS 500/600 family built-in
CapPowerReporting PR_STANDARD
cash drawer, which supports
ADVANCED
CapStatisticsReporting True (see Appendix A, JavaPOS False
support for UnifiedPOS device
statistics properties on page 555)
CapUpdateFirmware False

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 81

Property JavaPOS OPOS
CapUpdateStatistics False (see Appendix A, JavaPOS False
support for UnifiedPOS device
statistics properties on page 555)
CheckHealthText All Not supported
Claimed All
DataCount Not supported
DataEventEnabled Not supported
DeviceControlDescription All
DeviceControlVersion All
DeviceServiceDescription All
DeviceServiceVersion All
FreezeEvents All
OpenResult Not supported All
OutputID Not supported
PhysicalDeviceDescription All
PhysicalDeviceName All
PowerNotify All
PowerState All
State All

Table 21. Cash drawer specific properties

Property JavaPOS OPOS
CapStatus All
CapStatusMultiDrawerDetect All except 4610 and 6145 printer built-in cash drawer
DrawerOpened All

Table 22. Cash drawer common methods

Method JavaPOS OPOS
compareFirmwareVersion Not supported
checkHealth All All except SurePOS 500/600 family
built-in cash drawer
claim All
clearInput Not supported
clearOutput All Not supported
close All
directIO Not supported
open All

82 UnifiedPOS User's Guide

Method JavaPOS OPOS
release All
resetStatistics Not supported
retrieveStatistics True (see Appendix A, JavaPOS Not supported
support for UnifiedPOS device
statistics properties on page 555)
updateFirmware Not supported
updateStatistics Not supported

Table 23. Cash drawer specific methods

Method JavaPOS OPOS
openDrawer All
waitForDrawerClose All

Table 24. Cash drawer events

Event JavaPOS OPOS
DirectIOEvent Not supported

IBM_JPOS_SUE_CASH_OPEN_ 1,8,10,13 Not supported

TIME_OUT

StatusUpdateEvent All

JavaPOS configuration

CashDrawer.OpenDrawerRetries

<prop name="com.ibm.jpos.sdi.config.CashDrawer.OpenDrawerRetries"
type="String" value="0"/>

This property is used to configure the number of retries to attempt before a fail with the
openDrawer method.
Default value is 0.
Note:
1. If no property is found in the entry, the default value is used.
2. If the property is present but it has an invalid or negative value, then the default value is
used.
3. The value is read only at open time.

Chapter 6. Cash drawer 83

CashDrawer.OpenTimeOut

<Prop name="com.ibm.jpos.sdi.config.CashDrawer.OpenTimeOut"
type="String" value="0"/>

This property is used to configure the Open timeout event of the cash drawer. When the cash
drawer had been opened but was not closed during the timeout value, the driver will fire a
com.ibm.jpos.DirectIO.IBM_JPOS_SUE_CASH_OPEN_TIME_OUT (1000) Status Update Event.
The value represents the interval of time (in seconds); the range of the property is from 0 to 255.
If the value is 0, the timeout is disabled. If the value is out of range, it is set to the default (255).
• Values accepted: 0 to 255 (Default 255)
• Device Support: 1
Note:
1. If no property is found in the entry, the default value is used.
2. If the property is present but contains an invalid value, then the default value is used.
3. The value is read only at open time.

signalsReversed

<Prop name="signalsReversed" type="Boolean" value="false"/>

Reverses the wiring polarity of the cash drawer when the cash drawer is attached to a 4610
printer. Some OEM drawers are wired in reverse to the standard drawer, so will require this
value to be changed to TRUE.
• Valid values are TRUE and FALSE.
• Default is FALSE.

deviceNumber
<prop name="com.ibm.posj.bus.deviceNumber" type="String" value="0"/>

Used to properly identify the cash drawers present. The values 0-3 are reserved for the cash
drawer attached to the system unit. For example, 0 means the cash drawer is attached to port 3A
on the system, and 1 means the cash drawer is attached to port 3B on the system. Cash drawers
attached to RS-485 and USB 4610 printers have a deviceNumber starting with 4.

84 UnifiedPOS User's Guide

CashDrawer.CheckOpenStatus

<prop name="com.ibm.jpos.sdi.config.CashDrawer.CheckOpenStatus"
type="Boolean" value="true"/>

This property is used to configure the CheckOpenStatus for the cash drawer. When the cash
drawer has been opened but the property is enabled, use this property to control the cash
drawer physical status validation.
Default value is true.
• False - Drawer mechanism will be activated every time openDrawer is called.
• True (default) - Drawer mechanism will be activated if and only if openDrawer is called
while drawer is physically closed.
Note:
1. If no property is found in the entry, the default value is used.
2. If the property is present but contains an invalid value, then the default value is used.
3. The value is read only at open time.

CashDrawer.DisableCDStatus

<prop name="com.ibm.jpos.sdi.config.CashDrawer.DisableCDStatus"
type="Boolean" value="false"/>

This property is used to control SUE_DRAWEROPEN (Status Update Event).

Default value is false.
• True - Only actual cashDrawer physical status changes are reported.
• False (default) - Force a SUE_DrawerOpen Status Update Event disregarding actual cash
drawer physical state besides reporting actual cashDrawer physical status changes.
Note:
1. If no property is found in the entry, the default value is used.
2. If the property is present but contains an invalid value, then the default value is used.
3. The value is read only at open time.

Pulse Width
This property is used to configure the Pulse Width during openDrawer call.
For System built-in Cash Drawers:
• Refer to the posj.properties file and property:

com.ibm.posj.CashDrawer.PulseWidth

• Values accepted:
0-100 ms Cash Drawer Pulse (Default)

Chapter 6. Cash drawer 85

1-200 ms Cash Drawer Pulse
For 4610 printer built-in cash drawer:
• Refer to the posj.properties file and properties:

com.ibm.posj.CashDrawer.4610.PulseWidthOn

• Values accepted:
From 0 to 255 - Cash Drawer Pulse x 2 milliseconds
(Default ON value = 100)

Additional JavaPOS information

4610 printer-attached cash drawer

JavaPOS supports regular Toshiba cash drawers and OEM cash drawers attached to the Toshiba
4610 Printer via EIA-232, RS-485, and USB.
For a Toshiba cash drawer, set the signalsReversed property to false. For example:
<Prop name="signalsReversed" type="Boolean" value="false"/>

For some OEM cash drawers, the signalsReversed property will need to be set to true. For
example:
<Prop name="signalsReversed" type="Boolean" value="true"/>

Note: In the jpos.xml.<os>Sample, the signalsReversed property is in the JposEntries with

the following logicalName values:
• "CashDrawer RS232 4610-A"
• "CashDrawer RS232 4610-B"
• "CashDrawer RS485 4610-A"
• "CashDrawer RS485 4610-B"
• "CashDrawer USB 4610-A"
• "CashDrawer USB 4610-B"

Loading the cash drawer driver for Linux

To load the correct cash drawer device driver in Linux, the /opt/tgcs/javapos/etc/
machine.conf file must be modified. The format of machine.conf is:

<keyword> <number of entries>

<machine type><model number>

<keyword> represents the device for which a driver is needed and <number of entries>
indicates the number of <machine type><model number> pairs that follow. If the system on
which JavaPOS is running matches one of the specified <machine type><model number>
pairs, the device driver for that <machine type><model number> is loaded.

86 UnifiedPOS User's Guide

For the cash drawer, machine.conf might have the following entries:

CD 1
4810321

waitForDrawerClose method
The waitForDrawerClose method makes the system beep while the drawer is open. Windows
supports different frequencies and durations for this beep. Linux, however, does not support it
and the beep will always have the same frequency and duration regardless of the parameters
used.
Additionally, the beep is limited to a maximum duration of 250 milliseconds. If you attempt to
use a higher value, the beep will always use 250.

USB drawer enumeration

To enumerate USB Cash drawers JavaPOS uses the device serial number and write the
usbenumeration.dat file.
The driver uses the .dat file to associate the cash drawer number to the serial number of the
device. If the drawer/system unit pair changes then the file needs to be deleted and the drawer
reconfigured.
Example:
<name = "javapos.cashdrawer.0" value = "1,11S80Y0745YK12RR0080B7" />
<name = "javapos.cashdrawer.1" value = "0,11S80Y0745YK12RR007836" />
File locations:
Linux: /root/.toshiba/usbenumeration.dat
Windows: C:\Users\[UserName]\.toshiba\usbenumeration.dat

Cash drawer firmware update

The Toshiba JavaPOS driver has the ability to automatically update the cash drawer firmware if
the cash drawer is attached to the terminal when the terminal boots. It does not have this ability
if the cash drawer is attached to the terminal after the terminal has booted and the operating
system has loaded.

Automatic update
When a terminal starts, JavaPOS will check the firmware version and update all devices that
are defined in the JPOS.XML file if necessary. In Windows, the firmware update process is
controlled by a windows service named Toshiba JavaPOS Flash Utility.
The Toshiba JavaPOS Flash Utility service controls the updating of firmware in all devices,
not just cash drawers. If you do not want the driver to automatically update the cash drawer
firmware, you must delete the firmware update files from the \pos\javapos \flash folder.

Chapter 6. Cash drawer 87

On Linux, the firmware update process is controlled by a shell script:
/etc/init.d/flashdev start

The batch controls the updating of firmware in all devices, not just cash drawers. If you do
not want the driver to automatically update the cash drawer firmware, you must delete the
firmware update files from the /opt/tgcs/javapos/flash/ folder.
To confirm the success of the firmware, check the tgcsflash.log file under \pos\log in
Windows, or /var/log in Linux POS systems.

JavaPOS DirectIO calls

The following DirectIO commands are supported by the Cash Drawer device. The syntax is as
follows:
Syntax directIO ( command: int32, inout data: int32, inout obj: object ):
void { raises-exception, use after open-claim-enable }

To access DirectIO constants: import com.ibm.jpos.services.DirectIO.

Cash Drawer get serial number command

Get the serial number of the Cash Drawer device.

Supported devices:
• USB Cash Drawer
• AnyPlace Hub Cash Drawer
• 4610 printer built-in Cash Drawer

Table 25. DEVICE_INFORMATION_CMD information

Parameter Type Value
Command int32 DirectIO.DEVICE_INFORMATION_CMD
Data int32 Any value. A null value is accepted.
Obj String com.ibm.jpos.services.DeviceInformation.jav
a

Remarks
For the DeviceInformation object:
getSerialNumber() returns the serial number in a String object. An empty string is
returned for unsupported devices.

88 UnifiedPOS User's Guide

OPOS configuration
In order to apply the configurations shown below, create the keyword of the specified type into
the following windows registry:
-
HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\CashDrawer\Logical
Name
Note: For 32 bits Application running on 64 bits Windows use the following path instead:
-
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\OLEforRetail\ServiceOPOS\CashDr
awer\LogicalName
"LogicalName" refers to the actual device logical name given by end user at configuration time.

Table 26. Service Object settings for cash drawer

Keyword Type Description
CashDrawerNumber String Cash drawer number. Valid values are 1 (default) and 2.
PulseWidthOnTime String Pulse on time (0-512) for firing the cash drawer. The default value is 100.
Note: This setting cannot be modified with the Configuration tool.

PulseWidthOffTime String Pulse off time (0-512) for firing the cash drawer. The default value is 100.
Note: This setting cannot be modified with the Configuration tool.

SignalsReversed REG_SZ Reverses the wiring polarity of the cash drawer. Valid values:

True
Reverse polarity

(other value)
Standard polarity (default)
CDFireRetries REG_DWOR Determines the number of CD fire retires. Valid values:
D
0
No CD fire retries (default)

1-3
# of retries for CD fire
DisableCDStatus REG_SZ Set this registry to disable the cash drawer status checking after
OpenDrawer and StatusUpdateEvent firing.
Valid values:

True
Disable

Other values (default)

Enable

CheckOpenStatus REG_SZ Valid values:

Chapter 6. Cash drawer 89

Keyword Type Description

True
Check the cash drawer open status and only fire the drawer open
command when it’s closed.

Other values (default)

Fire the drawer open command regardless of the cash drawer
open status.

Additional OPOS information

OEM cash drawer support

Some OEM cash drawers are wired the opposite of Toshiba cash drawers. Use the Signals
Reversed check box in the configuration utility to indicate that your cash drawer is one of these
OEM cash drawers.
OPOS support for the USB SureMark printer assumes the Toshiba cash drawer wiring. The
OPOS support for EIA-232 SureMark printers prior to release 1.7.1 assumes the OEM wiring.
Starting with release 1.7.1, OPOS support for the EIA-232 SureMark Printer cash drawer has
been changed to match the behavior of the USB Printer cash drawer. Therefore, it may be
necessary to reconfigure EIA-232 SureMark printer cash drawers by modifying the Signals
Reversed check box.

USB cash drawer support

When one or more USB cash drawers are attached, they are enumerated in the OPOS
Configuration tool in the following way:

Table 27. USB cash drawer support

Cash Drawer on Port Enumeration in OPOS Config tool
3A on AnyPlace POS Hub slot = 0x08, port = 0x11, device = 0x54
1st Powered USB Port slot = 0x08, port = 0x22, device = 0x54
2nd Powered USB Port slot = 0x08, port = 0x33, device = 0x54

For repeatable port assignments, keep the cash drawer on the same powered USB port(s) during
hardware configuration. This becomes crucial when attaching more than one cash drawer.

Hot-plug support:
Officially, hot-plugging is not recommended and is not supported for Toshiba Retail IOs.
Currently, there is no means of associating a specific device to a specific slot, port, or device
definition.
The supported means of changing USB cash drawers is to power down the machine and perform
the device swapping while the machine is powered down.

90 UnifiedPOS User's Guide

OPOS DirectIO calls
The directIO commands in this section are supported for the cash drawer device.
The following is the correct syntax: LONG DirectIO ( LONGCommand, LONG*pData,
BSTR*pString);
To access constants for a cash drawer attached to a POS Printer, include TGCSPOSPtr.h. For a
cash drawer attached to a Fiscal Printer, include TGCSFPtr.h.
Note: For all operations, use BinaryConversion rather than OPOS_BC_NONE so that data is not
prematurely truncated.

Cash Drawer get serial number command

Get the serial number of the Cash Drawer device or the main device where the cash drawer is
attached to.
Supported devices:
• USB Cash Drawer
• AnyPlace Hub Cash Drawer
• 4610 and 6145 printer built-in Cash Drawer
• Fiscal printer built-in Cash Drawer
Constant definition: #define DIRECTIO_DEVICE_INFORMATION_CMD 0x30

Table 28. Parameters for DIRECTIO_DEVICE_INFORMATION_CMD subcommand

Parameter Type Value
Command LONG DIRECTIO_DEVICE_INFORMATION_CM
D
pData LONG* Not used
pString BSTR* A BSTR to be filled with data.

Remarks
pString returns the serial number in a BSTR object. An empty string is returned for
unsupported devices.

Supported properties and methods (cash drawer attached fiscal printer:

Italy)
Table 29. Common properties (cash drawer attached fiscal printer: Italy)
Property JavaPOS OPOS
AutoDisable Not supported
CapCompareFirmwareVersion False
CapPowerReporting PR_NONE
CapStatisticsReporting False
CapUpdateFirmware False
CapUpdateStatistics False

Chapter 6. Cash drawer 91

Property JavaPOS OPOS
CheckHealthText String
Claimed True/False
DataCount Not supported
DatEventEnabled Not supported
DeviceEnabled True/False
DeviceControlDescription String
DeviceControlVersion int
DeviceServiceDescription String
DeviceServiceVersion Supported
FreezeEvents False
OutputID E_ILLEGAL
PhysicalDeviceDescription String
PhysicalDeviceName String
PowerNotify E_ILLEGAL
PowerState PS_UNKNOWN
State int

Table 30. Specific properties (cash drawer attached fiscal printer: Italy)
Property JavaPOS OPOS
CapStatus False
CapStatusMultiDrawerDetect False
DrawerOpened False

Table 31. Common methods (cash drawer attached fiscal printer: Italy)
Method JavaPOS OPOS
checkHealth Supported
claim Supported
clearInput Not supported
clearOutput E_ILLEGAL
close Supported
compareFirmwareVersion E_ILLEGAL
directIO Supported
open Supported
release Supported
resetStatistics E_ILLEGAL
retrieveStatistics E_ILLEGAL

92 UnifiedPOS User's Guide

Method JavaPOS OPOS
updateFirmware E_ILLEGAL
updateStatistics E_ILLEGAL

Table 32. Cash drawer attached fiscal printer (Italy) specific methods
Method JavaPOS OPOS
openDrawer Supported
waitForDrawerClose E_ILLEGAL

Chapter 6. Cash drawer 93

94 UnifiedPOS User's Guide
Chapter 7. Check scanner
Check scanner

Check scanner supported devices

Table 33. Check scanner supported devices

Device Connectivity
1. 4610 TI8 CheckScanner EIA-232, RS-485, USB
2. 4610 TI9 CheckScanner EIA-232, RS-485, USB

Supported properties and methods

Table 34. Check scanner common properties
Property JavaPOS OPOS
AutoDisable All Supported
CapCompareFirmwareVersion False
CapPowerReporting PR_STANDARD Supported
CapStatisticsReporting True (see Appendix A, JavaPOS support for False
UnifiedPOS device statistics properties on
page 555)
CapUpdateFirmware False
CapUpdateStatistics False (see Appendix A, JavaPOS support for False
UnifiedPOS device statistics properties on
page 555)
CheckHealthText All Supported
Claimed All Supported
CompareFirmwareVersion Not supported
DataCount All Supported
DataEventEnabled All Supported
DeviceControlDescription All Supported
DeviceControlVersion All Supported
DeviceEnabled All Supported
DeviceServiceDescription All Supported
DeviceServiceVersion All Supported
FreezeEvents All Supported
OutputID All Supported
PowerNotify All Supported

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 95

Property JavaPOS OPOS
PowerState All Supported
PhysicalDeviceDescription All Supported
PhysicalDeviceName All Supported
State All Supported

Table 35. Check scanner specific properties

Property JavaPOS OPOS
CapAutoContrast False
CapContrast True
CapAutoGenerateFileID False Not supported
CapAutoGenerateImageTagData False Not supported
CapAutoSize True Supported
CapColor CheckScannerConst.CHK_CCL_GRAYSCA Supported
LE
CapConcurrentMICR True Supported
CapDefineCropArea True Supported
CapImageFormat • CheckScannerConst.CHK_CIF_TIFF Supported:
• CheckScannerConst.CHK_CIF_BMP • CHK_CIF_TIFF
• CheckScannerConst.CHK_CIF_JPEG • CHK_CIF_BMP
• CheckScannerConst.CHK_CIP_NATIVE • CHK_CIF_JPEG
• CHK_CIP_NATIVE

CapImageTagFormat True Supported

CapMICRDevice True Supported
CapStoreImageFiles True Supported
CapValidationDevice False Not supported
Color CheckScannerConst.CHK_CL_GRAYSCAL CHK_CCL_GRAYSCALE
E only
ConcurrentMICR True Supported
Contrast 0 - 100, default = 50 50
CropAreaCount 0 Supported
DocumentHeight Set by the driver after document scanned Supported
Initialized value: 8000

DocumentWidth Set by the driver after document scanned Supported

Initialized value: 4000

FileID "" Not supported

FileIndex 0 Supported
ImageData NULL Supported

96 UnifiedPOS User's Guide

Property JavaPOS OPOS
ImageFormat Supported: Supported:
CheckScannerConst.CHK_CIF_NATIVE • CHK_IF_TIFF
CheckScannerConst.CHK_CIF_TIFF
• CHK_IF_JPEG
CheckScannerConst.CHK_CIF_BMP
CheckScannerConst.CHK_CIF_JPEG
• CHK_IF_BMP
• CHK_IF_NATIVE

ImageMemoryStatus Current state of checkscanner memory Supported

ImageTagData Max 32 characters allowed Supported
MapMode Only Supported:
CheckScannerConst.CHK_MM_ENGLISH CHK_MM_ENGLISH only
supported
MaxCropAreas 20 Supported
Quality Only 200 dpi supported TI8: 200, TI9: 200 (default) or
100
QualityList 1 - set to "100" TI8: "200", TI9: "100,200"
2 - set to "100, 200"

RemainingImagesEstimate TI8/TI9 TI9 TI8/TI9 TI/9

(Estimates when memory
is empty.) Format: 200 DPI 100 DPI 200 DPI 100 DPI

CheckScannerConst.
CHK_CIF_TIFF
108 216 108 216

CheckScannerConst.
CHK_CIF_BMP
1 2 1 2

CheckScannerConst.
CHK_CIF_JPEG
20 40 20 40

CheckScannerConst.
CHK_CIF_NATIVE
1 2 1 2

Table 36. Check scanner common methods

Method JavaPOS OPOS
checkHealth Supported: All Supported:
JposConst.JPOS_CH_INTERNAL OPOS_CH_INTERNAL
JposConst.JPOS_CH_EXTERNAL OPOS_CH_EXTERNAL
OPOS_CH_INTERACTIVE
Throws jposException( JPOS_E_ILEGAL)
JposConst.JPOS_CH_INTERACTIVE

claim All Supported

clearInput All Supported
clearInputProperties All Supported
clearOutput All Supported
close All Supported

Chapter 7. Check scanner 97

Method JavaPOS OPOS
directIO All Supported
open All Supported
release All Supported
resetStatistics Not supported
retrieveStatistics True (see Appendix A, JavaPOS Not supported
support for UnifiedPOS device statistics
properties on page 555)
updateFirmware Not supported
updateStatistics Not supported

Table 37. Check scanner specific methods

Method JavaPOS OPOS
beginInsertion All Supported
beginRemoval All Supported
clearImage All (Only Supported: CHK_CLR_ALL only
CheckScannerConst.CHK_CLR_ALL
supported.)
defineCropArea All Supported
endInsertion All Supported
endRemoval All Supported
retrieveImage Supported: Supported:
CheckScannerConst.CHK_CROP_ CHK_CROP _AREA_ENTIRE _IMAGE
AREA_ENTIRE_IMAGE. All other values are supported starting from
All other values are supported EC level 0x68
starting from EC level 0x68

retrieveMemory Supported: Supported:

CheckScannerConst.CHK_LOCATE_ CHK_LOCATE_BY_FILEINDEX
BY_FILEINDEX. CHK_LOCATE_BY_IMAGETAGDATA.
All other values throw
JposException( JPOS_E_ILLEGAL ) Not suppported:
CHK_LOCATE_BY_FILEID returns
OPOS_E_ILLEGAL.

storeImage All

Table 38. Check scanner events

Event JavaPOS OPOS
DataEvent All Supported
DirectIOEvent All Supported
ErrorEvent All Supported
StatusUpdateEvent All Supported

98 UnifiedPOS User's Guide

JavaPOS DirectIO calls
The DirectIO commands in this section are supported for the check scanner device. The syntax is
as follows:

directIO ( command: int32, inout data: int32 , inout obj: object):

void { raises-exception }

To access DirectIO constants, import com.ibm.jpos.services.DirectIO.

Scanner calibration command

Calibrates the check scanner in Toshiba 4610 Printer Models TI8 and TI9.

Table 39. CHK_DIO_SCANNER_CALIBRATION_CMD information

Parameter Type Value
Command Int32 DirectIO.CHK_DIO_SCANNER_CALIBRATION_CMD
Data Int32 Any value. A null value is accepted.
Obj Object Any value. A null value is accepted.

Note: A white document must be inserted in the DI station. The printer scans the document
two or three times to update the printer's calibration data, then DirectIO is paired with the
beginInsertion method for controlling check insertion.

Print scanned image command

Prints the specified scanned image to the thermal station.

Table 40. CHK_DIO_PRINT_SCANNED_IMAGE_CMD information

Parameter Type Value
Command Int32 DirectIO.CHK_DIO_PRINT_SCANNED_IMAGE_CMD
Data[0] Int32 DirectIO.CHK_DIO_MEMORY_IMG prints the most recently
scanned image. DirectIO.CHK_LOCATE_BY_FILEINDEX
prints the image file using the FileIndex property.
Data[1] Int32 The numeric identifier for the defined crop area. If the values is
CHK_CROP_AREA_ENTIRE__IMAGE then the entire area of
the scanned image is printed.
Data[2] Int32 Percentage to scale image in x direction. (A value of 100 or 0
results in no scaling.)
Data[3] Int32 Percentage to scale image in y direction. (A value of 100 or 0
results in no scaling.)
Data[4] Int32 DirectIO.CHK_DIO_ROTATE_90 rotates the image counter
clockwise 90%. DirectIO.CHK_DIO_NO_ROTATE does not
rotate the image.
Obj Object Any value. A null value is accepted.

Note:

Chapter 7. Check scanner 99

Printing stored images causes the printer to pause momentarily while the printer formats the
data to be printed. This time varies depending on the amount of formatting required.
If cx and cy defined at the crop area extend the printer area further than the boundaries of
the image, the values are truncated to the image boundary. If the size of the print area is
greater than the thermal print head is capable of printing (either from image size or scaling),
the image is truncated to the width of the print head. Currently, the only scaling options are
100% (no scaling) and 200% (double).
Printing resident images in the work area memory with CheckScannerConst.CHK_IF_JPEG
format is not supported.

Set check side command

Set the side of the check to scan. This command assumes that the check is inserted face down.

Table 41. CHK_DIO_SET_CHECK_SIDE_CMD information

Parameter Type Value
Command Int32 DirectIO.CHK_DIO_SET_CHECK_SIDE_CMD
Data[0] Int32 • DirectIO.CHK_DIO_SIDE1 selects the front of the check.
• DirectIO.CHK_DIO_SIDE2 selects the back of the check.
• DirectIO.CHK_DIO_OPPOSITE selects the opposite face of
the check from the current side selected.

Obj Object Any value. A null value is accepted.

Note: This allows a check scan to occur on both sides of the document.
If a document is not inserted, an error is returned. If data[0] is different
from the value returned by DirectIO.CHK_DIO_GET_CHECK_SIDE_CMD or data[0]
is DirectIO.CHK_DIO_SIDE_OPPOSITE, the side of the document is changed and
the document is fed. If data[0] is the same as the value returned by
DirectIO.CHK_DIO_GET_CHECK_SIDE_CMD, nothing occurs and the method returns.

Get check side command

Return the current setting for the side of the check to be scanned. This command assumes the
check is inserted face down. After calling this DirectIO, data[0] is populated with one of the
values in the following table:

Table 42. CHK_DIO_GET_CHECK_SIDE_CMD information

Parameter Type Value
Command Int32 DirectIO.CHK_DIO_GET_CHECK_SIDE_CMD
Data Int32 • DirectIO.CHK_DIO_SIDE_UNKNOWN (Indicates no check
is inserted.)
• DirectIO.CHK_DIO_SIDE1 (Indicates the front of the check
is selected.)
• DirectIO.CHK_DIO_SIDE2 (Indicates the back of the check
is selected.)

Obj Object Any value. A null value is accepted.

100 UnifiedPOS User's Guide

Note: This property value can be changed using the
DirectIO.CHK_DIO_SET_CHECK_SIDE_CMD method. When a check is inserted, the value
returned is DirectIO.CHK_DIO_SIDE1.

Scanner image quality command

This command checks the quality of the image scanned on Model TI9 printers. The check
scanner automatically checks the image quality of each check scanned against a set of internal
quality attributes. After calling this DirectIO, data[0] is populated with a value of 0 or 1.
• 0 indicates image quality is acceptable.
• 1 indicates image quality may not be acceptable.

Table 43. CHK_DIO_SCANNER_IMAGE_QUALITY_CMD information

Parameter Type Value
Command Int32 DirectIO.CHK_DIO_SCANNER_IMAGE_QUALITY_CMD
Data Int32 An array with at least one element.
Obj Object Any value. A null value is accepted.

Note: This DirectIO is supported only for the 4610 TI9 model.

Additional OPOS information

Multiple devices
A POS machine cannot have both RS-485 and USB check scanners operating at the same time.

Chapter 7. Check scanner 101

102 UnifiedPOS User's Guide
Chapter 8. Fiscal printer
Fiscal printer

Fiscal printer operations are supported through directIO() calls. The directIO() functions do not
perform any verification of commands sent to the fiscal printer or of data returned from the
printer. The functions provide a simple passthrough operation, allowing an application to access
the fiscal functions on the printer.
Starting with version 1.13.1, the Toshiba JavaPOS products include full UnifiedPOS service
drivers for Greece and Italy Fiscal Printers. Refer to the extended documentation of each country
for details:
• Toshiba JavaPOS FiscalPrinter Greece
• Toshiba JavaPOS FiscalPrinter LineDisplay CashDrawer Italy
File locations:
Windows: <install dir>\doc
Linux: /opt/tgcs/javapos/config
Note: For Linux, it may be necessary to disable Auto-configuration only and enable XML at JCL
configuration.

Fiscal printer supported devices

USB fiscal printers are not supported on Linux.

Table 44. Fiscal printer supported devices

Toshiba SureMark Printer Connectivit Comments
Fiscal Printer Device y
1. Models Kx3 EIA-232 KD3: Hungary, Italy, Czech Republic, Romania

2. Models Kx4 EIA-232 KN4: Brazil

KC4: Chile

3. Models Kx5 EIA-232 KC5: Chile

KD5: Hungary, Italy, Czech Republic, Romania

4. Models Kx3 RS-485 KR3: Hungary, Italy, Czech Republic, Greece, Turkey

5. Models Kx5 RS-485 KR5: Hungary, Italy, Czech republic, Greece, Turkey, Chile

6. Models Kx5 USB (no KB5: Turkey

Linux KH5: Greece
support)
7. Models Gx3 EIA-232
8. Models Gx3 RS-485 Not supported

9. Models Gx3 USB GB3: Greece, Turkey

GE3: Argentina

10. Models Gx4 EIA-232 Not supported

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 103

Toshiba SureMark Printer Connectivit Comments
Fiscal Printer Device y
11. Models Gx5 EIA-232 GD5: Turkey

12. Models Gx5 RS-485 Not supported

13. Models Gx5 USB Not supported

14. Models Sx6 EIA-232 SJ6: Brazil

15. Models Sx6 USB SJ6: Brazil

16. Models 3xA RS-485 3FA: Argentina

17. Models Kx4 RS-485 Not supported

18. Models Kx3 USB KB3: Turkey

19. Gx4 RS-485 GR4: Venezuela

20. 3Bx RS-485 3BS: Brazil

3BM: Brazil

21. 3F RS-485 Brazil, Bulgaria, Greece, Hungary, Italy, Latvia, Mexico,

Romania, Russia, Slovakia, Turkey, Uruguay, Venezuela
22. 1NF EIA-232 / Chile, Greece, Hungary, Italy, Turkey, Venezuela
USB
23. Models Kx4 USB Not supported

24. 2xF EIA-232 / 2CF: Dominican Republic, Panamá, Venezuela

USB 2NF: Greece, Italy, Turkey

25. 1TF USB Turkey

Country-independent models (GF3, KG3) are not listed.

Supported properties and methods

Table 45. Fiscal printer common properties
Property JavaPOS OPOS
AutoDisable Not supported
CapCompareFirmwareVersion False
CapPowerReporting 4-6, 8, 9, 12-13, 15-21, 22/USB, 23, 24/ 4-6, 8-9, 12-13, 15 - 21 :
USB: PR_STANDARD PR_STANDARD
CapStatisticsReporting True False
CapUpdateFirmware False
CapUpdateStatistics False False

104 UnifiedPOS User's Guide

Property JavaPOS OPOS
CheckHealthText All 4-6, 8-9, 12-13, 15 - 21
Claimed All 4-6, 8-9, 12-13, 15 - 21
DataCount Not supported
DataEventEnabled Not supported
DeviceControlDescription All 4-6, 8-9, 12-13, 15 - 21
DeviceControlVersion All 4-6, 8-9, 12-13, 15 - 21
DeviceServiceDescription All 4-6, 8-9, 12-13, 15 - 21
DeviceServiceVersion All 4-6, 8-9, 12-13, 15 - 21
FreezeEvents All 4-6, 8-9, 12-13, 15 - 21
OutputID All 4-6, 8-9, 12-13, 15 - 21
PhysicalDeviceDescription All 4-6, 8-9, 12-13, 15 - 21
PhysicalDeviceName All 4-6, 8-9, 12-13, 15 - 21
PowerNotify PN_DISABLED 4-6, 8-9, 12-13, 15 - 21 :
PN_DISABLED
PowerState PS_UNKNOWN 4-6, 8-9, 12-13, 15 - 21 :
PS_UNKNOWN
State All 4-6, 8-9, 12-13, 15 - 21

Table 46. Fiscal printer specific properties

Property JavaPOS OPOS
ActualCurrency E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
AdditionalHeader E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
AdditionalTrailer E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
AmountDecimalPlaces E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
AsyncMode All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapAdditionalHeader All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapAdditionalLines All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapAdditionalTrailer All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapAmountAdjustment All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapAmountNotPaid All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapChangeDue All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapCheckTotal All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapCoverSensor All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapDoubleWidth All - false 4-6, 8-9, 12-13, 15 - 21 : false

Chapter 8. Fiscal printer 105

Property JavaPOS OPOS
CapDuplicateReceipt All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapEmptyReceiptIsVoidable All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapFiscalReceiptStation All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapFiscalReceiptType All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapFixedOutput All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapHasVatTable All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapIndependentHeader All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapItemList All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapJrnEmptySensor All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapJrnNearEndSensor All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapJrnPresent All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapMultiContractor All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapNonFiscalMode All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapOnlyVoidLastItem All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapOrderAdjustmentFirst All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapPackageAdjustment All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapPercentAdjustment All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapPositiveAdjustment All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapPostPreLine All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapPowerLossReport All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapPredefinedPaymentLines All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapReceiptNotPaid All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapRecEmptySensor All - true Not supported
CapRecNearEndSensor All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapRecPresent All - true Not supported
CapRemainingFiscalMemory All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapReservedWord All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapSetCurrency All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapSetHeader All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapSetPOSID All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapSetStoreFiscalID All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapSetTrailer All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapSetVatTable All - false 4-6, 8-9, 12-13, 15 - 21 : false

106 UnifiedPOS User's Guide

Property JavaPOS OPOS
CapSlpEmptySensor 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 4-6, 8-9, 12-13, 15 - 21 : false
17, 18, 20, 21, 23, 24
CapSlpFiscalDocument All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapSlpFullSlip All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapSlpNearEndSensor All – false Not supported
CapSlpPresent 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, Not supported
17, 18, 20, 21, 23, 24
CapSlpValidation All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapSubAmountAdjustment All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapSubPercentAdjustment All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapSubtotal All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapTotalizerType All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapTrainingMode All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapValidateJournal All - false 4-6, 8-9, 12-13, 15 - 21 : false
CapXReport All - false 4-6, 8-9, 12-13, 15 - 21 : false
ChangeDue E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
CheckTotal E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
ContractorId E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
CountryCode All 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
CoverOpen All - true or false 4-6, 8-9, 12-13, 15 - 21 : true or false
DateType E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
DayOpened E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
DescriptionLength E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
DuplicateReceipt E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
ErrorLevel E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
ErrorOutID E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
ErrorState E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
ErrorStation E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
ErrorString E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
FiscalReceiptStation E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
FiscalReceiptType E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
FlagWhenIdle E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
JrnEmpty 7, 8, 9, 10, 11, 12, 13, 20, 21 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL

Chapter 8. Fiscal printer 107

Property JavaPOS OPOS
JrnNearEnd E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
MessageLength E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
MessageType E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
NumHeaderLines E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
NumTrailerLines E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
NumVatRates E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
PostLine E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
PredefinedPaymentLines E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
PreLine E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
PrinterState E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
QuantityDecimalPlaces E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
QuantityLength E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
RecEmpty All - true or false 4-6, 8-9, 12-13, 15 - 21 : true or false
RecNearEnd E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
RemainingFiscalMemory E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
ReservedWord E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
SlpEmpty 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 4-6, 8-9, 12-13, 15 - 21 : true or false
17, 18, 20, 21, 23
SlpNearEnd E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
SlipSelection E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
TotalizerType E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
TrainingModeActive E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL

Table 47. Fiscal printer common methods

Method JavaPOS OPOS
checkHealth All 4-6, 8-9, 12-13, 15 - 21
claim All 4-6, 8-9, 12-13, 15 - 21
clearInput Not supported
clearOutput Not supported
close All 4-6, 8-9, 12-13, 15 - 21
compareFirmwareVersion E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
directIO All 4-6, 8-9, 12-13, 15 - 21
open All 4-6, 8-9, 12-13, 15 - 21
release All 4-6, 8-9, 12-13, 15 - 21

108 UnifiedPOS User's Guide

Method JavaPOS OPOS
resetStatistics E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
retrieveStatistics True (see Appendix A, JavaPOS E_ILLEGAL
support for UnifiedPOS device
statistics properties on page 555)
updateFirmware E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL
updateStatistics E_ILLEGAL 4-6, 8-9, 12-13, 15 - 21 : E_ILLEGAL

Table 48. Fiscal printer specific methods

Method JavaPOS OPOS
None supported The communication to Fiscal Printer 4-6, 8-9, 12-13, 15 - 21 : The
is only through directIO. communication to Fiscal Printer is
only through directIO.

Table 49. Fiscal printer (DirectIO) events

Event JavaPOS OPOS
DirectIOEvent All - yes 4-6, 8-9, 12-13, 15 - 21
ErrorEvent Not supported
OutputCompleteEvent Not supported
StatusUpdateEvent Not supported
FPTR_SUE_COVER_OPEN ALL
FPTR_SUE_COVER_OK ALL
FPTR_SUE_JRN_EMPTY Not supported
FPTR_SUE_JRN_NEAREMPTY Not supported
FPTR_SUE_JRN_PAPEROK Not supported
FPTR_SUE_REC_EMPTY Not supported
FPTR_SUE_REC_NEAREMPTY Not supported
FPTR_SUE_REC_PAPEROK Not supported
FPTR_SUE_SLP_EMPTY Not supported
FPTR_SUE_SLP_NEAREMPTY Not supported
FPTR_SUE_SLP_PAPEROK Not supported
FPTR_SUE_IDLE Not supported
FPTR_SUE_JRN_COVER_OPEN 7, 8, 9, 10, 11, 12, 13, 20, 21
FPTR_SUE_JRN_COVER_OK 7, 8, 9, 10, 11, 12, 13, 20, 21
FPTR_SUE_REC_COVER_OPEN ALL
FPTR_SUE_REC_COVER_OK ALL

Chapter 8. Fiscal printer 109

Event JavaPOS OPOS
FPTR_SUE_SLP_COVER_OPEN 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13,
17, 18, 20, 21, 23, 24
FPTR_SUE_SLP_COVER_OK 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13,
17, 18, 20, 21, 23, 24

Supported properties and methods (fiscal printer: Italy)

Table 50. Fiscal printer (Italy) specific properties
Property JavaPOS OPOS
AutoDisable Not supported
BinaryConversion Not supported
CapCompareFirmwareVersio False
n
CapPowerReporting PR_STANDARD
CapStatisticsReporting True False
CapUpdateFirmware False
CapUpdateStatistics True False
CheckHealthText String
Claimed True/False
DataCount Not supported
DatEventEnabled Not supported
DeviceEnabled True/False
DeviceControlDescription String
DeviceControlVersion int
DeviceServiceDescription String
DeviceServiceVersion Supported
FreezeEvents True/False
OutputID int
PhysicalDeviceDescription String
PhysicalDeviceName String
PowerNotify int
PowerState E_ILLEGAL
State int

Table 51. Fiscal printer (Italy) common methods

Method JavaPOS OPOS
checkHealth Supported

110 UnifiedPOS User's Guide

Method JavaPOS OPOS
claim Supported
clearInput Not supported
clearOutput Not supported
close Supported
compareFirmwareVersion E_ILLEGAL
directIO Supported
open Supported
release Supported
resetStatistics E_ILLEGAL
retrieveStatistics Supported
updateFirmware E_ILLEGAL
updateStatistics E_ILLEGAL

Table 52. Fiscal printer (Italy) specific methods

Method JavaPOS OPOS
setCurrency E_ILLEGAL
setDate Supported
setHeaderLine Supported
setPOSID Supported
setStoreFiscalID E_ILLEGAL
setTrailerLine E_ILLEGAL
setVatTable E_ILLEGAL
setVatValue E_ILLEGAL
beginFiscalReceipt Supported
endFiscalReceipt Supported
printDuplicateReceipt E_ILLEGAL
printRecCash E_ILLEGAL
printRecItem Supported
printRecItemAdjustment Supported
printRecItemAdjustmentVoid Supported
printRecItemFuel E_ILLEGAL
printRecItemFuelVoid E_ILLEGAL
printRecItemRefund Supported
printRecItemRefundVoid E_ILLEGAL
printRecItemVoid Supported

Chapter 8. Fiscal printer 111

Method JavaPOS OPOS
printRecMessage Supported
printRecNotPaid Supported
printRecPackageAdjustment E_ILLEGAL
printRecPackageAdjustVoid E_ILLEGAL
printRecRefund Supported
printRecRefundVoid Supported
printRecSubtotal Supported
printRecSubtotalAdjustment Supported
printRecSubtotalAdjustVoid E_ILLEGAL
printRecTaxID E_ILLEGAL
printRecTotal Supported
printRecVoid Supported
printRecVoidItem Supported
beginFiscalDocument Supported
endFiscalDocument Supported
printFiscalDocumentLine Supported
beginItemList E_ILLEGAL
endItemList E_ILLEGAL
verifyItem E_ILLEGAL
printPeriodicTotalsReport Supported
printPowerLossReport E_ILLEGAL
printReport Supported
printXReport E_ILLEGAL
printZReport Supported
beginInsertion KD3, KR3: Supported KD3, KR3: Supported
KR5, 3F: E_ILLEGAL KD5, KR5, 3F, 1NF, 2NF:
E_ILLEGAL
KD5, 1NF, 2NF: Invalid command

beginRemoval Supported
endInsertion E_ILLEGAL
endRemoval E_ILLEGAL
beginFixedOutput E_ILLEGAL
beginNonFiscal Supported
beginTrainig Supported
endFixedOutput E_ILLEGAL

112 UnifiedPOS User's Guide

Method JavaPOS OPOS
endNonFiscal Supported
endTraining Supported
printFixedOutput E_ILLEGAL
printNormal Supported
getData Supported
getDate Supported
getTotalizer E_ILLEGAL
getVatEntry E_ILLEGAL
clearError E_ILLEGAL
resetPrinter Supported

Table 53. Fiscal printer (Italy) events

Event JavaPOS OPOS
DirectIOEvent All: yes 4-6, 8-9, 12-13, 15-21
ErrorEvent Not supported
OutputCompleteEvent Not supported
StatusUpdateEvent Not supported
FPTR_SUE_COVER_OPEN ALL
FPTR_SUE_COVER_OK ALL
FPTR_SUE_JRN_EMPTY Not supported
FPTR_SUE_JRN_NEAREMPTY Not supported
FPTR_SUE_JRN_PAPEROK Not supported
FPTR_SUE_REC_EMPTY Not supported
FPTR_SUE_REC_NEAREMPTY Not supported
FPTR_SUE_REC_PAPEROK Not supported
FPTR_SUE_SLP_EMPTY Not supported
FPTR_SUE_SLP_NEAREMPTY Not supported
FPTR_SUE_SLP_PAPEROK Not supported
FPTR_SUE_IDLE Not supported
FPTR_SUE_JRN_COVER_OPEN 7, 8, 9, 10, 11, 12, 13, 20, 21

FPTR_SUE_JRN_COVER_OK 7, 8, 9, 10, 11, 12, 13, 20, 21

FPTR_SUE_REC_COVER_OPEN ALL
FPTR_SUE_REC_COVER_OK ALL

Chapter 8. Fiscal printer 113

Event JavaPOS OPOS
FPTR_SUE_SLP_COVER_OPEN 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13,
17, 18, 20, 21, 23, 24

FPTR_SUE_SLP_COVER_OK 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13,

17, 18, 20, 21, 23, 24

Supported properties and methods (fiscal printer: Greece)

Table 54. Fiscal printer (Greece) common properties
Property JavaPOS OPOS
AutoDisable Not supported
CapCompareFirmwareVersion False
CapPowerReporting PR_STANDARD
CapStatisticsReporting True
CapUpdateFirmware False
CapUpdateStatistics False
CheckHealthText String
Claimed True/False
DataCount Not supported
DatEventEnabled Not supported
DeviceEnabled True/False
DeviceControlDescription String
DeviceControlVersion int
DeviceServiceDescription String
DeviceServiceVersion int
FreezeEvents True/False
OutputID E_ILLEGAL
PhysicalDeviceDescription String
PhysicalDeviceName String
PowerNotify int
PowerState int
State int

Table 55. Fiscal printer (Greece) specific properties

Property JavaPOS OPOS
ActualCurrency E_ILLEGAL
AdditionalHeader E_ILLEGAL

114 UnifiedPOS User's Guide

Property JavaPOS OPOS
AdditionalTrailer E_ILLEGAL
AmountDecimalPlaces 2 (int)
AsyncMode False
CapAdditionalHeader False
CapAdditionalLines False
CapAdditionalTrailer False
CapAmountAdjustment True
CapAmountNotPaid False
CapChangeDue False
CapCheckTotal True
CapCoverSensor True
CapDoubleWidth True
CapDuplicateReceipt False
CapEmptyReceiptsVoidable True
CapFiscalReceiptStation True
CapFiscalReceiptType True
CapFixedOutput False
CapHasVatTable True
CapIndependentHeader False
CapItemList False
CapJrnEmptySensor False
CapJrnNearEndSensor True
CapJrnPresent False
CapMultiContractor False
CapNonFiscalMode True
CapOnlyVoidLastItem False
CapOrderAdjustmentFirst False
CapPackageAdjustment False
CapPercentAdjustment False
CapPositiveAdjustment True
CapPositiveSubtotalAdjustment True
CapPostPreLine False
CapPowerLossReport False
CapPredefinedPaymentLines False
CapReceiptNotPaid False

Chapter 8. Fiscal printer 115

Property JavaPOS OPOS
CapRecEmptySensor True
CapRecNearEndSensor False
CapRecPresent True
CapRemainingFiscalMemory False
CapReservedWord False
CapSetCurrency False
CapSetHeader True
CapSetPOSID True
CapSetStoreFiscalID False
CapSetTrailer False
CapSetVatTable True
CapSlpEmptySensor True
CapSlpFiscalDocument False
CapSlpFullSlip True
CapSlpNearEndSensor False
CapSlpPresent True
CapSlpValidation False
CapSubAmountAdjustment True
CapSubPercentAdjustment False
CapSubtotal True
CapTotalizerType True
CapTrainingMode False
CapValidateJournal False
CapXReport True
ChangeDue E_ILLEGAL
CheckTotal True
ContractorId E_ILLEGAL
CountryCode FPTR_CC_GREECE
CoverOpen True/False
DateType FPTR_DT_RTC/FPTR_DT_START
DayOpened True/False
DescriptionLength 38 (int)
DuplicateReceipt E_ILLEGAL
ErrorLevel EL_NONE
ErrorOutID E_ILLEGAL

116 UnifiedPOS User's Guide

Property JavaPOS OPOS
ErrorState E_ILLEGAL
ErrorStation E_ILLEGAL
ErrorString E_ILLEGAL
FiscalReceiptStation FPTR_RS_RECEIPT
FiscalReceiptType FPTR_RT_SALES/
FPTR_RT_CASH_IN/
FPTR_CASH_OUT

FlagWhenIdle E_ILLEGAL
JrnEmpty True/False
JrnNearEnd False
MessageLength 0 (int)
MessageType E_ILLEGAL
NumHeaderLines 6 (int)
NumTrailerLines 0 (int)
NumVatRates 5 (int)
PostLine E_ILLEGAL
PredefinedPaymentLines E_ILLEGAL
PreLine E_ILLEGAL
PrinterState FPTR_PS_MONITOR/
FPTR_PS_FISCAL_RECEIPT/
FPTR_PSFISCAL_RECEIPT_TOTAL/
FPTR_PSFISCAL_RECEIPT_ENDING/
FPTR_PS_NONFISCAL

QuantityDecimalPlaces 3 (int)
QuantityLength 7 (int)
RecEmpty True/False
RecNearEnd False
RemainingFiscalMemory E_ILLEGAL
ReservedWord E_ILLEGAL
SlpEmpty True/False
SlpNearEnd False
SlipSelection FPTR_SS_FULL_LENGTH
TotalizerType FPTR_TT_DAY /
FPTR_TT_RECEIPT/
FPTR_TT_GRAND

TrainingModeActive False

Chapter 8. Fiscal printer 117

Table 56. Fiscal printer (Greece) common methods
Method JavaPOS OPOS
checkHealth Supported
claim Supported
clearInput Not supported
clearOutput E_ILLEGAL
close Supported
compareFirmwareVersion E_ILLEGAL
directIO Supported
open Supported
release Supported
resetStatistics E_ILLEGAL
retrieveStatistics E_ILLEGAL
updateFirmware E_ILLEGAL
updateStatistics E_ILLEGAL

Table 57. Fiscal printer (Greece) specific methods

Method JavaPOS OPOS
setCurrency E_ILLEGAL
setDate E_ILLEGAL
setHeaderLine Supported
setPOSID Supported
setStoreFiscalID E_ILLEGAL
setTrailerLine E_ILLEGAL
setVatTable Supported
setVatValue E_ILLEGAL
beginFiscalReceipt Supported
endFiscalReceipt Supported
printDuplicateReceipt E_ILLEGAL
printRecCash Supported
printRecItem Supported
printRecItemAdjustment Supported
printRecItemAdjustmentVoid Supported
printRecItemFuel E_ILLEGAL
printRecItemFuelVoid E_ILLEGAL
printRecItemRefund Supported

118 UnifiedPOS User's Guide

Method JavaPOS OPOS
printRecItemRefundVoid Supported
printRecItemVoid Supported
printRecMessage E_ILLEGAL
printRecNotPaid E_ILLEGAL
printRecPackageAdjustment E_ILLEGAL
printRecPackageAdjustVoid E_ILLEGAL
printRecRefund Supported
printRecRefundVoid Supported
printRecSubtotal Supported
printRecSubtotalAdjustment Supported
printRecSubtotalAdjustVoid Supported
printRecTaxID E_ILLEGAL
printRecTotal Supported
printRecVoid Supported
printRecVoidItem Supported
beginFiscalDocument E_ILLEGAL
endFiscalDocument E_ILLEGAL
printFiscalDocumentLine E_ILLEGAL
beginItemList E_ILLEGAL
endItemList E_ILLEGAL
verifyItem E_ILLEGAL
printPeriodicTotalsReport Supported
printPowerLossReport E_ILLEGAL
printReport Supported
printXReport Supported
printZReport Supported
beginInsertion Supported
beginRemoval Supported
endInsertion E_ILLEGAL
endRemoval E_ILLEGAL
beginFixedOutput E_ILLEGAL
beginNonFiscal Supported
beginTrainig E_ILLEGAL
endFixedOutput E_ILLEGAL
endNonFiscal Supported

Chapter 8. Fiscal printer 119

Method JavaPOS OPOS
endTraining E_ILLEGAL
printFixedOutput E_ILLEGAL
printNormal Supported
getData Supported
getDate Supported
getTotalizer Supported
getVatEntry supported
clearError E_ILLEGAL
resetPrinter Supported

Table 58. Fiscal printer (Greece) events

Event JavaPOS OPOS
DirectIOEvent All: yes 4-6, 8-9, 12-13, 15-21
ErrorEvent Not supported
OutputCompleteEvent Not supported
StatusUpdateEvent Not supported
FPTR_SUE_COVER_OPEN ALL
FPTR_SUE_COVER_OK ALL
FPTR_SUE_JRN_EMPTY Not supported
FPTR_SUE_JRN_NEAREMPTY Not supported
FPTR_SUE_JRN_PAPEROK Not supported
FPTR_SUE_REC_EMPTY Not supported
FPTR_SUE_REC_NEAREMPTY Not supported
FPTR_SUE_REC_PAPEROK Not supported
FPTR_SUE_SLP_EMPTY Not supported
FPTR_SUE_SLP_NEAREMPTY Not supported
FPTR_SUE_SLP_PAPEROK Not supported
FPTR_SUE_IDLE Not supported
FPTR_SUE_JRN_COVER_OPEN 7, 8, 9, 10, 11, 12, 13, 20, 21

FPTR_SUE_JRN_COVER_OK 7, 8, 9, 10, 11, 12, 13, 20, 21

FPTR_SUE_REC_COVER_OPEN ALL
FPTR_SUE_REC_COVER_OK ALL
FPTR_SUE_SLP_COVER_OPEN 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13,
17, 18, 20, 21, 23, 24

120 UnifiedPOS User's Guide

Event JavaPOS OPOS
FPTR_SUE_SLP_COVER_OK 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13,
17, 18, 20, 21, 23, 24

Power management support for RS-232 fiscal printers

UPOS offers support to suspend a POS terminal (S3) if an RS232 fiscal printer is in use with
UPOS drivers. To access this feature, use the power brick to power on the fiscal printer.
Note: If you have a power cable attached to the POS terminal, power mangement support for
RS232 fiscal printers is not supported.

JavaPOS configuration

Monitor detection
Detection of a monitor is available in the JavaPOS drivers; it can be sensed by the VGA or Data
port.
Monitors supported:
• USB 4820 SurePoint
• EIA232 4820 SurePoint with Elo touch screen technology
• RS485 4820 SurePoint
• EIA232 SurePOS 500 Family
• EIA232 Anyplace Kiosk Family
• USB 6149 Touch Screen
To change the configuration settings, refer to the posj.properties file and the following
properties:
• com.ibm.posj.FiscalPrinter.MonitorDetection
• com.ibm.posj.FiscalPrinter.EnableDisplaySensing
Note: For EIA232 4820 SurePoint, Windows relies on the touch driver provided by EloTouch Inc.
Tested versions include 4.8.7b and 5.3.

JavaPOS DirectIO calls

The directIO commands in this section are supported for the fiscal printer device. The following
is the correct syntax:

directIO ( command: int32, inout data: int32 , inout obj: object):

void { raises-exception }

To access FiscalPrinter constants, import: com.ibm.jpos.services.*

Fiscal information command

This obtains information about the fiscal device. Valid values are returned only after the first
FISCAL_IPL_END_STATUS event.

Chapter 8. Fiscal printer 121

Table 59. Parameters for FISCAL_INFORMATION subcommand
Parameter Type Value
Command Int32 DirectIO.FISCAL_ID
Data Int32 DirectIO.FISCAL_INFORMATION
Obj Object FiscalInformation Object

Note: For the FiscalInformation object:

• getCountry() returns the Country Code value that is specified in the Fiscal Printer Hardware
Supplements.
• getVersion() returns the microcode version (EC level).
• getFiscalPowerInterrrupted() returns true if the printer was turned off in the middle of
a command; otherwise, it returns false. For more information, refer to the Fiscal Printer
Hardware Supplements available on the Web at .

Fiscal read command

This subcommand reads data from the fiscal device; it should be issued after receiving a
FISCAL_DATA_AVAIL directIOEvent from the fiscal device.

Table 60. Parameters for FISCAL_READ subcommand

Parameter Type Value
Command Int32 com.ibm.jpos.services.DirectIO.FISCAL_ID
Data Int32 com.ibm.jpos.services.DirectIO.FISCAL_READ
Obj Object A byte [ ] to be filled with data.

Note: If a FISCAL_DATA_AVAIL event is received and the application has not read the
previous fiscal data, the old data is replaced by the new incoming data. The next FISCAL_READ
command reads the new data.

Fiscal write command

This writes data to the fiscal device.

Table 61. Parameters for FISCAL_WRITE subcommand

Parameter Type Value
Command Int32 DirectIO.FISCAL_ID
Data Int32 DirectIO.FISCAL_WRITE
Obj Object A byte [ ] with the data to send. The byte [ ] (object parameter)
must contain the exact data to send. This data is a Fiscal
Command without the prefix {X'1B',X'66'}.

Note: DirectIO is a synchronous method and returns successfully when the data is written
to the device. However, command execution is not complete until a FISCAL_STATUS or
FISCAL_ERROR event is received. If another command is submitted before the reception

122 UnifiedPOS User's Guide

of these events, the second command is ignored. This means that there is no buffering of
FISCAL_WRITE subcommands.

Fiscal notify command

This sets fiscal notification On or Off. If fiscal notification is On, every fiscal command returns a
status event to the application.

Table 62. Parameters for FISCAL_NOTIFY subcommand

Parameter Type Value
Command Int32 DirectIO.FISCAL_ID
Data Int32 DirectIO.FISCAL_NOTIFY
Obj Object An Integer object with one of the
following values: DirectIO.FISCAL_NOTIFY_ON or
DirectIO.FISCAL_NOTIFY_OFF

JavaPOS DirectIO events

Fiscal error event

Indicates that a fiscal error has occurred. The DirectIOEvent parameters are shown in Table 63.

Table 63. Parameters for the FISCAL_ERROR event

Parameter Type Value
Event Number Int32 DirectIO.FISCAL_ERROR
Data Int32 Cause of the fiscal error event (Fiscal Printer Command Return
Code).
Obj Object Integer object that indicates the error codes as in the POS
Subsystem (see Table 64). The Integer value is the result of
an OR operation of the current error codes (printer status).

Table 64. Error codes for FISCAL_ERROR event

Error code Value
PosSTATUS_COVER_OPEN X'0001'
PosSTATUS_TRANSPORT_ERROR X'0002'
PosSTATUS_SJ_PAPER_ERROR X'0004'
PosSTATUS_DOCUMENT_AT_FRONT X'0008'
PosSTATUS_DOCUMENT_AT_TOP X'0010'
PosSTATUS_DOCUMENT_READY X'0020'
PosSTATUS_HEAD_PARKED X'0040'

Chapter 8. Fiscal printer 123

Error code Value
PosSTATUS_INSERTED_FORWARD X'0080'
PosSTATUS_ERROR_PENDING X'0100'
PosSTATUS_DI_FRONT_LOAD_ERROR X'0200'
PosSTATUS_DI_TOP_LOAD_ERROR X'0400'
PosSTATUS_PRINTER_ONLINE X'1000'
PosSTATUS_MICR_INSTALLED X'2000'
PosSTATUS_CR_PAPER_LOW X'4000'
PosSTATUS_SJ_PAPER_LOW X'8000'

Fiscal status event

Indicates that the last fiscal command completed successfully. Fiscal notification must be On to
receive these events. The DirectIOEvent parameters are shown in Table 65.

Table 65. Parameters for the FISCAL_STATUS event

Parameter Type Value
Event Number Int32 DirectIO.FISCAL_STATUS
Data Int32 Always 0
Obj Object Integer object that indicates the last command executed. For
example, for the command {X'FF', X'10', '0', '0', '0', '0', '0', '0',
'0', '0', '0', 'F'}, the object returns the value X'FF' (the first byte
indicating the command). For more information, see the Fiscal
Printer Hardware Supplements are available on the Web at .

Fiscal data available event

Indicates that data is available to be read from the fiscal device. The DirectIOEvent parameters
are shown in Table 66.

Table 66. Parameters for the FISCAL_DATA_AVAIL event

Parameter Type Value
Command Int32 DirectIO.FISCAL_DATA_AVAIL
Data Int32 Always 0
Obj Object Integer object that indicates the size in bytes of the data to be
read.

124 UnifiedPOS User's Guide

Fiscal raw status event
RAW_STATUS event is not supported for Fiscal Printer DirectIO in OPOS.

Fiscal IPL end status event

Indicates that the initial program load (IPL) process is complete and that the application can start
sending commands to the fiscal printer.
The directIO parameters are shown in Table 67.

Table 67. Parameters for the FISCAL_IPL_END_STATUS event

Parameter Type Value
Event Number Int32 DirectIO.FISCAL_IPL_END_STATUS
Data Int32 Always 0
Obj Object Always null

Note:
When the Fiscal Printer is reset or powered on, an IPL occurs. During IPL, the printer is not
operational and rejects fiscal commands. In some situations, the IPL process can take more than
one minute.
If the application tries to write a command before it receives a FISCAL_IPL_END_STATUS, the
driver ignores the command.

Additional JavaPOS information

Device sensing
In certain fiscal countries, the fiscal printer must know that one or more devices (such
as displays) are active before completing certain fiscal functions, usually related to totals
accumulation (item sale commands, voucher total commands, etc.). If the required devices are
not active, the fiscal printer will reject the appropriate commands with a failure return code to
the application.
Countries requiring device sense:
• Italy, firmware v16 or higher
• Greece, firmware v09 or higher
Device sensing is disabled by default. To change the configuration
settings, refer to the posj.properties file and the following property: -
com.ibm.posj.FiscalPrinter.EnableDisplaySensing.
By default, Toshiba JavaPOS drivers provide the existence notification of the external displays.
The supported combinations include the following:
1. EIA232 Fiscal Printer Models (4610-1NF only)
The EIA232 Fiscal Printer devices can sense external devices by Toshiba JavaPOS
Multiple external devices sensed:

Chapter 8. Fiscal printer 125

• RS485 Line Display
• USB Line Display
• USB 4820 SurePoint device–Italy only
• RS485 4820 SurePoint device–Italy only
• USB 6149 Touch Screen–Italy only
And only one of:
• RS232 4820 SurePoint touch device–Italy only
• SurePOS 500 Touch screen–Italy only
• AnyPlace Kiosk Touch Screen–Italy only
• TCxWave Touch Screen–Italy only
• TCxFlight Touch Screen–Italy only
2. RS485 Fiscal Printer Models
Italy only: The RS485 Fiscal Printer devices can sense external devices by Toshiba JavaPOS.
External devices sensed:
• RS485 Line Displays
And only one external devices of:
• USB Line Display
• RS232 4820 SurePoint touch device
• USB 4820 SurePoint device
• RS485 4820 SurePoint device
• USB 6149 Touch Screen
3. USB Fiscal Printer Models
The USB Fiscal Printer devices can sense external devices by Toshiba JavaPOS.
Multiple external devices sensed:
• RS485 Line Display
• USB Line Display
• USB 4820 SurePoint device–Italy only
• RS485 4820 SurePoint device–Italy only
• USB 6149 Touch Screen–Italy only
And only one of:
• RS232 4820 SurePoint touch device – Italy only
• SurePOS 500 Touch screen – Italy only
• AnyPlace Kiosk Touch Screen – Italy only
• TCxWave Touch Screen – Italy only
• TCxFlight Touch Screen – Italy only
Refer to the “Monitor detection” on page 121 section for configuration details and supported
hardware.

Fiscal Printer configuration for Turkey

Turkish fiscal regulations require that the following devices to be attached directly to the Fiscal
Printer. In this case, additional configuration is required to support 67-key keyboard attached to
the Fiscal Printer.
1. 2-sided Line Display

126 UnifiedPOS User's Guide

2. USB 67-key POS Keyboard

Setup instructions to support USB 67-key Keyboard for Windows

See the steps below for setup instructions to support USB 67-key Keyboard for Windows.
Note: Steps 2 and 3 are performed at the distribution center during Fiscal Printer configuration.
1. During JavaPOS Driver installation, install the keyboard as a System Attached keyboard by
choosing the following options:
In the "POSKeyboard or SurePoint 4820" dialog box, select the following options:
• Do you want to use POS Keyboard via OPOS/JavaPOS Drivers? Select Yes.
• The Toshiba Alphanumeric Point of Sale Keyboard is attached via: Select Universal
Serial Bus (USB).
2. Send Enable Keyboard Forwarding command to the Fiscal Printer.
3. Set the Keyboard to POS Mode by sending POS Mode command to the Fiscal Printer.

Setup instructions to support USB 67-key Keyboard for Linux

See the steps below for setup instructions to support USB 67-key Keyboard for Linux.
1. In the /opt/tgcs/javapos/etc/posj.properties file, uncomment the
character:com.ibm.posj.bus.hid.javaxusb.factory.kbdAsSystemKbd.13 =
0x06ff,0x4538 line, located under the "USB POSKeyboards as System Keyboards"
section, by deleting the ‘#’ character.
2. Create the ubskbd.conf file as shown below. The file can be empty or contain some text.
/opt/tgcs/javapos/etc/usbkbd.conf
3. Send Enable Keyboard Forwarding command to the Fiscal Printer, as described in
previous section.
4. The Keyboard must remain in “Boot/PC mode”. If not, set keyboard mode to PC/Boot mode.
Note:
1. When 67-key Keyboard is attached to Fiscal Printer, PowerReporting is not supported
by JavaPOS drivers as well as there is no support for downloading Firmware or
Configuration files to the keyboard.
2. The Firmware update and Configuration File update can be done by attaching the
keyboard to the system.

OPOS DirectIO calls

The directIO commands in this section are supported for the fiscal printer device. The following
is the correct syntax:
LONG DirectIO ( LONGCommand, LONG*pData, BSTR*pString);
To access FiscalPrinter constants, include TGCSFPTR.H.
Note: For all operations, use BinaryConversion rather than OPOS_BC_NONE so that data is not
prematurely truncated.

Chapter 8. Fiscal printer 127

Fiscal information command
Obtains information about the fiscal device. Valid values are returned only after the first
FISCAL_IPL_END_STATUS event.

Table 68. Parameters for

Parameter Type Value
Command LONG FISCAL_ID
pData LONG* FISCAL_INFORMATION
pString BSTR* FiscalInformation

Note: The fiscal information is put into the output string as a three-field comma-delimited string,
encoded according to the current binary conversion mode. The ordering of the three fields in the
comma-delimited string is: Country, Power interrupted, Version.

Fiscal read command

This subcommand reads data from the fiscal device and should be issued after receiving a
FISCAL_DATA_AVAIL directIOEvent from the fiscal device.

Table 69. Parameters for FISCAL_READ subcommand

Parameter Type Value
Command LONG FISCAL_ID
pData LONG* FISCAL_READ
pString BSTR* A BSTR to be filled with data.

Note: If a FISCAL_DATA_AVAIL event is received and the application has not read the
previous fiscal data, the old data is replaced by the new incoming data. The next FISCAL_READ
command reads the new data.

Fiscal write command

This subcommand writes data to the fiscal device.

Table 70. Parameters for FISCAL_WRITE subcommand

Parameter Type Value
Command LONG FISCAL_ID
pData LONG* FISCAL_WRITE
pString BSTR* A BSTR with the data to send.
The BSTR must contain the
exact data to send. This data
is a Fiscal Command without
the prefix {X'1B',X'66'}.

128 UnifiedPOS User's Guide

Note: DirectIO is a synchronous method and returns successfully when the data is written
to the device. However, command execution is not complete until a FISCAL_STATUS or
FISCAL_ERROR event is received. If another command is submitted before the reception
of these events, the second command is ignored. This means that there is no buffering of
FISCAL_WRITE subcommands.

Fiscal notify command

Set fiscal notification On or Off. If fiscal notification is On, every fiscal command returns a status
event to the application.

Table 71. Parameters for FISCAL_NOTIFY subcommand

Parameter Type Value
Command LONG FISCAL_ID
pData LONG* FISCAL_ NOTIFY
pString BSTR* The first byte in the string
has one of the following
values: FISCAL_NOTIFY_ON
or FISCAL_NOTIFY_OFF

OPOS DirectIO events

Fiscal error event

Indicates that a fiscal error has occurred. The DirectIOEvent parameters are shown in Table 72.

Table 72. Parameters for the FISCAL_ERROR event

Parameter Type Value
Event Number LONG FISCAL_ ERROR
pData LONG* Cause of the fiscal error event
(Fiscal Printer Command
Return Code).
pString BSTR* Indicates the error codes as
in the POS Subsystem (see
Table 64. The value is a string
of the hex values of an OR
operation of the current error
codes (printer status).

Table 73. Error codes for FISCAL_ERROR event

Error code Value
PosSTATUS_COVER_OPEN X'0001'
PosSTATUS_TRANSPORT_ERROR X'0002'

Chapter 8. Fiscal printer 129

Error code Value
PosSTATUS_SJ_PAPER_ERROR X'0004'
PosSTATUS_DOCUMENT_AT_FRONT X'0008'
PosSTATUS_DOCUMENT_AT_TOP X'0010'
PosSTATUS_DOCUMENT_READY X'0020'
PosSTATUS_HEAD_PARKED X'0040'
PosSTATUS_INSERTED_FORWARD X'0080'
PosSTATUS_ERROR_PENDING X'0100'
PosSTATUS_DI_FRONT_LOAD_ERROR X'0200'
PosSTATUS_DI_TOP_LOAD_ERROR X'0400'
PosSTATUS_PRINTER_ONLINE X'1000'
PosSTATUS_MICR_INSTALLED X'2000'
PosSTATUS_CR_PAPER_LOW X'4000'
PosSTATUS_SJ_PAPER_LOW X'8000'

Fiscal status event

Indicates that the last fiscal command completed successfully. Fiscal notification must be On to
receive these events. The DirectIOEvent parameters are shown in Table 74.

Table 74. Parameters for the FISCAL_STATUS event

Parameter Type Value
Event Number LONG FISCAL_ STATUS
pData LONG* Always 0
pString BSTR* BSTR that indicates the last command
executed. For example, for the command
{X'FF', X'10', '0', '0', '0', '0', '0', '0',
'0', '0', '0', 'F'}, the object returns the
value X'FF' (the first byte indicating the
command). For more information, see
the Fiscal Printer Hardware Supplements
available on the Toshiba Global Commerce
Solutions website: .

Fiscal data available event

Indicates that data is available to be read from the fiscal device. The DirectIOEvent parameters
are shown in Table 75.

130 UnifiedPOS User's Guide

Table 75. Parameters for the FISCAL_DATA_AVAIL event
Parameter Type Value
Event Number LONG FISCAL_ DATA_AVAIL
pData LONG* Always 0
pString BSTR* BSTR that indicates the size in
bytes of the data to be read.

Fiscal raw status event

Indicates status has been received. The directIO parameters are shown in Table 76.

Table 76. Parameters for the FISCAL_RAW_STATUS event

Parameter Type Value
Event Number LONG FISCAL RAW_STATUS
pData LONG* Always 0
pString BSTR* Containing the raw status
data.

Note: The object parameter is filled with bytes reported by the Fiscal Printer Device. The
processing of these bytes must be done according to the Fiscal Printer Hardware Supplements
available on the Toshiba Global Commerce Solutions website: .

Fiscal IPL end status event

Indicates that the initial program load (IPL) process is complete and that the application can start
sending commands to the fiscal printer.
The directIO parameters are shown in Table 77.

Table 77. Parameters for the FISCAL_IPL_END_STATUS event

Parameter Type Value
Event Number LONG FISCAL END_STATUS
pData LONG* Always 0
pString BSTR* Always null

Note: When the fiscal printer is reset or powered on, an IPL occurs. During IPL, the printer
is not operational and rejects fiscal commands. In some situations, the IPL process can take
more than one minute. If the application tries to write a command before it receives a
FISCAL_IPL_END_STATUS, the driver ignores the command.

Chapter 8. Fiscal printer 131

Additional OPOS information

Suspended fiscal transaction

OPOS provides a mechanism to allow non-fiscal lines (prinNormal, getData and

printRecMessage) to be printed even after a printRecSubtotal() method is called. This is done
by buffering the subTotal call until one of the following methods is processed:
printRecItem
printRecItemAdjustment
printRecItemAdjustmentVoid
printRecItemRefund
printRecItemVoid
printRecNotPaid
printRecRefund
printRecSubtotalAdjustment
printRecTotal
printRecVoid
printRecVoidItem
resetPrinter
The function will only be effective when the following property is added to the Windows
registry:

Name
BufferedSubTotal

Type
REG_SZ

Valid Value
• true/TRUE: Enable the buffering of NonFiscal Lines after printRecSubtotal() is called.
• false/FALSE: Disable the function. This is the default value.

Location
HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\FiscalPrinter
\LogicalName
Location for 32 bits application running on 64 bits:
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\OLEforRetail\ServiceOPOS\F
iscalPrinter\LogicalName

Display device sensing

In certain fiscal countries, the fiscal printer must know that one or more devices (such as
displays) are active before completing certain fiscal functions. These functions are usually
related to totals accumulation, such as item sale commands and voucher total commands. If
the required devices are not active, the fiscal printer will reject the appropriate commands with a
failure return code to the application.

132 UnifiedPOS User's Guide

Countries requiring device sense:
• Italy, firmware v16 or higher
• Greece, firmware v09 or higher
Device sensing is enabled by default for both Italy and Greece Fiscal Printers configured in
OPOSConfig. No support is provided for DirectIO printers configured in OPOSConfig.
Italian fiscal regulation requires at least two displays and Greek fiscal regulation requires at least
one display to be connected to either the system or printer to perform a transaction. Table 78
contains information on the display devices supported by this functionality.
Note: The fiscal printers noted here have the following limitations:
• KR3/KR5 Models (RS-485, Italy): Only one external display device connected to the POS
system can be detected.
• KD3/KD5 Models (RS-232, Italy): Two displays must be sensed, and both displays must be
attached either to the POS or to the printer. No mix is allowed.

Table 78. Supported display devices

Connectivity Display device Notes
EIA232 SurePOS 500 2x20 displays The following registry* must to be set:
Name: IntegratedDisplay
Type: REG_SZ
Value: True; treat SurePOS 500 2x20
displays as Integrated Display for Fiscal
Printer display sensing (Italy)
This setting is for SurePOS 500 system-attached
2x20 displays only.
USB • Line Display 2x20 one- A two-sided line display is considered two
sided/two-sided, APA display devices.
• 6149 Touch Screen
Display devices can also
connected to AnyPlace
POS Hub

RS485 Line Display 2x20 one- A two-sided line display is considered two
sided/two-sided, APA display devices.

System • AnyPlace Kiosk Family

Integrated • TCxWave Touch Screen
Display
• TCxFlight Touch Screen

Data port 4820 SurePoint with Elo The following registry^ can be set:
(RS232) touch screen technology
Name: EloMonitorPollTime
(RS232)
Type: REG_DWORD
Value: Contains the interval (in
milliseconds) between the polling of the Elo
Monitor
Default/Not present: 2000
When a 4820 SurePoint display device is
connected to the system via data port (RS232),
do not configure the VGA/DisplayPort any
further.

Chapter 8. Fiscal printer 133

Connectivity Display device Notes
Data port (USB) 4820 SurePoint (USB) When a 4820 SurePoint display device is
connected to the system via data port (USB),
it is automatically sensed as one of the
valid displays. Do not configure the VGA/
DisplayPort any further.
Generic display devices connected via USB
can still be detected by setting the vendorId
and productId of the device in the following
registry^:
Name: MonitorDevices
Type: REG_SZ
Value:
vendorID<1>,productID<1>;vendorID<2>,
productID<2>;...vendorID<n>,productID<n>;
The vendorID and productID are separated
by a comma and each device is separated
by a semicolon. There is no whitespace
between each. Put hex value prefixed by '0x'.

VGA/ General VGA/Display Note: For systems running Microsoft Windows

DisplayPort monitors 7 and above only.
The following registry^ must be set:
Name: DisplaySenseMonitor
Type: REG_SZ
Value: Contains the Hardware ID of the
monitor to be detected. The Hardware ID
can be found in the properties of the
monitor in Device Manager. For example,
if the Hardware ID of the monitor is
"MONITOR\TOS1234", "TOS1234" should
be set in the "DisplaySenseMonitor" registry.
The polling interval can be set from the
following registry^:
Name: VideoCableMonitorPollTime
Type: REG_DWORD
Value: Contains the interval (in
milliseconds) between the polling of the
video cable monitor
Default/Not present: 1000

*The registry path is

HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\FiscalPrinter\Log
icalName.
^The registry path is
HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\FiscalPrinter.

Note:
• GB3/KB3/KB5 (USB, Greece): Display sensing is not required for USB Greece fiscal printer.
• KR3/KR5 (RS485, Greece): Display sensing with two line displays (or one two-sided line
display) is required. The line displays must be RS485 VFD or LCD displays and must be

134 UnifiedPOS User's Guide

attached to the POS system, not to the printer. Do not attach an external line display with
other buses (USB, RS232) to the system as well; only RS485 line displays can be attached to
the system.

OPOS getData method (fiscal printer: Italy)

Table 79. Parameter support status and value for fiscal printer getData method (Italy)
Supporte
Description dataItem optArgs Data d?

Identification data

Get the Fiscal Printer’s FPTR_GD_FIRMWARE Not used Value is set by the Y
firmware release number. method

Get the Fiscal Printer’s FPTR_GD_PRINTER_ID Not used Value is set by the Y
fiscal ID. method

Totals

Get the current receipt FPTR_GD_CURRENT_TOTAL Not used Value is set by the Y
total. method

Get the daily total. FPTR_GD_DAILY_TOTAL Not used Value is set by the Y
method

Get the Fiscal Printer’s FPTR_GD_GRAND_TOTAL N

grand total.

Get the total number of FPTR_GD_MID_VOID Not used Value is set by the Y
voided receipts. method

Get the current total of not FPTR_GD_NOT_PAID Not used Value is set by the Y
paid receipts. method

Get the number of fiscal FPTR_GD_RECEIPT_NUMBER Not used Value is set by the Y
receipts printed. method

Get the current total of FPTR_GD_REFUND Not used Value is set by the Y
refunds. method

Get the current total of FPTR_GD_REFUND_VOID N

voided refunds.

Fiscal memory counts

Get the grand number of FPTR_GD_NUMB_CONFIG_BLOCK N

configuration blocks.

Get the grand number of FPTR_GD_NUMB_CURRENCY_BLOCK N

currency blocks.

Get the grand number of FPTR_GD_NUMB_HDR_BLOCK N

header blocks.

Get the grand number of FPTR_GD_NUMB_RESET_BLOCK N

reset blocks.

Chapter 8. Fiscal printer 135

Supporte
Description dataItem optArgs Data d?

Get the grand number of FPTR_GD_NUMB_VAT_BLOCK N

VAT blocks.

Counter

Get the number of daily FPTR_GD_FISCAL_DOC N

fiscal documents.

Get the number of daily FPTR_GD_FISCAL_DOC_VOID N

voided fiscal documents.

Get the number of daily FPTR_GD_FISCAL_REC Not used Value is set by the Y
fiscal sales receipts. method

Get the number of daily FPTR_GD_FISCAL_REC_VOID Not used Value is set by the Y
voided fiscal sales receipts. method

Get the number of daily FPTR_GD_NONFISCAL_DOC Not used Value is set by the Y
non fiscal documents. method

Get the number of FPTR_GD_NONFISCAL_DOC_VOID N

daily voided non fiscal
documents.

Get the number of daily FPTR_GD_NONFISCAL_REC Not used Value is set by the Y
non fiscal receipts. method

Get the Fiscal Printer’s FPTR_GD_RESTART Not used Value is set by the Y
restart count method

Get the number of daily FPTR_GD_SIMP_INVOICE N

simplified invoices.

Get the Z report number. FPTR_GD_Z_REPORT Not used Value is set by the Y
method

Fixed fiscal printer text

Get the payment FPTR_GD_TENDER FPTR_PDL_CASH N

description used in the
printRecTotal method, FPTR_PDL_CHEQUE

defined by the given

FPTR_PDL_CHITTY
identifier in the optArgs
argument. Valid only if the
FPTR_PDL_COUPON
CapPredefinedPaymentLin
es property is true. FPTR_PDL_CURRENCY

FPTR_PDL_DRIVEN_OFF

FPTR_PDL_EFT_IMPRINTER

FPTR_PDL_EFT_TERMINAL

FPTR_PDL_TERMINAL_IMPRINTER

FPTR_PDL_FREE_GIFT

FPTR_PDL_GIRO

FPTR_PDL_HOME

136 UnifiedPOS User's Guide

Supporte
Description dataItem optArgs Data d?

FPTR_PDL_IMPRINTER_WITH_ISSUE
R

FPTR_PDL_LOCAL_ACCOUNT

FPTR_PDL_LOCAL_ACCOUNT_CAR
D

FPTR_PDL_PAY_CARD

FPTR_PDL_PAY_CARD_MANUAL

FPTR_PDL_PREPAY

FPTR_PDL_PUMP_TEST

FPTR_PDL_SHORT_CREDIT

FPTR_PDL_STAFF

FPTR_PDL_VOUCHER

Linecounter

Get the number of printed FPTR_GD_LINECOUNT FPTR_LC_ITEM N

lines, defined by the
given identifier in the FPTR_LC_ITEM_VOID

optArgs argument. If
FPTR_LC_DISCOUNT
the CapMultiContractor
property is true, line
FPTR_LC_DISCOUNT_VOID
counters depend on the
contractor defined by the FPTR_LC_SURCHARGE
ContractorId property.
FPTR_LC_SURCHARGE_VOID

FPTR_LC_REFUND

FPTR_LC_REFUND_VOID

FPTR_LC_SUBTOTAL_DISCOUNT

FPTR_LC_SUBTOTAL_DISCOUNT_VO
ID

FPTR_LC_SUBTOTAL_SURCHARGE

FPTR_LC_SUBTOTAL_SURCHARGE_
VOID

FPTR_LC_COMMENT

FPTR_LC_SUBTOTAL

FPTR_LC_TOTAL

Description length

Get the maximum number FPTR_GD_DESCRIPTION_LENGTH FPTR_DL_ITEM Value is set by the Y

of characters that may be method
passed as a description FPTR_DL_ITEM_ADJUSTMENT

Chapter 8. Fiscal printer 137

Supporte
Description dataItem optArgs Data d?

parameter for a specific FPTR_DL_ITEM_FUEL

method, defined by the
ContractorId property. FPTR_DL_ITEM_FUEL_VOID

FPTR_DL_NOT_PAID

FPTR_DL_PACKAGE_ADJUSTMENT

FPTR_DL_REFUND

FPTR_DL_REFUND_VOID

FPTR_DL_SUBTOTAL_ADJUSTMENT

FPTR_DL_TOTAL

FPTR_DL_VOID

Additional to UPOS

Print barcode FPTR_GD_PRINT_BARCODE Not used Width (1 char) Y

Minimum : 2
Maximum : 4
Height (3 char)
Minimum : 1
Maximum : 255
Default : 162
- HRIfont()
1 : 12 CPI
2 : 15CPI
- HRI location
11 : Over and under the
barcode
10 : Under the barcode
01 : Over the barcode
00 : HRI not printed
- Barcode type
1000 : CODE93
0111 : CODE128 C
0110 : CODABAR
0101 : ITF
0100 : CODE39
0011 : JAN8
0010 : JAN13
0001 : UPC_E
0000 : UPC_A
- Barcode data
Any length and
only numbers and
alphabetic characters

Print logo FPTR_GD_PRINT_LOGO OptArgs[0] = logo Not used Y

OptArgs[1] = DPI

Cut receipt FPTR_GD_CUT_RECEIPT Not used Not used Y

138 UnifiedPOS User's Guide

Supporte
Description dataItem optArgs Data d?

Set manual cut FPTR_GD_MANUAL_CUT 0: set m_bManualCut to false Not used Y

1: set m_bManualCut to true

Set emphasized font FPTR_GD_EMPHASIZED_FONT 0: set m_bEmphasizedFont to false Not used Y

1: set m_bEmphasizedFont to true

Set print total 0 FPTR_GD_PRINT_TOT_0 0: set m_bprintTot0 to false Not used Y

1: set m_bprintTot0 to true

Get device ID FPTR_GD_DEVICE_ID Not used Value is set by the Y

method

Get credit note number FPTR_GD_CREDIT_NOTE_NUM Not used Value is set by the Y
method

Get credit note total FPTR_GD_CREDIT_NOTE_TOT Not used Value is set by the Y
method

Get discounts FPTR_GD_DISCOUNTS Not used Value is set by the Y

method

Get electronic journal free FPTR_GD_EJ_FREE_SPACE Not used Value is set by the Y
space method

OPOS getData method (fiscal printer: Greece)

Table 80. Parameter support status and value for fiscal printer getData method (Greece)
Support
Description dataItem optArgs Data ed?

Identification data

Get the Fiscal Printer’s firmware FPTR_GD_FIRMWARE Not used Value is Y

release number. set by the
method

Get the Fiscal Printer’s fiscal ID. FPTR_GD_PRINTER_ID Not used Value is Y
set by the
method

Totals

Get the current receipt total. FPTR_GD_CURRENT_TOTAL Not used Value is Y

set by the
method

Value is set by the method FPTR_GD_DAILY_TOTAL Not used Value is Y

set by the
method

Chapter 8. Fiscal printer 139

Support
Description dataItem optArgs Data ed?

Get the Fiscal Printer’s grand total. FPTR_GD_GRAND_TOTAL Not used Value is Y
set by the
method

Get the total number of voided FPTR_GD_MID_VOID Not used Value is Y

receipts. set by the
method

Get the current total of not paid FPTR_GD_NOT_PAID N

receipts.

Get the number of fiscal receipts FPTR_GD_RECEIPT_NUMBER Not used Value is Y

printed. set by the
method

Get the current total of refunds. FPTR_GD_REFUND Not used Value is Y

set by the
method

Get the current total of voided FPTR_GD_REFUND_VOID Not used Value is Y

refunds. set by the
method

Fiscal memory counts

Get the grand number of FPTR_GD_NUMB_CONFIG_BLOCK N

configuration blocks.

Get the grand number of currency FPTR_GD_NUMB_CURRENCY_BLOCK N

blocks.

Get the grand number of header FPTR_GD_NUMB_HDR_BLOCK N

blocks.

Get the grand number of reset FPTR_GD_NUMB_RESET_BLOCK N

blocks.

Get the grand number of VAT FPTR_GD_NUMB_VAT_BLOCK N

blocks.

Counter

Get the number of daily fiscal FPTR_GD_FISCAL_DOC N

documents.

Get the number of daily voided FPTR_GD_FISCAL_DOC_VOID N

fiscal documents.

Get the number of daily fiscal sales FPTR_GD_FISCAL_REC Not used Value is Y
receipts. set by the
method

Get the number of daily voided FPTR_GD_FISCAL_REC_VOID Not used Value is Y

fiscal sales receipts. set by the
method

Get the number of daily non fiscal FPTR_GD_NONFISCAL_DOC N

documents.

140 UnifiedPOS User's Guide

Support
Description dataItem optArgs Data ed?

Get the number of daily voided FPTR_GD_NONFISCAL_DOC_VOID N

non fiscal documents.

Get the number of daily non fiscal FPTR_GD_NONFISCAL_REC N

receipts.

Get the Fiscal Printer’s restart FPTR_GD_RESTART Not used Value is Y

count set by the
method

Get the number of daily simplified FPTR_GD_SIMP_INVOICE N

invoices.

Get the Z report number. FPTR_GD_Z_REPORT Not used Value is Y

set by the
method

Fixed fiscal printer text

Get the payment description used FPTR_GD_TENDER FPTR_PDL_CASH N

in the printRecTotal method,
defined by the given identifier in FPTR_PDL_CHEQUE

the optArgs argument.Valid only

FPTR_PDL_CHITTY
if the CapPredefinedPaymentLines
property is true.
FPTR_PDL_COUPON

FPTR_PDL_CURRENCY

FPTR_PDL_DRIVEN_OFF

FPTR_PDL_EFT_IMPRINTER

FPTR_PDL_EFT_TERMINAL

FPTR_PDL_TERMINAL_IMPRINTER

FPTR_PDL_FREE_GIFT

FPTR_PDL_GIRO

FPTR_PDL_HOME

FPTR_PDL_IMPRINTER_WITH_ISSUER

FPTR_PDL_LOCAL_ACCOUNT

FPTR_PDL_LOCAL_ACCOUNT_CARD

FPTR_PDL_PAY_CARD

FPTR_PDL_PAY_CARD_MANUAL

FPTR_PDL_PREPAY

FPTR_PDL_PUMP_TEST

FPTR_PDL_SHORT_CREDIT

FPTR_PDL_STAFF

FPTR_PDL_VOUCHER

Chapter 8. Fiscal printer 141

Support
Description dataItem optArgs Data ed?

Linecounter

Get the number of printed lines, FPTR_GD_LINECOUNT FPTR_LC_ITEM N

defined by the given identifier
in the optArgs argument. If the FPTR_LC_ITEM_VOID

CapMultiContractor property is
FPTR_LC_DISCOUNT
true, line counters depend on
the contractor defined by the
FPTR_LC_DISCOUNT_VOID
ContractorId property.
FPTR_LC_SURCHARGE

FPTR_LC_SURCHARGE_VOID

FPTR_LC_REFUND

FPTR_LC_REFUND_VOID

FPTR_LC_SUBTOTAL_DISCOUNT

FPTR_LC_SUBTOTAL_DISCOUNT_VOI
D

FPTR_LC_SUBTOTAL_SURCHARGE

FPTR_LC_SUBTOTAL_SURCHARGE_V
OID

FPTR_LC_COMMENT

FPTR_LC_SUBTOTAL

FPTR_LC_TOTAL

Description length

Get the maximum number of FPTR_GD_DESCRIPTION_LENGTH FPTR_DL_ITEM Value is Y

characters that may be passed set by the
as a description parameter for a FPTR_DL_ITEM_ADJUSTMENT method
specific method, defined by the
FPTR_DL_ITEM_FUEL
ContractorId property.

FPTR_DL_ITEM_FUEL_VOID

FPTR_DL_NOT_PAID

FPTR_DL_PACKAGE_ADJUSTMENT

FPTR_DL_REFUND

FPTR_DL_REFUND_VOID

FPTR_DL_SUBTOTAL_ADJUSTMENT

FPTR_DL_TOTAL

FPTR_DL_VOID

FPTR_DL_VOID_ITEM

Additional to UPOS

142 UnifiedPOS User's Guide

Support
Description dataItem optArgs Data ed?

Cut receipt FPTR_GD_CUT_RECEIPT Not used Not used Y

Set manual cut FPTR_GD_MANUAL_CUT 0: set m_bManualCut to false Not used Y

1: set m_bManualCut to true

Get credit note number FPTR_GD_CREDIT_NOTE_NUM Not used Value is Y

set by the
method

Get credit note total FPTR_GD_CREDIT_NOTE_TOT Not used Value is Y

set by the
method

Get discounts FPTR_GD_DISCOUNTS Not used Value is Y

set by the
method

OPOS getTotalizer method (fiscal printer: Greece)

Table 81. Parameter support status and value for fiscal printer getTotalizer method (Greece)
Support
optArgs vatID Data ed?

TotalizerType

FPTR_GT_GROSS FPTR_TT_RECEIPT 1-5 Value is set by the Y

method

FPTR_TT_DAY 1-5 Value is set by the Y

method

FPTR_TT_GRAND Not used Value is set by the Y

method

FPTR_GT_NET FPTR_TT_RECEIPT Not used Value is set by the Y

method

FPTR_TT_DAY Not used Value is set by the Y

method

FPTR_TT_GRAND Not used Value is set by the Y

method

FPTR_GT_DISCOUNT FPTR_TT_RECEIPT Not used Value is set by the Y

method

FPTR_TT_DAY Not used Value is set by the Y

method

FPTR_TT_GRAND N

FPTR_GT_DISCOUNT_VOID FPTR_TT_RECEIPT Not used Value is set by the Y

method

Chapter 8. Fiscal printer 143

Support
optArgs vatID Data ed?

FPTR_TT_DAY Not used Value is set by the Y

method

FPTR_TT_GRAND N

FPTR_GT_ITEM FPTR_TT_RECEIPT Not used Value is set by the Y

method

FPTR_TT_DAY Not used Value is set by the Y

method

FPTR_TT_GRAND N

FPTR_GT_ITEM_VOID FPTR_TT_RECEIPT Not used Value is set by the Y

method

FPTR_TT_DAY Not used Value is set by the Y

method

FPTR_TT_GRAND N

FPTR_GT_NOT_PAID FPTR_TT_RECEIPT N

FPTR_TT_DAY N

FPTR_TT_GRAND N

FPTR_GT_REFUND FPTR_TT_RECEIPT Not used Value is set by the Y

method

FPTR_TT_DAY Not used Value is set by the Y

method

FPTR_TT_GRAND N

FPTR_GT_REFUND_VOID FPTR_TT_RECEIPT Not used Value is set by the Y

method

FPTR_TT_DAY Not used Value is set by the Y

method

FPTR_TT_GRAND N

FPTR_GT_SUBTOTAL_DISCOUNT FPTR_TT_RECEIPT Not used Value is set by the Y

method

FPTR_TT_DAY Not used Value is set by the Y

method

FPTR_TT_GRAND N

FPTR_GT_SUBTOTAL_DISCOUNT_VOID FPTR_TT_RECEIPT Not used Value is set by the Y

method

FPTR_TT_DAY Not used Value is set by the Y

method

FPTR_TT_GRAND N

FPTR_GT_SUBTOTAL_SURCHARGES FPTR_TT_RECEIPT Not used Value is set by the Y

method

144 UnifiedPOS User's Guide

Support
optArgs vatID Data ed?

FPTR_TT_DAY Not used Value is set by the Y

method

FPTR_TT_GRAND N

FPTR_GT_SUBTOTAL_SURCHARGES_V FPTR_TT_RECEIPT Not used Value is set by the Y

OID method

FPTR_TT_DAY Not used Value is set by the Y

method

FPTR_TT_GRAND N

FPTR_GT_SURCHARGE FPTR_TT_RECEIPT Not used Value is set by the Y

method

FPTR_TT_DAY Not used Value is set by the Y

method

FPTR_TT_GRAND N

FPTR_GT_SURCHARGE_VOID FPTR_TT_RECEIPT Not used Value is set by the Y

method

FPTR_TT_DAY Not used Value is set by the Y

method

FPTR_TT_GRAND N

FPTR_GT_VAT FPTR_TT_RECEIPT Not used Value is set by the Y

method

FPTR_TT_DAY Not used Value is set by the Y

method

FPTR_TT_GRAND Not used Value is set by the Y

method

FPTR_GT_VAT_CATEGORY FPTR_TT_RECEIPT 1-5 Value is set by the Y

method

FPTR_TT_DAY N

FPTR_TT_GRAND 1-5 Value is set by the Y

method

Fiscal Printer Configuration for Turkey

Turkish fiscal regulations require that the following devices to be attached directly to the Fiscal
Printer. In this case, additional configuration is required to support 67-key keyboard attached to
the Fiscal Printer.
1. 2-sided Line Display
2. USB 67-key POS Keyboard

Chapter 8. Fiscal printer 145

Setup instructions to support USB 67-key Keyboard for Windows

See the steps below for setup instructions to support USB 67-key Keyboard for Windows.
Note: Steps 2 and 3 are performed at the distribution center during Fiscal Printer configuration.
1. During OPOS Driver installation, install the keyboard as a System Attached keyboard by
choosing the following options:
In the "POSKeyboard or SurePoint 4820" dialog box, select the following options:
• Do you want to use POS Keyboard via OPOS/JavaPOS Drivers? Select Yes.
• The Toshiba Alphanumeric Point of Sale Keyboard is attached via: Select Universal
Serial Bus (USB).
2. Send Enable Keyboard Forwarding command to the Fiscal Printer.
3. Set the Keyboard to POS Mode by sending POS Mode command to the Fiscal Printer.
Note:
1. When 67-key Keyboard is attached to Fiscal Printer, PowerReporting is not supported
by OPOS drivers as well as there is no support for downloading Firmware or
Configuration files to the keyboard.
2. The Firmware update and Configuration File update can be done by attaching the
keyboard to the system.

146 UnifiedPOS User's Guide

Chapter 9. Hard totals
Hard totals

Hard totals supported devices

Table 82. Hard totals supported devices
Device Connectivity
1. 4694 NVRAM Integrated
2. SurePOS 700 Series NVRAM Integrated
3. SureOne built-in NVRAM (excluding A04/A05 models) Integrated
4. SurePOS 300 4810-35x Not supported
5. TCx 300 Series 4810-3x1 Integrated
6. TCx 700 Series NVRAM Integrated

Supported properties and methods

Table 83. Hard totals common properties
Property JavaPOS OPOS
AutoDisable Not supported
BinaryConversion Not supported All
CapCompareFirmwareVersion False
CapPowerReporting PR_NONE All support STANDARD
CapStatisticsReporting True (see Appendix A, JavaPOS False
support for UnifiedPOS device
statistics properties on page 555)
CapUpdateFirmware False
CapUpdateStatistics False (see Appendix A, JavaPOS False
support for UnifiedPOS device
statistics properties on page 555)
CheckHealthText All
Claimed All
DataCount Not supported
DeviceEventEnabled Not supported All
DeviceControlDescription All
DeviceControlVersion All
DeviceEnabled All
DeviceServiceDescription All

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 147

Property JavaPOS OPOS
DeviceServiceVersion All
FreezeEvents All
OpenResult All
OutputID Not supported All
PowerNotify PN_DISABLED All
PowerState PS_UNKNOWN All
PhysicalDeviceDescription All
PhysicalDeviceName All
ResultCode All
ResultCodeExtended All
State All

Table 84. Hard totals specific properties

Property JavaPOS OPOS
CapErrorDetection Not supported
CapSingleFile All
CapTransactions Not supported
FreeData All
NumberOfFiles Maximum of 1 file
TotalsSize All
TransactionInProgress Always false

Table 85. Hard totals common methods

Method JavaPOS OPOS
checkHealth All
claim All
clearInput Not supported
clearOutput Not supported
close All
compareFirmwareVersion Not supported
directIO Not supported
open All
release All
resetStatistics Not supported

148 UnifiedPOS User's Guide

Method JavaPOS OPOS
retrieveStatistics True (see Appendix A, JavaPOS Not supported
support for UnifiedPOS device
statistics properties on page 555)
updateFirmware Not supported
updateStatistics Not supported

Table 86. Hard totals specific methods

Method JavaPOS OPOS
beginTrans Not supported
claimFile All
commitTrans Not supported
create All
delete All
find All
findByIndex All
releaseFile All
read All
recalculateValidationData Not supported
rename Not supported
rollback Not supported
setAll All
validateData Not supported
write All

Table 87. Hard totals events

Event JavaPOS OPOS
DirectIOEvent Not supported
StatusUpdateEvent All

OPOS configuration
Note: These settings cannot be modified with the Configuration tool.
In order to apply the configurations shown below, create the keyword of the specified type into
the following windows registry:
-
HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\HardTotals\Logical
Name
Note: For 32 bits Application running on 64 bits Windows use the following path instead:

Chapter 9. Hard totals 149

-
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\OLEforRetail\ServiceOPOS\HardTo
tals\LogicalName
"LogicalName" refers to the actual device logical name given by end user at configuration time.

Table 88. Service object settings for hard totals

Keyword Type Description
UseHarddiskFile String Enables use of file on hard drive for Hard Totals. Valid
values are:

True
Use hard disk

False
Do not use hard disk (default)
HarddiskFileName String Path name of file to use for Hard Totals storage on hard
disk.
HarddiskFileSize String Size (in bytes) of file used for Hard Totals Storage on hard
disk.

150 UnifiedPOS User's Guide

Chapter 10. Keylock
Keylock

Supported devices
Table 89. Keylock supported devices
Device Connectivity
Two-position 1. Retail alphanumeric POS keyboard with card reader PS/2, RS-485, USB
Two-position 2. Retail alphanumeric POS keyboard with MSR and pointing PS/2
device
Two-position 3. Retail POS keyboard RS-485, USB
Two-position 4. Retail POS keyboard with card reader RS-485, USB
Two-position 5. Retail POS keyboard with card reader and display RS-485, USB
Two-position 6. Modifiable layout keyboard with card reader RS-485, USB
Two-position 7. SurePoint 4820 integrated keylock RS-485, USB
Three-position 8. SureOne integrated keyboard PS/2
Four-position 9. POS keyboard V RS-485, USB
Four-position 10. PC POS keyboard or PC Point of Sale keyboard PS/2, RS-485, USB
Four-position 11. Retail POS keyboard VI RS-485, USB
Three-position 12. SurePOS 100 integrated keyboard PS/2
Five-position 13. 4674 Integrated keyboard RS-485
Four-position 14. 4685-KC1 (OPOS only) RS-485
Four-position 15. 4685-K01 (OPOS only) RS-485
Four-position 16. 4685-K02 (Ultra7) keyboard with card reader RS-485, USB
Four-position 17. 4685-K02 with MSR/Encoder and 4 position keylock USB
Six-position 18. 4685-K02 with MSR/Encoder and 6 position keylock USB
Four-position 19. 4685-K03 RS-485,USB
Two-position/ PS/2, USB
20. Modular alphanumeric keyboard
Four-position
Two-position/ PS/2, USB
21. Modular Compact alphanumeric keyboard
Four-position
Two-position/ PS/2, USB
22. Modular 67 Key keyboard
Four-position
Two-position 23. Modular 67 Key keyboard with Display and Keylock USB PS/2, USB
Electronic 24. TCxWave Electronic Keylock USB
Two-position 25. 4820 Integrated Keylock USB
Electronic 26. 4820 Integrated Electronic Keylock USB

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 151

Device Connectivity
Two-position 27. 6149 Integrated keylock USB

The JavaPOS driver returns predetermined UnifiedPOS values for each keylock position. The
OPOS driver generally allows the user to configure each key position to a different meaning.
For a two-position keylock, the OPOS driver can either return a predetermined UnifiedPOS
value or the raw hardware value for each keylock position, which the application can then
interpret as necessary.
For a three-position keylock, the OPOS driver returns predetermined UnifiedPOS values for
each keylock position.
For four-, five-, and six-position keylocks, the OPOS driver allows you to map the raw hardware
value to any UnifiedPOS value. This means that the driver can associate a physical key position
with whatever UnifiedPOS value required.
For keylocks that contain more than the three positions that the UnifiedPOS standard provides,
the drivers report those higher positions as a unique value. Table 90 describes the three standard
positions in the UnifiedPOS standard.

Table 90. UnifiedPOS keylock standards

Position Value returned
LOCK_KP_LOCK 1
LOCK_KP_NORM 2
LOCK_KP_SUPR 3

Two-position (devices 1, 2, 3, 4, 5, 6, 20, 21, 22, 23, 27)

1

Figure 15. Two-position keylock

Position JPOS value OPOS mapped value OPOS raw value

1 LOCK_KP_NORM LOCK_KP_NORM 2
2 LOCK_KP_SUPR LOCK_KP_SUPR 1

152 UnifiedPOS User's Guide

Two-position (devices 7, 25)

Figure 16. 4820 Two-position keylock

Position JPOS value OPOS mapped value OPOS raw value

Lock (1) LOCK_KP_NORM LOCK_KP_NORM 2
Unlock (2) LOCK_KP_SUPR LOCK_KP_SUPR 1

Three-position keylock (devices 8, 12)

Figure 17. SureOne three-position keylock

Figure 18. SurePOS 100 three-position keylock

Chapter 10. Keylock 153

Position JPOS value OPOS mapped value
LOCK LOCK_KP_LOCK LOCK_KP_LOCK
1 LOCK_KP_NORM LOCK_KP_NORM
2 LOCK_KP_SUPR LOCK_KP_SUPR

Four-position (devices 9, 10, 11, 14, 15, 16, 17, 19)

2
1 3

Figure 19. Four-position keylock

Position JPOS value OPOS mapped value OPOS raw value

1 4 4
2 LOCK_KP_LOCK 3
Configured by user
3 LOCK_KP_NORM 2
4 LOCK_KP_SUPR 1

Four-position (devices 20, 21, 22)

Figure 20. Four-position keylock

Position JPOS value OPOS mapped value OPOS raw value

3 4 4
Lock LOCK_KP_LOCK 3
Configured by user
1 LOCK_KP_NORM 2
2 LOCK_KP_SUPR 1

154 UnifiedPOS User's Guide

Five-position (device 13)
2
1 3
4

Figure 21. Five-position keylock

Position JPOS value OPOS mapped value OPOS raw value

1 5 5
2 LOCK_KP_LOCK 3
3 LOCK_KP_NORM Configured by user 2
4 LOCK_KP_SUPR 1
5 4 4

Six-position (device 18)

1 2
3
Off
4

5
6
Figure 22. Six-position keylock

Position JPOS value OPOS mapped value OPOS raw value

1 LOCK_KP_LOCK 3
2 LOCK_KP_NORM 2
3 5 5
Configured by user
4 6 6
5 LOCK_KP_SUPR 1
6 4 4

Chapter 10. Keylock 155

Electronic keylock (iButton)
The iButton is supported through the Keylock Device Category of the UnifiedPOS Standards. It
behaves just like keylock, except the application reads keylock data from ElectronicKeyValue
instead of the KeyPosition property.
The Electronic Keylock supports the following properties:

CapKeylockType:
Set to LOCK_KT_ELECTRONIC

ElectronicKeyValue:
Contains 8 bytes of hexadecimal data of the iButton
• When iButton is connected: XX XX XX XX XX XX XX XX
• When iButton is disconnected: 00 00 00 00 00 00 00 00
• When iButton value can not be read: E_FAILURE

KeyPosition:
This property has no meaning for Electronic Keylock

Methods associated:
waitForKeylockChange( )

StatusUpdateEvent:
LOCK_KP_ELECTRONIC event is fired when iButton is connected and disconnected
Configuration:
• OPOS: Use the OPOS Configuration Tool to configure an iButton device under the Keylock
category.
• JavaPOS: Use the POS Control Center to generate new JposEntry (jpos.xml) for iButton.

Supported properties and methods

Table 91. Keylock common properties
Property JavaPOS OPOS
AutoDisable Not supported
BinaryConversion Not supported All
CapCompareFirmwareVersion False
CapPowerReporting PR_NONE for EIA-232, PR_STANDARD
PS/2 and embedded
PR_STANDARD for all
other keylock devices

CapStatisticsReporting True (see Appendix False

A, JavaPOS support
for UnifiedPOS device
statistics properties on
page 555)

156 UnifiedPOS User's Guide

Property JavaPOS OPOS
CapUpdateFirmware False
CapUpdateStatistics False (see Appendix False
A, JavaPOS support
for UnifiedPOS device
statistics properties on
page 555)
CheckHealthText All
Claimed All
DataCount Not supported
DataEventEnabled Not supported
DeviceControlDescription All
DeviceControlVersion All
DeviceEnabled All
DeviceServiceDescription All
DeviceServiceVersion All
FreezeEvents All
OpenResult Not supported
OutputID Not supported
PowerNotify All
PowerState All
PhysicalDeviceDescription All
PhysicalDeviceName All
State All

Table 92. Keylock specific properties

Property JavaPOS OPOS
CapKeylockType All
ElectronicKeyValue 24, 26
KeyPosition All
PositionCount All

Table 93. Keylock common methods

Method JavaPOS OPOS
checkHealth All
claim Always shareable

Chapter 10. Keylock 157

Method JavaPOS OPOS
clearInput Not supported
clearOutput Not supported
close All
compareFirmwareVersion Not supported
directIO Not supported
open All
release Always shareable
resetStatistics Not supported
retrieveStatistics True (see Appendix Not supported
A, JavaPOS support
for UnifiedPOS device
statistics properties on
page 555)
updateFirmware Not supported
updateStatistics Not supported

Table 94. Keylock specific methods

Method JavaPOS OPOS
waitForKeylockChange All

Table 95. Keylock events

Event JavaPOS OPOS
DirectIOEvent Not supported
StatusUpdateEvent All

JavaPOS configuration

PositionCount
<prop name="com.ibm.jpos.sdi.config.Keylock.PositionCount" type="String" value="4"/>

For some Toshiba keylocks, the number of keylock positions cannot be reliably determined:
• RS-485 4685-K03: four positions
• RS-485 4685-K02 Keyboard with MSR Encoder: six positions
In these situations, use the PositionCount property to define the number of keylock positions.

Values accepted
Any value on Integer range

158 UnifiedPOS User's Guide

Device support
All

OPOS configuration
In order to apply the configurations shown below, create the keyword of the specified type into
the following windows registry:
-
HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\Keylock\LogicalNam
e
Note: For 32 bits Application running on 64 bits Windows use the following path instead:
-
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\OLEforRetail\ServiceOPOS\Keyloc
k\LogicalName
"LogicalName" refers to the actual device logical name given by end user at configuration time.

Table 96. Service Object settings for keylock

Keyword Type Description
SecondKeyPosition String When present, the additional position on the
Japanese ANPOS keyboard is mapped to a
LOCK_KP_LOCK.
PositionCount DWORD 4685-K02 only. Number of keylock positions (1-6).
PositionMapFrom Binary 4685-K02 only. Keylock position code mapping
(from).
PositionMapTo Binary 4685-K02 only. Keylock position code mapping
(to).
LetLastKeepAcquired String Allows the last interface to access the physical POS
keyboard interface to keep the device acquired
instead of passing it on to the next device that
attempts to acquire it.
Note: This setting is an unsupported and untested
option used to modify Service Object behavior only
in very limited cases. Use it only when directed to
do so by Toshiba Support.

OnlineTimeout String Time in milliseconds to wait for device to come

online.
Note: This setting cannot be modified with the
Configuration tool.

Chapter 10. Keylock 159

Additional OPOS information

Two-position keylock
The keylocks for the NANPOS, 50-Key, 133-Key, and 4820 Point of Sale Keyboards all
have two positions and report them as LOCK_KP_NORM and either LOCK_KP_SUPR or
LOCK_KP_LOCK.
In OPOS, two-position keylocks can report the key positions as LOCK_KP_NORM and either
LOCK_KP_SUPR or LOCK_KP_LOCK. In the OPOS Configuration Utility:
• Select the Toshiba Raw Values radio button during configuration to cause the manager
position on the keyboard to return LOCK_KP_LOCK.
• Select the Map to OPOS Values radio button to cause the manager position to return
LOCK_KP_SUPR.

Figure 23. Two-position keylock

Key position Description Key position value

1 Operator LOCK_KP_NORM
2 Manager LOCK_KP_SUPR
LOCK_KP_LOCK (OPOS only)

Figure 24. 4820 Two-position keylock

Key position Description Key position value

Lock Operator LOCK_KP_NORM

160 UnifiedPOS User's Guide

Key position Description Key position value
Unlock Manager LOCK_KP_SUPR
LOCK_KP_LOCK (OPOS only)

Position count
For some Toshiba keylocks, the number of keylock positions cannot be reliably determined by
OPOS:
• RS-485 4685-K03: four positions
• RS-485 4685-K02 Keyboard with MSR Encoder: six positions
For this reason, a mechanism is provided to define the mapping of the native keylock positions
to OPOS values. During configuration of the keylock device, the number of positions and the
mapping of the positions can be set. Use the three-six position keyboard keylock for keylocks
with three to six positions.
In the OPOS Configuration Utility, use the Keylock entry labeled "Three-Six position keyboard
keylock" or "Three-six position keyboard keylock - USB" for keylocks with three to six positions.

Figure 25. Three-six position keylock properties

Chapter 10. Keylock 161

162 UnifiedPOS User's Guide
Chapter 11. Line display
Line display

Supported devices
Table 97. Line display supported devices
Device Connectivity
1. 40-character VFD II/SureOne EIA-232
2. 40-character VFD II USB, RS-485
3. Two-sided VFD II USB, RS-485
SBCS 4. 40-character VFD II (Japan)/4674 RS-485
5. Character Graphic (C/G) APA USB, RS-485
6. 40-character LCD USB, RS-485
7. 50-key keyboard LCD USB, RS-485
8. Character Graphic (C/G) APA EIA-232
DBCS 9. Character Graphic (C/G) APA USB, RS-485
10. PLU keyboard APA USB, RS-485
SBCS 11. LED display 1x11 EIA-232
SBCS 12. Modular 67-Key Keyboard w/Card Reader and Display USB
SBCS 13. TCxWave 6140 Integrated 40-character LCD USB
SBCS 14. TCx 2x20 Single-sided LCD USB
SBCS 15. TCx 2x20 Double-sided LCD USB
DBCS 16. TCx APA Single-sided USB
SBCS 17. TCx 800 2x20 Single-sided USB
DBCS 18. TCx 800 APA Single-sided USB
SBCS 19. TCx 810 2x20 Single sided USB
DBCS 20. TCx 810 APA Single-Sided USB

Note: On the SurePOS 500/600, the line display is preconfigured for COM4. Other values can be
selected through the BIOS, but this is not recommended.

Supported properties and methods

Table 98. Line display common properties
Property JavaPOS OPOS
AutoDisable Not supported
BinaryConversion Not supported All
CapCompareFirmwareVersion False

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 163

Property JavaPOS OPOS
CapPowerReporting PR_NONE for 1,8,11 PR_NONE for 1,8,11
PR_STANDARD for all other PR_STANDARD for all other
LineDisplay LineDisplay

CapStatisticsReporting True (see Appendix A, JavaPOS False

support for UnifiedPOS device
statistics properties on page 555)
CapUpdateFirmware False
CapUpdateStatistics False (see Appendix A, JavaPOS False
support for UnifiedPOS device
statistics properties on page 555)
CheckHealthText All
Claimed All
DataCount Not supported
DataEventEnabled Not supported
DeviceControlDescription All
DeviceControlVersion All
DeviceEnabled All
DeviceServiceDescription All
DeviceServiceVersion All
FreezeEvents All
OpenResult Not supported All
OutputID Not supported Not supported
PowerNotify PN_DISABLED OPOS_PN_DISABLED for 11, All
for others
PowerState All
PhysicalDeviceDescription All
PhysicalDeviceName All
ResultCode Not supported All
ResultCodeExtended Not supported All
State All

Table 99. Line display specific properties

Property JavaPOS OPOS
BlinkRate Not supported
CapBlink Not supported except 10 (set Not supported except 8 (set
CB_BLINKALL) CB_BLINKALL)

164 UnifiedPOS User's Guide

Property JavaPOS OPOS
CapBitmap Not supported
CapBlinkRate Not supported
CapBrightness Not supported except 1 and 10 (Supported on EIA-232 integrated and
external line displays)
CapCharacterSet See “Character sets supported All (values based on HW)
in JavaPOS” on page 176 and
“Character sets supported in
OPOS” on page 181
CapCursorType See Table 103. Not supported
CapCustomGlyph 1, 2, 3, 6, 7, 8, 12, 13, 14, 15 Not supported
CapDescriptors True for: 2, 3, 4, 5, 9, 10, 16, and 18 All true except for 1, 10, 11, 12, 13,
and 15
False for the remaining LineDisplay
devices

CapHMarquee Not supported

CapICharWait Not supported
CapMapCharacterSet Not supported Not Supported except 1 (Supported
on EIA-232 40-character VFD II/
SureOne)
CapReadBack Not supported
CapReverse Not supported
CapScreenMode 8 Not supported
CapVMarquee Not supported
CharacterSet All (values based on HW)
CharacterSetList See “Character sets supported in JavaPOS” on page 176
CurrentWindow All
Columns All
CursorColumn All
CursorRow All
CursorType See Table 103. Not supported Not supported
directly as property, but supported
using DirectIO method for EIA-232
external LineDisplay (All-points
addressable [APA]).
CursorUpdate All
CustomGlyphList Not supported
1
"0015-001A,001C-001E"

Chapter 11. Line display 165

Property JavaPOS OPOS

2, 3, 6, 7, 12, 13, 14, 15

0000-0007

8
ASCII returns: "0020-00FF"
English(437) returns:
"0001-0007,0009,000B,000C,00
0E-001A,001C-00FF"
Japanese(932) returns:
"8140-81FF,8240-84FF,8840-88
FF,8940-9FFF,E040-
E0FF,E140-EAFF"
Korean(1361)
returns: "A1A0-A1FF,A2A0-
ACFF,B0A0-B0FF,B1A0-
C8FF,CAA0-CAFF,CBA0-
FDFF"
Simplified Chinese(936)
returns: "A1A0-A1FF,A2A0-
A9FF,B0A0-B0FF,B1A0-F7FF"
Traditional Chinese(950)
returns: "A1A0-A1FF,A240-
C6FF,C940-C9FF,CA40-F9FF"

CustomDSGlyphList Not supported

CustomSSGlyphList Not supported
DeviceBrightness Only 1 0 or 100% only except on 1 and 10 (0
to 100%)
DeviceColumns All
DeviceDescriptors 2,3,4,5,9,10,16 '20 All

DeviceRows All
DeviceWindows Not supported All
GlyphHeight Not supported
1, 2, 3
7

6, 7, 12, 13, 14, 15

8

8
16 (2x20), 7 (4x20), 7 (5x20)

166 UnifiedPOS User's Guide

Property JavaPOS OPOS

9
SBCS: 16 (2x20),
DBCS: 16 (2x20)

GlyphWidth Not supported

1, 2, 3, 6, 7, 12, 13, 14, 15
5

8
16 (2x20), 8(2x20), 5 (4x20), 5
(5x20)

9
SBCS: 8 (2x20),
DBCS: 16 (2x20)

InterCharacterWait Not supported

MapCharacterSet Not supported 1
MarqueeFormat Not supported
MarqueeRepeatWait Not supported
MarqueeType Not supported
MarqueeUnitWait Not supported
MaximumX Not supported
MaximumY Not supported
Rows All
ScreenMode Not supported
All (Except 8)
0

8
0, 1, 2
ScreenModeList All (Except 8) "2x20" Not supported

8 "2x20,4x20,5x20"

Table 100. Line display common methods

Method JavaPOS OPOS
checkHealth All
claim All
clearInput Not supported
clearOutput Not supported
close All

Chapter 11. Line display 167

Method JavaPOS OPOS
compareFirmwareVersion Not supported
directIO
5, 8, 9, 10 8
command 1-ScreenMode, Command 1 = ScreenMode,
pData Value = (0-2x20,1-3x32) pData Value = (0-2x20,
1-3x32)

10
Command 0 = ScreenMode,
pDataValue = (2-2x20, 4-4x20,
5-5x20)
open All
9
command 0 = ScreenMode
pData Value =
(2-2x20,4-4x20,5-5x20)
release All
resetStatistics Not supported
retrieveStatistics True (see Appendix A, JavaPOS Not supported
support for UnifiedPOS device
statistics properties on page 555)
updateFirmware Not supported
updateStatistics Not supported

Table 101. Line display specific methods

Method JavaPOS OPOS
clearDescriptors Supported for USB-VFD All except 1, 10, 12, and 13
LineDisplay
clearText All
createWindow Not supported All
defineGlyph 1, 2, 3, 6, 7, 8, 12, 13, 14, 15 Not supported

Note:
glyph parameter is a byte array
with length as follows:

1, 2, 3
7

6, 7, 12, 13, 14, 15

8

168 UnifiedPOS User's Guide

Method JavaPOS OPOS

8
32 (2x20), 16 (2x20), 7 (4x20),
7 (5x20)

destroyWindow Not supported All

displayBitmap Not supported
displayText All
displayTextAt All
readCharacterAtCursor Not supported
refreshWindow Not supported All
scrollText All
setBitmap Not supported
setDescriptor Supported only for USB-VFD All except 1, 10, 12, and 13
LineDisplay

Table 102. Line display events

Event JavaPOS OPOS
DirectIOEvent All
StatusUpdateEvent All

Table 103. CapCursor Type and Cursor Type Properties

Cursor type 2, 3, 4, 5, 6 (RS-485), 7 6 (USB), 7 (USB), 12, 13 1 8
(RS-485), 9, 10, 11, 14, 15,
16 (USB)

capCursor DISP_CCT_NONE DISP_CCT_UNDERLINE DISP_CCT_UNDERLINE DISP_CCT_UNDERLINE¹

Type +DISP_CCT_FIXED

cursorType DISP_CT_NONE DISP_CT_UNDERLINE DISP_CT_UNDERLINE, DISP_CT_UNDERLINE¹

DISP_CT_NONE DISP_CT_NONE

¹The 2x20 screen mode does not have a cursor.

Supported properties and methods (line display attached fiscal printer:

Italy)
Table 104. Common properties (line display attached fiscal printer: Italy)
Property JavaPOS OPOS
AutoDisable Not supported
CapCompareFirmwareVersion False
CapPowerReporting PR_NONE
CapStatisticsReporting False Not supported

Chapter 11. Line display 169

Property JavaPOS OPOS
CapUpdateFirmware False
CapUpdateStatistics False
CheckHealthText String
Claimed True/False
DataCount Not supported
DatEventEnabled Not supported
DeviceEnabled True/False
DeviceControlDescription String
DeviceControlVersion int
DeviceServiceDescription String
DeviceServiceVersion Supported
FreezeEvents False
OutputID E_ILLEGAL
PhysicalDeviceDescription String
PhysicalDeviceName String
PowerNotify PN_DISABLED
PowerState PS_UNKNOWN
State int

Table 105. Specific properties (line display attached fiscal printer: Italy)
Property JavaPOS OPOS
CapBlink DISP_CB_NOBLINK
CapBitmap False
CapBlinkRate False
CapBrightness False
CapCharacterSet DISP_CCS_ASCII
CapCursorType DISP_CCT_NONE
CapCustomGlyph False
CapDescriptors False
CapHMarquee False
CapICharWait False
CapMapCharacterSet False
CapReadBack DISP_CRB_NONE

170 UnifiedPOS User's Guide

Property JavaPOS OPOS
CapReverse DISP_CR_NONE
CapScreenMode False
CapVMarquee False
BlinkRate E_ILLEGAL
CharacterSet DISP_CS_ASCII
CharacterSetList "998" (String)
Columns 20 (int)
CurrentWindow E_ILLEGAL
CursorColumn 0-19 (int)
CursorRow 0-1 (int)
CursorType DISP_CT_NONE
CursorUpdate False
CustomGlyphList E_ILLEGAL
DeviceBrightness E_ILLEGAL
DeviceColumns 20 (int)
DeviceDescriptors 0 (int)
DeviceRows 2 (int)
DeviceWindows 0 (int)
GlyphHeigh E_ILLEGAL
GlyphWidth E_ILLEGAL
InterCharacterWait E_ILLEGAL
MapCharacterSet False
MarqueeFormat E_ILLEGAL
MarqueeRepeatWait E_ILLEGAL
MarqueeType DISP_MT_NONE
MarqueeUnitWait E_ILLEGAL
MaximumX 0 (int)
Rows 2 (int)
ScreenMode 0 (int)
ScreenModeList "2x20" (String)

Chapter 11. Line display 171

Table 106. Common methods (line display attached fiscal printer: Italy)
Method JavaPOS OPOS
checkHealth Supported
claim Supported
clearInput Not supported
clearOutput E_ILLEGAL
close Supported
compareFirmwareVersion E_ILLEGAL
directIO Supported
open Supported
release Supported
resetStatistics E_ILLEGAL
retrieveStatistics E_ILLEGAL
updateFirmware E_ILLEGAL
updateStatistics E_ILLEGAL

Table 107. Specific methods (line display attached fiscal printer: Italy)
Method JavaPOS OPOS
clearText Supported
displayText Supported
displayTextAt Supported
scrollText E_ILLEGAL
clearDescriptors E_ILLEGAL
setDescriptor E_ILLEGAL
createWindow E_ILLEGAL
destroyWindow E_ILLEGAL
refreshWindow E_ILLEGAL
defineGlyph E_ILLEGAL
readCharacterAtCursor E_ILLEGAL
displayBitmap E_ILLEGAL
setBitmap E_ILLEGAL

172 UnifiedPOS User's Guide

JavaPOS configuration

CharacterSetASCIIBehavior
The behavior of Character Set ASCII (998) is undefined for characters beyond 127 (0x7F). To
make these characters behave as some other character set in the CharacterSetList, specify it using
this property. To keep these characters working as in previous JPOS releases, specify 998. If the
property does not exist, the default is 998.

<prop name="com.ibm.jpos.services.sdi.config.LineDisplay.CharacterSetASCIIBehavior" type="String"

value="998"/

CharacterSet
<prop name="com.ibm.jpos.sdi.config.LineDisplay.CharacterSet" type="String"
value="998"/>

Initializes the character set for APA, VFD or LED displays.

Valid values: See “Character sets supported in JavaPOS” on page 176.

CursorState
<prop name="com.ibm.jpos.services.sdi.config.LineDisplay.CursorState" type="String"
value="ON"/>

Initializes the EIA-232 LineDisplay VFD cursor state to On or Off. This is done only at
initialization time.
Valid values: ON or OFF

lineDisplayId
<prop name="com.ibm.posj.bus.rs232.lineDisplayId" type="String" value="APA/>

For EIA-232 displays, this property is used to distinguish between All-Points Addressable (APA)
and Vacuum Fluorescent Displays (VFD).
Valid values: APA, VFD, or LED

NumberOfRows
<prop name="com.ibm.jpos.services.sdi.config.LineDisplay.NumberOfRows" type="String"
value="2"/>

Initializes the EIA-232 APA line display to a selected number of rows.

Chapter 11. Line display 173

Valid values: 2, 4, or 5

JavaPOS DirectIO calls

The DirectIO commands in this section are supported for the LineDisplay. The following is the
correct syntax:

Syntax directIO (command: int32, inout data: int32, inout obj:

object) :
void {raises-exception}

To access line display constants, import: com.ibm.jpos.services.DirectIO.

Select cursor type command

Set display cursor type. This command applies to EIA-232 displays.

Table 108. Parameters for DirectIO.SELECT_APA_VFD_CURSOR_TYPE

Parameter Type Value
Command Int32 DirectIO.SELECT_APA_VFD_CURSOR_TYPE
Data [0] Int32 4 = DISP_CT_UNDERLINE, 1 = DISP_CT_NONE
Obj Object Always null

Select number of rows command

Set number of display rows. This command applies to EIA-232 APA (all points addressable)
character graphics displays.
This command can also be used with ScreenMode property.

Table 109. Parameters for DirectIO.SELECT_APA_NUMBER_OF_ROWS

Parameter Type Value
Command Int32 DirectIO.SELECT_APA_NUMBER_OF_ROWS
Data [0] Int32 2 = 2 rows by 20 columns, 4 = 4 rows by 20 columns, 5 = 5 rows
by 20 columns
Obj Object Always null

Select rotate text 180 command

Set display test mode. This command applies to USB APA Vacuum Fluorescent Display (VFD).

Table 110. Parameters for the DirectIO.SELECT_ROTATE_TEXT_180

Parameter Type Value
Command Int32 DirectIO.SELECT_ROTATE_TEXT_180

174 UnifiedPOS User's Guide

Parameter Type Value
Data [0] Int32 0 = display text in normal mode, 1 = display text mode 180
degrees rotated
Obj Object Always null

Errors
A UposExceptionException may be thrown when this method is invoked. Some possible
values of the exception ErrorCode properties are:

Table 111. ErrorCode property for DirectIO.SELECT_ROTATE_TEXT_180

Value Possible causes
E_ILLEGAL • cmd name /value is not known or is not
valid.
• Some of the parameter values are not
correct.

Additional JavaPOS information

Descriptors
Most models of Toshiba vacuum fluorescent and character graphics displays have the ability to
display descriptors. The following displays have 20 descriptors:
• USB 2x20 VFD External LineDisplay
• USB 2x20 VFD Integrated LineDisplay
• RS-485 2x20 VFD External LineDisplay
• All descriptors are on one row, below the bottom line of text
The following displays have 24 descriptors:
• USB Character/Graphic APA LineDisplay
• RS-485 APA LineDisplay
• There are two rows of descriptors, 12 above the top row of text and 12 below the bottom row
of text
In prior versions of JavaPOS, the descriptors were numbered incrementally from one, with
position one being the top leftmost position. In JavaPOS 1.9.6, the descriptors have been
renumbered to be consistent with OPOS. The descriptors are still numbered incrementally from
one, but the starting position is now the lowest rightmost position.

Capability definitions
DISP_CCT_NONE
Cursor is not displayable.

DISP_CCT_UNDERLINE
Cursor is displayable as an underline. Cursor can be turned on and off.

Chapter 11. Line display 175

DISP_CCT_UNDERLINE+DISP_CCT_FIXED
Cursor is displayable as an underline. Cursor is always displayed.

Property definitions
DISP_CT_NONE
Cursor is not displayed.

DISP_CT_UNDERLINE
Cursor is displayed as an underline.
Note: Another value received in the device will cause a JPOS_E_ILLEGAL at setCursorType()

Character sets supported in JavaPOS

Table 112 shows the country character sets supported by the line displays in JavaPOS. The
US/European character set contains at least the upper case characters from many of the previous
code pages (excluding Cyrillic). These are duplicated in the code pages for those countries.

Table 112. Character sets supported by line display in JavaPOS

LineDisplay device

1 2,3,4 2,3 5,9,10 5,9,10 6,7 6,7 8 11 12, 13, 14, 16

Code page
15
EIA-232 RS485 USB RS485 USB RS485 USB EIA232 EIA232 USB
USB

Single-byte character set

101 (Mini-Alphanumeric) ✓

437 U.S. English ✓ ✓ ✓ ✓ ✓ ✓ ✓

775 ✓ ✓

808 (Cyrillic-Russia) ✓ ✓ ✓ ✓

Note 1 on
page 178

819 (Alphanumeric and ✓

special)
Note 1 on
page 178

848 ✓ ✓

852 (Central Europe or ✓ ✓ ✓ ✓ ✓ ✓

Hungary)
Note 1 on
page 178

855 (Cyrillic) ✓ ✓ ✓ ✓ ✓ ✓

Note 1 on
page 178

857 (Turkey) ✓ ✓ ✓ ✓ ✓ ✓

176 UnifiedPOS User's Guide

LineDisplay device

1 2,3,4 2,3 5,9,10 5,9,10 6,7 6,7 8 11 12, 13, 14, 16

Code page
15
EIA-232 RS485 USB RS485 USB RS485 USB EIA232 EIA232 USB
USB

Note 1 on
page 178

858 (Multilingual) ✓ ✓ ✓ ✓ ✓ ✓

Note 1 on
page 178

860 ✓ ✓

861 ✓ ✓

862 (Israel) ✓ ✓ ✓ ✓ ✓ ✓

Note 1 on
page 178

863 (Canada-French) ✓ ✓ ✓ ✓ ✓ ✓

Note 1 on
page 178

864 (Arabic) ✓ ✓ ✓ ✓ ✓ ✓

Note 1 on
page 178

865 (Nordic) ✓ ✓ ✓ ✓ ✓ ✓

Note 1 on
page 178

866 (Russia) ✓ ✓ ✓

Note 1 on
page 178

867 ✓ ✓

869 (Greek) ✓ ✓ ✓ ✓ ✓ ✓

Note 1 on
page 178

872 ✓ ✓

897 (Katakana) ✓ ✓ ✓ ✓ ✓ ✓

998 (US/European CP850) ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

1250 ✓ ✓

1251 ✓ ✓

1252 ✓ ✓ ✓

1253 ✓ ✓

1254 ✓ ✓

1255 ✓ ✓

Chapter 11. Line display 177

LineDisplay device

1 2,3,4 2,3 5,9,10 5,9,10 6,7 6,7 8 11 12, 13, 14, 16

Code page
15
EIA-232 RS485 USB RS485 USB RS485 USB EIA232 EIA232 USB
USB

1256 ✓ ✓

1257 ✓ ✓

Double-byte character set

926 (Hangeul and ✓

Alphanumeric)

932 (Japanese) ✓ ✓ ✓ ✓

Note 2 on Note 3 on Note 3 on

page 178 page 178 page 178

936 (Simplified Chinese) ✓ ✓ ✓

Note3 on Note 3 on
page 178 page 178

949 (Korean Wansung) ✓ ✓ ✓

Note 2 on Note 3 on Note 3 on

page 178 page 178 page 178

950 (Traditional Chinese) ✓ ✓ ✓ ✓

Note 2 on Note 3 on Note 3 on

page 178 page 178 page 178

1361 (Korean Johab) ✓

Note:
1. Only available if EC Level >= 16 (0x10)
2. Only available if corresponding font is in device ROM
3. Only available if corresponding font was downloaded

USB APA font download

The following information is necessary to download fonts to the USB Character/Graphics
Display:
• The command line utility AipFntVfd, provided to download fonts to the Line Display.
• Font files for the USB Character/Graphics Display:
• Windows file location: <install dir>\fonts
• Linux file location: /usr/share/pos/fonts
• Only one font file can be applied at a time.

Table 113. Font File Summary

Font File Name Font File Description
jpnm16.bin 932 (Japanese)
korm16.bin 949 (Korean Wansung)

178 UnifiedPOS User's Guide

Font File Name Font File Description
sbcs0001.bin 437 U.S. English
prcmz16.bin 936 (Simplified Chinese)
rocbg16b.bin 950 (Traditional Chinese)

Syntax for the utility:

java com.tgcs.jpos.util.font.AipFntVfd [filename] [logicalname]

Where:
filename: The fully qualified pathname of the font file.
logicalname: The name specified in the JposEntry in the jpos.xml for that device

Example:
java com.tgcs.jpos.util.font.AipFntVfd /usr/share/pos/fonts/
jpnm16.bin LineDisplay1
java com.tgcs.jpos.util.font.AipFntVfd C:\POS\fonts\jpnm16.bin
LineDisplay1

OPOS configuration
Note: These settings cannot be modified with the Configuration tool.
In order to apply the configurations shown below, create the keyword of the specified type into
the following windows registry:
-
HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\LineDisplay\Logica
lName
Note: For 32 bits Application running on 64 bits Windows, use the following path instead:
-
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\OLEforRetail\ServiceOPOS\LineDi
splay\LogicalName
"LogicalName" refers to the actual device logical name given by end user at configuration time.

Table 114. Service Object settings for RS-485/USB line display

Keyword Type Description
DefineCharacter Key Key values for user-defined characters.
DefineCharacter\<X> String Hexadecimal value of user-defined character to be
downloaded. Eight bytes of data for character definition.
Each data byte is represented by 2 ASCII characters (e.g., the
value 0x69969960 is the string 0609090609090600). For more
information on the character format, refer to Toshiba Point
of Sale Subsystem Programming Reference and User's Guide
(SC30-3560).
DefaultCodePage DWORD The value stored in this property (if it exists) will be read
during line display device open and is used to initialize the

Chapter 11. Line display 179

Keyword Type Description
CharacterSet property. A valid codepage number must be
entered.
Note: This keyword will be deprecated in the future. Use
CharacterSet keyword instead.

CharacterSet DWORD The value stored in this property (if it exists) will be read
during line display device open and is used to initialize the
CharacterSet property. A valid codepage number must be
entered.

Table 115. Service object settings for EIA-232 line display

Keyword Type Description
Type String Line display type. Valid values are:

LINE
Single-byte display

APA
Double-byte display
Mode String Screen display mode. Valid values are 2x20 (default), 4x20,
and 5x20.

OPOS DirectIO calls

Set number of APA rows

Sets the number of rows on EIA-232 USB and RS-485 all points addressable (APA) line displays.

Table 116. Set number of APA rows

Parameter Type Description
Command Int32 0
Data Long* Pointer to a byte which determines the line display size.
Valid values are:
2 (2x20)
3 (3x32)
4 (4x20)
5 (5x20)

Obj BSTR* Ignored

180 UnifiedPOS User's Guide

Additional OPOS information

USB APA font download

To download fonts to the USB Character/Graphics Display, you will need the following:
• The display font download program, AIPFNVFD.EXE, which comes with the Toshiba Point
of Sale Subsystem for Windows.
• Font files for the USB Character/Graphics Display, which are found in the Toshiba Point of
Sale Subsystem for Windows FONTS directory.

Font File Name Font File Description

jpnm16.bin Japan, Mincho style
korm16.bin Korea, Mincho style
sbcs0001.bin SBCS fonts, updated version
Prcmz16.bin PRC Simplified Chinese
Rocbg16b.bin Taiwan Traditional Chinese

Font files for the USB Character/Graphics Display must be downloaded manually using the
AIPFNVFD.EXE program.

AIPFNVFD -Sslot -Pport {-Ndevice-number} -Fx:\dir\font-file {-Q}

-Sslot
The slot number (in decimal) of the display for which the download is intended.

-Pport
The port number (in decimal) of the display for which the download is intended.

-Ndevice-number
An indication of the device number of the display for which the download is intended.
Valid values are:
• A : device number 2A (default)
• B : device number 2B
• C : device number 2C
• D : device number 2D

-Fx:\dir\font-file
Fully qualified path name for the font file to be downloaded to the display.

-Q
Quiet mode. No progress information is displayed

Character sets supported in OPOS

Table 117 shows the country character sets supported by the line displays in OPOS. The US/
European character set contains at least the upper case characters from many of the previous
code pages (excluding Cyrillic). These are duplicated in the code pages for those countries.

Chapter 11. Line display 181

Table 117. Character sets supported by line display in OPOS
LineDisplay device

1 2,3,4 2,3 5,9,10 5,9,10 6,7 6,7 8 11 12, 13, 14, 16

Code page
15
EIA-232 RS485 USB RS485 USB RS485 USB EIA232 EIA232 USB
USB

Single-byte character set

101 (Mini-Alphanumeric)

437 U.S. English ✓ ✓ ✓ ✓ ✓

775 ✓ ✓

808 (Cyrillic-Russia)

819 (Alphanumeric and

special)

848 ✓

852 (Central Europe or ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

Hungary)

855 (Cyrillic) ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

857 (Turkey) ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

858 (Multilingual) ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

860 ✓ ✓

861 ✓ ✓

862 (Israel) ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

863 (Canada-French) ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

864 (Arabic) ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

865 (Nordic) ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

866 (Russia) ✓ ✓ ✓ ✓ ✓ ✓

867 ✓ ✓

869 (Greek) ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

872 ✓ ✓

897 (Katakana) ✓ ✓ ✓ ✓ ✓ ✓

998 US/European (based ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

on CP437)

999 ✓ ✓

1250 ✓ ✓

1251 ✓ ✓

1252 ✓ ✓ ✓ ✓

1253 ✓ ✓

1254 ✓ ✓

1255 ✓ ✓

1256 ✓ ✓

1257 ✓ ✓

Double-byte character set

926 (Hangeul and

Alphanumeric)

932 (Japanese) ✓ ✓ ✓

936 (Simplified Chinese) ✓

949 (Korean Wansung) ✓ ✓

950 (Traditional Chinese) ✓

182 UnifiedPOS User's Guide

LineDisplay device

1 2,3,4 2,3 5,9,10 5,9,10 6,7 6,7 8 11 12, 13, 14, 16

Code page
15
EIA-232 RS485 USB RS485 USB RS485 USB EIA232 EIA232 USB
USB

1361 (Korean Johab)

Chapter 11. Line display 183

184 UnifiedPOS User's Guide
Chapter 12. Magnetic Ink Character Recognition
Magnetic Ink Character Recognition

Supported devices
Table 118. Magnetic Ink Character Recognition (MICR) supported devices
Device Connectivity
1. 4610 Printer built-in MICR EIA-232, RS-485, USB, Network
2. Model 4 printer (OPOS only) RS-485 - Not Supported
3. 6145 Printer built-in MICR USB

Supported properties and methods

Table 119. Magnetic Ink Character Recognition (MICR) common properties
Property JavaPOS OPOS
AutoDisable Not supported All
BinaryConversion Not supported All
CapCompareFirmwareVersion False
CapPowerReporting PR_STANDARD All support PR_STANDARD
CapStatisticsReporting True (see Appendix A, JavaPOS False
support for UnifiedPOS device
statistics properties on page 555)
CapUpdateFirmware False
CapUpdateStatistics False (see Appendix A, JavaPOS False
support for UnifiedPOS device
statistics properties on page 555)
CheckHealthText All
Claimed All
DataCount All
DataEventEnabled All
DeviceControlDescription All
DeviceControlVersion All
DeviceEnabled All
DeviceServiceDescription All
DeviceServiceVersion All
FreezeEvents All
OpenResult Not supported All

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 185

Property JavaPOS OPOS
OutputID Not supported
PowerNotify All
PowerState All
PhysicalDeviceDescription All
PhysicalDeviceName All
ResultCode Not supported All
ResultCodeExtended Not supported All
State All

Table 120. Magnetic Ink Character Recognition (MICR) specific properties

Property JavaPOS OPOS
AccountNumber All
Amount All
BankNumber All Not supported
CapValidationDevice All
CheckType All - cannot determine without exception processing
CountryCode All - cannot determine without exception processing
EPC All
RawData All
SerialNumber All
TransitNumber All

Table 121. Magnetic Ink Character Recognition (MICR) common methods

Method JavaPOS OPOS
checkHealth All
claim All
clearInput All
clearInputProperties Supported
clearOutput Not supported
close All
compareFirmwareVersion Not supported
directIO Not supported
open All
release All

186 UnifiedPOS User's Guide

Method JavaPOS OPOS
resetStatistics Not supported
retrieveStatistics True (see Appendix A, JavaPOS Not supported
support for UnifiedPOS device
statistics properties on page 555)
updateFirmware Not supported
updateStatistics Not supported

Table 122. Magnetic Ink Character Recognition (MICR) specific methods

Method JavaPOS OPOS
beginInsertion All
beginRemoval All
endInsertion All
endRemoval All

Table 123. Magnetic Ink Character Recognition (MICR) events

Event JavaPOS OPOS
DataEvent All
DirectIOEvent Not supported
ErrorEvent All
StatusUpdateEvent All

Magnetic Ink Character Recognition data

The format of the data read from Magnetic Ink Character Recognition (MICR) looks like the
following:

Transit Transit Field Transit On-Us Field Amou Amount Field Amou
Symbol Symbol nt nt
9-digit fixed 19-character max 10-digit
Symbol Symbol

Where:

Transit Field
Nine-digit number bracketed between the two Transit symbols. Bank Number is digits 5
through 8 of the Transit field.

On-Us Field
According to the X9.13 standard, section 8.4.1, the On-Us field "usually contains the
account number and may also contain a serial number and/or a transaction code." In
addition, section 8.4.2 also states that "no recommendation is made as to how the On-Us
field is to be structured." This fact allows the individual financial institution the widest
possible latitude in designing the field to suit its own internal system requirement.
However, in no case shall the On-Us field contain more than 19 characters.

Chapter 12. Magnetic Ink Character Recognition 187

Amount Field
Ten-digit number bracketed between the two Amount symbols.

Auxiliary On-Us field

If it exists, it is to the left of the Routing Number (Transit field). It is also stated that
"when a serial number or other data is printed in this field, it must be preceded by, and
followed by, an On-Us symbol." The field length is variable up to nine characters.
Note: Only On-Us and Auxiliary On-Us fields need interpretation rules.

JavaPOS configuration

MinMicrSignalLevel
<prop name="com.ibm.jpos.sdi.config.MICR.MinMicrSignalLevel" type="String"
value="50"/>

Defines a minimum signal level accepted for a successful MICR read. If a MICR reads below the
minimum signal level, an error event is fired.
Valid values are 0 to 100. Default is 20.

CheckTypeAutodetection
<prop name="com.ibm.jpos.sdi.config.MICR.CheckTypeAutodetection" type="String"
value="false"/>

When true, this property allows the automatic detection of a check type without the need of an
exception table based on the following criteria:
• If AUXILIARY ON-US field present in MICR data, then CheckType = Business
• If AUXILIARY ON-US filed NOT present in MICR data, then CheckType = Personal
Note: If the property is set to true AND there is a valid MICR exception table, the value that will
be set is the one defined on the exception table.
Valid values are TRUE or FALSE.

stripAccountDashes
prop name="com.ibm.jpos.sdi.config.MICR.stripAccountDashes" type="String"
value="false"/

Determines whether to remove any dashes from the account number. When true, a value of
"1234-56-7" would become "1234567".
Valid values are TRUE or FALSE.

188 UnifiedPOS User's Guide

stripTransitDashes
<prop name="com.ibm.jpos.sdi.config.MICR.stripTransitDashes" type="String"
value="false"/>

Determines whether to remove any dashes from the transit number. When true, a value of
"3579-12-" would become "357912".
Valid values are TRUE or FALSE.

switchTransitDashToSpace
<prop name="com.ibm.jpos.sdi.config.MICR.switchTransitDashToSpace" type="String"
value="false"/>

Determines whether to change any dashes in the transit number to spaces. When true, a value of
"12-4-66-7" would become "12 4 66 7".
Valid values are TRUE or FALSE.

Additional JavaPOS information

MICR exception tables

An exception table contains Transit Field/On-Us Field interpretation rule pairs. This enables you
to manually code the On-Us field interpretation rule based on the Transit Field because each
bank is likely to have a different Transit Field. For this purpose, three formats for Exception
Table are supported. The first format (format 1) is an XML description of how the data is to be
extracted from the check, and should be written in a separate file. Formats two (2) and three (3)
can be put directly into the MICR JposEntry.

Format 1
Supported since JavaPOS 1.7.5, this is an XML representation of the On-Us and Auxiliary On-Us
fields stored in an independent file. This file is identified in a property in the JposEntry for the
MICR device:

<prop name=“com.ibm.jpos.sdi.config.MICR.exceptionTableFile”
Type=“String”
Value=“<file-path-goes-here>”/>

If this property is omitted, JavaPOS searches the classpath for a file named
micrexception.xml.
This file can also contain entries for legacy formats (PositionSkip and Symbol formats). An entry
for legacy format must be a child of MICRExceptionTable and is just like the prop elements
described for formats 2 and 3.

Chapter 12. Magnetic Ink Character Recognition 189

For example:
<?xml version=“1.0” encoding=“UTF-8”?>
<!DOCTYPE JposEntries PUBLIC "-//IBMJavaPOS//DTD//EN"
"/com/ibm/jpos/res/micrexception.dtd">

<MICRExceptionTable FormatToUse=“XML”>
<ExceptionEntry TransitField=“123456789” CheckType=“Business”>
<OnUsFieldParsingRule>
<SkipCharacterLength value=“1” />
<AccountNumberLength value=“5” />
<SkipCharacterLength value=“1” />
<SerialNumberLength value=“5” />
</OnUsFieldParsingRule>
<AuxOnUsFieldParsingRule>
<SerialNumberLength value=“5” />
</AuxOnUsFieldParsingRule>
</ExceptionEntry>
<prop name=“com.ibm.jpos.sdi.config.MICR.exceptionTable0”
type=“String”
value=“P123456789AAAAAAAAAAXSSSSSSSS”/>
<prop name=“com.ibm.jpos.sdi.config.MICR.exceptionTable1”
type=“String”
value=“B778899001D154R”/>
</MICRExceptionTable>

A sample file called micrexception.xml.Sample is included with the installation. This

can be useful as a starting point for configuring your own exception tables. The location for
micrexception.xml.Sample is:
• For Windows: C:\POS\JavaPOS\Docs
• For Linux: /opt/tgcs/javapos/docs
The following considerations must be applied:
• There can be as many ExceptionEntry and prop elements as needed. ExceptionEntry elements
must come before any prop element.
• Values for transit number (TransitField in ExceptionEntry and characters 2-10 in the case of
prop elements) must be unique.
• Valid values for the attribute FormatToUse are XML and Legacy. The default is XML. This
indicates which format is to be read first. Since any repeated value for transit number is
dropped, this switches priority from one format to the other.
• Formats 2 and 3 (legacy formats) are read in order of the property names, first the ones in the
new micrexception.xml and then the ones in the JposEntry. All listed entries must have
consecutive names inside each file, and counts should start at 0.
• Order of elements within OnUsFieldParsingRule is strict. The order shown above is the
expected order. OnUsFieldParsingRule is required.
• SerialNumberLength and AccountNumberLength can be in either order, and
SkipCharacterLength can be at the beginning or between SerialNumberLength and
AccountNumberLength.
• Exactly one occurrence of AccountNumberLength is required.
• SerialNumberLength and SkipCharacterLength are optional.
• All value attributes are required. TransitField attribute from ExceptionEntry element is also
required.
• CheckType attribute from ExceptionEntry is optional. If specified, it must be either Personal
or Business. The default is Personal.
• The serial number may appear in the Auxiliary On-Us field; AuxOnUsFieldParsingRule
holds a SerialNumberLength element if this is the case. AuxOnUsFieldParsingRule is
optional.
• SerialNumberLength should appear in one field only. If it appears in both, the value from
AuxOnUsFieldParsingRule is ignored.

190 UnifiedPOS User's Guide

Format 2
Supported since JavaPOS 1.7.2, the On-Us field interpretation rule is as follows:

A
account number character (can be a dash)

S
serial number character (can be a dash)

X
ignored (no parsing)
A typical MICR exception table looks like this:
<prop name=“com.ibm.jpos.sdi.config.MICR.exceptionTable0”
type=“String” value=“P123456789AAAAAAAAAAXSSSSSSSS”/>
<prop name=“com.ibm.jpos.sdi.config.MICR.exceptionTable1”
type=“String” value=“B123456709AAAAAAAAXXXSSSSSSSS”/>

where the value attribute is parsed as shown in Table 124.

Table 124. MICR exception table fields for format 2

Characters Content
1 Check type: B = Business check, P = Personal check
2 to 10 Transit field.
On-Us Field. The A,X,S field is not required to be 19 characters long. You can
choose the number of A, X, or S characters to encode the rule. This rule is
11 to end applicable to the first valid digit immediately after the Transit Field. The On-Us
symbol can be part of the On-Us Field, and the parser is expected to handle this
condition.

Format 3
Supported since JavaPOS 1.5.1, exception configuration properties are provided for MICR
processing to handle MICR data that do not conform to some of the standard formats. Default
exception tables are set up for each MICR entry in the JPOS.xml file.
Use the following format:
<prop name=“exceptionTable0” type=“String” value= “B778899001D154R”/>

where each byte represents the following:

P/B (byte 1)
Type of check: either Business or Personal. This option is not used for parsing but instead
is used to set the check type property, which is usually set to UNKNOWN.

TRANSIT (byte 2-10)

A 9-digit bank transit number that is key for determining if the exception table entry is
applied to the MICR data.

SPC (byte 11)

SPC options:

Chapter 12. Magnetic Ink Character Recognition 191

• If SPC is set to D, all spaces are removed from the primary On-Us field for processing
• If SPC is not set to D, the On-Us field remains unchanged.

Field (byte 12)

Not used. The driver always use the first field in the primary On-Us field.

SKIP (byte 13)

The account starts in this index and includes the remaining characters to the right in the
primary On-Us field. (The index count starts at 0.)

SIZE (byte 14)

Not used because the driver identifies the serial number.

ACC (byte 15)

Not used.
The following table shows sample output for Format 3:

Table 125. Format 3 Exception Table (sample data)

Raw Data t123456780t 0123456789o 0671
Primary On-Us 0123456789o 0671
Field #1 0123456789
Exception Table entry Account Serial
P123456780D111R 123456789 0671
P123456780D165R 6789 0671
P123456780D295R 9 0671
P123456780D422R 23456789 0671

OPOS configuration
In order to apply the configurations shown below, create the keyword of the specified type into
the following windows registry:
- HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\MICR\LogicalName
Note: For 32 bits Application running on 64 bits Windows, use the following path instead:
-
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\OLEforRetail\ServiceOPOS\MICR\L
ogicalName
"LogicalName" refers to the actual device logical name given by end user at configuration time.

Table 126. Service object settings for MICR

Keyword Type Description
ExceptionFile String Fully-qualified filename of MICR exception file, which contains
exception processing information. The default value is:
C:\POS\BIN\PARSE.DAT.

192 UnifiedPOS User's Guide

Keyword Type Description
MinMicrSignalLevel String Minimum signal string (0-100) for successful MICR read. The default
value is 20 (full string).
SlipRegTimeout String Time (in milliseconds) to wait for check to be registered.
Note: This setting cannot be modified with the Configuration tool.

SlipRegMinDelay String Time (in milliseconds) to delay before sending document register
command.
Note: This setting cannot be modified with the Configuration tool.

CheckTypeAutoDetecti String Auto detect check type based on the Auxiliary On -Us field.
on
Values:
TRUE: Enable auto detection of check type. If Auxiliary On -Us field is
present, check type will be set to Business, otherwise, check type will be
Personal. If check is specified in the Exception File, check type will be set
according to the file.
FALSE: Disable auto detection of check type. If check is specified in the
Exception File, check type is set according to the file, otherwise check
type will default to Unknown(99).

OPOS DirectIO calls

Add new MICR exception

Adds the specified MICR exception string into the current MICR exception file.

Table 127. Add new MICR exception

Parameter Type Description
Command Int32 101
Data Long* Ignored
Obj BSTR* Pointer to a string containing the MICR exception string.
See “Additional OPOS information” on page 193 for more
information on the format of the exception string.

Additional OPOS information

MICR exception file

Exception configuration properties for MICR processing enable you to handle MICR data that do
not conform to some of the standard formats. Default exception tables are set up for each MICR
entry in the <INSTALL_DIR>\bin\parse.dat file.

Chapter 12. Magnetic Ink Character Recognition 193

Use the following format to create exception table entries:
#P/B TRANSIT SPC FIELD SKIP SZ ACC
P 123456789 D 1 5 5 R

Each parameter must be separated for any number of spaces, and each byte represents the
following:

P/B (byte 1)
The type of check: either Business or Personal. This option is not used for parsing; instead,
it is used to set the check type property, which is usually set to "UNKNOWN."

TRANSIT (byte 2-10)

9-digit bank transit number, which is used as the key to determine if the exception table
entry is applied to the MICR data.

SPC (byte 11)

If SPC is set to D, all spaces are removed from the primary On-Us field for processing;
otherwise, the On-Us field remains unchanged.

Field (byte 12)

Indicates which subfield in the primary On-Us field is used to get the account number
and the serial number.

SKIP (byte 13)

The account starts in this index and includes the remaining characters to the right in the
primary On-Us field. (The index count starts at 0.)

SIZE (byte 14)

The length of the serial number.

ACC (byte 15)

The alignment of the account number in the subfield:
• If it is "L," then the account number aligns on the left of the subfield.
• If it is "R," then the account number aligns on the right of the subfield.
The following table shows sample output:

Table 128. Exception configuration properties for MICR processing: Example 1

Raw Data t123456780t 0123456789o 0671
Primary On-Us 0123456789o 0671
Field #1 0123456789
Field #2 0671
Exception Table entry Account Serial
P123456780D 1 1 1 R 9 8
P123456780D 1 6 5 R 456789 0123
P123456780D 2 1 5 R 1 067
P123456780D 4 1 5 R 1 067
P123456780D 2 2 2 L 06
P123456780D 1 1 1 L 01234567 8

194 UnifiedPOS User's Guide

P123456780D 1 3 5 L 01 23456

The following image illustrates how the information is parsed to retrieve the Account and Serial
numbers for the table entry "P123456780D 1 6 5 R":
SKIP=6 Serial 5
Field #1 (Account) character long

Parsing Rule P 123456780 D 1 6 5 R Account is

on the right
10
9
8
7
6
5
4
3
2
1
Index

Field #1 0 1 2 3 4 5 6 7 8 9

Account Number
Serial Number

Figure 26. Data parsing: Example 1

The following image illustrates how the information is parsed to retrieve the Account and Serial
numbers for the table entry "P123456780D 1 3 5 L":
SKIP=3 Serial 5
Field #1 (Account) character long

Parsing Rule P 123456780 D 1 3 5 L Account is

on the left
10
9
8
7
6
5
4
3
2
1

Index

Field #1 0 1 2 3 4 5 6 7 8 9

Account Number
Serial Number
Skipped character

Figure 27. Data parsing: Example 2

Table 129. Exception configuration properties for MICR processing: Example 2

Raw Data o87654321o t123456780t 0123456789o
Primary On-Us 0123456789o
Field #1 0123456789
Exception Table entry Account Serial
P123456780D 1 6 5 R 456789 0123
P123456780D 4 1 5 R 9 45678
P123456780D 2 2 2 L 012345 67

Chapter 12. Magnetic Ink Character Recognition 195

P123456780D 1 3 5 L 01 23456

196 UnifiedPOS User's Guide

Chapter 13. Motion sensor
Motion sensor

Motion sensor supported devices

Table 130. Motion sensor supported devices
Device Connectivity
1. SurePOS 500/600 Integrated
2. Kiosk Integrated

Supported properties and methods

Table 131. Motion sensor common properties
Property JavaPOS OPOS
BinaryConversion Not supported All
CapCompareFirmwareVersion False
CapPowerReporting PR_NONE PR_NONE
CapStatisticsReporting True (see Appendix A, JavaPOS False
support for UnifiedPOS device
statistics properties on page 555)
CapUpdateFirmware False
CapUpdateStatistics False (see Appendix A, JavaPOS False
support for UnifiedPOS device
statistics properties on page 555)
CheckHealthText All
Claimed All
DeviceControlDescription All
DeviceControlVersion All
DeviceEnabled All
DeviceServiceDescription All
DeviceServiceVersion All
FreezeEvents All
OpenResult Not supported All
PhysicalDeviceDescription All
PhysicalDeviceName All
PowerNotify All
PowerState All

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 197

Property JavaPOS OPOS
ResultCode Not supported All
ResultCodeExtended Not supported All
State All

Table 132. Motion sensor specific properties

Property JavaPOS OPOS
Motion All
Timeout All

Table 133. Motion sensor common methods

Method JavaPOS OPOS
checkHealth All
claim Always shareable
close All
compareFirmwareVersion Not supported
directIO Not supported
open All
release Always shareable
resetStatistics Not supported
retrieveStatistics True (see Appendix A, JavaPOS Not supported
support for UnifiedPOS device
statistics properties on page 555)
updateFirmware Not supported
updateStatistics Not supported

Table 134. Motion sensor specific methods

Method JavaPOS OPOS
waitForMotion All

Table 135. Motion sensor events

Event JavaPOS OPOS
DirectIOEvent Not supported
StatusUpdateEvent All

Additional JavaPOS information

This section contains information on loading the correct motion sensor driver in Linux for your
hardware.

198 UnifiedPOS User's Guide

Add the following lines in /opt/tgcs/javapos/etc/machine.conf:

<keyword> <number of entries>

<machine type><model number>

<keyword> represents the device for which a driver is needed and <number of entries>
indicates the number of <machine type><model number> pairs that follow. If the system on
which JavaPOS is running matches one of the specified <machine type><model number>
pairs, the device driver for that <machine type><model numbser> is loaded.
For the motion sensor, machine.conf might have the following entries:
Motion 2
4838132
4838135

In this case the <number of entries> value is 2.

Chapter 13. Motion sensor 199

200 UnifiedPOS User's Guide
Chapter 14. Magnetic stripe reader
Magnetic stripe reader

Supported devices
Table 136. Magnetic stripe reader (MSR) supported devices
Device Connectivity
ISO (3-track) 1. Retail alphanumeric POS keyboard w/Card Reader PS/2, RS-485, USB
ISO (3-track) 2. Retail alphanumeric POS keyboard with MSR and PS/2
pointing device
ISO (3-track) 3. Retail POS keyboard with card reader RS-485, USB
ISO (3-track) 4. Retail POS keyboard with card reader and display RS-485, USB
ISO (3-track) 5. Modifiable layout keyboard with card reader RS-485, USB
ISO (3-track) 6. 32-key programmable keypad with ISO MSR EIA-232, RS-485, USB
JUCC 7. 32-key programmable keypad with JUCC MSR EIA-232, RS-485, USB
ISO (3-track) 8. SurePoint 4820 integrated ISO MSR EIA-232, RS-485, USB
JUCC 9. SurePoint 4820 integrated JUCC MSR EIA-232, RS-485, USB
ISO (3-track) 10. SurePOS 500/600 integrated ISO MSR EIA-232
JUCC 11. SurePOS 500/600 integrated JUCC MSR EIA-232
ISO (3-Track) 12. Anyplace Kiosk integrated ISO MSR EIA-232
JUCC 13. Anyplace Kiosk integrated JUCC MSR EIA-232
ISO (3-Track) 14. SureOne Integrated ISO MSR PS/2
ISO (3-Track) 15. . Compact Alphanumeric POS Keyboard (requires PS/2
manual firmware update for support)
JUCC 16. POS keyboard V RS-485, USB
JUCC 17. PC POS Keyboard or PC Point of Sale Keyboard PS/2, RS-485, USB
JUCC 18. Retail POS keyboard VI RS-485, USB
ISO (3-Track) 19. SurePOS 100 integrated ISO MSR PS/2
JUCC 20. 4674 Integrated JUCC MSR RS-485
JUCC 21. 4685-KC1 (OPOS only) RS-485
JUCC 22. 4685-K01 (OPOS only) RS-485
JUCC 23. 4685–K02 (Ultra7) keyboard with card reader RS-485, USB
JUCC 24. 4685-K02 with MSR/Encoder and 4 position keylock RS-485
JUCC 25. 4685-K02 with MSR/Encoder and 6 position keylock RS-485
JUCC 26. 4685-K03 RS-485, USB

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 201

Device Connectivity
ISO (3-Track) 27. Modular alphanumeric keyboard PS/2, USB
JUCC 28. Modular alphanumeric keyboard PS/2, USB
ISO (3-Track) 29. Modular Compact Alphanumeric keyboard PS/2, USB
JUCC 30. Modular Compact Alphanumeric keyboard PS/2, USB
ISO (3-Track) 31. Modular 67 Key Keyboard PS/2, USB
JUCC 32. Modular 67 Key Keyboard PS/2, USB
ISO (3-Track) 33. Modular 67 Key Keyboard with Card Reader and PS/2, USB
Display USB
ISO (3-Track) 34. TCxWave 6140 Integrated ISO MSR USB
ISO (3-Track) 35. TCx Display Integrated MSR USB
ISO (3-Track) 36. TCx 800 Integrated MSR USB
ISO (3-track) 37. TCx 810 Integrated MSR USB

Supported properties and methods

Table 137. MSR common properties
Property JavaPOS OPOS
AutoDisable Not supported All
BinaryConversion Not supported All
CapCompareFirmwareVersion False
CapPowerReporting PR_NONE for EIA-232 and PS/2 PR_STANDARD
PR_STANDARD for all other
MSR devices

CapStatisticsReporting True (see Appendix A, JavaPOS False

support for UnifiedPOS device
statistics properties on page 555)
CapUpdateFirmware False
CapUpdateStatistics False (see Appendix A, JavaPOS False
support for UnifiedPOS device
statistics properties on page 555)
CheckHealthText All
Claimed All
DataCount All
DataEventEnabled All
DeviceControlDescription All
DeviceControlVersion All

202 UnifiedPOS User's Guide

Property JavaPOS OPOS
DeviceEnabled All
DeviceServiceDescription All
DeviceServiceVersion All
FreezeEvents All
OpenResult Not supported All
OutputID Not supported
PowerNotify All
PowerState All
PhysicalDeviceDescription All
PhysicalDeviceName All All
ResultCode Not supported All
ResultCodeExtended Not supported All
State All

Table 138. MSR specific properties

Property JavaPOS OPOS
AccountNumber All
AdditionalSecurityInformation Not supported
CapCardAuthentication Not supported
CapDataEncryption Not supported
CapDeviceAuthentication Not supported
CapISO All except JUCC 4840 MSR All except JUCC 4840 MSR
CapJISOne All All except 4840 MSR, SureOne
Built-In, and 4820 MSR
CapJISTwo All All except 4840 MSR and SureOne
Built-In
CapTrackDataMasking Not supported
CapTransmitSentinels False All
CapWritableTracks 24, 25 Not supported
CardAuthenticationData Not supported
CardAuthenticationDataLength Not supported
CardPropertyList All Not supported
CardType All Not supported
CardTypeList All Not supported

Chapter 14. Magnetic stripe reader 203

Property JavaPOS OPOS
DataEncryptionAlgorithm Not supported
DecodeData All
DeviceAuthenticated Not Supported
DeviceAuthenticationProtocol Not Supported
EncodingMaxLength 24, 25 Not supported
ErrorReportingType All
ExpirationDate All
FirstName All
MiddleInitial All
ParseDecodeData All
ServiceCode All
Suffix All
Surname All
Title All
Track1Data All
Track1DiscretionaryData All
Track1EncryptedData Not supported
Track1EncryptedDataLength Not supported
Track2Data All
Track2DiscretionaryData All
Track2EncryptedData Not supported
Track2EncryptedDataLength Not supported
Track3Data All
Track3EncryptedData Not supported
Track3EncryptedDataLength Not supported
Track4Data All JUCC
Track4EncryptedData Not supported
Track4EncryptedDataLength Not supported
TracksToRead All
TracksToWrite 24, 25 Not supported
TransmitSentinels Not supported
WriteCardType Not supported

204 UnifiedPOS User's Guide

Table 139. MSR common methods
Method JavaPOS OPOS
checkHealth All
claim All
clearInput All
ClearInputProperties All Not Supported
clearOutput Not supported
close All
compareFirmwareVersion Not supported
directIO RS-485 – 4685-K02 (Ultra 7) Not supported
open All
release All
resetStatistics Not supported
retrieveStatistics True (see Appendix A, JavaPOS Not supported
support for UnifiedPOS device
statistics properties on page 555)
updateFirmware Not supported
updateStatistics Not supported

Table 140. MSR specific methods

Method JavaPOS OPOS
authenticateDevice Not supported
deauthenticateDevice Not supported
retrieveCardProperty All Not supported
retrieveDeviceAuthenticationData Not supported
updateKey Not supported
writeTracks 24, 25 Not supported

Table 141. MSR events

Event JavaPOS OPOS
DataEvent All
DirectIOEvent Not supported
ErrorEvent All
StatusUpdateEvent All

Chapter 14. Magnetic stripe reader 205

Configuration file update
UPOS provides a mechanism to update the configuration file for some USB MSR types.
Configuration file is not provided in UPOS installer. If required, please contact Toshiba technical
support.

Table 142. MSR Configuration (Device 34, 35)

MSR Type Configuration File Location on Windows Location on Linux
TCxWave HeadIO aip4500.cfg c:\pos\config /usr/share/pos/
config
TCxDisplay aip467d2.cfg c:\pos\config /usr/share/pos/config

JavaPOS configuration

enableOnlineWatcher
<prop name="com.ibm.posj.bus.rs232.enableOnlineWatcher" type="Boolean" value="true"/>

Monitors the device for being online or offline and performs

appropriate actions. To configure the poll time for events, modify
the com.ibm.posj.bus.rs232.onLineWatcherPollTime.MSR property in the
posj.properties file.
Values accepted
• TRUE - Default value
• FALSE
Device Support
• EIA-232 : 12, 13

msrID
<prop name="com.ibm.posj.bus.rs232.msrId" type="String" value="ISO"/>

Determines whether the EIA-32 MSR hardware is a 3-track ISO unit or a double-sided JUCC
unit.
Valid values accepted:
• ISO (default value)
• JUCC
Device support:
• EIA-232: 6, 7, 8, 9, 10, 11, 12, 13

206 UnifiedPOS User's Guide

TracksToRead
<prop name="com.ibm.jpos.sdi.config.override.MSR.TracksToRead" type="String"
value="MSR_TR_1_2_3"/>

Holds the track data that the application wishes to have placed into Track1Data, Track2Data,
Track3Data, and Track4Data properties following a card swipe.
Values accepted:
• MSR_TR_1
• MSR_TR_2
• MSR_TR_3
• MSR_TR_1_2
• MSR_TR_1_3
• MSR_TR_2_3
• MSR_TR_1_2_3 - Default value
• MSR_TR_4
• MSR_TR_1_4
• MSR_TR_2_4
• MSR_TR_3_4
• MSR_TR_1_2_4
• MSR_TR_1_3_4
• MSR_TR_2_3_4
• MSR_TR_1_2_3_4

ErrorReportingType
<prop name="com.ibm.jpos.sdi.config.override.MSR.ErrorReportingType" type="String"
value="MSR_ERT_CARD"/>

Holds the type of errors to report via ErrorEvents.

This property has one of the following values:
• MSR_ERT_CARD
• MSR_ERT_TRACK

JavaPOS DirectIO calls

The following DirectIO commands are supported for the MSR. The syntax is as follows:

Syntax directIO (command: int32, inout data: int32, inout obj:

object) :
void {raises-exception, use after open-claim-enable}

MSR write data command

Note: This command is used to write data to the JIS magnetic stripe of payment cards
conforming to the JIS specification.

Chapter 14. Magnetic stripe reader 207

See Table 143 for a reference of the parameters to call DirectIO.MSR_WRITE_DATA_CMD.

Table 143. Parameters for DirectIO.MSR_WRITE_DATA_CMD

Parameter Type Value
Command Int32 DirectIO.MSR_WRITE_DATA_CMD
Data [0] Int32 Write wait timeout value in milliseconds.
The wait timeout can be set to JposConst.JPOS_FOREVER and
the command has no timeout to return. The maximum wait
timeout is 25,000 milliseconds (25 seconds).

Obj Object String representation of the data to be written. The maximum

length for the object is 69 characters. The first 69 characters will
be written to the magnetic stripe and additional characters will
be ignored.

Note: A card with a JIS II track must be swiped through the MSR during the directIO call with
MSR_WRITE_DATA_CMD so data can be stored. Otherwise an exception is thrown.
Device Support:
• 24, 25

Errors
A UposException Exception may be thrown when this method is invoked. Some possible
values of the exception's ErrorCode property are noted in Table 144:

Table 144. UposExceptionException error code property

Value Possible causes
E_ILLEGAL One of the following errors has occurred:
• The device is not write enabled.
• Some of the parameter values are not correct.
• Command sent to not capable write MSR

E_TIMEOUT Timeout expired and card was not swiped.

Additional JavaPOS information

SureOne MSR
SureOne firmware discards any invalid MSR reading and sends only valid track data. Track
errors are not reported.
If track 2 is empty and track 3 contains data, the track 3 data is displayed as track 2 and no data
appears in track 3.

OPOS configuration
Note: These settings cannot be modified with the Configuration tool.

208 UnifiedPOS User's Guide

In order to apply the configurations shown below, create the keyword of the specified type into
the following windows registry:
- HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\MSR\LogicalName
Note:
For 32 bits Application running on 64 bits Windows, use the following path instead:
-
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\OLEforRetail\ServiceOPOS\MSR\Lo
gicalName
"LogicalName" refers to the actual device logical name given by end user at configuration time.

Table 145. Service object settings for EIA-232 MSR

Keyword Type Description
MsrType REG_SZ Type of MSR reader attached. Valid values are:

ISO
Standard three-track reader

JUCC
JIS-I and II reader
ReadTotalTimeout REG_SZ Set the total read timeout of a single MSR swipe.
Default: 1500 ms

ReadIntervalTimeout REG_SZ Set the read interval timeout between tracks of a single MSR
swipe.

Default: 190 ms

Note: Due to error checking, it takes more time to read MSR

cards which are not in good condition. To allow the reading
of wider conditions of MSR cards, you may adjust the value
up to 400 ms.

Table 146. Service object settings for ALL MSR

Keyword Type Description
TracksToRead REG_SZ Holds the track data that the
application wishes to have placed
into Track1Data, Track2Data,
Track3Data, and Track4Data
properties following a card swipe.
This property has one of the
following values:

MSR_TR_1
Obtain track 1.

MSR_TR_2
Obtain track 2.

Chapter 14. Magnetic stripe reader 209

Keyword Type Description

MSR_TR_3
Obtain track 3.

MSR_TR_1_2
Obtain tracks 1 and 2.

MSR_TR_1_3
Obtain tracks 1 and 3.

MSR_TR_2_3
Obtain tracks 2 and 3.

MSR_TR_1_2_3
Obtain tracks 1, 2, and 3.

MSR_TR_4
Obtain track 4.

MSR_TR_1_4
Obtain tracks 1 and 4.

MSR_TR_2_4
Obtain tracks 2 and 4.

MSR_TR_3_4
Obtain tracks 3 and 4.

MSR_TR_1_2_4
Obtain tracks 1, 2, and 4.

MSR_TR_1_3_4
Obtain tracks 1, 3, and 4.

MSR_TR_2_3_4
Obtain tracks 2, 3, and 4.

MSR_TR_1_2_3_4
Obtain tracks 1, 2, 3, and 4.
ErrorReportingType REG_SZ Holds the type of errors to report
via Error Events. This property has
the following values:

MSR_ERT_CARD
Reports errors at a card level

MSR_ERT_TRACK
Reports errors at the track
level

210 UnifiedPOS User's Guide

Additional OPOS information

SureOne/SurePOS 100 MSR limitations

The MSR on the SureOne is part of the Keyboard. The raw data is in ASCII format.
When a credit card is swiped with the MSR DataEventEnabled set to false, the incoming data is
treated as keyboard data. The only way to get MSR data events is to set DataEventEnabled to
true. In order to queue MSR data, both DataEventEnabled and FreezeEvents must be set to true.

Chapter 14. Magnetic stripe reader 211

212 UnifiedPOS User's Guide
Chapter 15. POS keyboard
POS keyboard

POS keyboard supported devices

Table 147. POS keyboard supported devices
Device Connectivity
1. Retail alphanumeric POS keyboard with card reader PS/2, RS-485, USB
Also known as: ANPOS or NANPOS

2. Retail alphanumeric POS keyboard with MSR and pointing device PS/2
Also known as: ANPOS with pointer

3. Retail POS keyboard RS-485, USB

Also known as: 50-Key keyboard

4. Retail POS Keyboard with card reader RS-485, USB

Also known as: 50-Key/MSR

5. Retail POS Keyboard with card reader and display RS-485, USB,
Also known as: 50-Key/Display

6. Modifiable Layout Keyboard with card reader RS-485, USB

Also known as: 133 Key or Matrix

7. 32-Key programmable keypad with MSR RS-485, USB, PS/2

Also known as: 4820 Keyboard

8. SureOne Integrated Keyboard PS/2

9. Compact Alphanumeric POS Keyboard PS/2
Also known as: CANPOS

10. POS Keyboard V RS-485, USB

11. PC POS Keyboard or PC Point of Sale keyboard PS/2, RS-485, USB
Also known as: ANKPOS

12. PLU Keyboard/Display III RS-485, USB

13. Retail POS Keyboard VI RS-485, USB
Also known as: 50-Key keyboard with JUCC MSR

14. SurePOS 100 Integrated keyboard PS/2

15. 4674 Integrated keyboard RS-485
16. 4685-KCI (OPOS only) RS-485

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 213

Device Connectivity
17. 4685-K01 (OPOS only) RS-485
18. 4685-K02 (Ultra 7) keyboard with card reader RS-485, USB
19. 4685-K02 with MSR/Encoder and 4 position keylock USB
20. 4685-K02 with MSR/Encoder and 6 position keylock USB
21. 4685-K03 RS-485, USB
22. Modular Alphanumeric keyboard PS/2, USB
23. Modular Compact Alphanumeric Keyboard PS/2, USB
24. Modular 67-Key Keyboard USB
25. Modular 67-Key Keyboard with Display USB USB
26. 32-Key programmable keypad with Keylock USB
27. 32-Key programmable keypad with Electronic Keylock USB
28. 32-Key programmable keypad with keylock and MSR USB

Supported properties and methods

Table 148. POS keyboard common properties
Property JavaPOS OPOS
AutoDisable Not supported All
BinaryConversion Not supported All
CapCompareFirmwareVersion False
CapPowerReporting PR_STANDARD PR_NONE for PS/2 connectivity,
PR_STANDARD for other
connectivities.

CapStatisticsReporting True (see Appendix A, JavaPOS False

support for UnifiedPOS device
statistics properties on page 555)
CapUpdateFirmware False
CapUpdateStatistics False (see Appendix A, JavaPOS False
support for UnifiedPOS device
statistics properties on page 555)
CheckHealthText All
Claimed All
DataCount All
DataEventEnabled All
DeviceControlDescription All
DeviceControlVersion All

214 UnifiedPOS User's Guide

Property JavaPOS OPOS
DeviceEnabled All
DeviceServiceDescription All
DeviceServiceVersion All
FreezeEvents All
OpenResult Not supported All
OutputID Not supported
PowerNotify All
PowerState All
PhysicalDeviceDescription All
PhysicalDeviceName All
ResultCode Not supported All
ResultCodeExtended Not supported All
State All

Table 149. POS keyboard specific properties

Property JavaPOS OPOS
CapKeyUp All
EventTypes All
POSKeyData All
POSKeyEventType All

Table 150. POS keyboard common methods

Method JavaPOS OPOS
checkHealth All
claim All
clearInput All
clearOutput All
close All
compareFirmwareVersion Not supported
directIO All All except 8, 14
open All
release All
resetStatistics Not supported

Chapter 15. POS keyboard 215

Method JavaPOS OPOS
retrieveStatistics True (see Appendix A, JavaPOS Not supported
support for UnifiedPOS device
statistics properties on page 555)
updateFirmware Not supported
updateStatistics Not supported

Table 151. POS keyboard events

Event JavaPOS OPOS
DataEvent All
DirectIOEvent All Not supported
ErrorEvent All
StatusUpdateEvent All

CANPOS keyboard
The CANPOS keyboard firmware version must be at least 1.2.3 for the CANPOS automatic
download utility to work. The firmware can be automatically updated to newer versions in
UnifiedPOS. If required, the update typically takes three to five minutes, depending on the
operating system.
The keyboard function keys can also be updated automatically, but you must create your own
keyboard configuration file. To create a configuration file, a separate utility is available from the
Toshiba Global Commerce Solutions support website. To download and use this utility, perform
the following steps:
1. Go to .
2. Click Other Systems and Devices.
3. Click Firmware and Utilities for CANPOS. All utilities are packaged in a single zip file for
supporting different operating systems. Based on your preferred system, you can download
the appropriate utility.
4. Unzip the package and choose the appropriate utility to generate the configuration file.
5. Rename or save your file as aipcnpos.pcf and place it in folder \pos\config for
Windows systems, or /usr/share/pos for Linux systems.
6. Reboot your POS system and the configuration file is loaded automatically.
To confirm the success of the firmware and configuration download, check aipanpos.log
under \pos\log in Windows, or /var/log in Linux POS systems.

Installing USB system-attached keyboard in Windows

The proper device driver is automatically installed for the USB system keyboard in POS Ready
2009, if you select Alphanumeric Point of Sale Keyboard and indicate that it is attached to a
USB port during installation. After reboot, a Windows message is displayed indicating that you
are installing the POS USB Keyboard. Click Continue Anyway to install Toshiba's driver.
Note: If you are installing the keyboard for the first time, the system must be rebooted again
before the new driver can be used.

216 UnifiedPOS User's Guide

JavaPOS configuration

Click
<prop name="com.ibm.jpos.sdi.config.POSKeyboard.Click" type="Byte" value="0x00"/>

JavaPOS provides a user-configurable mechanism to modify the loudness of the keyboard click.
This is accomplished by specifying the following in the keyboard’s JposEntry.
Valid values for the Click property (default is 0x00):
0x00 (off)
0x01 (soft)
0x02 (loud)
Device Support*:
• 1, 2, 3, 4, 5, 6, 7, 11, 13, 19, 20, 21, 22, 23, 24
• USB Only: 10, 12, 18, 21
*USB not supported when configured as system keyboard.

FatFingerTimeout
<prop name="com.ibm.jpos.sdi.config.POSKeyboard.FatFingerTimeout" type="Byte"
value="0x03"/>

A fat-finger situation occurs when an operator attempts to press a single key, but misses the
center of the key and presses both the intended key and an adjacent key. The time interval
between subsequent key strokes is measured by the keyboard's processor. If the two keys were
pressed within a certain interval, a fat-finger situation is assumed and a status indicating this
occurrence accompanies the scan codes to the terminal.
Device Support:
• 1 (RS-485, USB)*, 3, 4, 5, 6, 7 (RS-485, USB), 11 (RS-485, USB)*, 13, 19, 20, 24
• USB Only: 10, 12, 18, 21, 22*, 23*
*USB not supported when configured as system keyboard.
Valid values are 0 through 4. The default is 3:
0 = 0 milliseconds (fat-finger detection disabled)
1 = 10 milliseconds
2 = 20 milliseconds
3 = 30 milliseconds
4 = 40 milliseconds

ExtendedKeyMapping
<prop name="com.ibm.jpos.sdi.config.POSKeyboard.ExtendedKeyMapping" type="Boolean"
value="true"/>

Chapter 15. POS keyboard 217

The extended scan code property is used to differentiate between two keys having the same
hardware scan code. A typical extended scan code is represented by two scan codes, for
example: X'e0' X'23'.
When the ExtendedKeyMapping property is true, the first scan code of the extended key is
replaced by X'01'; the second scan code is not altered. For example, the extended key X'e0' X'23'
is returned to the application as X'123'.
When the ExtendedKeyMapping property is false, the extended keys are not supported. Only a
single scan code is returned to the application (X'0023').
Valid values are TRUE and FALSE. The default is TRUE.
Device Support:
• PS2: 1, 2, 8, 9, 11, 14, 22, 23
• USB when configured as system keyboard: 1, 11, 22, 23

KbdScanning

<prop name="com.ibm.jpos.sdi.config.POSKeyboard.KbdScanning" type="Boolean"

value="true"/>

This property controls whether to enable or disable keyboard scanning. When scanning is
enabled, the keyboard generates make and break scan codes for each key press.
Device Support:
• 1, 2, 3, 4, 5, 6, 7, 9, 10, 11, 12, 13, 15, 18, 19, 20, 21, 22, 23, 24
Valid values are TRUE and FALSE. The default is TRUE.

KeyTranslationFile
<prop name="KeyTranslationFile" type="String" value="\keys.dat"/>

The KeyTranslationFile property contains the full path name of the file containing key
translation information. A sample file called keys.dat is included with the installation.
The location of the sample file depends on the operating system:
• Linux: /opt/tgcs/javapos/docs
• Windows: C:\POS\JavaPOS\Docs

Typematic
<prop name="com.ibm.jpos.sdi.config.POSKeyboard.Typematic" type="Boolean"
value="true"/>

This property controls the typematic function of the keyboard.

Most of the keys on all keyboards are optionally typematic keys. The typematic function is
enabled or disabled for the entire keyboard with this option.

218 UnifiedPOS User's Guide

If the typematic function is disabled and a key is pressed, then the make key code is generated
only once–no matter how long that key is held down. If the key is released, the break code is
sent.
If the typematic function is enabled and a key is pressed, the make key code is generated. If the
key remains pressed for a period longer than the amount of time defined by typematic delay in
the jpos.xml, another make key code is generated. As long as the key remains pressed, make
key codes are generated at the rate defined by typematic rate until the key is released, at which
time the break code is sent.
Valid values are TRUE and FALSE. The default is TRUE.
Device Support:
• 1*, 2, 3, 4, 5, 6, 7, 11*, 13, 19, 20, 21
• USB Only: 10, 12, 18, 21, 22*, 23*, 24
*USB on Linux not supported when configured as system keyboard.

TypematicDelay
<prop name="com.ibm.jpos.sdi.config.POSKeyboard.TypematicDelay" type="Byte"
value="0x01"/>

Device Support:
• 1 (RS-485, USB)*, 3, 4, 5, 6, 7 (RS-485, USB), 11 (RS-485, USB)*, 13, 19, 20, 22*, 23*
• USB Only: 10, 12, 18, 21
*USB not supported when configured as system keyboard.
The typematic delay determines how long the key must be pressed before the typematic function
is enabled.
Valid values for the TypematicDelay property are listed below; the default is 0x01:
0x00 = Delay 250 milliseconds
0x01 = Delay 500 milliseconds
0x02 = Delay 750 milliseconds
0x03 = Delay 1000 milliseconds

TypematicRate
The typematic rate determines how many make codes are generated per second (+/-20%).

<prop name="com.ibm.jpos.sdi.config.POSKeyboard.TypematicRate"
type="Byte" value="0x14"/>

Device Support:
• 1 (RS-485, USB)*, 3, 4, 5, 6, 7 (RS-485, USB), 11 (RS-485, USB)*, 13, 19, 20, 22*, 23*
• USB Only: 10, 12, 18, 21
*USB not supported when configured as system keyboard
Valid values for the TypematicRate property are listed below. The default is 0x14.

Chapter 15. POS keyboard 219

0x00 = Rate 2.0
0x01 = Rate 2.1
0x02 = Rate 2.3
0x03 = Rate 2.5
0x09 = Rate 4.3
0x0a = Rate 4.6
0x0b = Rate 5.0
0x0c = Rate 5.5
0x0d = Rate 6.0
0x0e = Rate 6.7
0x0f = Rate 7.5
0x10 = Rate 8.0
0x11 = Rate 8.6
0x12 = Rate 9.2
0x13 = Rate 10.0
0x14 = Rate 10.9
0x15 = Rate 12.0
0x16 = Rate 13.3
0x17 = Rate 15.0
0x18 = Rate 16.0
0x19 = Rate 17.1
0x1a = Rate 18.5
0x1b = Rate 20.0
0x1c = Rate 21.8
0x1d = Rate 24.0
0x1e = Rate 26.7
0x1f = Rate 30.0

JavaPOS DirectIO calls

Syntax directIO ( command: int32, inout data: int32, inout obj:
object ): void { raises-exception, use after open-claim-enable}
To access DirectIO constants, import com.ibm.jpos.services.DirectIO.

Get keyboard light status command

This command returns the indicators status in data[0].

Table 152. DirectIO.GET_KBD_LIGHT_STATUS_CMD

Parameter Type Description

Command Int32 DirectIO.GET_KBD_LIGHT_STATUS_CMD
Data Int32 An int array with at least one element
Obj Object Any value. A null value is accepted

220 UnifiedPOS User's Guide

Remarks
Returns the indicator status on data[0] reference parameter. The bit values in the int
parameter ( data[0] ) are:
• '1' = LED is to be turned on
• '0' = LED is to be turned off

Table 153. DirectIO.GET_KBD_LIGHT_STATUS_CMD bit representation

Parameter Bit representation of the data element

7–31 bits Reserved - must =0
6 SCROLL-LOCK = DirectIO.KBD_SCROLL_LOCK_LIGHT
5 CAPS-LOCK = DirectIO.KBD_CAPS_LOCK_LIGHT
4 NUM-LOCK = DirectIO.KBD_NUM_LOCK_LIGHT
3 "no label" or READY = DirectIO.KBD NO_LABEL_LIGHT
2 MSG PEND or SYS MSG =
DirectIO.KBD_MESSAGE_PENDING_LIGH
T
1 OFFLINE = DirectIO.KBD_OFFLINE_LIGHT
0 WAIT = DirectIO.KBD_WAIT_LIGHT

Set keyboard light on command

This command illuminates the indicator specified on the data[0] parameter.

Table 154. DirectIO.TURN_KBD_LIGHT_ON_CMD bit representation

Parameter Type Description

Command Int32 DirectIO.TURN_KBD_LIGHT_ON_CMD
Data[0] Int32 Data can be set to any of the following options:
DirectIO.KBD_WAIT_LIGHT
DirectIO.KBD_OFFLINE_LIGHT
DirectIO.KBD_MESSAGE_PENDING_LIGHT
DirectIO.KBD_NO_LABEL_LIGHT
DirectIO.KBD_NUM_LOCK_LIGHT
DirectIO.KBD_CAPS_LOCK_LIGHT
DirectIO.KBD_SCROLL_LOCK_LIGHT

Obj Object Any value. A null value is accepted.

Chapter 15. POS keyboard 221

Set keyboard light off command
This command turns off the indicator specified on the data[0] parameter.

Table 155. DirectIO.TURN_KBD_LIGHT_OFF_CMD

Parameter Type Description

Command Int32 DirectIO.TURN_KBD_LIGHT_OFF_CMD
Data[0] Int32 Data can be set to any of the following options:
DirectIO.KBD_WAIT_LIGHT
DirectIO.KBD_OFFLINE_LIGHT
DirectIO.KBD_MESSAGE_PENDING_LIGHT
DirectIO.KBD_NO_LABEL_LIGHT
DirectIO.KBD_NUM_LOCK_LIGHT
DirectIO.KBD_CAPS_LOCK_LIGHT
DirectIO.KBD_SCROLL_LOCK_LIGHT

Obj Object Any value. A null value is accepted.

A UposExceptionException might be thrown when this method is invoked.

Additional JavaPOS information

Firmware Update
The JavaPOS provides a mechanism to update the firmware for Modular keyboards for USB
and PS/2 connectivity. The driver release contains the most up-to-date firmware files for these
keyboards and the firmware will be automatically updated when system boots. The table below
describes Modular keyboard type, firmware file, and location of the firmware file on the system.
To update the firmware, copy the new firmware file at the location specified in the table below
and reboot the system.

Table 156. Modular Keyboards (Device 22, 23, 24, 25)

Modular Keyboard Location on Location on
Type Bus Firmware File Windows Linux
67-Key without MSR USB aip46013.dat c:\pos\usb /opt/tgcs/
javapos/
flash/usb
67-Key with MSR USB aip46063.dat c:\pos\usb /opt/tgcs/
javapos/
flash/usb

222 UnifiedPOS User's Guide

Modular Keyboard Location on Location on
Type Bus Firmware File Windows Linux
Alphanumeric(All) USB aip46043.dat c:\pos\usb /usr/
share/pos/usb
Alphanumeric(All) PS/2 aip46043.dat C:\pos\usb /usr/
share/pos/usb
Compact USB aip46093.dat c:\pos\usb /usr/
Alphanumeric share/pos/usb
67-Key with Display USB aip46023.dat c:\pos\usb /usr/
USB share/pos/usb

Table 157. Compact Alphanumeric Keyboard (Device 9)

Location on Location on
Keyboard Type Bus Firmware File Windows Linux
Compact USB aipcnpos.dat c:\pos\firmwa /usr/
Alphanumeric re share/pos/
Keyboard firmware

Configuration file update

The JavaPOS provides a mechanism to update the configuration file for Modular keyboards for
USB and PS/2 connectivity. This is a two step process.
To avoid conflict with JavaPOS drivers, it is recommended to install this utility on a separate
system which does not contain JavaPOS drivers.
1. Download Configuration Utility and install it.
2. Attach the Modular keyboard to the system and using the utility, create a configuration
file. Depending on keyboard type, the configuration will assign the correct configuration file
name. However, make sure that it complies with the table below.
3. Copy the configuration file to the location specified in the table below.
4. Reboot the system.

Table 158. Modular Keyboards (Device 22, 23, 24, 25, 26, 27)
Modular Keyboard
Type Configuration File Location on Windows Location on Linux
67-Key without MSR aip46013.cfg c:\pos\config /usr/share/pos/config
67-Key with MSR aip46063.cfg c:\pos\config /usr/share/pos/config
Alphanumeric aip46043.cfg c:\pos\config /usr/share/pos/config
Compact aip46093.cfg c:\pos\config /usr/share/pos/config
Alphanumeric
67-Key Keyboard with aip46023.cfg c:\pos\config /usr/share/pos/config
Display

Chapter 15. POS keyboard 223

Modular Keyboard
Type Configuration File Location on Windows Location on Linux
32-Key programmable aip467c.cfg c:\pos\config /usr/share/pos/config
keypad with Keylock/
Electronic Keylock

Keyboard definition file

The keyboard definition file is used in conjunction with the KeyTranslationFile property. The file
allows the user to map physical keys into virtual key codes. It also allows the user to configure
double keys.

Virtual key codes

Each line of the table consists of an integer virtual keyboard code followed by white space (any
combination of spaces and tabs) followed by the input sequence consisting of any number of
actual keyboard codes. Individual codes in the input sequence are separated by white spaces.
For example, the line for up-arrow might be coded like this:
301 01 26 30

This coding indicates that when the sequence of values 01, 26, 30 comes in, it is recognized as
virtual keyboard code 301. (The characters corresponding to 01, 26, and 30 are Esc, [, and A.)
It is also possible to generate several virtual scan codes at once. This is achieved by grouping all
the virtual scan codes to be generated within square brackets. The following example shows an
entry indicating the drivers to generate two virtual scan codes: 302, followed by 303 when the
value 141 is scanned.
[302 303] 141

The actual keyboard codes needed to generate multiple virtual scan codes can be a sequence, as
in the first example:
[312 320 322] 141 29

In this case the virtual scan code sequence 312-320-322 is generated when the scan code sequence
is complete. This means that the single 141 code does not trigger any scan code.
The character-encoding rules are:
1. Any single character, except space, tab, and # stands for itself. The example sequence can be
coded as:
301 01 [ A 2

2. A sequence of two or more digits is interpreted as an integer value, as in the example. If an

integer starts with a zero, it is interpreted as an octal number.
The example above can be coded as:
301 01 032 036

If an integer starts with a 0x, it is interpreted as a hex number.

224 UnifiedPOS User's Guide

3. An integer (decimal, hex, or octal) can have a leading plus sign.
This is essential for coding decimal integers less than ten, because a single digit alone is
interpreted as an ASCII character under Rule 1. A # character could be coded as +4 but not
as a 4 only.
4. A # starts a comment. It and the rest of the line are skipped.
If a line consists of nothing but a comment, or is empty, it is skipped.
5. The character's space, tab, and # cannot be coded literally. They can be coded as integers 57,
15, and +4 (Windows scan codes).
6. Input characters that are their own virtual keyboard codes (such as carriage return, A, Z,
=, ...) do not need to be coded in the table. When the Java Keyboards Mapping function is
reading characters and is about to begin a new sequence, a character that does not match
any sequence is returned as is.
7. When the finite-state machine is in the middle of some candidate sequences, a non matching
character signals the end of sequence. All previous characters from the beginning of
sequence to the non matching character are returned as is.
The finite-state machine then resets to accept a new sequence. For example, assume that 99
is the scan code for a, and 100 is the scan code for b. The entries in the keys.dat file are:
400 99 b

If you press the a key, and then press the b key, two data events are generated:
• Press the a key (scan code 99). The a key does not return scan codes until scan code
completes the sequence.
• Press the b key. The b key does return 2 data events: scancode 99 (for a) and scancode
100 (for b); the rule is not reached.
8. Virtual keycode value range from 0000 to 0xFFFF and keyboard code value range from 00 to
0xFF. If any of the values exceed its range, the line is skipped.
When making the keyboard definition table, only scan codes may be used for the system-
attached keyboard. Characters cannot stand for themselves, as stated in Rule 1.

Double key support

The double key definition format is as follows:0xFF <expected scan code> <scancode
for 1st key> <scancode for 2nd key> <filter time in ms>
The <filter time in ms> is optional.
Its default value is zero, and the recommended filter time is 60 milliseconds
For example:
0xFF 0X1C 0x71 0x1C 50
0xFF 0x7E 0x7E 0x5F 0x32

where:
0x1C is the scancode for key switch 109
0x71 is the scancode for key switch 108
0x7E is the scancode for key switch 106
0x5F is the scancode for key switch 107

Whenever keys 108 and 109 are pressed within 50 milliseconds of each other, the scancode
returned to the application is 0x1C.
Whenever keys 106 and 107 are pressed within 50 milliseconds of each other, the scan code
returned to the application is 0x7E.

Chapter 15. POS keyboard 225

The filter time specified for both double key definitions in the example above is 50 milliseconds

USB System attached keyboard on Linux

When there is a USB System keyboard, you can not have a PS/2 keyboard plugged into the
system. It might cause the USB Keyboard to malfunction.

OPOS configuration
In order to apply the configurations shown below, create the keyword of the specified type into
the following windows registry:
-
HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\POSKeyboard\Logica
lName
Note: For 32 bits Application running on 64 bits Windows, use the following path instead:
-
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\OLEforRetail\ServiceOPOS\POSKey
board\LogicalName
"LogicalName" refers to the actual device logical name given by end user at configuration time.

Table 159. Settings for POS keyboard

Keyword Type Description
NumlockOn String Initial state of Num Lock light. Overrides the Numlock setting. Valid
values are:

True
Illuminated

(other value)
Dark (default)
NumlockEnabled String Whether the Num Lock key is enabled. Valid values are:

True
Enabled

(other value)
Disabled (default)
ScrolllockOn String Initial state of Scroll Lock light. Valid values are:

True
Illuminated

(other value)
Dark (default)
ScrolllockEnabled String Whether the Scroll Lock key is enabled. Valid values are:

226 UnifiedPOS User's Guide

Keyword Type Description

True
Enabled

(other value)
Disabled (default)
Typematic String Whether the typematic function is enabled. Valid values are:

True
Enabled

(other value)
Disabled (default)

Note: The settings above apply to the physical keyboard. Since one physical keyboard can
contain multiple logical devices (MSR, keylock, Line display, POS keyboard), these settings are
not stored with the normal service object settings, but are stored in a different location in the
registry (HKLM\SOFTWARE\OLEforRetail\ServiceInfo).

Table 160. Service Object settings for POS keyboard

Keyword Type Description
MapPosKeys String Filename of Key Map file. The default value is
C:\POS\BIN\KBDKMAP.DAT.
MapKeyboardToOS String Denotes whether key events from RS-485 keyboard are converted to
Windows key events. Valid values are:

True
Enable conversion

(other value)
Disable conversion
Note: This setting cannot be modified with the Configuration tool.

OnlineTimeout String Time (in milliseconds) to wait for device to come online.
Note: This setting cannot be modified with the Configuration tool.

OPOS DirectIO calls

Get keyboard light status

Returns the current state of the keyboard LEDs

Table 161. Get keyboard light status

Parameter Type Description
Command Int32 200

Chapter 15. POS keyboard 227

Parameter Type Description
Data Long* Pointer to a byte. On return the byte contains a mask of the
current keyboard LED state. See Table 162 for more details.
Obj BSTR* Ignored

Table 162. Byte information

Bit Value LED
0 1 Wait LED
1 2 Offline LED
2 4 Message Pending LED
3 8 Unlabeled LED

Set keyboard light on

This turns on the POS LEDs on the keyboard. This does not affect the 3 standard keyboard LEDs
(Caps Lock, Scroll Lock or Num Lock).

Table 163. Set keyboard light on

Parameter Type Description
Command Int32 201
Data Long* Pointer to a byte containing a mask of LEDs to enable
Obj BSTR* Ignored

Set keyboard light off

This turns off the POS LEDs on the keyboard. This does not affect the 3 standard keyboard LEDs
(Caps Lock, Scroll Lock or Num Lock).

Table 164. Set keyboard light off

Parameter Type Description
Command Int32 202
Data Long* Pointer to a byte containing a mask of LEDs to disable
Obj BSTR* Ignored

Additional OPOS information

228 UnifiedPOS User's Guide

Firmware Update
The OPOS provides a mechanism to update the firmware for Modular keyboards for USB
and PS/2 connectivity. The driver release contains the most up-to-date firmware files for these
keyboards and the firmware will be automatically updated when system boots. The table below
describes Modular keyboard type, firmware file, and location of the firmware file on the system.
To update the firmware, copy the new firmware file at the location specified in the table below
and reboot the system.

Table 165. OPOS Modular Keyboards (Device 22, 23, 24)

Modular Keyboard
Type Bus Firmware File Location on Windows
67-Key without MSR USB aip46013.dat c:\pos\usb
67-Key with MSR USB aip46063.dat c:\pos\usb
67-Key with Display USB aip46023.dat c:\pos\usb
Alphanumeric(All) USB aip46043.dat c:\pos\usb
Alphanumeric(All) PS/2 aip46043.dat c:\pos\usb
Compact USB aip46093.dat c:\pos\usb
Alphanumeric

Table 166. Compact Alphanumeric Keyboard (Device 9)

Keyboard Type Bus Firmware File Location on Windows
Compact USB aipcnpos.dat c:\pos\firmware
Alphanumeric
Keyboard

Configuration file update

The OPOS provides a mechanism to update the configuration file for Modular keyboards for
USB and PS/2 connectivity. This is a two step process.
To avoid conflict with OPOS drivers, it is recommended to install this utility on a separate
system which does not contain OPOS drivers.
1. Download Configuration Utility and install it.
• Go to .
• Click POS Keyboards under Peripherals.
• Click Downloads under Toshiba Modular POS Keyboards.
• Click Modular POS Keyboard & 4820 Keypad/MSR/Keylock Firmware &
Configuration Utility.
• Install utility.
2. Attach the Modular keyboard to the system. Using the utility, create a configuration file.
Depending on the keyboard type, the configuration will assign the correct configuration file
name. Verify that this name complies with the table below.
3. Copy the configuration file to the location specified in the table below.

Chapter 15. POS keyboard 229

4. Reboot the system.

Table 167. Modular Keyboards (Device 22, 23, 24)

Modular Keyboard Type Configuration File Location on Windows
67-Key without MSR aip46013.cfg c:\pos\config
67-Key with MSR aip46063.cfg c:\pos\config
Alphanumeric aip46043.cfg c:\pos\config
Compact Alphanumeric aip46093.cfg c:\pos\config

Configuring the Alphanumeric Point of Sale keyboard

If you chose to install your Toshiba Alphanumeric Point-of-Sale (ANPOS) or Compact
Alphanumeric Point-of-Sale (CANPOS) keyboard as the system keyboard, you should use the
ANPOS utility program to:
1. Define double keys. These key switches can be doubled: 77, 78, 82, 87, 88, 90, 94, 95, 99, 100,
105 to 109, 112 to 123, 125 to 128.
2. Override the keyboard default values for the following settings:
• Numeric keypad zero (key 94, 99)
• Key click
• POS LEDs initial setting
The ANPOS utility runs automatically at boot time. It uses the sample resource file,
aipsys.res.
• On Windows, aipsys.res is located in the default install directory, C:\POS.
• On Linux systems, aipsys.res is located in the /etc directory.
Note:
1. In the aipsys.res file, the keyboard resource names must be qualified with the application
name, aipanpos, and the device name, system. For example:
aipanpos.system.keyboardClick: SOFT
aipanpos.system.doubleKey01: 77,82
aipanpos.system.doubleKey02: 90,95

See “Modifying USB, RS-485, and PS/2 device behavior” on page 75 for more information on
using the resource file.
2. The ANPOS utility records any errors in the file, aipanpos.log.
• On Windows systems, aipanpos.log is created in the default log directory,
C:\POS\LOG.
• On Linux systems, aipanpos.log is created in the /var/log directory.
3. For a system keyboard, the ANPOS utility is used only for:
• Double key definition
• LED setting (initial)
• Key click setting
The POS LEDs and the key click setting are not supported for the USB System Keyboard.
4. Changes to the aipsys.res file will not take effect until the system is rebooted.

230 UnifiedPOS User's Guide

SureOne/SurePOS 100 keyboard
The keyboard on the SureOne is a standard PS/2 keyboard. Toshiba OPOS does not implement
the UnifiedPOS POS keyboard specification for this keyboard.

Mapping POS keys

To configure the keyboard, perform the following steps:
1. Select a POS keyboard entry and click Configure. The keyboard configuration dialog is
displayed (see Figure 28).

Figure 28. Keyboard properties dialog

Note: There are 2 entries for System Attached Keyboard. For a PS/2 system keyboard, use
the entry with Slot value 0; for a USB system keyboard, use the entry with Slot value 8.
2. Select or clear the Num Lock and Scroll Lock to specify the initial settings you want for
those keys.
3. To configure POS keyboard mapping, select Map Pos Keys and click the Edit Map File
button. A filename field is displayed.
4. Enter the name of the POS keyboard mapping file. If the file exists, it is read and the values
are displayed in the POS Keyboard Mapping window (see Figure 29 ).

Chapter 15. POS keyboard 231

Figure 29. Sample POS keyboard mapping dialog
5. Edit the mapping data.
• To create an entry, click the Add button. A new entry is inserted at the top of the list.
Enter the scan code and mapping value, then click Save.

Figure 30. Example of adding a keyboard mapping entry

Note: Non-unique entries are allowed. If multiple entries with the same name exist, only
the first entry is used.
• To modify an existing entry, select it and click the Edit button. Edit the values and click
Save.

232 UnifiedPOS User's Guide

Figure 31. Editing a keyboard mapping entry
• To remove an entry, select it and click Delete.
• To record the scan code of a key, click Record and press the key you want to record.
An entry is inserted in the list with the scan code of the key you pressed. The dialog
continues recording keys until you click the Stop button. Use the Edit menu to assign
mapping values to the new entries.
6. When you have finished editing the keyboard mapping information, click Save File. The
keyboard mapping file is saved.

Chapter 15. POS keyboard 233

234 UnifiedPOS User's Guide
Chapter 16. POS printer
POS printer

Supported devices
Table 168. POS printer supported devices
Device Connectivity Comments
1. 4610 printer family EIA-232 Includes Tx1, Tx2, Tx3, Tx4, Tx5, Tx6, Tx7, Tx8, Tx9 models
2. 4610 printer family RS-485 Includes Tx1, Tx2, Tx3, Tx4, Tx5, Tx6, Tx7, Tx8, Tx9 models
3. 4610 printer family USB Includes Tx1, Tx2, Tx3, Tx4, Tx5, Tx6, Tx7, Tx8, Tx9 models
4. Model 3/4 printer family RS-485 Not Supported
5. Model 3/4 printer family USB Not Supported
6. 4689 printer family OPOS Only; Includes 001, 002
RS-485
(impact)
7. 4689 printer family OPOS Only; Includes 301, 3G1, 3M1
RS-485
(thermal)
8. 4689 printer family TD5
RS-485, USB
(thermal)
9. 4674 built-in printer RS-485 TD5 integrated
10. SureOne printer (single- OPOS only
EIA-232
head impact)
11. SureOne and SurePOS
EIA-232
100 printer (thermal)
12. SureOne printer (double- OPOS only
EIA-232
head impact)
13. SureOne printer
(A04/A05 impact) and
EIA-232
SurePOS 100 printer
(impact)
14. 4610 2xR/1NR EIA-232
15. 4610 2xR/1NR RS-485
16. 4610 2xR/1NR USB
17. 4610 2xR/1NR Network
USB, Network, Includes 6145-2TC and 6145-2TN
18. 6145-2Tx/1TN
EIA-232

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 235

Supported properties and methods
Table 169. POS printer common properties
Property JavaPOS OPOS
AutoDisable Not supported
BinaryConversion Not supported All except 4, 5
CapCompareFirmwareVersion False 1 true only for
SST/TI3/TI4/TI5/TI8/TI9
14 - true

CapPowerReporting PR_STANDARD PR_STANDARD

CapStatisticsReporting True (see Appendix A, JavaPOS False
support for UnifiedPOS device
statistics properties on page 555)
CapUpdateFirmware False 1 true only for
SST/TI3/TI4/TI5/TI8/TI9
14 - true

CapUpdateStatistics False (see Appendix A, JavaPOS False

support for UnifiedPOS device
statistics properties on page 555)
CheckHealthText All except 4, 5
Claimed All except 4, 5
DataCount Not supported
DeviceControlDescription All except 4, 5
DeviceControlVersion All except 4, 5
DeviceEnabled All except 4, 5
DeviceServiceDescription All except 4, 5
DeviceServiceVersion All except 4, 5
FreezeEvents All except 4, 5
OpenResult Not supported All except 4, 5
OutputID All except 4, 5
PowerNotify All except 4, 5
PowerState All except 4, 5
PhysicalDeviceDescription All except 4, 5
PhysicalDeviceName All except 4, 5
ResultCode Not supported All except 4, 5
ResultCodeExtended Not supported All except 4, 5

236 UnifiedPOS User's Guide

Property JavaPOS OPOS
State All except 4, 5

Table 170. POS printer specific properties

Property JavaPOS OPOS
AsyncMode All except 4, 5
CapCharacterSet All except 4, 5 - Values based on HW
CapConcurrentJrnRec 6, 7, 8, 9 6, 7, 8
CapConcurrentJrnSlp Not supported
CapConcurrentPageMode Not supported
CapConcurrentRecSlp 1, 2, 3 (TI1-5, TI8-9), 14, 15, 16 1, 2, 3 (TI1-5, TI8–9), 14,15,16, 17 (2xR), 18
(2xR), 18
CapCoverSensor All except 4, 5 All except 4, 5, 10, 11, 12, 13
CapMapCharacterSet Not supported 1, 2, 3, 7, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18
CapRecPageMode 1, 2, 3, 14, 15, 16,17, 18 1, 2, 3 - true only for TI4/TI8/TI9, TI5/TI9
14, 15, 16, 17, 18 - true

CapSlpPageMode Not supported

CapTransaction All except 4, 5
CapJrnPresent 6, 7, 8, 9 6, 7, 8
CapJrn2Color Not supported
CapJrnBold 7, 8, 9 Not supported
CapJrnCartridgeSensor Not supported
CapJrnColor Not supported
CapJrnDhigh 7, 8, 9 7, 8
CapJrnDwide 7, 8, 9 7, 8
CapJrnDwideDhigh 7, 8, 9 7, 8
CapJrnEmptySensor 6, 7, 8, 9 6, 7, 8
CapJrnItalic Not supported
CapJrnNearEndSensor 7, 8, 9 7, 8
CapJrnUnderline 7, 8, 9 7, 8
CapRecPresent All except 4, 5
CapRec2Color 1, 2, 3 (TI3-4,Tx6-9), 14, 15, 16, 17 EC > 0x33, 18
CapRecBarCode 1, 2, 3, 7, 8, 9, 11, 14, 15, 16, 17, 18 1, 2, 3, 7, 8, 11, 14, 15, 16, 17, 18
CapRecBitmap All except 4, 5

Chapter 16. POS printer 237

Property JavaPOS OPOS
CapRecBold 1, 2, 3, 7, 8, 9, 11, 13, 14, 15, 16, 17, 1, 2, 3, 10, 11, 13, 14, 15, 16, 17, 18
18
CapRecCartridgeSensor Not supported
CapRecColor 1, 2, 3 (TI3-4,Tx6-9), 14, 15, 16, 17 EC > 0x33
CapRecDhigh 1, 2, 3, 7, 8, 9, 11, 13, 14, 15, 16, 17, 1, 2, 3, 7, 8, 11, 13, 14, 15, 16, 17, 18
18

CapRecDwide 1, 2, 3, 7, 8, 9, 11, 13, 14, 15, 16, 17, 1, 2, 3, 7, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18
18
CapRecDwideDhigh 1, 2, 3, 7, 8, 9, 11, 13, 14, 15, 16, 17, 1, 2, 3, 7, 8, 11, 13, 14, 15, 16, 17, 18
18

CapRecEmptySensor 1, 2, 3, 6, 7, 8, 9, 11 (Only SurePOS 1,2,3 (2CR, 2NR, 1NR models only) 6, 14, 15,
100), 13 (Only SurePOS 100), 14, 16, 17, 18
15, 16, 17, 18

CapRecItalic Not supported

CapRecLeft90 1, 2, 3, 14, 15, 16, 17, 18
CapRecMarkFeed Not supported
CapRecNearEndSensor 7, 8, 14, 15, 16, 17 (2xR), 18
CapRecPapercut All except 4, 5 All except 4, 5, 10, 12, and 13
CapRecRight90 1, 2, 3, 8, 9, 14, 15, 16, 17, 18 1, 2, 3, 8, 14, 15, 16, 17, 18
CapRecRotate180 1, 2, 3, 11, 14, 15, 16, 17 EC > 0x33, 1, 2, 3 EC > 0x33 and 10, 11, 12, 13, 14, 15, 16,
18 17, 18
CapRecRuledLine Not Supported
CapRecStamp 1, 2, 3, 11, 13, 14, 15, 16, 17, 18- uses stored bitmap 1
6 - physical stamp
7, 8, 9 - downloaded stamp

CapRecUnderline 1, 2, 3, 7, 8, 9, 11, 13, 14, 15, 16, 17, 1, 2, 3, 7, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18
18
CapSlpPresent 1, 2, 3 (TI1-5, TI8-9), 14, 15, 16, 17 1, 2, 3, 14, 15, 16, 17 (2xR), 18
(2xR), 18
CapSlpFullslip Not supported
CapSlp2Color Not supported
CapSlpBarCode 1, 2, 3, 14, 15, 16, 17 (2xR) EC > 0x1D
CapSlpBitmap 1, 2, 3 (TI1-5, TI8-9), 14, 15, 16, 17 1, 2, 3, 6, 14, 15, 16, 17 (2xR), 18
(2xR), 18
CapSlpBold 1, 2, 3 (TI1-5, TI8-9), 14, 15, 16, 17 1, 2, 3, 14, 15, 16, 17 (2xR), 18
(2xR), 18

238 UnifiedPOS User's Guide

Property JavaPOS OPOS
CapSlpBothSidesPrint 1, 2, 3, (TI1-4, TI8-9), 14, 15, 16, 17 (2CR), 18
CapSlpCartridgeSensor Not supported
CapSlpColor Not supported
CapSlpDhigh 1, 2, 3
14, 15, 16, 17 (2xR), 18

CapSlpDwide 1, 2, 3, 14, 15, 16, 17 (2xR), 18

CapSlpDwideDhigh 1, 2, 3, 14, 15, 16, 17 (2xR), 18
CapSlpEmptySensor 1, 2, 3, 14, 15, 16, 17 (2xR), 18
CapSlpItalic Not supported
CapSlpLeft90 1, 2, 3, 14, 15, 16, 17 (2xR), 18 1, 2, 3 (except TI5 and Tx7), 14,15,16, 17 (2xR
- SBCS Only), 18 (SBCS Only)
CapSlpNearEndSensor 1, 2, 3, 14, 15, 16, 17 (2xR), 18 1, 2, 3, 6, 14, 15, 16, 17 (2xR), 18
CapSlpRight90 Not supported
CapSlpRotate180 Not supported
CapSlpRuledLine Not supported
CapSlpUnderline Not supported
CartridgeNotify Not supported
CharacterSet All except 4, 5
CharacterSetList See “Character sets supported by See “Character sets supported by
POSPrinter devices for JavaPOS” POSPrinter devices for OPOS” on page 344
on page 291
CoverOpen 1, 2, 3, 11, 14, 15, 16, 17, 18 1, 2, 3, 14, 15, 16, 17, 18
7, 8, 9 - when printer not idle 7, 8 - when printer not idle

ErrorLevel All except 4, 5

ErrorStation All except 4, 5
ErrorString All except 4, 5
FlagWhenIdle All except 4, 5
FontTypefaceList Not supported 1, 2, 3 (TI3-5, Tx6-9) EC > 0x33 14, 15,
16, 17, 18 can list "Fixed, Proportional"
based on downloaded UD Fonts, null string
otherwise
JrnCartridgeState Not supported
JrnCurrentCartridge Not supported
JrnEmpty 6, 7, 8, 9 6, 7, 8

Chapter 16. POS printer 239

Property JavaPOS OPOS
JrnLetterQuality Not supported
JrnLineChars 1, 2, 3, 14, 15, 16, 17, 18 - 0 1, 2, 3, 10, 11, 12, 13, 14, 15, 16, 17, 18 - 0
6 - 25 6 - 25
7, 8, 9 - 32 7, 8 - 32

JrnLineCharsList 1, 2, 3, 14, 15, 16, 17, 18 - "" (empty) 1, 2, 3, 10, 11, 12, 13, 14, 15, 16, 17, 18 - ""
(empty)
6 - "25,30"
6 - "25,30"
7, - "32,42"
7, 8- "32,42"
8, 9 - "32"

JrnLineHeight 1, 2, 3, 14, 15, 16, 17, 18 - 0 1, 2, 3, 10, 11, 12, 13, 14, 15, 16, 17, 18 - 0
6-9 6-9
7, 8, 9 - 24 7, 8- 24

JrnLineSpacing 1, 2, 3, 14, 15, 16, 17, 18 - 0 1, 2, 3, 10, 11, 12, 13 - 0

6 - 12 6 - 12
7, - 27 7, 8- 27
8, 9 - 30

JrnLineWidth 1, 2, 3, 14, 15, 16, 17, 18 - 0 1, 2, 3, 10, 11, 12, 13, 14, 15, 16, 17, 18 - 0
6 - 300 6 - 300
7 - 420 7, 8 - 420
8, 9 - 432

JrnNearEnd 7, 8, 9 7, 8
MapCharacterSet Not supported 1, 2, 3, 14, 15, 16, 17, 18
MapMode All except 4, 5
PageModeArea 4610: When PageModeStation 1,2,3 (TI4/TI8/TI9, TI5/TI9 EC > 0x33) 14,
is set "0,0,576,1250" (for 15, 16, 17, 18 - When PageModeStation is
TI8/9/2xR/1NR/2TC/2TN) or set "0,0,576,1250" (for TI8/9) or "0,0,576,800";
"0,0,576,800"; else zero else zero
PageModeDescriptor 4610: 1,2,3 (TI4/TI8/TI9, TI5/TI9 EC > 0x33) 14, 15,
16, 17, 18
PTR_PM_BITMAP |
PTR_PM_BARCODE | PTR_PM_BITMAP |
PTR_PM_BM_ROTATE | PTR_PM_BARCODE |
PTR_PM_BC_ROTATE | PTR_PM_BM_ROTATE |
PTR_PM_OPAQUE PTR_PM_BC_ROTATE |
PTR_PM_OPAQUE
When PageModeStation is set; else
zero. When PageModeStation is set; else zero.
PageModeHorizontalPosition 4610: Zero before setting 1, 2, 3 (TI4/TI8/TI9, TI5/TI9 EC > 0x33)
PageModeStation 14, 15, 16, 17, 18 - Zero before setting
PageModeStation

240 UnifiedPOS User's Guide

Property JavaPOS OPOS
PageModePrintArea 4610: When PageModeStation is OPOS: 1, 2, 3 (TI4/TI8/TI9, TI5/TI9 EC
set, max is PageArea value, else > 0x33) 14, 15, 16, 17, 18 - When
zero PageModeStation is set, max is PageArea
value, else zero
PageModePrintDirection 4610: Initialized to 1, 2, 3 (TI4/TI8/TI9, TI5/TI9 EC >
jpos.POSPrinterConst.PTR_PD_
0x33) 14, 15, 16, 17, 18 - Initialized
LEFT_TO_RIGHT to PTR_PD_LEFT_TO_RIGHT when the
device is first enabled
when the device is first enabled
PageModeStation 4610: 1, 2, 3 (TI4/TI8/TI9, TI5/TI9 EC > 0x33) 14,
jpos.POSPrinterConst.PTR_ 15, 16, 17, 18 - PTR_S_RECEIPT
S_RECEIPT

PageModeVerticalPosition 4610: Zero before setting 1, 2, 3 (TI4/TI8/TI9, TI5/TI9 EC > 0x33)

PageModeStation 14, 15, 16, 17, 18 - Zero before setting
PageModeStation
RecBarCodeRotationList 1, 2, 3, 14, 15, 16, 17, 18 (TI3-5, 1, 2, 3 (TI3-5, Tx6-9) EC > 0x33 can list
Tx6-9) EC > 0x33 can list "0,180". "0,180". Otherwise, 1, 2, 3 list "0".
Otherwise, 1, 2, 3 list "0".
8, 9 - "0"
14, 15, 16, 17, 18 "0,180"

RecBitmapRotationList "0"
RecCartridgeState Not supported
RecCurrentCartridge Not supported
RecEmpty 1, 2, 3, 6, 7, 8, 9, 14, 15, 16, 17, 18 1, 2, 3, 6, 14, 15, 16, 17, 18
RecLetterQuality 1, 2, 3 (TI3-5, Tx6-9) EC > 0x33, 14, 15, 16, 17, 18
RecLineChars 1, 2, 3 - (TI5,Tx7) - 38, (all other) - 1, 2, 3 (TI3-5, Tx6-9 EC > 0x33) - 44
44
1, 2, 3 (TI5,Tx7) - 38
6, 7 - 38
(all other) - 44
11 - 48
6, 7, 8 - 38
13 – 40 with narrow paper - 28
10, 11, 12, 13 - 40
8, 9 - 32
14, 15, 16, 17, 18 (DBCS) - 38
14, 15, 16, 17, 18 (DBCS) - 38
14, 15, 16, 17, 18 (SBCS) - 44
14, 15, 16, 17, 18 (SBCS) - 44

RecLineCharsList 1, 2, 3 - EC > 0x33 1, 2, 3 - EC > 0x33

(TI5,Tx7) - (TI5,Tx7) - "28,30,32,33,36,38,41,44,48"
"28,30,32,33,36,38,41,44,48"
(TI4, Tx6, TI8, TI9, 2xR/1NR -SBCS) -
(TI4, Tx6, TI8, TI9, 2xR/ "32,34,36,38,41,44,48,52,57,64,72"
1NR, 2TC/2TN -SBCS) -
1, 2, 3 (All other), - "34,44,48" (older models
"32,34,36,38,41,44,48,52,57,64,72"
only support "30, 38")

Chapter 16. POS printer 241

Property JavaPOS OPOS

1, 2, 3 (All other), - "34,44,48" 6 - "25, 30"

6 - "25,30" 7, 8 - "32, 42"
7 - "32,42" 10, 13 - "22, 33, 40"
8, 9, "32" 11 - "36, 38, 44, 48"
11- "36, 38, 41, 48" 12 - "33, 40"
13 – “22, 33, 40” with narrow 14,15,16, 17 (DBCS), 18 (2TC/2TN)(DBCS) -
paper “15, 23, 28” "28,30,32,33,36,38,41,44,48"
14,15,16, 17 (DBCS), 18 - 14,15,16, 17 (SBCS), 18 -
"28,30,32,33,36,38,41,44,48" "32,34,36,38,41,44,48,52,57,64,72"
14,15,16, 17 (SBCS), 18 -
"32,34,36,38,41,44,48,52,57,64,72"

RecLineHeight 1, 2, 3 (TI5,Tx7) - 24, (All other) - 1, 2, 3 (TI5,Tx7) - 24, (All other) - 20

20
6-9
6-9
7, 8, 9 - 24
7, 8, 9 - 24
11 - 24
11 - 24
13 - 9
13 - 9
14, 15, 16, 17, 18 (DBCS) - 24
14, 15, 16, 17, 18 (DBCS) - 24
14, 15, 16, 1), 18 (SBCS) - 20
14, 15, 16, 17, 18 (SBCS) - 20

RecLineSpacing 1, 2, 3 - 34 1, 2, 3 - 34
6 - 12 6 - 12
7 - 27 7, 8 - 27
8, 9 - 30 10, 12, 13 - 9
11 - 32 11 - 32
13 - 11 14, 15, 16, 17, 18 - 34
14, 15, 16, 17, 18 - 34

RecLinesToPaperCut 1, 2, 3 - 5 1-7
7-6 2, 3 - 12
8, 9 - 3 7, 8 - 6
6 - 16, 17, 18 6 - 16
11, 13 - 5 10, 11, 12, 13 - 4
14, 15, 16, 17, 18 - 5 14, 15, 16, 17, 18 - 6

RecLineWidth 1, 2, 3 (TI1-5, Tx6-9) - 576 1, 2, 3 (TI1-5, Tx6-9) - 576

1, 2, 3 Tx6-9 Narrow Paper - 400 1, 2, 3 Tx6-9 narrow paper - 400
6 - 300

242 UnifiedPOS User's Guide

Property JavaPOS OPOS

7 - 420 6 - 300
8, 9 - 320 7, 8 - 420
11 - 576 10, 12, 13 - 280
13 – 200, with narrow paper 140 11 - 576
14, 15, 16 – 576 14, 15, 16, 17, 18 - 576
14, 15, 16, 17 (1NR), 18 narrow 14, 15, 16, 17 (1NR), 18 narrow paper- 400
paper- 400

RecNearEnd 1, 2, 3, 7, 8, 14, 15, 16, 17, 18 14, 15, 16, 17, 18

RecSidewaysMaxLines 1, 2, 3 - 17 1, 2, 3 (Tx1-2) -25,
1, 2, 3 (Tx6-9 Narrow Paper - 12 1, 2, 3 (Tx3-5,Tx9) -17
7, 8, 9 - 14 1, 2, 3 (Tx6-7 Narrow Paper - 11
14, 15, 16, 17, 18 -17
14, 15, 16, 17 (1NR), 18 narrow
paper- 12

RecSidewaysMaxChars 1, 2, 3 - 61 (Tx8-9) – 95 1, 2, 3 (Tx1-2) - 256, (Tx3-5) - 53, (Tx6-7) -

61,( Tx8-9) - 96
7, 8, 9 – 256
7, 8 - 53
14, 15, 16, 17, 18 – 95
14, 15, 16, 17, 18 - 96

RotateSpecial _NORMAL: 1, 2, 3, 8, 9, 11, 14, 15, OPOS: _NORMAL: 1, 2, 3, 8, 9, 14, 15, 16, 17,
16 18
_LEFT90: — _LEFT90: --
_RIGHT90: — 8, 9 _RIGHT90: --
_ROTATE180: 1, 2, 3 (TI3-5, Tx6-9) _ROTATE180: 1, 2, 3 (TI3-5, Tx6-9) EC >
EC > 0x33, 14, 15, 16, 17, 18 0x33, 14, 15, 16, 17, 18

SlpBarCodeRotationList "0" 1, 2, 3, 14, 15, 16, 17, 18 - (TI3-5, Tx6-9) EC >

1D has "0"
SlpBitmapRotationList "0"
SlpCartridgeState Not supported
SlpCurrentCartridge Not supported
SlpEmpty 1, 2, 3, 14, 15, 16, 17 (2xR), 18
SlpLetterQuality 1, 2, 3 (TI3-5, Tx6-9), EC > 0x33 14, 1, 2, 3 (TI3-4, Tx6-9, TI8, TI9) EC > 0x33 (not
15, 16, 17, 18 supported on TI5) 14, 15, 16, 17, 18
SlpLineChars 1, 2, 3 - (TI5)- 24, (all other) 47 1, 2, 3- (TI5) -24 (all other ) - 47
14, 15, 16, 17 (2xR-DBCS), 18 (2Tx- 6 - 58
DBCS) - 24

Chapter 16. POS printer 243

Property JavaPOS OPOS

14, 15, 16, 17 (2R-SBCS), 18 (2Tx- 14, 15, 16, 17 (2xR-DBCS), 18(2Tx-DBCS) -
DBCS) - 47 24
14, 15, 16, 17 (2xR-SBCS), 18(2Tx-SBCS) - 47

SlpLineCharsList 1, 2, 3 - (TI5) - "19, 23, 24, 26, 27, 1 - (TI5,Tx7) - "19, 24" (all other)"37, 47, 52"
29", (all other) "30, 37, 38, 42, 47,
2, 3 - (TI5, Tx7) - "23, 24, 26, 27, 29" (all
52"
other)"30, 37, 38, 42, 47, 52"
14, 15, 16, 17 (2Tx-DBCS) - "19, 20,
6 - "58, 70"
21, 22, 23, 24, 26, 27, 29
14 (2xR-DBCS) - "19, 24", (with FW >=
14, 15, 16, 17 (2xR-DBCS) FW >=
0x0D.00, on DI station and codepage set to
0x0D.00 - "29, 31, 33, 36, 39, 43, 47,
1381), "30, 32, 34, 36, 38, 42, 44, 46, 48, 52, 54,
52, 59" Note 1
58"
14, 15, 16, 17 (2xR-SBCS), 18 (2Tx)-
15, 16, 17 (2xR-DBCS) - "23, 24, 26, 27, 29",
"30, 37, 38, 42, 47, 52"
(with FW >= 0x0D.00, on DI station and
codepage set to 1381), "30, 32, 34, 36, 38, 42,
44, 46, 48, 52, 54, 58"
14 (2xR-SBCS) - "23, 24, 26, 27, 29"
15, 16, 17 (2xR-SBCS), 18 (2Tx-SBCS) - "30,
37, 38, 42, 47, 52"

SlpLineHeight 1, 2, 3, 14, 15, 16, 17 (2xR), 18 (2Tx) 1, 14 - 4

-7
2, 3, 15, 16, 17, 18 - 7
6-9

SlpLinesNearEndToEnd All except 4, 5 - values based on HW

SlpLineSpacing 1, 2, 3, 14, 15, 16, 17 (2xR), 18 (2Tx) 1, 14 - 9
-9
2, 3, 15, 16, 17, 18 - 8
6 - 12

SlpLineWidth 1, 2, 3, 14, 15, 16, 17 (2xR), 18 (2Tx) 1, 14 - 474

- 474
2, 3, 15, 16, 17, 18 - 470
6 - 300

SlpMaxLines All except 4, 5 - values based on HW

SlpNearEnd 1, 2, 3, 14, 15, 16, 17 (2xR), 18 (2Tx) 1, 2, 3, 6, 14, 15, 16, 17 (2xR), 18 (2Tx)
SlpPrintSide 1, 2, 3 (TI1–5, TI8–9),
14, 15, 16, 17 (2xR), 18 (2Tx)

SlpSidewaysMaxLines 1, 2, 3, 14, 15, 16, 17 (2xR), 18 (2Tx) 1, 14 - 18

- 19
2, 3, 15, 16, 17, 18 (2Tx) - 19

244 UnifiedPOS User's Guide

Property JavaPOS OPOS
SlpSidewaysMaxChars 1, 2, 3, 14, 15, 16, 17 (2xR), 18 (2Tx) 1, 2, 3, 14, 15, 16, 17 (2xR), 18 (2Tx) - 147
- 148

Note:
1. The property
com.ibm.jpos.sdi.config.POSPrinter.EnableSlipDBCSCharCompression must
be enabled in order to show the mentioned List; refer to the “Additional JavaPOS
information” on page 175 section for property details.

Table 171. POS printer common methods

Method JavaPOS OPOS
checkHealth INTERNAL = ALL except 4, 5 All except 4, 5
EXTERNAL = ALL except 4, 5
INTERACTIVE = Not supported

claim All except 4, 5

clearInput Not supported
clearOutput All except 4, 5
close All except 4, 5
compareFirmwareVersion Not supported 1 true only for
SST/TI3/TI4/TI5/TI8/TI9/2CR/2N
R/1NR
directIO For 1, 2, 3 only: For 1, 2, 3 only:

X'01' X'01'
Flip check Flip check
8, 9 - X'10'
X'02' Write flash memory
PRINT_DOWNLOADED_BITMAP_ID X'11'
X'09' Read flash memory
DOWNLOAD_NON_PROP_FONT_ID X'12'
X'23' Query flash size
ERASE_FLASH_MEMORY_SECTOR_I X'13'
D
Query maximum records
X'20'
X'14'
SET_STAMP_ID
Set record length
X'25'
X'15'
DOWNLOAD_DBCS_FONT_ID
Erase flash memory

Chapter 16. POS printer 245

Method JavaPOS OPOS

X'16'
Get record length

101
Clear page mode print
area

102
Set/get page mode print

103
Set/get horizontal print
position (page mode)

104
Set/get vertical print
position (page mode)

105
Get page area

106
Set/get page mode station

107
Set/get page mode print
area

108
Set/get print direction

201
Set/get MICR read with
scan

202
Set/get compression
format

203
Scan document

204
Store document

205
Retrieve by index

246 UnifiedPOS User's Guide

Method JavaPOS OPOS

206
Retrieve by tagname

207
Erase image storage
open All except 4, 5
release All except 4, 5
resetStatistics Not supported
retrieveStatistics True (see Appendix A, JavaPOS support for Supported: 4610 and SureOne
UnifiedPOS device statistics properties on
page 555)
updateFirmware Not supported 1 true only for
SST/TI3/TI4/TI5/TI8/TI9
14 - true

updateStatistics Not supported

Table 172. POS printer specific methods

Method JavaPOS OPOS
beginInsertion 1, 2, 3 (except SST) 1, 2, 3 (except SST), 6
14, 15, 16, 17 (2xR), 18 (2Tx)
14,15,16, 17 (2xR), 18 (2Tx))

beginRemoval 1, 2, 3 (except SST) 1, 2, 3 (except SST), 6

14, 15, 16, 17 (2xR), 18 (2Tx)
14,15,16, 17 (2xR), 18 (2Tx)

changePrintSide 1, 2, 3 except SST and TI5 1, 2, 3 (except SST, TI5), 6

14, 15, 16, 17 (2xR), 18 (2Tx))
14,15,16, 17 (2CR), 18 (2Tx)

clearPrintArea 4610: supported 1, 2, 3 (TI3-4, Tx6-9, TI8, TI9) EC >

0x33
14, 15, 16, 17, 18

cutPaper 1,2,3,7,8,9,14,15,16, 17, 18 All except 4, 5, 11

drawRuledLine Not supported
endInsertion 1, 2, 3 (except SST) 1, 2, 3 (except SST), 6
14, 15, 16, 17 (2xR), 18 (2Tx)
14,15,16, 17 (2xR), 18 (2Tx)

endRemoval 1, 2, 3 (except SST) 1, 2, 3 (except SST), 6

14, 15, 16, 17 (2xR), 18 (2Tx)
14,15,16, 17 (2xR), 18 (2Tx)

markFeed Not supported

pageModePrint 4610: Control is one of the following: PTR_PM_PAGE_MODE,
PTR_PM_PRINT_SAVE, PTR_PM_NORMAL, PTR_PM_CANCEL

Chapter 16. POS printer 247

Method JavaPOS OPOS
printBarCode 1, 2, 3, 11, 14, 15, 16, 17 (receipt), 18
1, 2, 3, 7, 8, 9, 11, 14, 15, 16, 17 (receipt),
18 1, 2, 3 (TI3-5, Tx6-9) EC>1D (slip) 14,
15, 16, 17, 18
1, 2, 3 (TI3-5,Tx6-9) EC>1D (slip), 14, 15,
16, 17, 18

printBitmap All except 4, 5. All except 4, 5

8, 9 (receipt) Note: OPOS doesn't support URL as
Filename parameter

printImmediate All except 4, 5

printMemoryBitmap All except 4, 5
printNormal All except 4, 5
printTwoNormal All except 4, 5, 11, 13 1, 2, 3, 6, 7, 8, 9, 14, 15, 16, 17, 18
rotatePrint _NORMAL: All except 4, 5 _NORMAL: All except 4, 5
_LEFT90: 1, 2, 3, 14, 15, 16, 17, 18 _LEFT90: 1, 2, 3, 14, 15, 16, 17, 18
_RIGHT90: 1, 2, 3, 7, 8, 9, 14, 15, 16, 17, _RIGHT90: 1, 2, 3, 7, 8, 14, 15, 16, 17,
18(receipt) 18 (receipt)
_ROTATE180: 1, 2, 3, (TI3-5, Tx6-9) EC _ROTATE180: 1, 2, 3 (TI3-5, Tx6-9) EC
> 0x (receipt), 11, 13, 14, 15, 16, 17, 18 > 0x33 2CR, 2NR, 1NR(receipt), 10, 11,
(receipt) 12, 13, 14, 15, 16, 17, 18 (receipt)

setBitmap 1,2,3,7,8,9,11,13,14,15,16, 17, 18 All except 4, 5

setLogo All except 4, 5
transactionPrint All except 4, 5
validateData All except 4, 5

Table 173. POS printer events

Event JavaPOS OPOS
DirectIOEvent All except 4, 5 1, 2, 3, 14, 15, 16, 17,
18
ErrorEvent All except 4, 5
OutputCompleteEvent All except 4, 5
StatusUpdateEvent: All except 4, 5
PTR_SUE_COVER_OK All except 4, 5
PTR_SUE_COVER_OPEN All except 4, 5
PTR_SUE_JRN_COVER_OK Not supported
PTR_SUE_JRN_COVER_OPEN Not supported

248 UnifiedPOS User's Guide

Event JavaPOS OPOS
PTR_SUE_REC_COVER_OK 1, 2, 3, 11, 14, 15, 16, 1, 2, 3, 14, 15, 16, 17,
17, 18 18
PTR_SUE_REC_COVER_OPEN 1, 2, 3, 11, 14, 15, 16, 1, 2, 3, 14, 15, 16, 17,
17, 18 18
PTR_SUE_SLP_COVER_OK 1, 2, 3 ( except SST) 1, 2, 3 ( except SST)
14, 15, 16, 17 (except 14, 15, 16, 17 (except
1NR) 18 (except 1NR) 18 (except
1TN) 1TN)
PTR_SUE_SLP_COVER_OPEN 1, 2, 3 ( except SST) 1, 2, 3 ( except SST)
14, 15, 16, 17 (except 14, 15, 16, 17 (except
1NR) 18 (except 1NR) 18 (except
1TN) 1TN)
PTR_SUE_JRN_EMPTY 8, 9 8, 9
PTR_SUE_JRN_NEAREMPTY 8, 9 8, 9
PTR_SUE_JRN_PAPEROK 8, 9 8, 9
PTR_SUE_REC_EMPTY 8, 9, 14, 15, 16, 17, 18 8, 9, 14, 15, 16, 17, 18
PTR_SUE_REC_NEAREMPTY 8, 9, 14, 15, 16, 17, 18 8, 9, 14, 15, 16, 17, 18
PTR_SUE_REC_PAPEROK 8, 9, 14, 15, 16, 17, 18 8, 9, 14, 15, 16, 17, 18
PTR_SUE_SLP_EMPTY 1, 2, 3 (except SST), 1, 2, 3 (except SST),
14, 15, 16, 17 (except 14, 15, 16, 17 (except
1NR), 18 (except 1NR), 18 (except
1TN) 1TN)
PTR_SUE_SLP_NEAREMPTY 1, 2, 3 (except SST), 1, 2, 3 (except SST),
14, 15, 16, 17 (except 14, 15, 16, 17 (except
1NR), 18 (except 1NR), 18 (except
1TN) 1TN)
PTR_SUE_SLP_PAPEROK 1, 2, 3 (except SST), 1, 2, 3 (except SST),
14, 15, 16, 17 (except 14, 15, 16, 17 (except
1NR), 18 (except 1NR), 18 (except
1TN) 1TN)
PTR_SUE_IDLE All except 4, 5 All except 4, 5
PTR_SUE_JRN_CARTRIDGE_EMPTY Not Supported Not Supported
PTR_SUE_JRN_HEAD_CLEANING Not Supported Not Supported
PTR_SUE_JRN_CARTRIDGE_NEAREMPTY Not Supported Not Supported
PTR_SUE_JRN_CARTRIDGE_OK Not Supported Not Supported
PTR_SUE_REC_CARTRIDGE_EMPTY Not Supported Not Supported
PTR_SUE_REC_HEAD_CLEANING Not Supported Not Supported
PTR_SUE_REC_CARTRIDGE_NEAREMPTY Not Supported Not Supported
PTR_SUE_REC_CARTRIDGE_OK Not Supported Not Supported

Chapter 16. POS printer 249

Event JavaPOS OPOS
PTR_SUE_SLP_CARTRIDGE_EMPTY Not Supported Not Supported
PTR_SUE_SLP_HEAD_CLEANING Not Supported Not Supported
PTR_SUE_SLP_CARTRIDGE_NEAREMPTY Not Supported Not Supported
PTR_SUE_SLP_CARTRIDGE_OK Not Supported Not Supported
OPOS_CFV_FIRMWARE_OLDER Not Supported 1 true only for
SST/TI3/TI4/TI5/TI8/
TI9, 14
OPOS_CFV_FIRMWARE_SAME Not Supported 1 true only for
SST/TI3/TI4/TI5/TI8/
TI9, 14
OPOS_CFV_FIRMWARE_NEWER Not Supported 1 true only for
SST/TI3/TI4/TI5/TI8/
TI9, 14
OPOS_CFV_FIRMWARE_DIFFERENT Not Supported 1 true only for
SST/TI3/TI4/TI5/TI8/
TI9, 14
OPOS_CFV_FIRMWARE_UNKNOWN Not Supported 1 true only for
SST/TI3/TI4/TI5/TI8/
TI9, 14
OPOS_SUE_UF_PROGRESS Not Supported 1 true only for
SST/TI3/TI4/TI5/TI8/
TI9, 14
OPOS_SUE_UF_COMPLETE Not Supported 1 true only for
SST/TI3/TI4/TI5/TI8/
TI9, 14
OPOS_SUE_UF_COMPLETE_DEV_NOT_RESTORED Not Supported 1 true only for
SST/TI3/TI4/TI5/TI8/
TI9, 14
OPOS_SUE_UF_FAILED_DEV_OK Not Supported 1 true only for
SST/TI3/TI4/TI5/TI8/
TI9, 14
OPOS_SUE_UF_FAILED_DEV_UNRECOVERABLE Not Supported 1 true only for
SST/TI3/TI4/TI5/TI8/
TI9, 14
OPOS_SUE_UF_FAILED_DEV_NEEDS_FIRMWARE Not Supported 1 true only for
SST/TI3/TI4/TI5/TI8/
TI9, 14
OPOS_SUE_UF_FAILED_DEV_UNKNOWN Not Supported 1 true only for
SST/TI3/TI4/TI5/TI8/
TI9, 14

250 UnifiedPOS User's Guide

Event JavaPOS OPOS
IBM_JPOS_SUE_PTR_REC_UNEXPECTED_COVER_OPEN 14,15,16,17, 18 Not Supported
(10000):Notify the Receipt cover was opened without an error
condition present.
IBM_JPOS_SUE_PTR_SLP_UNEXPECTED_COVER_OPEN 14,15,16,17, 18 All except 4, 5
(10001):Notify the Slip cover was opened without an error
condition present.
IBM_JPOS_SUE_PTR_MAIN_LOGIC_CARD_FAILURE (10002): 14,15,16,17, 18 Not Supported
Notify the Main Logic Card of the printer has a failure.
IBM_JPOS_SUE_PTR_INTERFACE_LOGIC_CARD_FAILURE 14,15,16,17, 18 Not Supported
(10003): Notify the Interface Card of the printer has a failure.
IBM_JPOS_SUE_PTR_REC_PRINT_HEAD_FAILURE (10004): 14,15,16,17, 18 Not Supported
Notify the Receipt Print Head has a failure.
IBM_JPOS_SUE_PTR_SLP_PRINT_HEAD_FAILURE (10005): 14,15,16,17, 18 Not Supported
Notify the Slip Print Head has a failure.
IBM_JPOS_SUE_PTR_PAPER_MOTION_SENSOR_FAILURE 14,15,16,17, 18 Not Supported
(10006):Notify the Paper Motion Sensor has a failure.
IBM_JPOS_SUE_PTR_REC_CRITICALLY_LOW_PAPER (10007): 14,15,16,17, 18 Not Supported
Notify the paper in the Receipt station is almost out.
IBM_JPOS_SUE_PTR_REC_PRINT_HEAD_OVERHEAT (10008): Not Supported
1,2,3 – (Tx8-Tx9)
Notify the Receipt Print Head has been overheated. 14,15,16,17, 18

IBM_JPOS_SUE_PTR_REC_PRINT_HEAD_OK (10009): Notify the Not Supported

1,2,3 – (Tx8-Tx9)
Receipt Print Head is ready. 14,15,16,17, 18

IBM_JPOS_SUE_PTR_REC_CUTTER_JAM (10010): Notify the 14,15,16,17, 18 Not Supported

Receipt station fired a Cutter Jam Event.
IBM_JPOS_SUE_PTR_REC_PARTIAL_CUT (10011): Notify the 14,15,16,17, 18 Not Supported
Receipt station fired a Partial Cut Event.

Table 174. POS printer BarCode symbologies supported

BarCode Symbology JavaPOS OPOS
PTR_BCS_AZTEC Not supported
PTR_BCS_DATAMATRIX Not supported
PTR_BCS_UPCA 1, 2, 3, 8, 9, 11, 14, 15, 16,17, 18
PTR_BCS_UPCA_S Not supported
PTR_BCS_UPCE 1, 2, 3, 8, 9, 11, 14, 15, 16,17, 18
PTR_BCS_UPCE_S Not supported
PTR_BCS_UPCD1 Not supported
PTR_BCS_UPCD2 Not supported

Chapter 16. POS printer 251

BarCode Symbology JavaPOS OPOS
PTR_BCS_UPCD3 Not supported
PTR_BCS_UPCD4 Not supported
PTR_BCS_UPCD5 Not supported
PTR_BCS_UPDF417 Not supported
PTR_BCS_QRCODE 14, 15, 16,17, 18
PTR_BCS_QRCODE 14,15,16,17, EC >= 0E 18 (Receipt Station Only)
PTR_BCS_UQRCODE Not supported
PTR_BCS_EAN8 Not supported
PTR_BCS_JAN8 1, 2, 3, 8, 9, 11, 14, 15, 16,17, 18
PTR_BCS_EAN8_S Not supported
PTR_BCS_EAN13 1, 2, 3, 8, 9, 11, 14, 15, 16,17, 18
PTR_BCS_JAN13 Not supported
PTR_BCS_EAN13_S Not supported
PTR_BCS_EAN128 18
PTR_BCS_TF Not supported
PTR_BCS_ITF 1, 2, 3, 8, 9, 11, 14, 15, 16,17, 18
PTR_BCS_Codabar 1, 2, 3, 8, 9, 11, 14, 15, 16,17, 18
PTR_BCS_Code39 1, 2, 3, 8, 9, 11, 14, 15, 16,17, 18
PTR_BCS_Code93 1, 2, 3, 8, 9, 11, 14, 15, 16,17, 18
PTR_BCS_Code128 1, 2, 3, 8, 9, 11, 14, 15, 16,17, 18
PTR_BCS_OCRA Not supported
PTR_BCS_OCRB Not supported
PTR_BCS_Code128_Parsed 1,2,3,14,15,16, 17, 18
PTR_BCS_GS1DATABAR 14,15,16,17 EC >= 0F, 18 (Receipt Station Only)
PTR_BCS_GS1DATABAR_S 14,15,16,17 EC >= 0F, 18 (Receipt Station Only)
PTR_BCS_GS1DATABAR_E 14,15,16,17 EC >= 0F, 18 (Receipt Station Only)
PTR_BCS_GS1DATABAR_E_S 14,15,16,17 EC >= 0F, 18 (Receipt Station Only)
PTR_BCS_PDF417 1,2,3,14,15,16,17, 18 (Receipt Station only)
PTR_BCS_MAXICODE Not supported
PTR_BCS_OTHER Not supported

In the following table, the specific models and stations to which escape sequences can be sent are
listed in parentheses () after the type identifier. If none are specified, assume that all models and
stations can accept the escape sequence. An application can also determine if an escape sequence
can be sent to a particular printer station by calling the validateData method.

252 UnifiedPOS User's Guide

Table 175. POS printer escape sequences
Operation Escape sequence JavaPOS OPOS
Alternate color ESC |rC 1, 2, 3 (TI3-5, Tx6-9) EC 1, 2, 3 (TI3-5, Tx6-9) EC
> 0x33 with Configured > 0x33, 14, 15, 16, 17, 18
setting and correct paper with Configured setting
(receipt) and correct paper
Alternate color (Custom) ESC |#rC 1, 2, 3 (TI3-5, Tx6-9) EC 1, 2, 3 (TI3-5, Tx6-9) EC
> 0x33 with Configured > 0x33, 14, 15, 16, 17, 18
setting and correct paper with Configured setting
(receipt) and correct paper
Bold ESC |(!)bC Same as CapXxxBold (For Same as CapXxxBold
Slp it must be used at
the beginning of the data
and applies to the entire
printed line.)
Center ESC |cA All except 4, 5
Double high ESC |3C Same as CapXxxDhigh
Double high & wide ESC |4C Same as CapXxxDwideDhigh
Double wide ESC |2C Same as CapXxxDwide
Feed and paper cut ESC |#fP All (receipt) except 4, 5, 13 All except 4, 5
Feed, paper cut, and ESC |#sP • 1, 2, 3, 6, 11 (receipt) 1, 2, 3, 6, 7, 8, 14, 15, 16, 17,
stamp Prints downloaded 18
receipt bitmap 1
• 7, 8, 9 (receipt)
Prints the stamp stored
with the DirectIO
SET_STAMP_ID

Feed lines ESC |#lF All except 4, 5

Feed reverse ESC |#rF 8, 11, 13 - Cannot mix with Not supported
feed forward (receipt)
Feed units ESC |#uF All except 4, 5
Fire stamp ESC |sL • 1, 2, 3, 11, 13 - Prints 1, 2, 3, 14, 15, 16, 17, 18 -
downloaded receipt Prints downloaded receipt
bitmap 1 bitmap 1
• 8, 9 - Prints 6, 7, 8 - Supported
the stamp stored Stamp, but not as a single
with the DirectIO command
SET_STAMP_ID

Font typeface selection ESC |#fT Not supported 1, 2, 3 (TI3-5, Tx6-9) EC >
0x33, 14, 15, 16, 17, 18 with
downloaded proportional
font
Integrated escape ESC |#E Not supported

Chapter 16. POS printer 253

Operation Escape sequence JavaPOS OPOS
Italic ESC |iC Not supported
Left Justify ESC |lA All except 4, 5
Normal ESC |N All except 4, 5
Paper cut ESC |#P All except 4, 5, 10, 12, 13
Print bitmap ESC |#B • 1, 2, 3, 11, 13 1, 2, 3, 7, 8, 10, 11, 12, 13,
• 7, 8, 9 (receipt) 14, 15, 14, 15, 16, 17, 18
16, 17, 18

Print bottom logo ESC |bL All except 4, 5

Print in-line barcode ESC |#R Same as CapXxxBarcode Same as CapXxxBarcode
Print in-line ruled line ESC |*#dL Not Supported
Print top logo ESC |tL All except 4, 5
Reverse video ESC |(!)rvC • 1, 2, 3 (receipt) 1, 2, 3, 8, 11, 14, 15, 16, 17,
• 7, 8, 9 18 (11 reverts to normal
rotation in 180 mode)

RGB color ESC |#fC Not supported

Right justify ESC |rA All except 4, 5
Scale horizontally ESC |#hC 1, 2, 3, 6, 7, 8, 9. Up to 2. 1, 2, 3, 6, 7, 8, 11. Up to 2.
Same as CapXxxDwide Same as CapXxxDwide
1, 2, 3 (TI3-5, Tx6-9) EC > 1, 2, 3 (TI3-5, Tx6-9) EC >
0x33 Up to 8 (receipt) 0x33, 14, 15, 16, 17, 18 Up
to 8
11: Up to 6 (receipt)
13: Up to 2

Scale vertically ESC |#vC 1, 2, 3, 6. Up to 2 is for slip; 1, 2, 3, 6, 7, 8, 11. Up

up to 8 is for receipt. Same to 2 is for slip; up to
as CapXxxDhigh 8 is for receipt. Same as
CapXxxDhigh
1, 2, 3 (TI3-5, Tx6-9) EC >
0x33 Up to 8 (receipt) 1, 2, 3 (TI3-5, Tx6-9) EC >
0x33, 2CR, 2NR, 1NR Up
8, 9. Up to 2
to 8
11: Up to 6 (receipt)
13: Up to 2

Shading ESC |#sC 7 7, 8

Single high and wide ESC |1C All except 4, 5
Strike Through ESC |(!)#stC 14,15,16,17, 18 (receipt Not supported
only)
Subscript ESC |tbC Not supported
Superscript ESC |tpC Not supported

254 UnifiedPOS User's Guide

Operation Escape sequence JavaPOS OPOS
Underline ESC |(!)#uC Same as CapXxxUnderline

JavaPOS configuration

Arabic code page support

<prop name="com.ibm.jpos.sdi.config.POSPrinter.EnableArabic"
type="Boolean" value="true"/>

Values accepted:
• True
• False (default)
When true, the JavaPOS drivers provide support for printing Arabic characters by performing
the following actions automatically:
1. Set the POSPrinter.CharacterSet property:
• “864” for 4610-2xR/1xR and 6145 2Tx/1TN printers
• “101” for the 4610-TI-3/4/5/8/9 TM/F 6/7
2. Perform word shaping for the Arabic characters.
3. Set intercharacter spacing to zero for Arabic characters.
4. Reverse the resulting text after word shaping.

<prop name=”com.ibm.jpos.sdi.config.POSPrinter.enableArabicReverse”
type=”Boolean” value=”true” />

enableArabicReverse (Reverse Arabic Input):

• True (default)
• False
By default, the Arabic input is reversed by JavaPOS drivers. If application is reversing the input,
this property must be set to false.
Arabic phrase reversing rules:
• An Arabic phrase is a text portion made up of only Arabic text and single spaces.
• The beginning of an Arabic phrase is defined by the parser encountering an Arabic character.
• The ending of an Arabic phrase is reached when any of the following conditions occur:
• The next character is a non-Arabic character (except a single space).
• The next two characters are spaces.
• The next character is a line feed or carriage return.
• Escape sequences will break an Arabic phrase.
Code page support:

4610 2xR/1NR and 6145-2Tx/1TN

These models natively support Arabic code page 864 and 1256.

Chapter 16. POS printer 255

4610 TI-3/4/5/8/9 TM 6/7
The Arabic printing on these models is supported through the User Defined
Arabic font file. Therefore, you must first download the user defined font file
“4610cp864Thermal_a.fon” and “4610cp864Impact.fnt” to the location 101.

POS Applications
It is assumed that Windows POS applications use code page 1256 for generating Arabic
characters.
Device support:
• 4610 2xR/1NR
• 4610 TI-3/4/5/8/9 TM/F 6/7
• 6145-2Tx/1TN
Supported since UPOS 1.13.6, with backward compatibility to 1.13.4.
Font Download for 4610-TI-3/4/5/8/9 TM/F 6/7, 6145-2Tx/1TN:
• By default, those printers do not have the code page 864; use the following command line
instructions to download the font:
1. Use aipfnt46s JavaPOS utility to download the fonts (dual station printers):
a. java com.ibm.jpos.util.font.AipFnt46s -f
<filePath>/4610cp864Thermal_a.fon 1 <PrinterLogicalName>
b. java com.ibm.jpos.util.font.AipFnt46s -f
<filePath>/4610cp864Impact.fnt 5 <PrinterLogicalName>
2. Use JavaPOS to download the fonts (single station printers):
a. java com.ibm.jpos.util.font.AipFnt46s -f
<filePath>/4610cp864Thermal_a.fon 1 <PrinterLogicalName>
The font file is found in the following locations:
• Windows: [INSTALL DIR]\fonts
• Linux: /usr/share/pos/fonts

AddLineFeed

<prop name="com.ibm.jpos.sdi.config.POSPrinter.AddLineFeed"
type="Boolean" value="True"/>

This property determines whether to add a line feed to the end of any text sent in a
printNormal, printImmediate, or printTwoNormal command when it does not contain
a complete line.
A complete line is defined as:
• A line finishing with the line feed character, for example:
"Complete Line\n"

• A line finishing with an escape sequence that produces a line feed, for example:
"Complete Line ESC|10lF"

256 UnifiedPOS User's Guide

• A line that completely fills the characters per line for the station in use, for example when
RecLineChars=20 and the print text is:
"Line of 20 chars7890"

Valid values are TRUE or FALSE. Default is TRUE.

Bitmap quality
UnifiedPOS standard has defined the RecLetterQuality and SlpLetterQuality properties to
control the bitmap and text quality. Prior to Toshiba UnifiedPOS release 1.9.2, drivers supported
High Quality bitmap printing only.
For Toshiba UnifiedPOS 1.9.2 and later the driver follows the UnifiedPOS specification. When
the LetterQuality property is false, the bitmap will be printed in low quality/high speed mode.
When the property true, the bitmap will be printed in high quality mode.
If you want to force bitmaps to always print in high quality mode, you must add the following
property in the POSPrinter’s JposEntry:

<prop name="com.ibm.jpos.sdi.config.POSPrinter.BitmapLetterQuality" type="Boolean"

value="true"/>

Values accepted:

True
Use high quality mode always.

False (default)
Use UnifiedPOS RecLetterQuality/SlpLetterQuality setting to control the bitmap quality.
Device support:
4610 TI-3/4/5/8/9 TM/F 6/7, 6145-2Tx/1TN
Supported since:
UnifiedPOS 1.9.5

Color support
Two-color printing is supported on the 4610 Models TI3, TI4, TI5, TI6, TI8, and TI9 printers that
have a microcode EC level of 33 or greater. To enable color printing the JavaPOS configuration
entry for the printer must be modified to have the following property:

<prop name="colorMode" type="Integer" value="2"/>

Any value other than 2 defaults to single color. Color mode should be configured only if color
printing is used, because enabling the feature slows down the printer, whether or not color
printing is performed.

Chapter 16. POS printer 257

Default8LPI

<prop name="com.ibm.jpos.sdi.config.POSPrinter.Default8LPI"
type="String" value="False"/>

This property selects the font and the spacing needed to allow the user to print 8 lines per inch in
the paper.
Valid values are TRUE and FALSE. Default is FALSE.

DefaultCharacterSet

<prop name="com.ibm.jpos.sdi.config.POSPrinter.DefaultCharacterSet"
type="String" value="<number>"/>

This property will allow the users to define the default value for the characterSet property. Valid
values are the ones defined by the POSPrinter CharacterSet property.
Device supported: 4610 2xR/1NR, 6145 2Tx/1TN.

DefaultLargeFont

<prop name="com.ibm.jpos.sdi.config.POSPrinter.DefaultLargeFont"
type="String" value="False"/>

This property selects the font with the largest size available on the printer, typically 12x24 dots
on the receipt station and 7x9 dots on slip station.
Valid values are TRUE and FALSE. Default is FALSE.

DocAdvance

<prop name="com.ibm.jpos.sdi.config.POSPrinter.DocAdvance"
type="String" value="50"/>

This property selects the number of motor steps to advance the paper on a Document Insert,
from the top Document sensor to the first print position.
Valid values are 1 to 255. The default is 50.
Device support: 4610 TI-3/4/5/8/9.

258 UnifiedPOS User's Guide

DoubleHighAndDoubleWideIsQuad

<prop
name="com.ibm.jpos.sdi.config.POSPrinter.DoubleHighAndDoubleWideIsQuad"

type="String" value="OFF"/>

This property enables the conversion of the double wide (1b|2C) and double high (1b|3C)
escape sequences to work as double wide and high (1b|4C).
Only supported on 4610 Tx5/Tx7 using a DBCS character set.
Valid values are ON and OFF. Default is OFF.

Enable or Disable Partial Cut Detection

JavaPOS provides the following mechanism to enable/disable partial cut detection in supported
hardware.
Valid values are TRUE and FALSE. Default is FALSE.
Device support: 4610 2XR/1NR
1. To Enable Partial Cut Detection, locate the aip46mct.cfg file located in the following
directory:
Linux: /usr/share/pos/config/aipmct.cfg
Windows: c:\pos\config\aip46mct.cfg
2. Locate the partialCutDetection property and set the value of the property to true.
partialCutDetection=true
3. To disable Partial Cut Detection, set the partialCutDetection property to false.
partialCutDetection=false
4. To broadcast this value to other printers, transfer aip46mct.cfg file to clients to the location
specified above and reboot the clients.

Enable or Disable Paper Motion Sensing

Partial cut is supported in 4610-1NR/2xR and 6145-2Tx/1TN POS Printers which have a required
hardware change. This function is supported starting from firmware 0D_01.
Valid values are TRUE and FALSE. Default is FALSE.
1. To Enable Paper motion sensing, locate the aip46mct.cfg file located in the following
directory:

Linux: /usr/share/pos/config/aip46mct.cfg
Windows: c:\pos\config\aip46mct.cfg

2. Locate the paperMotionDetection property and set the value of the property to true.
paperMotionDetection = true
3. To disable Paper motion sensing, set the paperMotionDetection property to false.
paperMotionDetection = false

Chapter 16. POS printer 259

4. To broadcast this value to other printers, transfer aip46mct.cfg file to clients to the location
specified above and reboot the clients.

Enable or Disable Low Paper Detection

Low Paper Detection can be disabled in 4610-1NR/2xR and 6145-2Tx/1TN printers.
This function is supported starting from firmware 0C_01.
Valid values are TRUE and False. Default is False.
1. To disable Low Paper Detection, locate the aip46mct.cfg file located in the following
directory:

Linux: /usr/share/pos/config/aip46mct.cfg
Windows: c:\pos\config\aip46mct.cfg

2. Locate the lowPaperDetectionDisabled property and set the value of the property to true.
lowPaperDetectionDisabled = true
3. To enable Low Paper Detection, set the lowPaperDetectionDisabled property to false.
lowPaperDetectionDisabled = false
4. To broadcast this value to other printers, transfer aip46mct.cfg file to clients to the location
specified above and reboot the clients.
5. The Low paper detection configuration will require a system reboot for the printer to
recognize it.

Enable or Disable Low Paper LED

The Low Paper LED indicator can be disabled in 4610-1NR/2xR and 6145-2Tx/1TN printers.
This function is supported starting from firmware 0C_01.
Valid values are TRUE and False. Default is False.
1. To disable the Low Paper LED indicator, locate the aip46mct.cfg file located in the following
directory:

Linux: /usr/share/pos/config/aip46mct.cfg
Windows: c:\pos\config\aip46mct.cfg

2. Locate the lowPaperLEDDisabled property and set the value of the property to true.
lowPaperLEDDisabled = true
3. To enable the Low Paper LED indicator, set the lowPaperLEDDisabled property to false.
lowPaperLEDDisabled = false
4. To broadcast this value to other printers, transfer aip46mct.cfg file to clients to the location
specified above and reboot the clients.
5. The Low Paper LED configuration will require a system reboot for the printer to recognize
it.

260 UnifiedPOS User's Guide

NoSetBitmap
This property allows the printing of bitmaps that are stored in printer memory without issuing
SetBitmap each time the printer is opened.
Ensure that bitmaps are downloaded to the printer memory. Otherwise, unexpected results can
occur when printing bitmaps.

<prop name="com.ibm.jpos.sdi.config.POSPrinter.NoSetBitmap" type="String"

value="true"/>

6145 POS Printer and Bitmaps Downloaded with TCx POS Printer
Utility
Please consider that for slip station, driver has an offset of 127 for bitmap location with respect to
TCx POS Printer Utility.
Example :
In order to print bitmap using escape sequence for slip station in position 10 (i.e. "ESC|10B"),
bitmap should be downloaded to position 137.
Valid values are TRUE and FALSE. The default value is TRUE.
Device support:
• 6145 2Tx/1TN
Supported since:
• UnifiedPOS 1.14.2

OptimizedBaudRate

<prop name="com.ibm.jpos.sdi.config.POSPrinter.4610OptimizedBaudRate"
type="Boolean" value="true"/>

Values accepted:
• False
• True (default)

Device support:
4610 2xR/1NR and 6145 2Tx/1TN

Since:
UPOS 1.13.7

Description:
Enable\Disable the optimized baud rate and flow control for EIA232 POSPrinters.
When the property is set to true, the baud rate is set to 115,200 baud rate and flow control to
XON/XOFF.

Chapter 16. POS printer 261

When the property is set to false, the driver uses the values defined on the POSPrinter.

PDF417AspectHeight

<prop name="com.ibm.jpos.sdi.config.POSPrinter.PDF417AspectHeight"
type="String" value="1"/>

This property selects the value for the aspect ratio height of the PDF417 barcode. When using
PDF417 symbology, the height must be set through the Aspect Ratio property parameter height
included in printBarcode or the escape sequence will be ignored.
Valid values are 1 to 9. Default is 1.

PDF417AspectWidth

<prop name="com.ibm.jpos.sdi.config.POSPrinter.PDF417AspectWidth"
type="String" value="2"/>

This property selects the value for the aspect ratio width of the PDF417 barcode. When using
PDF417 symbology, the width must be set through the Aspect Ratio property parameter width
included in printBarcode or the escape sequence will be ignored.
Valid values are 1 to 9. Default is 2.

PDF417ECCLevel

<prop name="com.ibm.jpos.sdi.config.POSPrinter.PDF417ECCLevel"
type="String" value="15"/>

A security level is appended to the printed barcode. This property enables scanners to read the
bar code even if it has been torn, written on, or otherwise damaged.
You can select a level from 0 to 8 to apply error correction. At level 0, a damaged PDF417 cannot
be read, but the damage can be detected. At levels 1 through 8, a PDF417 symbol can still be
read, even when damaged. As the error correction level increases, more damage can occur to the
symbol and still be read. For values of 9 to 400, the ECC level is assume as a percentage of the
code words in the barcode.
Valid values are 0 to 400. Default is 15.

262 UnifiedPOS User's Guide

PDF417Truncation

<prop name="com.ibm.jpos.sdi.config.POSPrinter.PDF417Truncation"
type="String" value="OFF"/>

This property enables the truncation of the PDF417 barcode. The truncated PDF generates a
single width bar symbol to replace the right row indicator and stop pattern. When truncation is
enabled, decode performance is slightly degraded in order to allow more data to fit in the image
width.
Valid values are ON or OFF. Default is OFF.

ProportionalFontFixedWidth

<prop
name="com.ibm.jpos.sdi.config.POSPrinter.ProportionalFontFixedWidth"
type="String" value="20"/>

This property aligns proportional font characters on a fixed width. The value is expressed
in printer dots. When this property is used, the proportional characters are treated as fixed
characters.
Valid values are 8 to 32. Default is 20.

QRCODEEncodingMode
Note: On this mode, an error may occur if provided an invalid value.

<prop name="com.ibm.jpos.sdi.config.POSPrinter.QRCODEEncodingMode"
type="String" value="0"/>

This property selects the value for the encoding mode for the QR Barcode.
Valid values are 0 to 4. Default is 0.
• 0 Byte - Encodes lower case letters, text double-byte characters, binary data and 8 bit values.
• 1 Alpha-Numeric Mode - Alphanumeric mode encodes data from a set of 45 characters.*
They are:
• 10 numeric digits (0 - 9) (byte values 30 HEX to 39 HEX)
• 26 alphabetic characters (A - Z) (byte values 41 HEX to 5A HEX)
• 9 symbols SP, $, %, *, +, -, ., /, : (byte values 20 HEX, 24 HEX, 25 HEX, 2A HEX, 2B HEX, 2D
HEX, 2E HEX, 2F HEX, 3A HEX respectively)
• 2 Numeric Mode - This mode encodes data from the decimal digit set (0 - 9) (byte values 30
HEX to 39 HEX).*
• 3 Kanji Mode - This mode encodes Kanji characters.
Note:

Chapter 16. POS printer 263

1. The amount of data needs to be an even number.
2. The supported range of Kanji characters are from 8140 HEX to 9FFC HEX and from E040
HEX to EBBF HEX.*
• 4 Extended Channel Interpretation (ECI) Mode - This mode allows the encoding of character
sets different than the default. See QRCODEECIValue property.
• 5 Mixing Mode - This mode allows the printer to encode data using different modes.
Currently works with numeric, alpha numeric, byte, and Kanji characters. In this mode, the
printer will decide the type of characters and encode them accordingly.

QRCODEErrorCorrectionLevel
Note: *On this mode, the command will be rejected if a byte data is outside the supported range.

<prop name="com.ibm.jpos.sdi.config.POSPrinter.QRCODEErrorLevel"
type="String" value="0"/>

This property selects the value for the error correction level for the QR Barcode.
Valid values are 0 to 3. Default is 0.
• 0 L - 7% recovery
• 1 M - 15% recovery
• 2 Q - 25% recovery
• 3 H - 30% recovery
The maximum number of characters to be encoded is:

Table 176. Characters to be encoded

Error Correction Numeric Alpha Numeric Byte Kanji
L (7%) 1000 1000 919 500
M (15%) 1000 1000 701 432
Q (25%) 1000 721 499 308
H (30%) 945 566 393 242

QRCodeECIValue

<prop name="com.ibm.jpos.sdi.config.POSPrinter.QRCODEECIValue"
type="String" value="0"/>

This property is read only when the EncodingMode for QR Barcode is set as 04.
Valid values are 0 to 26, Default is 0.

Table 177. Supported CharactersSets as defined on the Extended Channel Interpretations

standard:

264 UnifiedPOS User's Guide

ECI Value CharacterSet
0 cp437
1 cp819
2 cp437 with ECI rules
3 cp819
4 cp912
5 cp913
6 cp914
7 cp915
8 cp1089
9 cp813
10 cp916
11 cp920
12 iso8859_10
13 iso8859_11
14 Reserved on ECI standard
15 cp921
16 iso8859_14
17 cp923
18 iso8859_16
19 Reserved on ECI standard
20 cp932
21 cp1250
22 cp1251
23 cp1252
24 cp1256
25 UTF16BE
26 UTF-8

Note: ECI Values 14 and 19 are reserved by the ECI standard and are not accepted as a
valid parameter. For detailed information on each code, refer to Chapter 22, Character sets for
terminal printers and displays on page 495.

Chapter 16. POS printer 265

QR Barcode Usage
From the UnifiedPOS Standard, the structure of a printBarcode Method will accept only String
objects as a valid data parameter.
For JavaPOS, this means that those String objects must be encoded specifically for the Encoding
Mode used so that the driver will decode them with the proper character set.
Depending on the Encoding Mode, the way to create the barcode uses a specific character set.
Here are some examples on how to create this String object for each mode:

Byte Mode, Alpha-Numeric, Numeric and Mixed Mode:

The String object must be created from a valid byte array, this byte array should contain
only valid values depending on the selected mode.

Kanji Mode:
The String object can be constructed using either the Unicode representation or following
the 932 Code Page values (refer to Chapter 22, Character sets for terminal printers and
displays on page 495). The used characters must be inside the range specified for Kanji
Mode.

ECI Mode:
The String object must be created using the correspondent Character set for the selected
ECI Value as established by the ECI standards. Refer to the ECI Value/Characterset table
in “QRCodeECIValue” on page 264 property.
Example code:

POSPrinter posPrinter = new POSPrinter();

posPrinter.open(args[0]);
//Sending kanji characters through the use of an array
try{

//Data array which contains the value to send the array to be printed
String kanjiStr = "\u250f\u2501\u2501\u2501\u2501\u2513";

//Variable which will contains the encoded characters in kanji mode

String data = new String(array,"Shift_JIS");
posPrinter.claim(JposConst.JPOS_FOREVER);
posPrinter.setDeviceEnabled(true);
posPrinter.printBarCode(POSPrinterConst.PTR_S_RECEIPT,
data,
POSPrinterConst.PTR_BCS_QRCODE,
100,
(int)(posPrinter.getRecLineWidth()*.75),
POSPrinterConst.PTR_BC_CENTER,
POSPrinterConst.PTR_BC_TEXT_BELOW);
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
finally
{
posPrinter.close();
}

266 UnifiedPOS User's Guide

Issuing the printBarCode command
QR Barcode is supported in JavaPOS using the UnifiedPOS method for printing barcodes.

printBarCode (station: int32, data: string, symbology: int32, height: int32, width:
int32, alignment: int32, textPosition: int32)

Table 178. Accepted argument values

Parameter Accepted values
Station Receipt. QR code printing is supported on the
Receipt station only.
Data The input string must already be in the
character encoding that matches the encoding
mode.
Symbology PTR_BCS_QRCODE (Value = 204)
Height Height is used to scale the QR code.
Valid values: 0<= height <= 5
Other values: Auto-scaling where 0 is the
minimum scale size, which translates to 3 dots
per pixel.
Supported from OPOS1.14.0 and printer FW
15.81 onward.

Width Unused. Printer automatically derives QR

code dimensions.
Alignment As per UnifiedPOS specification.
textPosition Unused.

RecLineCharsFont

<prop name="com.ibm.jpos.sdi.config.POSPrinter.RecLineCharsFont"
type="String" value="<letter>"/>

Values accepted:
• "A": To select font A ( 10x20 dots ), (RecLineCharList="32,33,36,38,41,44,48,52,57")
• "B": To select font B ( 12x24 dots ), (RecLineCharList="28,30,32,33,36,38,41,44,48")
• "C": To select font C ( 8x16 dots ), (RecLineCharList="36,38,41,44,48,52,57,64,72")
• "TallA": To select font Tall A ( 10x24 dots ), (RecLineCharList="32,33,36,38,41,44,48,52,57")
Default Value: "32, 34, 36, 38, 41, 44, 48, 52, 57, 64, 72" with mixed fonts
Device support: 4610 TI-3/4/5/6/7/8/9/2xR/1NR, 6145 2Tx/1TN
Description: This property allows the user to select a specific resident Font so that the driver can
provide a specific RecLineCharsList with values that are only valid for the specified Font.

Chapter 16. POS printer 267

Note: The property is read at OPEN time. If the property is not added into the XML, no changes
to the default values will be performed. If the value provided in the property is invalid, it will be
ignored and no changes will be performed. Font Tall A is only supported for 2xR/1NR printers
with firmware Level 16.xx and 6145 2Tx/1TN printers.

SetCompatibilityMode

com.ibm.posj.POSPrinter.SetCompatibilityMode = false

This property sets the printer to work in Compatibility Mode (TI3/4 Emulation) when true or in
Native Mode when false. This property is only available in the posj.properties file.
Valid values: True(Compatibility), False(Native) - Default
Device supported: 4610-2xR/1NR, 6145-2Tx/1TN

SlpLineSpacing

<prop name="com.ibm.jpos.sdi.config.POSPrinter.SlpLineSpacing"
type="String" value="3"/>

This property defines the spacing between lines in the SLIP station. Valid values are 1 to 255. The
default is 9.

SureOneVersion

<prop name="SureOneVersion" type="String" value="Standard"/>

SureOneVersion defines the character set to be used by the service implementation of the
SureOne printer thermal station. No default value is set, so you must indicate a selection.
To determine which character set is currently installed in the printer, perform an offline test as
follows:
1. Turn off the system.
2. Press and hold the paper feed button.
3. Turn on the system and wait for a beep.
4. Release the paper feed button.
Possible values for this property are shown in the following table.

Table 179. SureOne Version property values

Possible Value Character set
"Standard" character set 998 (equal to character set 437)

268 UnifiedPOS User's Guide

Possible Value Character set
"ChineseTrad" character set 950
"ChineseSimp" character set 1381
"Korean" character set 1361
"Japanese" character set 932

TranslateCharacter

<prop
name="com.ibm.jpos.sdi.config.POSPrinter.TranslateCharacter.<AsciiHexCh
arNumber>"
type="String" value="<NewHexCharacter>"/>

This property replaces the value of the <AsciiHexCharNumber> parameter with the value of
the <NewHexCharacter parameter>. In the text that prints, all the characters that match the
AsciiHexCharNumber are replaced by the new character.
Values accepted:
• <AsciiHexCharNumber>: 0x00 to 0xFF in Hexadecimal representation. This value represents
the character number in the ASCII table to be replaced.
• <NewHexCharacter>: The character to be used in place of the ASCII Character.
Examples:
• Replace the character 29 0x1D (also known as group separator) with the character G 0x47:
<prop name="com.ibm.jpos.sdi.config.POSPrinter.TranslateCharacter.0x1D"
type="String" value="0x47"/>

• Replace the character K 0x4B with the character N 0x4E;

<prop name="com.ibm.jpos.sdi.config.POSPrinter.TranslateCharacter.0x4B"
type="String" value="0x4E"/>

Watermark
<prop name=”com.ibm.jpos.sdi.config.POSPrinter.BitmapNumberForWatermark”
type=”String” value=”<bitmap#,offset,alignment,density;
bitmap#,offset,alignment,density>”/>

Values accepted:
The property is a constructed property based on four different parameters that are defined as
follows:
• bitmap#: The stored bitmap position to use as watermark. Accepted values are 1 to 20.
• offset: The number of millimeters (8 dot rows = 1mm) offset from the bottom of one
watermark to the top of the next watermark. Accepted values: 0 to 255.
• alignment: The alignment of the watermark in the receipt. Accepted values (case sensitive):
• ALIGN_LEFT

Chapter 16. POS printer 269

• ALIGN_RIGHT
• ALIGN_CENTER
• ROLL_LEFT
• ROLL_RIGHT
• ZIGZAG
• density: The print density of the watermark image. Accepted values (case sensitive):
• NORMAL
• DOUBLE_WIDE
• DOUBLE_HIGH
• DOUBLE_WIDE_HIGH
This property permits the definition of 1 to 5 different watermark bitmaps by using a semicolon
‘;’ character as separator for each defined bitmap number:

<bitmap1,offset1,alignment1,density1; bitmap2,offset2,alignment2,density2>

Device support:
• 4610 2XR/1NR
• 6145 2Tx/1TN
Station support:
• Receipt

JavaPOS DirectIO calls

There are several DirectIO commands for downloading fonts to the PosPrinter. The general
syntax for DirectIO commands is:
Syntax directIO ( command: int32, inout data: int32, inout obj:
object ): void { raises-exception }
The device must be claimed and enabled before invoking the directIO() method.
To access POS printer constants, import: com.ibm.jpos.services.DirectIO.

Download DBCS Font ID Command

Download double-byte character sets (DBCS) and fonts to a double-byte printer.

Table 180. DirectIO.DOWNLOAD_DBCS_FONT_ID

Parameter Type Description

Command Int32 com.ibm.jpos.services.DirectIO.DOWNLOAD_DBCS_FONT_ID
Data Int32 Not used
Object Object com.ibm.jpos.services.sdiibmprinter.DBCSFontInfo. Class that holds
the filename of the DBCS font to download.

Remarks
None Defined

270 UnifiedPOS User's Guide

Errors
A UposException might be thrown when this method is invoked. Some possible values of
the exception ErrorCode property are listed in Table 181:

Table 181. UposException error codes

Value Meaning
E_ILLEGAL One of the following errors has occurred:
• This printer does not support DBCS font downloads.
• This printer station does not allow DBCS fonts.
• Font file type is incorrect.

E_NOEXIST Font file was not found.

E_FAILURE Error reading from font file.

Download Non-Proportional Font ID Command

Download non-proportional fonts to the Toshiba 4610, 4689, and 6145 POS printers.

Table 182. DirectIO.DOWNLOAD_NON_PROP_FONT_ID

Parameter Type Description
Command Int32 com.ibm.jpos.services.DirectIO.DOWNLOAD_NON_PROP_FONT_ID
Data Int32 Not used
Object Object com.ibm.jpos.services.sdiibmprinter. DirectIOFontInfo

Remarks for Toshiba 4689 POS Printers

• The station field of DirectIOFontInfo is ignored; the downloaded font applies to both
the receipt and journal station.
• The codepage field of DirectIOFontInfo is ignored.
• For the Toshiba 4689 POSPrinter, non-proportional font characters for receipt/journal
stations must be either width 8 and height 12 or width 12 and height 24.

Remarks for Toshiba 4610 and 6145 POS Printers

• Valid values for the station field of DirectIOFontInfo are:
• PTR_S_RECEIPT: Customer Receipt (CR) station
• PTR_S_SLIP: slip (Document Insert or DI) station
• Valid values for the codepage field of DirectIOFontInfo are:
• 1 – 4: one of the four codepages for the customer receipt (CR) station
• 5 – 6: one of the two codepages for slip (DI) station
• Non-proportional font characters for the receipt station must have a width between 8
and 16 inclusive and a height between 16 and 32 inclusive; those for the slip station
should have a width and height between 7 and 16 inclusive.
After a successful font download, use the characterSet property to retrieve and set the desired
code pages for font printing. Table 185 shows the usage of the different user-defined character
sets.

Chapter 16. POS printer 271

Errors
A UposException might be thrown when this method is invoked. Some possible values of
the exception ErrorCode property are listed in Table 183:

Table 183. UposException error codes

Value Meaning
E_ILLEGAL One of the following errors has occurred:
• This printer does not support non-proportional fonts downloading.
• This printer station does not allow non-proportional fonts.
• Incorrect font number.
• Incorrect font file type.
• Character size not valid.

E_EXIST Memory sector already has a font, erase the memory sector before
downloading a font.
E_NOEXIST Font file was not found.

Download Prop Font ID Command

Download a proportional font to the Toshiba 4610 and 6145 POS printers.

Table 184. DirectIO.DOWNLOAD_PROP_FONT_ID

Parameter Type Description
Command Int32 com.ibm.jpos.services.DirectIO.DOWNLOAD_PROP_FONT_ID
Data Int32 Not used
Obj Object com.ibm.jpos.services.sdiibmprinter. DirectIOFontInfo.

Remarks
Proportional fonts are supported only for the Receipt station. Valid values for the
codepage field of DirectIOFontInfo are:
• 1: User-defined (UD) Code Page 1
• 3: UD Code Page 3
Note:
1. Proportional font characters should have width and height between 8 and 32 inclusive.
2. When using proportional fonts, there is not a way to accurately wrap lines since each
character may have a different width. You should manage the Line width using the
RecLineChars property.
After a successful font download, use the characterSet property to retrieve and set the desired
code pages for font printing. Table 185 shows the usage of the user-defined character sets.

Table 185. User-defined (UD) character sets

Character set Font attribute CR station DI station
101 Fixed UD Code Page 1 UD CodePage 1

272 UnifiedPOS User's Guide

Character set Font attribute CR station DI station

Proportional UD Code Page 1 N\A

102 Fixed UD Code Page 2 N\A

Proportional N/A N\A

103 Fixed UD Code Page 3 UD CodePage 2

Proportional UD Code Page 3 N\A

104 Fixed UD Code Page 4 N\A

Proportional N\A N\A

Errors
A UposException might be thrown when this method is invoked. Some possible values of
the exception ErrorCode property are:

Table 186. UposException error codes

Value Meaning
E_ILLEGAL One of the following errors has occurred:
• This printer does not support proportional fonts downloading.
• This printer station does not allow proportional fonts.
• Incorrect font number.
• Incorrect font file type.
• Character size not valid.

E_EXIST Memory sector already has a font, erase the memory sector before
downloading a font.
E_NOEXIST Font file was not found.

FontInfo Object
The DirectIOFontInfo object is used as input or output to the DirectIO functions for
downloading fonts to Toshiba 4610, 4689, and 6145 POS printers. The DirectIOFontInfo object
has the structure shown in Table 187.

Table 187. DirectIOFontInfo object structure

Field Name Type Description
station int Print station indentifier:
• POSPrinterConst.PTR_S_RECEIPT
• POSPrinterConst.PTR_S_SLIP

codepage int Font number. This can have a value of 1 – 6.

filename string Font file name. This must be a fully qualified path.

Chapter 16. POS printer 273

Specific usage of the DirectIOFontInfo object will be documented for each DirectIO function

Get Font Info ID Command

Get Font information. Font information will be returned in the
com.ibm.jpos.services.sdiibmprinter.DirectIOFontInfo object.

Table 188. DirectIO.GET_FONT_INFO_ID

Parameter Type Description

Command Int32 com.ibm.jpos.services.DirectIO.GET_FONT_INFO_ID
Data[1] Int32 com.ibm.jpos.services.DirectIO.GET_FONT_INFO
Obj Object com.ibm.jpos.services.sdiibmprinter.PrintGetDirectIOFontInfo

Remarks
None Defined

Errors
None Defined

Additional JavaPOS information

The device service formats the entire print line internally. This includes left, center, and right
alignments. It also inserts line breaks as necessary for long lines. This implementation approach
does not allow a single print line to be built up from multiple printNormal() invocations.
The *LineHeight properties are not modifiable.
It is not possible to mix bold and normal printing on the Slip station of the 4610 or 6145 POS
printers. The line prints either all normal or all bold, depending on which escape sequence is
used first.

Calibration for low paper sense

Low paper sensing on the 4610-1NR/2xR and 6145-2Tx/1TN POS printer models is based upon
the paper thickness and core size. The user can modify the low paper and critically low sensing
settings. These settings determine the amount of paper that remains on the roll and at which
time the low-paper and critically low-paper status is sent. The default setting for low paper
status is 5 meters and critically low status is 1 meter remaining on the roll.
The user must calibrate the printer to accurately recognize the thickness of the paper supply. The
user only needs to calibrate one printer for a specific paper supply. They can then broadcast that
calibration constant to all printers that will use the same paper. For details, refer to User’s Guide
for SureMark Printers Models 2xR/1NR and 2TC/2TN.
1. Find MCT values for low-paper sense by running an offline test on the printer:
a. Add a new paper roll to be calibrated.
b. Power off the printer.
c. Hold down the CR button and turn on the printer.
d. Release the CR button when CR light starts to flashing. A menu is printed.

274 UnifiedPOS User's Guide

e. Select option 5, More selections.
f. Select option 1, MCT listing.
g. Record the values for MCTs 0x26, 0x27, 0x28.
2. Transfer the MCT values to the aip46mct.cfg file located in the following directory:
• Linux: /usr/share/pos/config/aipmct.cfg
• Windows: c:\pos\config\aip46mct.cfg
The mapping between MCT values and constants provided in the 46mct.cfg file are as
follows:
• lowPaperSensing = MCT 0x26
• criticallyLowPaperSensing = MCT 0x27
• calibrationConstant = 0x28
3. To broadcast this value to other printers, transfer the aip46mct.cfg file to clients in the
location specified above and reboot the clients.

4610 printer firmware update

The Toshiba JavaPOS driver has the ability to automatically update the printer firmware if the
printer is attached to the terminal when the terminal boots. It does not have this ability if the
printer is attached to the terminal after the terminal has booted and the operating system has
loaded.
In addition, printer firmware can be update manually at any time.
Updated printer firmware update files can be downloaded from the Toshiba website at: .
1. Go to: .
a. Under Peripherals, click Toshiba SureMark Printer.
b. Under Downloads, select the appropriate link for your printer model.
c. From the Search Results displayed, select Toshiba 4610 SureMark Printer, Microcode
Files for Firmware Update.
d. Download the ZIP file for OPOS/JavaPOS. This file contains multiple firmware files;
choose the correct one for your printer type.
2. Place the firmware file for your printer type into the correct folder.

Table 189. Firmware update information for 6145 POS printers

Operating system Location
Windows \POS\JavaPOS\res\flash\usb
Linux /opt/tgcs/javapos/flash/usb

Table 190. Firmware update information for 4610 POS printers

Operating system Location
Windows \POS\JavaPOS\res\flash\rs485
Linux /opt/tgcs/javapos/flash/rs485

Note: The folder rs485 is used by EIA232, RS485, and USB POSPrinter connectivity. For
automatic update of the RS485 printer in Windows, see the folder structure in the Automatic
Update section.

Chapter 16. POS printer 275

3. Make sure the printer is attached and restart.
Each model of 4610 printer has a different firmware file associated with it.

Table 191. Toshiba 4610 printer firmware update

Printer Model Firmware update filename
TI1, TI2 aip46mc.hex
TI3, TI4, TG3, TG4, TF6, TM7 aip46mch.hex
TI5, TM7, TF7 aip46mcd.hex
TI8 aip46ti8.hex
TI9 aip46ti8.hex
2CR, 2NR, 1NR aip46v4.hex
2TC, 2TN, 1TN. (EIA-232) aip45355.hex

Note: If the firmware file you select does not match the type of printer you have attached, the
program will not update the printer.

Automatic update
When a terminal starts, JavaPOS will check the firmware version and update all devices
(including printers) that are defined in the JPOS.XML file if necessary.
The only exception to the automatic firmware update process is for Network printers, which are
not supported.
In Windows, the firmware update process is controlled by a windows service named:
• Toshiba JavaPOS Flash Utility
For automatic update of an RS485 printer in Windows, the desired firmware files should be
placed in \pos\firmware. If they are not placed in this location, the automatic update will not
be executed for this printer.
Since the Toshiba JavaPOS Flash Utility service controls the updating of firmware in all devices,
not just printers, it is recommended that if you do not want the driver to automatically
update the printer firmware then you should delete the firmware update files from the
\pos\javapos\flash\rs485 folder.
On Linux, the firmware update process is controlled by a shell script, /etc/init.d/
flashdev.
Since the batch controls the updating of firmware in all devices, not just printers, it is
recommended that if you do not want the driver to automatically update the printer firmware
then you should delete the firmware update files from the /opt/tgcs/javapos/flash/
rs485 folder.
To confirm the success of the firmware, check the tgcsflash.log file under \pos\log in
Windows, or /var/log in Linux POS systems.

276 UnifiedPOS User's Guide

Manual update
Use this command line utility to manually update the firmware on an Toshiba 4610 printer. The
syntax for the utility is:
java com.ibm.jpos.util.flash.AipFlash46s [param] [flash_filename]

where:
param:
-e: Update the printer microcode

flash_filename: The fully qualified path for the firmware file.

On Linux for example:
java com.ibm.jpos.util.flash.AipFlash46s –e /opt/tgcs/javapos/flash/aipmch46.hex

4610 printers font download

A command utility is also provided to download fonts to the printer. The syntax for the utility is:
java com.ibm.jpos.util.font.AipFnt46s [param] [filename] [codepage] [logicalname]

where:
param:
• -f: fixed font file
• -p: proportional font file
• -d: dbcs font file (valid only for double-byte printers)
filename: The fully qualified pathname of the font file.
codepage:
• 1: CR (receipt) station Code Page 1
• 2: CR (receipt) station Code Page 2
• 3: CR (receipt) station Code Page 3
• 4: CR (receipt) station Code Page 4
• 5: DI (slip) station Code Page 1
• 6: DI (slip) station Code Page 2
• 0: DBCS font download
For example:
java com.ibm.jpos.util.font.AipFnt46s -p /opt/tgcs/javapos/fonts/FontFile.fTH 3
POSPrinter4610

The font files are described in Table 235.

6145 Printer font download

The USB 6145 Printers support .dat font file format only. To download DBCS font file:
1. Select desired .dat file from Table 235, under the 6145 File Name column.

Chapter 16. POS printer 277

2. Copy the file to the following location based on operating system:
• Windows: c:\pos\JavaPOS\res\flash\usb
• Linux: /opt/tgcs/javapos/flash/usb
3. Reboot system. The font file will be automatically updated.

6145 printer firmware and configuration update

The Toshiba JavaPOS drivers can automatically download firmware and/or configure files to
6145 USB printers after system reboots. The firmware and/or configuration files must be present
in specific folders before system is rebooted and device must be configured in jpos.xml.

Printer firmware file

The printer firmware file can be downloaded from http://www.toshibacommerce.com.
The firmware file name for USB Printer is of the format aip45355_00-<optional
description>.dat.

Configuration files
The printer configuration files are created using Toshiba TCx Printer configuration
utility. It can be downloaded from http://www.toshibacommerce.com. The configuration
file name for the USB printer is of the format aip45355_<component>-
<description>.dat.
The TCx Printer configuration utility can generate different types of configuration files.
Each configuration file is separate and uniquely identified by its component during file
creation. Listed below are types of configuration files that can be generated by the utility.
1. Printer settings
2. Network Settings
3. DBCS Fonts
4. SBCS Fonts
5. Resident Message
6. Resident Graphics (bitmaps)
Note: Don’t change the file name generated by the TCx Printer configuration utility.

Firmware and configuration file location

The firmware and configuration files must be copied to the location described in Table
192. The JavaPOS drivers will automatically update the firmware and configuration files
upon system reboot.

Table 192. 6145 POS Printer

POS Printer Type File Name Location on Location on Linux
Windows
Toshiba 6145 POS aip45355_<component> c:\pos\JavaPOS\ /opt/tgcs/
Printer -<description>.dat1 res\flash\usb javapos/
flash/usb
1<component> and <description> assigned by TCx Printer Configuration Utility.

278 UnifiedPOS User's Guide

Automatic update (USB)
1. 1. Make sure the device is configured correctly in jpos.xml and is online.
2. Copy the firmware/configuration files to the location specified in Table 192.
3. Reboot the system.
In Windows, automatic update process is controlled by Toshiba JavaPOS Flash Update
service. In Linux, it is controlled by a shell script /etc/init.d/flashdev.

Manual update (USB)

You can use the POS Control Center.

Automatic and manual update (Network)

Use the TCx Printer configuration utility from http://www.toshibacommerce.com to download
firmware and/or configuration files.

Using POSPrinter's MICR device

When using a printer with an integrated MICR, it is possible for a multi-threaded application
to attempt to talk to both devices at the same time. Unpredictable results can occur. Such
applications should provide a locking mechanism to ensure that only one thread at a time talks
to these devices.

Handling invalid characters

The first 31 ASCII characters are non-printable. The POSPrinter handles these as strings and
prints the hexadecimal value of the character in the string. Table 193 shows the values that the
POSPrinter prints for these values.

Table 193. Handling invalid characters

Hex Value Character Also known as JavaPOS print
0x00 NUL Null 00
0x01 SOH Start of Heading 01
0x02 STX Start of Text 02
0x03 ETX End of Text 03
0x04 EOT End of Transmission 04
0x05 ENQ Enquiry 05
0x06 ACK Acknowledge 06
0x07 BEL Bell 07

Chapter 16. POS printer 279

Hex Value Character Also known as JavaPOS print
0x08 BS Backspace 08
0x09 Tab Horizontal Tab *
0x0A LF NL line feed, New Line *
0x0B VT Vertical Tab 0B
0x0C FF NP form feed, New Page 0C
0x0D CR Carriage Return *
0x0E SO Shift Out 0E
0x0F SI Shift In 0F
0x10 DLE Data Link Escape 10
0x11 DC1 Device Control 1 11
0x12 DC2 Device Control 2 12
0x13 DC3 Device Control 3 13
0x14 DC4 Device Control 4 14
0x15 NAK Negative Acknowledge 15
0x16 SYN Synchronous Idle 16
0x17 ETB End of Transmission Block 17
0x18 CAN Cancel 18
0x19 EM End of Medium 19
0x1A SUB Substitute 1A
0x1B ESC Escape *
0x1C FS File Separator 1C
0x1D GS Group Separator 1D
0x1E RS Record Separator 1E
0x1F US Unit Separator 1F

*These values are processed by the POSPrinter.

Escape sequence handling

• The Fire Stamp escape sequence is supported on the 4610 and 6145 POS printers. JavaPOS
uses the bitmap downloaded as bitmap #1 for the stamp.
• Handling of invalid, unrecognized, or illegal value escape sequences is performed as follows:
• Sequences that do not start with esc| are passed to the printer unmodified. In this case,
validateData() returns JPOS_E_FAILURE.
• Sequences that start with esc| but are not valid JavaPOS sequences are passed through
unmodified. In this case validateData() returns JPOS_E_FAILURE.

280 UnifiedPOS User's Guide

• Sequences that specify a function not supported by the printer are ignored. Note that they
are not passed to the printer. The validateData() would return JPOS_E_FAILURE.
• Sequences that include a number that is considered invalid (such as less than 0, or in
the case where the number represents a percentage, greater than 100), the device service
chooses a number to use. This is an interpretation of the validateData method in the case
when JPOS_E_ILLEGAL is returned. The specification states that the service can select
valid alternatives. In this case validateData() would return JPOS_E_ILLEGAL.

Line wrapping on the slip station using rotatePrint

method(PTR_RP_LEFT90)
The hardware cannot determine the width of the slip station paper when print is rotated 90
degrees left; it is not possible to perform automatic wrapping in this case. Applications should
not assume the printer service provides automatic wrapping before reaching the edge of the
paper while in this mode. Set the SlpLineChars value property to a value that causes the print
lines to wrap correctly for your document length.
Where printing is rotated 90 degrees on the slip station, only the following escape sequences are
supported:
• Top and bottom log
• Double wide
• Left, center, and right alignment
Note: 4610 and 6145 POS printers are not able to print characters from a font with a size of X x
16 dots on the slip station (document station) while in rotate mode. Examples are larger SBCS
impact fonts and the DBCS impact fonts currently supported (9x16 dots).

Bar Code GS1 Databar information

Syntax printBarCode ( station: int32, data: string, symbology: int32, height: int32, width: int32,
alignment: int32, textPosition: int32 ): void { raises-exception, use after open-claim-enable }
The following table shows accepted argument values.

Table 194. Accepted Argument Values

Parameter Accepted Value

station POSPrinterConst.PTR_S_RECEIPT
data Character string to be bar coded, See remarks for details (Below)
symbology POSPrinterConst. PTR_BCS_GS1DATABAR
POSPrinterConst. PTR_BCS_GS1DATABAR_S
POSPrinterConst. PTR_BCS_GS1DATABAR_E
POSPrinterConst. PTR_BCS_GS1DATABAR_E_S

height Ignored
width Ignored
alignment POSPrinterConst.PTR_BC_LEFT
POSPrinterConst.PTR_BC_CENTER
POSPrinterConst.PTR_BC_RIGHT

Chapter 16. POS printer 281

Parameter Accepted Value
text position POSPrinterConst.PTR_BC_TEXT_NONE
POSPrinterConst.PTR_BC_TEXT_ABOVE
POSPrinterConst.PTR_BC_TEXT_BELOW

GS1 DataBar Omnidirectional and GS1 DataBar Stacked

Omnidirectional
Character Set:
• Must begin with an Application Identifier (01).
• Data is 13 or 14 digits. If 13 digits are sent, check digit is calculated by the firmware and is
embedded into the barcode. If 14 digits are sent, the check digit needs to be the correct one.
Example:
posPrinter.printBarcode( PTR_S_RECEIPT,
"(01)12345678901231", PTR_BCS_GS1DATABAR,
0, 0,PTR_BC_CENTER, PTR_BC_TEXT_ABOVE)

Invalid Input:
• Data does not start with Application Identifier (01).
• Alpha numeric values.
• Less than 13 digits or more than 14 digits.
• If input is 14 digits and check digit is not correct.

GS1 DataBar Expanded and GS1 DataBar Expanded Stacked

Character Set:
• ISO/IEC 646: (0-9) (A-Za-z) ! " % & ' ( ) * + , - . / : ; < = > ? _ (SPACE).
• Max number of digits depends on the AI and the order of the AI. See ISO/IEC specification
The data needs to be formatted following these rules:
• Must begin with an Application Identifier.
• Any Application Identifier needs to be enclosed in parentheses.
• There are different encode modes. The modes are enumerated from the most compressed (1)
to the least compressed size (7). In addition, certain AI can only be used in specific modes:
• Mode 1: (01) & (310x)
• Mode 2: (01) & (320x)
• Mode 3: (01), (11), (13), (15), (310x) & (320x)
• Mode 4: (01) & (392x)
• Mode 5: (01) & (393x)
• Mode 6: (01) & any AI
• Mode 7: any AI
• Mode 1, 2, 3, 4 and 5 need an indicator digit of 9 after (01) and a check digit at the end of
Global Trade Item Number (GTIN).
• Mode 6 does not need an indicator, after (01). It does need a check digit.
• Mode 7 accepts any other AI
Example for Mode 1:

282 UnifiedPOS User's Guide

printBarcode( PTR_S_RECEIPT,
"(01)90012345678908(3103)001750",
PTR_BCS_GS1DATABAR,
1, 1,PTR_BC_CENTER, PTR_BC_TEXT_ABOVE)

Firmware will append group separator after the variable length AIs. Depending on the scanner,
the group separator most likely will be transmitted as 0x1D on scanner output data.
Invalid input:
Not beginning with an AI
AI is not enclosed in parenthesis "()"
AI is not a valid AI
Data length is not correct.

Example (14-digit GTIN & 6-digit weight of 1.750kg)

Mode 1: (01)90012345678908(3103)001750
Mode 6: (01)00012345678905(3103)001750
(mode 1 will produce a smaller printed barcode on the paper because
it is more compressed)

Example (14-digit GTIN & 6-digit weight of 1.280lb)

Mode 2: (01)90012345678908(3203)001280
Mode 6: (01)00012345678908(3203)001280
(mode 2 will produce a smaller printed barcode on the paper because
it is more compressed)

Example (14-digit GTIN & 6-digit of $100.99)

Mode 4: (01)90012345678908(3922)010099
Mode 6: (01)00012345678905(3922)010099

Example (serial number)

Mode 7: (21)123456789

Note:
1. The validateData(int station, String data) method will NOT validate the contents of the GS1
Databar inline data parameter. It will still check the values for the station, alignment and
text position parameters and throw an exception if any of those fail.
2. Whenever invalid data is sent in an inline with printNormal, printImmediate or
printTwoNormal, the barcode will NOT be printed and it will throw an exception in
response of the invalid barcode data.
3. For more information about the GS1 standard and how to make sure your input
data is valid, visit: https://www.gs1.org/standards/barcodes-epcrfid-id-keys/gs1-general-
specifications.
4. For more information about GS1 application identifiers, https://www.gs1.org/standards/
barcodes/application-identifiers.

Bitmap printing
To use setBitmap and printBitmap in a non-graphics environment on Linux, the following
parameter must be passed to Java:
java -Djava.awt.headless=true

• The methods printBitmap and setBitmap support JPEG and GIF file formats. Uncompressed
Windows bitmaps (.BMP) up to 8 bits per pixel are also supported.
• If the bitmap width exceeds the RecLineWidth or SlpLineWidth, an exception is thrown with
ErrorCodeExtended = EPTR_TOOBIG.

Chapter 16. POS printer 283

Table 195. Bitmap printing
Type of Station Method Property Max height Size
printer
4610 TI 3/4/5 receipt printBitmap() RecLineWidth None None
4610 TI 3/4/5 receipt setBitmap() RecLineWidth 2040 w*h/8<8K
4610 TI 3/4/5 slip printBitmap() SlpLineWidth None None
4610 TI 3/4/5 slip setBitmap() SlpLineWidth 40 w*h/8<8K

Note: printBitmap() has no height maximum because the bitmap is divided into horizontal
slices. The height is physically limited on the slip station to the length of the paper.

Enable GrayScale printing

Stored logos on POSPrinter memory can be used to exercise grayscale functionality.
Support:
• 6145 POSPrinters
• .BMP files only, at 8 bits per pixel (BPP) resolution or higher.
• Receipt station
Complete the steps below to enable GrayScale printing.
1. Create an empty file with extension .grey or .gray. This new file must exist in the same
directory and have the same name as the original bitmap file.
Example:
C:\bitmaps\image.bmp
C:\bitmaps\image.grey or C:\bitmaps\image.gray
2. Print the bitmap using one of the following two methods:
• Using printBitmap() method
• Using Escape Sequence (ESC |#B) with a Bitmap previously stored on the printer
Additonal notes
• To print a GrayScale image, a valid bitmap image must exist in the defined location and
name. Otherwise, the print will cause a failure.
• If only a gray file exists on the given path, then the print will cause a failure.
• If a gray and bmp file exists on the given path with the same name, and gray is used as a
parameter instead of the bmp file, then the print will cause a failure.
• The only way to successfully print a gray image is to have two files with same name,
with extensions .grey/.gray and .bmp

284 UnifiedPOS User's Guide

Enable DBCS character compression on SLIP (Impact) station

<prop name =
"com.ibm.jpos.sdi.config.POSPrinter.EnableSlipDBCSCharCompression"
type= "Boolean" value= "true"/>

Values accepted:

False (default)
DBCS Chars will be printed with full width (32 dots).

True
DBCS Chars will be printed with half width (16 dots).
Device support:
4610 2xR with Firmware version >= 0x0D.00 and 6145-2TC/2TN.
Since:
1.13.1
EnableSlipDBCSCharCompression property enable/disable the mechanism to print more DBCS
chars per line on the SLIP station.
When the property is false the driver will behave as in previous JavaPOS driver version, printing
each DBCS char twice the width of a SBCS char.
When the property is true, the JavaPOS driver will print the half of the number of chars specified
in the SlpLineChars property. The DBCS chars will have the same width as the SBCS chars.
In order to modify the behavior the property should be added into the JposEntry.
Note:
1. The compression is only enabled for fonts of 16 x 16 dots.
2. If the property is not added or it has an invalid value, the default value will be used (false).

Check flipping support

While the drivers still support the DirectIO.FLIP_CHECK_ID, the preferred method to flip the
check is to use the POSPrinter method:

changePrintSide( )

PageMode support
JavaPOS supports Toshiba PageMode on Receipt Station only. When in PageMode, use of
transactionPrint and rotatePrint are prohibited and will cause an exception to be thrown. When
horizontalPosition or verticalPosition is set in PageMode, if the value set is not supported by the
printer, the UnifiedPOS driver adjusts the value to the closest supported value.

Chapter 16. POS printer 285

PageMode properties (default)
• AfterOpen (no station):
• PageModeArea = ""
• PageModePrintArea = ""
• PageModeHorizontalPosition = 0
• PageModeVeritcal Position = 0
• PageModePrintDirection = 0
• PageModeStation = 0
• After setting a valid station:
• PageModeArea = "576,800" ("576,1250" for Tx8/Tx9)
• PageModePrintArea = "0,0,0,0"
• PageModePrintDirection = PTR_PD_LEFT_TO_RIGHT
• After entering PageMode:
• PageModePrintArea = "0,0,576,800" ("0,0,576,1250" for Tx8/Tx9).
• Setting the PrintDirection: Property may change PageModeHorizontalPosition and
PageModeVerticalPostion.
• If the Vertical or Horizontal Position property values are not supported, then they will
be set to the closest supported value. If the values are outside of the area described
by PageModePrintArea, the driver sets these values to the size of the area described by
PageModePrintArea.
Note: The vertical and horizontal position properties must be set before sending any print
command. If you set the vertical position near the top edge, then text, bitmaps, and barcodes do
not display because they are beyond the PageMode area. Set the vertical position to be greater
than the vertical dimension of the image to print.
Several examples below illustrate the use of PageMode printing.

Code:
printer.setPageModeStation(POSPrinterConst.PTR_S_RECEIPT);
printer.setPageModeArea("0,0,576,1250");
printer.pageModePrint(jpos.POSPrinterConst.PTR_PM_PAGE_MODE);
printer.printBitmap(POSPrinterConst.PTR_S_RECEIPT,"logo.bmp";
POSPrinterConst.PTR_BM_ASIS;
POSPrinterConst.PTR_PM_CENTER);
printer.pageModePrint(jpos.POSPrinterConst.PTR_PM_NORMAL);

Figure 32. Partial image, no position setting

In the next example the printing is correct, with position properties set.

Example:
This example illustrates how to print a bitmap and a barcode correctly.

286 UnifiedPOS User's Guide

Code:
printer.setPageModeStation(POSPrinterConst.PTR_S_RECEIPT);
printer.setPageModePrintArea("0,0,576,400");
printer.pageModePrint(POSPrinterConst.PTR_PM_PAGE_MODE);
printer.setPageModeHorizontalPosition(0);
printer.setPageModeVerticalPosition(150);
printer.printBitmap( POSPrinterConst.PTR_S_RECEIPT,"logo.bmp",
POSPrinterConst.PTR_BM_CENTER;
POSPrinterConst.PTR_BM_ASIS);
printer.setPageModeHorizontalPosition(0);
printer.setPageModeVerticalPosition(300);
printer.printBarCode( POSPrinterConst.PTR_S_RECEIPT,"01234567",
108,
POSPrinterConst.PTR_BCS_CODE39,
100, 200,
POSPrinterConst.PTR_BC_CENTER;
POSPrinterConst.PTR_BM_CENTER);
printer.pageModePrint(jpos.POSPrinterConst.PTR_PM_NORMAL);

Figure 33. Setting position properties for printing

Code:
printer.setPageModeStation(POSPrinterConst.PTR_S_RECEIPT);
printer.setPageModePrintArea("0,0,576,400");
printer.pageModePrint(POSPrinterConst.PTR_PM_PAGE_MODE);
printer.setPageModeHorizontalPosition(0);
printer.setPageModeVerticalPosition(150);
printer.printBitmap( POSPrinterConst.PTR_S_RECEIPT,"logo.bmp",
POSPrinterConst.PTR_BM_CENTER;
POSPrinterConst.PTR_BM_ASIS);
printer.pageModePrint(jpos.POSPrinterConst.PTR_PM_NORMAL);

Chapter 16. POS printer 287

Figure 34. Setting image position for printing

Code:
printer.setPageModeStation(POSPrinterConst.PTR_S_RECEIPT);
printer.setPageModePrintArea("0,0,576,400");
printer.pageModePrint(POSPrinterConst.PTR_PM_PAGE_MODE);
printer.printNormalText(POSPrinterConst.PTR_S_RECEIPT,"Text");
printer.printNormalText(POSPrinterConst.PTR_S_RECEIPT,"TextSecondLine");
printer.pageModePrint(POSPrinterConst.PTR_PM_NORMAL);

Example
Not specifying the PageMode Vertical Position/PageMode Horizontal Position results in partial
image printing.

Example
This is another example to illustrate how to print a bitmap.

Example
This example illustrates printing two lines of code in PageMode.

Printing text
Begin in the next line.

Figure 35. Printing text

When an image follows printed text, the image appears larger than when the image is printed
alone, because the image begins in the next line of the text.

Code:
printer.setPageModeStation(POSPrinterConst.PTR_S_RECEIPT);
printer.setPageModePrintArea("0,0,576,400");
printer.pageModePrint(POSPrinterConst.PTR_PM_PAGE_MODE);
printer.printNormal( POSPrinterConst.PTR_S_RECEIPT,"TestingPrintText\n");
printer.printBitmap( POSPrinterConst.PTR_S_RECEIPT,"logo.bmp";
POSPrinterConst.PTR_BM_CENTER;

288 UnifiedPOS User's Guide

POSPrinterConst.PTR_BM_ASIS)
printer.pageModePrint(POSPrinterConst.PTR_PM_NORMAL);

Figure 36. Image follows text

Example:
When you print an image or barcode, the following text, image, or barcode prints next to
the first.

Code:
printer.setPageModeStation(POSPrinterConst.PTR_S_RECEIPT);
printer.setPageModePrintArea("0,0,576,1250");
printer.pageModePrint(jpos.POSPrinterConst.PTR_PM_PAGE_MODE);
printer.printBarcode( POSPrinterConst.PRT_S_RECEIPT,"01234567", 108, 100,
200, -1, -13);
printer.printBitmap( POSPrinterConst.PTR_S_RECEIPT,"logo.bmp",
POSPrinterConst.PTR_BM_CENTER;
POSPrinterConst.PTR_BM_ASIS);
printer.pageModePrint(POSPrinterConst.PTR_PM_NORMAL);

Figure 37. Second image beside first image

SetPrintArea
If an empty string buffer is sent as a parameter to PageModePrintArea and a get is performed,
the current PrintArea is returned. If non-numeric values are used, or the wrong number of
values are entered, an exception is thrown. The driver adjusts values to the printer supported
values as shown below:
if x < 0 then x = 0
if y < 0 then y = 0
if x > MaxWidth - MinWidth then
x = MaxWidth - MinWidth
if y > MaxHeight - MinHeight
then y = MaxHeight - MinHeight
if width < MinWidth then width = MinWidth
if height < MinHeight then height = MinHeight
if (width + x) > MaxWidth then width = MaxWidth - x
if (height + y) > MaxHeight then height = MaxHeight - y

The values for MinHeight, MaxHeight, MinWidth, and MaxWidth are as follows:
• MinHeight: 6
• MaxHeight: 800 (1250 for TI8/9)
• MinWidthPosition: 15
• MaxWidthPosition: 576

Examples:
• "0,-1,570,600" is adjusted to: "0,0, 570,600"

Chapter 16. POS printer 289

• "-1,0,800,5000" is adjusted to: "0,0,576,800"
for TI8/9, 0,0,576,1250
• "-1,6,200,8000" is adjusted to: "0,6,200,794"
for TI8/9, 0,6,200,1244
• "" gets the current value of PageModePrintArea

Function of the ErrorEvent with response of ER_CLEAR

When the application responds to an ErrorEvent with ER_CLEAR, it clears all outputs that have
not been completed. For example:
1. open/ claim/ enable/ async=true
2. printNormal1
3. ErrorEvent on printNormal2
4. printNormal3
5. printNormal4
6. Respond ErrorEvent with ER_CLEAR
7. printNormal5
All the printNormal events up to, and including printNormal4, are cleared in step 6 on page 290.

Paper saving mode

Paper saving mode is implemented for 1xR/2xR printers and allows you to configure the driver
to compress certain aspects of the receipt and thus save paper. Configuration is implemented
using 3 different options: Dots Between Lines, Blank Lines Reduction and Barcode Height
Reduction. These 3 properties can be separately customized in the relevant JPOS.XML entry.

Dots Between Lines

This setting allows you to explicitly set the number of dots between lines of text. When
this property is disabled, the number of dots are calculated by the drivers. When enabled,
depending on the option, it will override the calculated values to either be 2 dots or 4
dots between lines. Two dots represents the highest compression; four dots represent a
medium compression setting.
<prop name="com.ibm.jpos.sdi.config.POSPrinter.DotsBetweenLines" type="String"
value="0"/>

For DotBetweenLines property the valid values are:

• 0 -> Application Settings
• 1 -> 2 Dots Between lines of text
• 2 -> 4 Dots Between lines of text

Blank Line Reduction

This setting will reduce the size of any section composed of only line feeds. When
this property is disabled, the size of the line feed behaves as it normally would. When
enabled, depending on the option, it will override the default size compressing it either to
a 50% or a 75% of the default value.
<prop name="com.ibm.jpos.sdi.config.POSPrinter.BlankLineReduction"
type="String" value="0"/>

290 UnifiedPOS User's Guide

For BlankLineReduction property the valid values are:
• 0 -> No reduction
• 1 -> 75% Reduction of blank space
• 2 -> 50% reduction of blank space

Barcode Height Reduction

This setting will reduce the vertical size of any barcode. When this property is disabled,
the barcode keeps its original size. When enabled, depending on the option, it will
override the printer settings and reduce the barcode height by either 25%, 50% or 75% of
the original size.
<prop name="com.ibm.jpos.sdi.config.POSPrinter.BarcodeHeightReduction"
type="String" value="0"/>

For BarcodeHeightReduction property, the valid values are:

• 0 -> No reduction
• 1 -> 75% Barcode height reduction
• 2 -> 50% Barcode height reduction
• 3 -> 25% Barcode height reduction

Concurrent MICR/full-image scan

The 4610 Model TI9 performs a concurrent MICR/full-image scan; however, when using a Model
TI8 you must do separate passes.

Rec/SlpLineChars behavior
If the parameter for setRec/SlpLineChars method is negative, the method will throw a
JPOS_E_ILLEGAL exception, if value is 0<=x<=10 the Rec/SlplineChars property will be set to
10.

Character sets supported by POSPrinter devices for JavaPOS

Table 196. Single-byte character sets supported by POSPrinter devices for JavaPOS
Code
Page
-
SBCS Device
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
437 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
775 ✓ ✓ ✓ ✓ ✓
808
819 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

Chapter 16. POS printer 291

Code
Page
-
SBCS Device
848 ✓ ✓ ✓ ✓ ✓
850 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294
852 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294
855 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294
857 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294
858 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294
860 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294
861 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294
862 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294
863 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note

292 UnifiedPOS User's Guide

Code
Page
-
SBCS Device
1 on
page
294
864 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294
865 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294
866 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294
867 ✓ ✓ ✓ ✓ ✓
869 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294
872 ✓ ✓ ✓ ✓ ✓
874 ✓ ✓
Note
1 on
page
294
897 ✓ ✓
Note
1 on
page
294
998 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
999 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
1116 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
1117 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
1118 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

Chapter 16. POS printer 293

Code
Page
-
SBCS Device
1250 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
1251 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
1252 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
1253 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
1254 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
1255 ✓ ✓ ✓ ✓ ✓
1256 ✓ ✓ ✓ ✓ ✓
1257 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
1258 ✓ ✓ ✓ ✓ ✓

Note:
1. Standard model only

Table 197. Double-byte character sets supported by POSPrinter devices for JavaPOS
Code
Page -
DBCS Device
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
926
932 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note Note Note Note Note Note Note Note Note Note
6 on 6 on 6 on 1 on 1 on 5 on 5 on 5 on 5 on 5 on
page page page page page page page page page page
295 295 295 295 295 295 295 295 295 295
936
949 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note Note Note Note Note Note Note Note
6 on 6 on 6 on 5 on 5 on 5 on 5 on 5 on
page page page page page page page page
295 295 295 295 295 295 295 295
950 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note Note Note Note Note Note Note Note Note Note
6 on 6 on 6 on 2 on 2 on 5 on 5 on 5 on 5 on 5 on
page page page page page page page page page page
295 295 295 295 295 295 295 295 295 295
951 ✓ ✓ ✓ ✓ ✓
Note Note Note Note Note
5 on 5 on 5 on 5 on 5 on

294 UnifiedPOS User's Guide

Code
Page -
DBCS Device
page page page page page
295 295 295 295 295
1361 ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note Note Note Note Note Note Note
3 on 3 on 5 on 5 on 5 on 5 on 5 on
page page page page page page page
295 295 295 295 295 295 295
1381 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note Note Note Note Note Note Note Note Note Note
6 on 6 on 6 on 4 on 4 on 5 on 5 on 5 on 5 on 5 on
page page page page page page page page page page
295 295 295 295 295 295 295 295 295 295

Only on::
1. Japanese version
2. Traditional Chinese version
3. Korean version
4. Simplified Chinese version
5. Available after Font Download
6. Available after Font Download on TI5/Tx7 models

OPOS configuration
In order to apply the configurations shown below, create the keyword of the specified type into
the following windows registry:
-
HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\POSPrinter\Logical
Name
Note: For 32 bit Applications running on 64 bit Windows use the following path instead:
-
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\OLEforRetail\ServiceOPOS\POSPri
nter\LogicalName
"LogicalName" refers to the actual device logical name given by end user at configuration time.

Table 198. Service object settings for SureOne devices (POS printer)
Keyword Type Description
ThermalPrinter String Whether printer is impact or thermal. Valid values are:

0
Impact (default)

Chapter 16. POS printer 295

Keyword Type Description

1
Thermal
Note: Applies only to SureOne/SurePOS 100.

NarrowPaper String Whether paper is normal or narrow width. Valid values are:

0
Normal (default)

1
Narrow
Note: Applies only to SureOne/SurePOS 100.

BitmapResolution String Bitmap resolution (for thermal printers only). Valid values are:

0
Low resolution (default)

9
High resolution
Note: Applies only to SureOne/SurePOS 100.

PrinterModel String Specifies the model of printer in use. Valid values are:

0
Single-head impact (default)

1
Double-head impact

2
Thermal

3
A04/A05 impact
Note: Applies only to SureOne/SurePOS 100.

Vietnamese code page support

Vietnamese character printing is supported via codepage 1258 in 4610-2xR/1xR (FW version
17.F0 and above) and 6145 2Tx/1TN POS printers. The support is limited on Receipt (CR) station.
OPOS also provides input conversion from Unicode (UTF8) to the characters in the specified
codepage by setting MapUnicodeToCodePage registry. Please refer to the “Supported settings”
on page 302 section below for the details of the registry setting.

296 UnifiedPOS User's Guide

Thai code page support

Thai character printing is supported via User Defined font (UDF) on 1NR/2xR/2TC/2TN. The
user needs to download the specific UDF font file to the printer and set UDFAsThaiCodePage
registry so the input is treated as Thai input for the UDF codepage specified. The support covers
Receipt (CR) station and Impact (DI) station and each station is using a different UDF font file.
OPOS also provides input conversion from Unicode (UTF8) to the characters in the specified
codepage by setting MapUnicodeToCodePage registry. Please refer to the “Supported settings”
on page 302 section below for the details of the registry setting.

Arabic code page support

OPOS provides support for printing Arabic characters by performing the following actions when
the codepage 864 or 1256 is selected:
1. Performs Arabic character word shaping (character transformation depending on the
position of the character in a word).
2. Removes the intercharacter spacing between Arabic characters.
The driver also allows default setting of the code page (CharacterSet property) at device open via
the following registry:
HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\PosPrinter\<Device Logical Name>

Keyword Type Description

DefaultCodePage REG_DWORD Setting of CharacterSet property automatically from
this registry entry when the device is opened. Set to
864 or 1256.

The driver assumes that the input characters have been reversed by the application and the
beginning character is at the right end of the word. The driver can also perform the Arabic
phrase reversing when the following registry is set:
HKEY_LOCAL_MACHINE\SOFTWARE\Toshiba\Point Of Sale Subsystem

Keyword Type Description

ReverseArabicPhrase REG_SZ TRUE or true: Enable the reversing of Arabic phrases.
s All other values or if not exist: function is disabled.

Arabic phrase reversing rules:

• An Arabic phrase is a text portion made up of only Arabic text and single spaces.
• The beginning of an Arabic phrase is defined by the parser encountering an Arabic character.
• The ending of an Arabic phrase is reached when any of the following conditions occur:
• The next character is a non-Arabic character (except a single space).
• The next two characters are spaces.
• The next character is a line feed or carriage return.
• Escape sequences will break an Arabic phrase.
Supported device and code page support:

Chapter 16. POS printer 297

• 4610 2xR/1NR, 6145 2Tx/1TN:
• These models natively support Arabic code page 864 and 1256.
• 4610 TI-3/4 TM 6:
• The following font file must be downloaded to the printer first for the Arabic code page
support: [INSTALL DIR]\fonts\4610cp864a.fon
• The font can be downloaded with [INSTALL DIR]\bin\aipfnt46.exe tool
with the following command line: aipfnt46 -s8 -p11 -f[INSTALL DIR]
\fonts\4610cp864a.fon -c1

Unsupported settings
The following settings are unsupported and untested options used to modify Service Object
behavior only in very limited cases. Use them only when directed to do so by Toshiba Support.
Note: These settings cannot be modified with the Configuration tool. Some settings may only be
valid for RS-485/USB devices (POS printer).

Table 199. Service Object settings for POS printer device, unsupported
Keyword Type Description
AsyncBufferDelay String Number of milliseconds Async Thread will wait for
Asynchronous request to be added to the queue before
processing begins. The default value is 100.
AsyncBlockChase String Whether the printer driver waits for confirmation that
the Asynchronous Block of data has been printed before
continuing with print commands. Valid values are:

ON
Wait (default)

OFF
Do not wait
AsyncCarriageReturn String Whether a carriage return character is added after each print
command in Async Mode. Valid values are:

ON
Add carriage return

OFF
Do not add carriage return (default)
SyncPrintWithoutWait String Whether the printer driver waits for confirmation that the
synchronous data has been printed before continuing with
print commands. Valid values are:

False
Wait (default)

True
Do not wait

298 UnifiedPOS User's Guide

Keyword Type Description
ChineseDBCS String 4610 and 6145 only. Enables the use of bitmap printing to
support DBCS characters. The character map is downloaded
to the subsystem and converted to bitmap at print time. (No
longer supported due to the availability of models TI5 and
Tx7.) Valid values are:

ON
Enabled

OFF
Disabled (default)
StripDBLineFeeds String Whether carriage-return and line-feed characters are stripped
out when in Chinese Double-Byte mode. Valid only when the
ChineseDBCS setting is ON. Valid values are:

ON
Strip CR and LF

OFF
Do not strip (default)
OnlineTimeout String Time in milliseconds to wait for device to come online. Only
applies to RS485/USB printers.
BarcodeScaleHeightCodabar String Value to scale height of Codabar barcodes. Only applies to
RS485/USB printers.
BarcodeScaleHeightCode128 String Value to scale height of Code128 barcodes. Only applies to
RS485/USB printers.
BarcodeScaleHeightITF String Value to scale height of ITF barcodes. Only applies to
RS485/USB printers.
BarcodeScaleHeightJAN13 String Value to scale height of JAN-13 barcodes. Only applies to
RS485/USB printers.
BarcodeScaleHeightJAN8 String Value to scale height of JAN-8 barcodes. Only applies to
RS485/USB printers.
BarcodeScaleHeightUPCA String Value to scale height of UPC-A barcodes. Only applies to
RS485/USB printers.
BarcodeScaleHeightUPCE String Value to scale height of UPC-E barcodes. Only applies to
RS485/USB printers.
BarcodeScaleWidthCodabar String Value to scale width of Codabar barcodes. Only applies to
RS485/USB printers.
BarcodeScaleWidthCode128 String Value to scale width of Code128 barcodes. Only applies to
RS485/USB printers.
BarcodeScaleWidthCode39 String Value to scale width of Code39 barcodes. Only applies to
RS485/USB printers.

Chapter 16. POS printer 299

Keyword Type Description
BarcodeScaleWidthITF String Value to scale width of ITF barcodes. Only applies to
RS485/USB printers.
BarcodeScaleWidthJAN13 String Value to scale width of JAN-13 barcodes. Only applies to
RS485/USB printers.
BarcodeScaleWidthJAN8 String Value to scale width of JAN-8 barcodes. Only applies to
RS485/USB printers.
BarcodeScaleWidthUPCA String Value to scale width of UPC-A barcodes. Only applies to
RS485/USB printers.
BarcodeScaleWidthUPCE String Value to scale width of UPC-E barcodes. Only applies to
RS485/USB printers.
Default40CPL String Set the receipt to default to 40 characters per line. Valid values
are TRUE and FALSE. Default is FALSE. Only applies to
RS485/USB printers.
DocAdvance String Sets the number of motor steps from the top Document sensor
to the first print position. Valid values are 1 to 256. Default is
50. Only applies to RS485/USB printers.
CompoundVietnameseCharacters String Valid values are TRUE and FALSE. Default value is TRUE.
When printing overlay characters in codepage 1258
(Vietnamese), this option dictates when the overlay character
is sent.
For example, the 4 bytes 0x42 0x61 0xd2 0x6f results in
3 characters (the word "bắo") being printed on the paper
because 0xd2 is a no-width overlay character.
The registry option dictates whether we use the original TGCS
order, or the Epson compatible order, in placing the overlay
character.
Which value you use will depend on whether your
application also runs on other vendor's hardware.
FALSE - sends 0x42 0x61 0xd2 0x6f (where the overlay 0xd2 is
sent after the 0x61)
TRUE - sends 0x42 0xd2 0x61 0x6f (the overlay 0xd2 is sent
before the 0x61 character)

InterCharSpacingDocument12Cpi String Sets the number of printer dots between characters when the
Slip station is set to 12 characters per inch. Only applies to
RS485/USB printers.
InterCharSpacingDocument15Cpi String Sets the number of printer dots between characters when the
Slip station is set to 15 characters per inch. Only applies to
RS485/USB printers.
InterCharSpacingDocument17Cpi String Sets the number of printer dots between characters when the
Slip station is set to 17 characters per inch. Only applies to
RS485/USB printers.

300 UnifiedPOS User's Guide

Keyword Type Description
InterCharSpacingDocument20Cpi String Sets the number of printer dots between characters when the
Slip station is set to 20 characters per inch. Only applies to
RS485/USB printers.
InterCharSpacingReceipt12Cpi String Sets the number of printer dots between characters when the
Receipt station is set to 12 characters per inch. Only applies to
RS485/USB printers.
InterCharSpacingReceipt15Cpi String Sets the number of printer dots between characters when the
Receipt station is set to 15 characters per inch. Only applies to
RS485/USB printers.
InterCharSpacingReceipt17Cpi String Sets the number of printer dots between characters when the
Receipt station is set to 17 characters per inch. Only applies to
RS485/USB printers.
InterCharSpacingReceipt20Cpi String Sets the number of printer dots between characters when the
Receipt station is set to 20 characters per inch. Only applies to
RS485/USB printers.
LegacyDIMode String In prior releases, the OPOS_SUE_PTR_PAPEROK was fired
once the document was registered, not merely detected by
the front sensor. This setting allows customers to maintain
this behavior. Valid values are TRUE and FALSE. Default is
FALSE. TRUE means the OPOS_SUE_PTR_PAPEROK event is
fired when the paper is detected at the front sensor. FALSE
means the OPOS_SUE_PTR_PAPEROK event is fired when
the paper is registered. Only applies to RS485/USB printers.
LegacyRS232Mode String In prior releases, the OPOS_SUE_PTR_NEAREND was fired
when the document was detected only by the Ready and
Front Sensor. This behavior was specific to the RS232 printer.
Valid values are TRUE and FALSE. Default is FALSE. TRUE
means the OPOS_SUE_PTR_NEAREND event is fired when
the document is positioned in the front. FALSE means
that OPOS_SUE_PTR_NEAREND event is not fired when
the document is positioned in the front. Only applies to
RS485/USB printers.
RecLineSpacing String Sets the default RecLineSpacing. Default is 34 (dots). Only
applies to RS485/USB printers.
TransactionHold String Determines whether to hold/release the buffer internal to the
printer during a TransactionPrint to the receipt. Valid values
are TRUE and FALSE. Default is FALSE. Only applies to
RS485/USB printers.
BitmapResolution String Indicates bitmap resolution on SurePOS 100/SureOne thermal
printers. Valid values are 0 (low) and 9 (high) only. Default is
9.
SetCompatibilityMode String This property allows the 2xR, 1NR printer to remain in
compatibility mode even when driver is updated. Valid
values: True, False (default).
Note:

Chapter 16. POS printer 301

Keyword Type Description

1. If no property is found, the default value is used.

2. If the property is present but it has an invalid value, then
the default value is used.

ReceiptInterCharacterSpacingUDFx DWORD This property sets the Inter Character Spacing of User Defined
Font (UDF) with the Character Set between 101 to 104.
DocumentInterCharacterSpacingUD
Fx ReceiptInterCharacterSpacingUDFx denotes the setting for
Receipt (CR) station;
DocumentInterCharacterSpacingUDFx denotes the setting for
Document (DI) station;
where x is a value from 1 to 4 which translates for the
setting of 12, 15, 17, 20 characters per inch (CPI)
respectively.

Valid values: 0 to 7 in decimal representation, where 0 denotes

No Inter Character Spacing.
Note: This setting cannot be modified with the Configuration
tool. If no property is found or if the property is present but
the value is not within the valid range, no setting will take
place.

IncreaseRecLeftMargin String Increase the left margin of the Receipt Station. Valid with
RecLineChars up to 42 characters.
Valid Values: 0 to 9. If the property is present but it has a
value that is not in the range of values, it is matched to the
closest parameter.
Only applies to RS232 printers.

MapToPrintNormal String Redirect the PrintImmediate function call to PrintNormal

during asynchronous mode.
Valid Values:

True:
Enabled

Other, Empty:
Disabled (Default)
Only applicable to USB 1xR/2xR/2TC/2TN printers.

Supported settings
Note: Not all of these settings can be modified with the Configuration tool. Some settings may
only be valid for EIA-232 attached SureMark devices (POS printer).

302 UnifiedPOS User's Guide

Table 200. Service Object settings for SureMark devices (POS printer), supported
Keyword Type Description
BitmapSpeedQuality String Speeds up bitmap downloading. Valid values are:

False
(default)

True

BitmapLetterQuality String Enhances the bitmap letter quality (line thickness). Valid
values are:

False
(default)

True

Please note that if this setting is present, it takes precedence

over RecLetterQuality (UPOS POS Printer property).

PDF417ECCLevel String This property adds on the barcode a printed security level
to enable scanners to read the bar code even if it has been
torn, written on, or damaged in other ways. Error correction
is specified by selecting a level from 0 to 8. At level 0, a
damaged PDF417 cannot be read, but the damage can be
detected. At levels 1 through 8, a PDF417 symbol can still
be read, even when damaged. As the error correction level
increases, more damage can occur to the symbol and still be
read. For values of 9 to 400, the ECC level is assumed as a
percentage of the code words in the barcode.
Valid values: 0 to 400 in decimal representation.
Note:
1. This setting cannot be modified with the Configuration
tool.
2. If no property is found, the default value is used: 15.
3. If the property is present but the value is not a number,
the default value is used.
4. If the property is present but has a value not in the range
of values, it is matched to the closest parameter.
5. TextPosition supports NONE option only.

PDF417AspectHeight String This property selects the value for the aspect ratio height of
the PDF417 barcode.
Valid values: 1 to 9 in decimal representation.
Note:
1. This setting cannot be modified with the Configuration
tool.
2. If no property is found, the default value is used: 1.

Chapter 16. POS printer 303

Keyword Type Description

3. If the property is present but the value is not a number,

the default value is used.
4. If the property is present but has a value not in the range
of values, it is matched to the closest parameter.

PDF417AspectWidth String This property selects the value for the aspect ratio width of
the PDF417 barcode.
Valid values: 1 to 9 in decimal representation.
Note:
1. This setting cannot be modified with the Configuration
tool.
2. If no property is found, the default value is used: 2.
3. If the property is present but the value is not a number,
the default value is used.
4. If the property is present but has a value not in the range
of values, it is matched to the closest parameter.

PDF417Truncation String This property enables the truncation of the PDF417 barcode.
Truncated PDF generates a symbol with the right row
indicator and stop pattern replaced by a single width bar.
There is a slight degradation in decode performance if
truncation is enabled, which allows more data to fit in the
image width. Valid values:

ON
(Enables truncation)

Other value
(Disables truncation, default)
Note:
1. This setting cannot be modified with the Configuration
tool.
2. If no property is found, the default value is used.

TranslateCharacter Key Key values for translating one character to another. This is a
key folder in the Registry in which entries that can replace the
characters are stored. See TranslateCharacter\<X> for details
about the entries that can be added inside this key.
Note: This setting cannot be modified with the configuration
tool.

TranslateCharacter\<X> String The one-byte hexadecimal value of the character to translate.

For example, when you translate char "E" (0x45) to char "e"
(0x65), the entry name is 45 and the entry value is 65. Write
only the number in the entry.
Note: This setting cannot be modified with the Configuration
tool.

304 UnifiedPOS User's Guide

Keyword Type Description
CapRec2Color String When color thermal paper is loaded in the SureMark printer,
the valid values are:

N
Color paper not loaded (default)

Y
Color paper loaded
ProportionalFontFixedWidth String This property aligns proportional font characters on a fixed
width. The value is expressed in printer dots. If this property
is used the proportional characters are treated as fixed
characters.
Valid values: 8 to 32 in decimal representation.
Note:
1. This setting cannot be modified with the Configuration
tool.
2. If no property is found, the default value is used: 20.
3. If the property is present, but the value is not a number,
the default value is used.
4. If the property is present but has a value not in the range
of values, it is matched to the closest parameter.

PrinterModel String 4689 only. Specifies the model of 4689 printer in use. Valid
values are:
• 4689-TD5
• 4689-3M1
• 4689-3G1
• 4689-TD5(integrated into 4674)
• 4689-TG1(integrated into 4674)

PersistantBitmaps String Enables storage of downloaded bitmap in the registry. Valid

values are:

False
Disabled (default). Service Object must download the
bitmap each time the driver is opened.

True
Enabled. Downloaded bitmap is stored in the registry.
Note: This setting cannot be modified with the Configuration
tool.

ErrorOnCoverOpen String Fired Error Event when cover is opened.

Valid values are:

False
Do not fire event (default)

Chapter 16. POS printer 305

Keyword Type Description

True
Fire event
Note: This setting cannot be modified with the Configuration
tool.

LegacyRS-232Mode String Processes same as prior to release 1.7.1. Valid values are:

OFF
Default

ON

Note: This setting cannot be modified with the Configuration

tool.

LegacyDIMode String Processes DI same as prior to release 1.7.1. Valid values are:

OFF
Default

ON

Note: This setting cannot be modified with the Configuration

tool.

OnlineTimeout String Time (in milliseconds) to wait for device to come online.
Note: This setting cannot be modified with the Configuration
tool.

OEMEmulation String Emulate OEM printer.

Valid values:
True
False (default)

DefaultLargeFont String This property selects the font with the largest size available on
the printer, typically: 12 dots x 24 dots on Receipt and 7 half
dots x 9 dots on SLIP. The selection is made when the device
is OPENed.
Valid values:
True
False (default)
Note:
1. If no property is found, the default value is used: False.
2. If the property is present but has an invalid value, then
the default value is used.

DefaultTallFontA String This property replaces the default font with the 10 dots x 24
dots font. The selection is made when the device is OPENed.

306 UnifiedPOS User's Guide

Keyword Type Description

Valid values:
True
False (default)
Note:
1. If no property is found, the default value is used: False.
2. If the property is present but has an invalid value, then
the default value is used.
3. This property is only valid for 4610 2xR/1NR (EIA-232,
RS-485, USB, Network) (SBCS) and 6145 2Tx/1TN (USB,
Network).

Default8LPI String This property selects the spacing needed to allow the user to
print 8 lines per inch on the paper.
Valid values:
True
False (default)
Note:
1. If no property is found, the default value is used.
2. If the property is present but has an invalid value, then
the default value is used.

DocAdvance String This property selects the number of motor steps to advance
the paper on a Document Insert, from the top Document
sensor to the first print position. Valid values: 1 to 255 in
decimal representation.
Note:
1. This setting cannot be modified with the Configuration
tool.
2. If no property is found, the default value is used: 50
(0x32).
3. If the property is present but the value is not a number,
the default value is used.
4. If the property is present but has a value not in the range
of values, it is matched to the closest parameter.
5. Applies only to EIA-232 4610 printer.

SetCompatibilityMode String This property allows the 2xR, 1NR, 2TC, 2TN printer to
remain in compatibility mode even when driver is updated.
Valid values are True, False (default)
Note:
1. If no property is found, the default value is used
2. If the property is present but has an invalid value, then
the default value is used.

Chapter 16. POS printer 307

Keyword Type Description
PaperSaveMode DWORD This property allows setting the paper save mode for 2xR,
1NR, 2TC, 2TN printer with EC level 0F and above. Please
do not change this value manually. Paper Save Mode
should only be configured from OPOS Configuration tool.
PaperSaveMode is only supported in thermal station and is
not supported in "Page mode."
PaperSaveMode consists of 3 different options:
• Dots Between Lines, found on page
• Blank Line Reduction, found on page
• Barcode Height Reduction, found on page
See “Paper saving mode” on page 290 for details on each of
these options.

DefaultCodePage DWORD The value stored in this property (if it exists) will be read
during 2xR, 1NR, 2TC, 2TN printer device open and is used to
initialize the CharacterSet property.
DefaultRecLineChars DWORD The value stored in this property (if it exists) will be read
during TxN, 2xR, 1NR, 2TC, 2TN printer device open and is
used to initialize the RecLineChars property.
Barcode128Mixed String When the value is True, it converts the
printBarcode symbology from PTR_BCS_Code_128 to
PTR_BCS_Code_128_Parsed when the barcode data contains
non numeric data and or odd length numberic data.
It will also automatically add start sentinel A before
the non numeric and single digit numeric data and
sentinel C before the even-length numeric data when
PTR_BCS_Code_128_Parsed symbology is selected and
sentinel character is not detected in barcode data.
Valid values:
True
False (default)

NoSetBitmap String This property allows the printing of bitmaps that are stored
in printer memory without issuing SetBitmap each time the
printer is opened.
Ensure that bitmaps are downloaded to the printer memory.
Otherwise, unexpected results can occur when printing
bitmaps.
Note:
6145 POS Printer and Bitmaps Downloaded with TCx POS
Printer Utility:
Please consider that for slip station, driver has an offset of 127
for bitmap location with respect to TCx POS Printer Utility.

308 UnifiedPOS User's Guide

Keyword Type Description

Example : In order to print bitmap using escape sequence for

slip station in position 10 (i.e. "ESC|10B"), bitmap should be
downloaded to position 137.
Valid values:
True (default)
False

RecLineCharsFont String This property allows the user to select a specific resident font
so that the driver can provide a specific RecLineCharsList
with values that are only valid for the specified font.

A
Select font A,
RecLineCharList="32,33,36,38,41,44,48,52,57"

B
Select font B,
RecLineCharList="28,30,32,34,36,38,41,44,48"

C
Select font C,
RecLineCharList="36,38,41,44,48,52,57,64,72"
Note:
1. If the registry is not set, the default RecLineCharList =
"32,34,36,38,41,44,48,52,57,64,72" is used.
2. To select Tall font A, set the registry to "A" and set
DefaultTallFontA to "TRUE".

MapUnicodeToCodePage REG_DW Set this when the input is in Unicode (UTF8). The input will
ORD be converted into the characters in the specified codepage
table when it's sent to the device.
Value: Codepage number for the Unicode (UTF8) to be
converted to

UDFAsThaiCodePage REG_DW When UDFAsThaiCodePage matches the codepage number

ORD selected, it will process the characters as if it's Thai codepage.
Value: UDF codepage number (101-104) to be treated as Thai
codepage.

EnableSlipDBCSCharCompression REG_SZ This property allows to print DBCS fonts in compressed mode
Valid values:
True
False (default)

Chapter 16. POS printer 309

OPOS DirectIO calls

Miscellaneous

Flip Check
This flips the document currently in the DI station. It is supported on all printers that contain a
check flipper.

Table 201. Flip check

Parameter Type Description
Command Int32 0
Data Long* Ignored
Obj BSTR* Ignored

Attention: This OPOS DirectIO call should not be used. Applications should use the
changePrintSide method of the printer object instead.

Print Downloaded Bitmap

This prints a bitmap previously stored in the printer. Not supported on EIA-232 printers.

Table 202. Print downloaded bitmap

Parameter Type Description
Command Int32 0
Data Long* Pointer to a byte containing the bitmap number
Obj BSTR* Ignored

Attention: This OPOS DirectIO call should not be used. Applications should use the SetBitmap
method and the ESC|#B escape sequence of the printer object instead.

Print Downloaded Message

This prints a message previously stored in the printer. It is not supported on EIA-232 printers.

Table 203. Print downloaded message

Parameter Type Description
Command Int32 0
Data Long* Pointer to a byte containing the message number

310 UnifiedPOS User's Guide

Parameter Type Description
Obj BSTR* Ignored

Read MICR Data

This reads the MICR data from the document currently in the DI station. It is only supported on
printers connected via USB and RS-485.

Table 204. Read MICR data

Parameter Type Description
Command Int32 4
Data Long* Ignored
Obj BSTR* Ignored

Attention: This OPOS DirectIO call should not be used. Applications should use the MICR
service object instead.

Reset Printer Object

This forces the service object to reset itself to a known state. It is only supported on printers
connected via USB and RS-485.

Table 205. Reset printer object

Parameter Type Description
Command Int32 501
Data Long* Ignored
Obj BSTR* Ignored

Check for Errors

This forces the service object to determine if the printer is in an error condition. It will cause the
ResultCode and ResultCodeExtended properties to be reset and is only supported on printers
connected via USB and RS-485.

Table 206. Check for errors

Parameter Type Description
Command Int32 502
Data Long* Ignored
Obj BSTR* Ignored

Chapter 16. POS printer 311

Set Double Strike Mode
This sets double-strike mode. It is only supported on Model 4 printers.

Table 207. Set double strike mode

Parameter Type Description
Command Int32 20
Data Long* Pointer to a byte which determines the double-strike
status
Valid values are:
0 (disable)
1 (enable)

Obj BSTR* Ignored

Flash memory
All OPOS access to the Flash memory in the SureMark printer is through DirectIO() methods.
The following DirectIO commands are added to the SureMark OPOS Service Object for the
RS-485, USB and EIA-232 interfaces.

Table 208. Flash memory

Parameter Type Description
Command Int32 FLASH_MEMORY
Data Long* Refer to the 'Remarks' section below
Obj BSTR* String

Remarks:
Write a record to flash memory. The format of the data to be written is r1.r2.r3.r4.n1.n2.data,
where r1,r2, r3 and r4 are 32-bit numbers, in little-endian format, indicating the record number
and n1 and n2 are 16-bit numbers, in little-endian format, indicating the number of data bytes to
be written.
When AsyncMode is set to true, the data is queued to the printer. Any error associated with this
write causes a DirectIoEvent. If the write is successful, an OutputCompleteEvent is fired.
If the record number is beyond the maximum records supported, pData is set to
DIRECTIO_FLASH_ERROR_REASON_OUT_OF_RANGE (0x2F).
If the record number is beyond the record length or is longer than the set record length or
the maximum supported, pData is set to DIRECTIO_FLASH_ERROR_REASON_TOO_LONG
(0x2D).
When AsyncMode is false, this command waits until the memory is written to the printer
(or an error condition occurs) before returning control to the application. If there is an error,
ResultCodeExtended is set with either of the two values, or with the POSSWIN internal error.

312 UnifiedPOS User's Guide

Read flash memory
Table 209. Read flash memory
Parameter Type Description
Command Long FLASH_MEMORY (0x11)
Data Long* Refer to the 'Remarks' section below
Obj BSTR* String

Remarks:
Read the flash memory record number. The format of the data to be written is
r1.r2.r3.r4.n1.n2.data, where r1, r2, r3 and r4 are 32-bit numbers, in little-endian format,
indicating the record number.
When AsyncMode is set to true, the data is returned to the application by a DirectIoEvent with
the EventNumber set to DIRECTIO_FLASH_DATA (0xFD). Any error associated with this read
causes a DirectIoEvent with the EventNumber set to DIRECTIO_FLASH_ERROR (0xFE).
If the record number is beyond the maximum records supporte, pData is set to
DIRECTIO_FLASH_ERROR_REASON_OUT_OF_RANGE (0x2F).
If there is not response to the request within 5 seconds, pData is set to
DIRECTIO_FLASH_ERROR_REASON_CMD_TIMEOUT (0x2E).
If the record number is beyond the record length or is longer than the set record length or
the maximum supported, pData is set to DIRECTIO_FLASH_ERROR_REASON_TOO_LONG
(0x2D).
When AsyncMode is false, this command waits until the memory is read from the printer (or
an error condition) before returning the data to the application. The record is returned in the
pString field of the DirectIO call. If there is an error, ResultCodeExtended is set with any one of
these three values, or with the POSSWIN internal error.

Query flash size

Table 210. Query flash size
Parameter Type Description
Command Long QUERY_FLASH_SIZE (0x12)
Data Long* Refer to the 'Remarks' section below
Obj BSTR* n/a

Returns the size of memory.

The value is returned in the pData field of the DirectIO call.

Chapter 16. POS printer 313

Query max records
Table 211. Query max records
Parameter Type Description
Command Long QUERY_MAXIMUM_RECORDS (0x13)
Data Long* Refer to the 'Remarks' section below
Obj BSTR* n/a

Returns the maximum number of records. This number is calculated by dividing the maximum
printer memory by the application requested memory size.
The value is returned in the pData field of the DirectIO call.

Set record length

Table 212. Set record length
Parameter Type Description
Command Long SET_RECORD_LENGTH (0x14)
Data Long* Refer to the 'Remarks' section below
Obj BSTR* n/a

Specifies the number of bytes for each record written to the flash memory. The flash memory
should be erased after changing the record size. The OPOS drivers do not automatically erase
the memory.

Erase flash memory

Table 213. Erase flash memory
Parameter Type Description
Command Long ERASE_FLASH_MEMORY (0x15)
Data Long* Refer to the 'Remarks' section below
Obj BSTR* n/a

Erases all data stored in the flash memory on the 4610 printer.

314 UnifiedPOS User's Guide

Get record length
Table 214. Get record length
Parameter Type Description
Command Long GET_RECORD_LENGTH (0x16)
Data Long* Refer to the 'Remarks' section below
Obj BSTR* n/a

Retrieves the number of bytes for each record written to the flash memory.
The value is zero if it has not yet been set after an erase.

Check scanning support

DirectIO commands are available to support check scanning on the SureMark™ TI8/9 POS
Printers. The supported commands for DirectIO check scanning are in the sections below.

Micro read with scan

Table 215. Micro read with scan
Parameter Type Description
Command Long CS_MICR_READ_WITH_SCAN (201)
Data Long* Refer to the 'Remarks' section below
Obj BSTR* n/a

Remarks:
This command is used to configure the printer to perform a MICR read in the same pass with a
check scan. Set Data to CS_ENABLE_READ(1) to enable read with scan, CS_DISABLE_READ(0)
to disable. To request the current value set Data to GET_VALUE(-1), which will return the
current value in Data. The default is 0 (disabled). A return code of OPOS_E_ILLEGAL is
returned if the value is not valid. A return code of OPOS_E_FAILURE is returned if the
SureMark Printer not equipped with a document scanner.

Compression format
Table 216. Compression format
Parameter Type Description
Command Long CS_COMPRESSION_FORMAT (202)
Data Long* Refer to the 'Remarks' section below
Obj BSTR* n/a

Chapter 16. POS printer 315

Remarks:
This command is used to set the compression format when an image is stored or retrieved.
Format of an image once stored does not change. To request the current value, set Data to
GET_VALUE(-1); the current value ill be returned in Data. The default is CS_CF_TIFF_COMP(0).
A return code of OPOS_E_ILLEGAL is returned if the value is not valid. A return code
of OPOS_E_FAILURE is returned if the SureMark Printer is not equipped with a document
scanner. The possible values for Data are:

CS_CF_TIFF_COMP(0)
TIFF-CCIT-Group 4 compression

CS_CF_JPEG(1)
JPEG compression

CS_CF_BMP(2)
BMP (uncompressed)

CS_CF_NONE (3)
No compression (grayscale)

CS_CF_TIFF(4)
TIFF file, no compression (grayscale)

Scan document
Table 217. Scan document
Parameter Type Description
Command Long CS_SCAN_DOCUMENT (203)
Data Long* Refer to the 'Remarks' section below
Obj BSTR* String

Remarks:
This command is used to start the scan of the document present in the document insert station.
A return code of OPOS_E_FAILURE is returned if the SureMark Printer is not equipped with
document scanner or if scan is not successful. String parameter contains the width and length of
the scanned document separated by a comma if the scan is successful.

Store document
Table 218. Store document
Parameter Type Description
Command Long CS_STORE_DOCUMENT (204)
Data Long* Refer to the 'Remarks' section below

316 UnifiedPOS User's Guide

Parameter Type Description
Obj BSTR* String

Remarks:
This command is used to store all or part of the last document scanned. The document image
will be stored in the format specified by compression format. The value in Data sets the area or
areas to store. Upon return, Data will contain the first index of the storage area in the printer
and String will contain the tag data string and the area dimensions to store. A return code of
OPOS_E_FAILURE is returned if the SureMark Printer is not equipped with document scanner
or if store is not successful. Possible Data values:

CS_STORE_ENTIRE(0
store entire image

CS_STORE_PERSONAL(1)
store personal check template

CS_STORE_BUSINESS(2)
store business check template

CS_STORE_UD(3)
store using user defined values
For String, see “Storage string remarks” on page 318 for additional information.

Retrieve by index
Table 219. Retrieve by index
Parameter Type Description
Command Long CS_RETRIEVE_BY_INDEX (205)
Data Long* Refer to the 'Remarks' section below
Obj BSTR* String

Remarks:
This command retrieves the image stored at the location specified in Data and stores the image
in String. If Data is zero, then the last scanned image is retrieved. The String data format is set
based on BinaryConversion. All data starts with a header. A return code of OPOS_E_FAILURE
is returned if the SureMark Printer is not equipped with a document scanner, or if the retrieve is
not successful.

Retrieve by tagname
Table 220. Retrieve by tagname
Parameter Type Description
Command Long CS_RETRIEVE_BY_TAGNAME (206)

Chapter 16. POS printer 317

Parameter Type Description
Data Long* Refer to the 'Remarks' section below
Obj BSTR* String

Remarks:
This command retrieves the image stored with the tagData value specified in String and stores
it in String. The String data format is set based on OPOS-specific property. A return code of
OPOS_E_ILLEGAL is returned if the string is empty. A return code of OPOS_E_FAILURE is
returned if the SureMark Printer is not equipped with document scanner or if the retrieve is not
successful. Image is marked as read after retrieval.

Erase storage
Table 221. Erase storage
Parameter Type Description
Command Long CS_ERASE_STORAGE (207)
Data Long* Refer to the 'Remarks' section below
Obj BSTR* n/a

Remarks:
This command erases all stored images from the printer storage. A return code of
OPOS_E_FAILURE is returned if the SureMark Printer is not equipped with document scanner
or if erase store is not successful.

Storage string remarks

The String parameter for the CS_STORE_DOCUMENT command contains the area or areas to be
stored from the last scanned image, in the format:

x0,y0,dx0,dy0,x1,y1,dx1,dy1,x2,y2,dx2,dy2,x3,y3,dx3,dy3,tagdata

where:

x0, y0
2 bytes each, top-left corner of area to be stored

dx0, dy0
2 bytes each, offset in the x and y direction respectively, to be stored

x1, x2, x3, y1, y2, y3,dx1,dx2,dx3,dy1,dy2,dy3

2 bytes each, corresponding offset in the x and y direction to define size of sub-block to
store

318 UnifiedPOS User's Guide

tagdata
ASCII string null-terminated character, maximum 100 characters
String is interpreted based on the OPOS-specific property. All offsets are based upon the
UnifiedPOS MapMode. If MapMode is set to PTR_MM_DOTS, 0.01 inches is used.
When storing an image, you can elect to store the entire image within the defined area, or just
selected blocks within the defined area. Saving selected blocks reduces storage use, but keeps
related data together. When storing multiple blocks of data, each block gets a unique storage
location. A byte in the header message indicates that the block is part of a group. The first
half-byte indicates which block of the group it is, the second half-byte indicates the number of
blocks in the group. If the byte returned is X'14', then the block is the first of a group of four.
All blocks contain header information, but only the first block in a group contains tag data. The
storage method defines how the image should be stored.
CS_STORE_ENTIRE(0): All data defined within x0, y0, dx0, dy0 is stored; x1, x2, x3, y1, y2, y3,
dx1, dx2, dx3, and dy1, dy2, dy3 should not be included.
CS_STORE_PERSONAL(1): A predefined template, based on a personal check is used to store
the image. The area defined is the entire personal check, however only the name/address and the
MICR blocks are saved; x0, x1, x2, x3, y0, y1, y2, y3, dx0, dx1, dx2, dx3, and dy0, dy1, dy2, dy3
should not be included.
CS_STORE_BUSINESS(2): A predefined template, based on a business check is used to store the
image. The area defined is the entire business check, however only the name/address, and MICR
blocks are saved; x0, x1, x2, x3, y0, y1, y2, y3, dx0, dx1, dx2, dx3, and dy0, dy1, dy2, dy3 should
not be included.
CS_STORE_UD(3): This method allows the user to define sub-blocks of data to store. All
command data (x0, x1, x2, x3, y0, y1, y2, y3, dx0, dx1, dx2, dx3, and dy0, dy1, dy2, dy3) must be
sent. If fewer than four blocks of data are to be saved, the value of -1 must be sent for unused
parameters.
The top-left corner of the scanned document is used as the point of reference (see Figure 38).
The xn command parameters are horizontal offsets from the left side of the scanned document.
The yn parameters are vertical offsets from the top of the scanned document. The dxn and dyn
parameters define the width and height, respectively, of the defined area or block.

Chapter 16. POS printer 319

(0,0)

(x0,y0) (dx0)
+
(dx1)
(x1,y1)
(dx2)
(x2,y2) Scanned Document

(dy1)

(dy2)

(dx3)
(x3,y3)

(dy3)

(dy0)

Figure 38. Scanned image organization

Retrieve storage header

Each image retrieved starts with header information in the following format:
• Status: 1 byte
• Bit 7, Image read; 1 = image has been read, 0 = image has not been read
• Bits 6 - 0; Reserved
• Compression: 1 byte
• Bits 7 - 3; Reserved
• Bits 2 - 0; Algorithm used to compress image. See Compression Format.
• Size1: 4 bytes
• Number of bytes in image, not including tag data.
• Size2: 4 bytes (x1, y1)
• Width of image (x1) (in hundredths of inch increments), 2 bytes
• Height of image (y1) (in hundredths of inch increments), 2 bytes
• Block position: 1 byte
• Lower four bits indicate the number of blocks that were saved for the image.
• Upper four bits represent the current block number.
• Future: 1 byte

320 UnifiedPOS User's Guide

• Reserved
• Tag data:
• ASCII data supplied by the application, terminated by a null string.

Page Mode printing

DirectIO commands are available to support Page Mode printing on the SureMark TI3, TI4,
TI8, and TI9 POS Printer. The following table shows the Page Mode supported commands for
DirectIO.
You must use the Page Mode commands PM_HORIZONTAL_POSITION and
PM_VERTICAL_POSITION to align Bar Codes. The printBarCode method alignment parameters
are ignored for bar codes printed in Page Mode.
DirectIO commands are also used to set/get properties and capabilities. All commands are
indirectly get commands, for example if the HORIZONTALPOSITION is set to a value that is
not supported, the data parameter is set to a value that is supported and the hardware is set to
that value.

Clear print area

Table 222. Clear print area
Parameter Type Description
Command Long PM_CLEAR_PRINT_AREA (101)
Data Long* Refer to the 'Remarks' section below
Obj BSTR* n/a

Remarks:
Clears the print area defined in the current PrintArea.

Page mode print

Table 223. Page mode print
Parameter Type Description
Command Long PM_PAGE_MODE_PRINT (102)
Data Long* Refer to the 'Remarks' section below
Obj BSTR* n/a

Remarks:
Data can be one of the following values:

Chapter 16. POS printer 321

PM_PM_PAGEMODE (1)
Enters Page Mode

PM_PM_PRINTSAVE (2)
Prints the current page and stays in page mode.

PM_PM_NORMAL (3)
Prints the current page and exits page mode.

PM_PM_CANCEL (4)
Clears the page area and exits page mode.
When the page is printed, the area printed is always from the top of the page area to the end of
the print area specified. The top cannot be cropped by using the print area.

Horizontal and vertical position

Table 224. Horizontal and vertical position
Parameter Type Description
Command Long PM_HORIZONTAL_POSITION (103)
PM_VERTICAL_POSITION (104)

Data Long* Refer to the 'Remarks' section below

Obj BSTR* n/a

Remarks:
Sets or returns the position for the horizontal/vertical print for the currently selected
PageModeStation. If the value sent in position 0 is GETVALUE(-1) the current position is
returned. Anything other than GETVALUE attempts to set the position; the value that is set
is returned in position 0. Horizontal and vertical position is set based on the print direction.
Horizontal position is parallel to the print direction. Vertical position is perpendicular to the
print direction.

Page area
Table 225. Page area
Parameter Type Description
Command Long PM_PAGE_AREA (105)
Data Long* Refer to the 'Remarks' section below
Obj BSTR* String

Remarks:

322 UnifiedPOS User's Guide

Returns the Page area of the printer in the object for the currently selected PageModeStation. The
format is “x,y”, where x is the width (horizontal) and y is the length (vertical).

Page mode station

Table 226. Page mode station
Parameter Type Description
Command Long PM_PAGE_MODE_STATION (106)
Data Long* Refer to the 'Remarks' section below
Obj BSTR* n/a

Remarks:
Sets or returns the current PageMode station using position 0 of the data int array. If the
value sent in position 0 is GETVALUE(-1) the current station is returned. Anything other than
GETVALUE attempts to set the station; the value that is set is returned in position 0.

Print area
Table 227. Print area
Parameter Type Description
Command Long PM_PRINT_AREA (107)
Data Long* Refer to the 'Remarks' section below
Obj BSTR* String

Remarks:
Sets or returns the desired Print Area. If an empty StringBuffer is sent then a "get only" is
emulated. Anything else attempts a set for the currently selected PageModeStation. The format
is:
x,y,dx,dy

where:
• x is the horizontal start position.
• y is the vertical start position.
• dx is the horizontal offset.
• dy is the vertical offset.

Chapter 16. POS printer 323

Print direction
Table 228. Print direction
Parameter Type Description
Command Long PM_PRINT_DIRECTION (108)
Data Long* Refer to the 'Remarks' section below
Obj BSTR* n/a

Remarks:

OPOS DirectIO events

NVRAM data
This is received by the application in response to a READ_FLASH_MEMORY DirectIO call.

Table 229. NVRAM data

Parameter Type Description
Event Number Int32 253
Data Long* 0
Obj BSTR* BSTR containing the NVRAM data

NVRAM error
This is received by the application in response to a WRITE_FLASH_MEMORY or
READ_FLASH_MEMORY DirectIO call.

Table 230. NVRAM error

Parameter Type Description
Event Number Int32 254
Data Long* One of the following values:
0x2A Data received is shorter than the record length.
0x2B NVRAM is full. 0x2C Unable to write record to NVRAM.
0x2D The record number is greater than the maximum number
of records supported, or the record size is greater than the
maximum record length.
0x2E The command took more than 5 seconds to complete.
0x2F The record number is greater than the maximum number
of records supported.

324 UnifiedPOS User's Guide

Parameter Type Description
Obj BSTR* Empty BSTR

OPOS extended result codes

Table 231. Extended result codes
ExtendedResultCode Name Description
501 IBM_EPTR_IMAGE_SCAN_FAILED Image failed to be scanned by the printer.
502 IBM_EPTR_IMAGE_RETRIEVE_FAILED An error occurred while reading check
image data from printer
503 IBM_EPTR_HOME_ERROR The DI station print head is not in the
home position.
If opening/closing the DI station cover
does not resolve the issue, call Toshiba and
place a hardware service call.

504 IBM_EPTR_PAPER_LOAD_ERROR A required document was not in the slip

station when data was to be printed.
505 IBM_EPTR_PAPER_ERROR A paper feed error occurred .
506 IBM_EPTR_UNRECOVERABLE_ERROR Possible at startup if a firmware update
corrupted the printer and the printer is
running out of the boot sector.
Should not happen on TI8/9 which does
not update the firmware until after all the
update data has been received.

507 IBM_EPTR_COMMAND_REJECT The printer has rejected a command sent to

it.
The only time this is likely to occur is if
the printer reset in the middle of sending
logo data to the printer. When the printer
is recovered and the first command is
a continue data command containing the
rest of the logo data, it will reject the data
because it has not been setup to accept the
starting logo data.

508 IBM_EPTR_COMMUNICATION_ERROR Low-level RS-485 communication protocol

error.
509 IBM_EPTR_NOT_RESPONDING An error occurred communicating with the
printer.
510 IBM_EPTR_RESCAN_REQUIRED An error occurred scanning the document,
and it must be scanned again.

Chapter 16. POS printer 325

ExtendedResultCode Name Description

Should only occur on TI9 printers, and

only if the firmware level is less than ec69.

511 IBM_EPTR_PRINTER_RESET The printer has reset itself. This is

normally caused by the OS re-enumerating
the USB bus and causing the printer to
power cycle.
512 IBM_EPTR_NO_IMAGE_AVAILABLE Check image failed to be read using
RetriveByIndex or RetrieveByTagName
DirectIO commands.
513 IBM_EPTR_CUTTER_JAM Printer cutter jam occurred.

Additional OPOS information

6145 printer firmware and configuration update

The Toshiba OPOS drivers can automatically download firmware and/or configure files to 6145
USB printers after system reboots. The firmware and/or configuration files must be present in
specific folders before system is rebooted.

Printer firmware file

The printer firmware file can be downloaded from https://commerce.toshiba.com.
The firmware file name for USB Printer is of the format aip45355_00-<optional
description>.dat.

Configuration files
The printer configuration files are created using Toshiba TCx Printer configuration utility.
It can be downloaded from https://commerce.toshiba.com. The configuration file name
for the USB printer is of the format aip45355_<component>-<description>.dat.
The TCx Printer configuration utility can generate different types of configuration files.
Each configuration file is separate and uniquely identified by its component during file
creation. Listed below are types of configuration files that can be generated by the utility.
1. Printer settings
2. Network Settings
3. DBCS Fonts
4. SBCS Fonts
5. Resident Message
6. Resident Graphics (bitmaps)
Note: Don’t change the file name generated by the TCx Printer configuration utility.

Firmware and configuration file location

The firmware and configuration files must be copied to the location described in Table
232. The OPOS drivers will automatically update the firmware and configuration files
upon system reboot.

326 UnifiedPOS User's Guide

Table 232. 6145 POS Printer
POS Printer Type File Name Location
Toshiba 6145 POS Printer aip45355_<component>- c:\pos\usb
<description>.dat1
1<component> and <description> assigned by TCx Printer Configuration Utility.

Automatic update (USB)

1. Copy the firmware/configuration files to the location specified in Table 232.
2. Reboot the system.
See the c:\pos\log\aipflash.log file for more details.

Manual update (USB)

Manual update is not supported in OPOS drivers.

Automatic and manual update (Network)

Use the TCx Printer configuration utility from https://commerce.toshiba.com to download
firmware and/or configuration files.

4610 printer firmware update

The Toshiba OPOS driver has the ability to automatically update the printer firmware if the
printer is attached to the terminal when the terminal boots. It does not have this ability if the
printer is attached to the terminal after the terminal has booted and the operating system has
loaded.
Printer firmware can be updated manually at any time.
Updated printer firmware update files are downloaded from the Toshiba website at https://
commerce.toshiba.com.
1. Go to https://commerce.toshiba.com.
a. Under Peripherals, click Toshiba SureMark Printer.
b. Under Downloads, select the appropriate link for your printer model.
c. From the Search Results displayed, select Toshiba 4610 SureMark Printer, Microcode
Files for Firmware Update.
d. Download the ZIP file for OPOS/JavaPOS. This file contains multiple firmware files;
choose the correct one from the following for your printer type.
2. Place the firmware file for your printer type into the \pos\firmware folder.
3. Make sure the printer is attached and restart.
Each 4610 printer model has a different firmware file associated with it.

Chapter 16. POS printer 327

Table 233. Toshiba 4610 printer firmware update
Printer Model Firmware update filename
TI1, TI2 aip46mc.hex
TI3, TI4, TG3, TG4, TF6, TM7 aip46mch.hex
TI5, TM7, TF7 aip46mcd.hex
TI8 aip46ti8.hex
TI9 aip46ti8.hex
1NR, 1CR, 2CR, 2NR aip46v4.hex

If the firmware file you select does not match the type of printer you have attached, the program
will not update the printer.

Manual update (EIA-232)

Printer firmware in an EIA-232 attached 4610 printer can be updated manually by using
\pos\bin\rs232firmwareupdater.exe. The status of the firmware update is logged to
\POS\LOG\rs232flash.log.
This is a GUI application that allows you to select a previously-configured printer to update, and
which firmware file to use.

Manual update (RS485/USB)

Printer firmware in RS485 and USB attached 4610 printers can be updated manually by using
\pos\bin\aipfld46.exe.
This is a Windows command-line program that must be run from a Windows shell prompt. Use
the following syntax to run the AIPFLD46 program:
aipfld46 -Sslot -Pport –Ffirmwarefilename [-O]

Table 234. Parameter setting for AIPFLD46

Parameter Description
-S slot The slot number of the 4610 for which the
firmware download is intended. RS485 is slot
number 1, USB is slot number 8.
-P port The port number of the 4610 for which the
firmware download is intended. The port
number for RS485 and USB is 17.
-F firmwarefilename The name of the file containing the firmware
data for the printer. A fully qualified path
name must be specified when this program is
run manually.
-O By default you can only upgrade firmware
in a printer; you can force the application

328 UnifiedPOS User's Guide

Parameter Description
to downgrade printer firmware by using this
option.

A log file named aipfld46.log is created in the \pos\log folder when the firmware
download program is executed.
There is no progress indicator on screen, but you can determine the update progress by looking
at the log file.

Automatic update (EIA-232)

Because EIA-232 printers can not be automatically detected by the driver, the firmware update
program will try to apply all of the printer firmware files to all of the currently configured
EIA-232 4610 printers.
The automatic firmware update process is started by a Windows service, "Toshiba OPOS RS232
Firmware Update".
If you do not want the firmware update process to run when the terminal boots, you may either
disable the service or delete the firmware update files from the \pos\firmware folder

Automatic update (RS485/USB)

The automatic firmware update process for RS485 and USB printers is exactly the same as the
manual process, except that the aipfld46 program is run automatically by the driver if it
detects that the firmware in the update file is newer than the firmware in the printer.
If you do not want the firmware update process to run when the terminal boots, you should
delete the firmware update files from the \pos\firmware folder.

Automatic update (Network)

The automatic firmware update process for Network printers is not supported.

4610/6145 printer font download

To download DBCS fonts to the RS485/USB Toshiba Point of Sale Printer Model TI5, TM7, TF7,
1xR, 2xR, 2Tx and 1TN you will need the following:
• The 4610 and 6145 Point of Sale Printer font download program, AIPFNT46.EXE, which is
installed in the \pos\bin directory.
• DBCS Font files located in \pos\fonts directory.

Chapter 16. POS printer 329

Table 235. 4610/6145 font file names and descriptions
4610 File Name 6145 File Name File Description
jpnms932.fon aip45355_06-cp932- Japan - codepage 932 (mincho
mincho.dat style)

jpngs932JIS.fon aip45355_06-cp932-JIS- Japan - codepage 932-JIS

gothic.dat (gothic style)

jpngs932NewJIS.fon aip45355_06-cp932-newJIS- Japan - codepage 932-JIS

gothic.dat (gothic style)

korms949.fon aip45355_06-949.dat Korea - codepage 949

(slip font size 9x16)

korms949_16x16.fon aip45355_06-949-16x16.dat Korea - codepage 949 (slip

font size 16x16)

korms949_Gothic.fon aip45355_06-949-gothic.dat Korea - codepage 949 (gothic

style) (slip font size 9x16))
korms949_16x16_gothic.fon aip45355_06-949-16x16- Korea - codepage 949 (gothic
gothic.dat style) (slip font size 16x16)
chnm950b.fon aip45355_06-cp950-bold.dat China - codepage 950 (bold)
chnm950n.fon aip45355_06-cp950-normal.dat China - codepage 950 (normal)
hkscs951b.fon aip45355_06-951hhkcs- Hong Kong Supplementary
bold.dat Characters - codepage 951
(bold)
hkscs951b.fon aip45355_06-951hkcs- Hong Kong Supplementary
normal.dat Characters - codepage 951
(normal)
chnm1381.fon aip45355_06-cp1381.dat Chinese Simplified (PRC) font
- Code Page 1381

Downloading DBCS fonts to the 6145 printer (USB)

The USB 6145 Printers support .dat font file format only. To download DBCS font file:
1. Select desired .dat file from Table 235, under the 6145 File Name column.
2. Copy the file to c:\pos\usb directory
3. Reboot system. The font file will be automatically updated.

330 UnifiedPOS User's Guide

Downloading DBCS fonts to the printer
Font files are downloaded manually using the AIPFNT46.EXE program:

AIPFNT46 -Sslot -Pport -Fx:\dir\font-file {-Q}

Argument Description
-Sslot The slot number (in decimal) of the printer for
which the download is intended.
-Pport The port number (in decimal) of the printer for
which the download is intended
-Fx:\dir\font-file Fully qualified path name for the font file to be
downloaded to the printer.
-Q : Quiet mode. No progress information is
displayed

To download SBCS fonts to the RS485/USB Toshiba SureMark Point of Sale Printer Model
TI3/4/6/8/9 1xR and 2xR you will need the following:
• The 4610 and 6145 SureMark Point of Sale Printer font download program, AIPFNT46.EXE,
which is installed in \pos\bin directory.
• For Windows the 4610 and 6145 SureMark Point of Sale Printer font conversion program,
AIPFNTCT.EXE, which is installed in \pos\bin directory.

Downloading DBCS fonts to the printer (EIA-232)

Font files are downloaded manually using the RS232FontUpdater program. The application
can be run either as CLI or GUI (administrator privileges are required when running the
application).
Run as CLI:

RS232FontUpdater {-p<port> -b<baud rate> -h<control flow>}{-n<printer name>} -f<font

file path>

Note: Specify either the combination of port, baud rate and control flow of the printer, or the
logical name configured to the printer.

Table 236. Details

Argument Description
-p <port> The port number (1-8) of the printer for which the download is
intended.
-b <baud rate> The baud rate of the printer for which the download is intended.
-h <control flow> The control flow (1-3) of the printer for which the download is
intended.
-n <printer name> The logical name configured in OPOS config for the printer which
the download is intended.

Chapter 16. POS printer 331

Argument Description
-f <font file path> Fully qualified path name for the font file to be downloaded to the
printer.

Run as GUI:
The printer font for an EIA-232 attached 4610 printer can be updated manually by using
\pos\bin\RS232FontUpdater.exe. This is a GUI application that allows you to select a
previously-configured printer to update, and which font file to use.

Converting printer font files

In Windows operating systems, manually convert the font files using the AIPFNTCT.EXE GUI
program.

Downloading SBCS fonts to the printer

Font files are downloaded manually using the AIPFNT46.EXE program:

AIPFNT46 -Sslot -Pport -Fx:\dir\font-file {-Q} -Cx

Argument Description
-Sslot The slot number (in decimal) of the printer for
which the download is intended.
-Pport The port number (in decimal) of the printer for
which the download is intended.
-Fx:\dir\font-file Fully qualified path name for the font file to be
downloaded to the printer.
-Q : Quiet mode. No progress information is
displayed.
-C x User-defined code page to be used for the
proportional/user-defined fonts; valid values
are:
1. One of the two proportional font
locations; default, code page 1; CR station
for user-defined.
2. CR station for user-defined.
3. One of the two proportional font
locations; code page 3; CR station for
user-defined.
4. CR station for user-defined.
5. DI station for user-defined.
6. DI station for user-defined.

332 UnifiedPOS User's Guide

Note:
1. Proportional fonts require two memory locations. For example, a proportional font in
location one also fills location two.
2. Proportional font only applies to sectors 1 and 3. Fixed font can apply to all 6 sectors.
3. All fonts are erased when code page 1 is specified. Specify code page 1 first and then
subsequent code pages.
4. The logfile (aipfnt46.log) contains the results of the last font download. This file is in
the /pos/log directory.
5. You can get some SBCS Toshiba-defined font files from the following web site: .

Downloading SBCS fonts to the printer (EIA-232)

Font files are downloaded manually using the RS232FontUpdater program. The application
can be run either as CLI or GUI (administrator privileges are required when running the
application).
Run as CLI:

RS232FontUpdater {-p<port> -b<baud rate> -h<control flow>}{-n<printer name>} -f<font

file path> -c<sector>

Note: Specify either the combination of port, baud rate and control flow of the printer, or the
logical name configured to the printer.

Table 237. Details

Argument Description
-p <port> The port number (1-8) of the printer for which the download is
intended.
-b <baud rate> The baud rate of the printer for which the download is intended.
-h <control flow> The control flow (1-3) of the printer for which the download is
intended.
-n <printer name> The logical name configured in OPOS config for the printer which
the download is intended.
-f <font file path> Fully qualified path name for the font file to be downloaded to the
printer.
-c <sector> User-defined code page to be used for the proportional/user-
defined fonts. Valid values:
1. One of the two proportional font locations; default, code
page 1; CR station for user-defined
2. CR station for user-defined
3. One of the two proportional font locations; code page
3; CR station for user-defined
4. CR station for user-defined
5. DI station for user-defined
6. DI station for user-defined

Chapter 16. POS printer 333

Note:
1. Proportional fonts require two memory locations. For example, a proportional font in
location one also fills location two.
2. Proportional font only applies to sectors 1 and 3. Fixed font can apply to all 6 sectors.
3. All fonts are erased when code page 1 is specified. Specify code page 1 first and then
subsequent code pages.
4. The logfile (aipfnt46.log) contains the results of the last font download. This file is in
the /pos/log directory.
5. You can get some SBCS Toshiba-defined font files from the following web site: .
Run as GUI:
The printer font for an EIA-232 attached 4610 printer can be updated manually by using
\pos\bin\RS232FontUpdater.exe. This is a GUI application that allows you to select a
previously-configured printer to update, the sector to download the font, and which font file to
use.

4689 printer font download

To download fonts to the Toshiba 4689 SurePOS Receipt Journal Printer, you will need the
following:
• The 4689 Printer font download program, AIPFNTRJ.EXE, which comes with the Toshiba
Point of Sale Subsystem for Windows.
• The 4689 Printer font conversion program, 4689CNVT.EXE, and Toshiba 4689 Printer font
files, which can be downloaded from the Toshiba Global Commerce Solutions support site: .
1. Select Support under Retail Store Solutions.
2. Select Other Systems and Adapters under SurePOS Peripherals.
3. Select 4689 under POS Printers.
4. Select Font Support Files to download the font files.
The download contains the following:

File Name File Description

4689JPNM.EXE Japan, Mincho style font (diskette image)
4689JPNG.EXE Korea, Mincho style font (diskette image)
4689JPNU.EXE Japan, user-defined fonts (diskette image)
CONVERT.EXE Contains:
• 4689CNVT.EXE : conversion program
• jpngs932.cfg: Japan, gothic style + user-defined fonts font
configuration file
• jpnms932.cfg: Japan, mincho style + user-defined fonts font
configuration file
• readme.txt: the directions given here

readme.txt The information presented in this section.

334 UnifiedPOS User's Guide

Converting Printer Font Files
Convert the downloaded files using the 4689CNVT.EXE program.
4689CNVT configuration-file

configuration-file
One of the configuration files contained in CONVERT.EXE
Note:
1. The font files must be in the same directory as the conversion program.
2. The output font file will have the same name as the supplied configuration file, but will
have a file extension of .FON.

Downloading Fonts to the Printer

Font files for the Toshiba 4689 SurePOS Receipt Journal Printer must be downloaded manually
using the AIPFNTRJ.EXE program:

AIPFNTRJ -Sslot -Pport -Fx:\dir\font-file {-Q}

-Sslot :
The slot number (in decimal) of the printer for which the download is intended.

-Pport :
The port number (in decimal) of the printer for which the download is intended.

-Fx:\dir\font-file :
Fully qualified path name for the font file to be downloaded to the printer.

-Q :
Quiet mode. No progress information is displayed.

Model 4 printer font download

When the Toshiba JavaPOS system recognizes a Model 4A printer that it has not used before, it
will automatically download one of the character sets described below to the printer:

M4A00850.FON
The single-byte characters are the same as those in the Model 4 printer. The characters in
this font file are used for the following code pages:
• 437
• 850
• 852
• 857
• 860
• 861
• 862
• 863

Chapter 16. POS printer 335

• 864
• 865

M4A00932.FON
The double-byte characters for Japan. This character set is a subset of the characters in
code page 932. For the supported characters, see the Toshiba JavaPOS system: Installation,
Keyboards, and Code Pages publication.

M4A00949.FON
The double-byte characters for Korea. This character set is a subset of the characters in
code page 949. For the supported characters, see the Toshiba JavaPOS system: Installation,
Keyboards, and Code Pages publication.

Manually Downloading Characters

If you want to use another character set at a later time, or if you want to define your own
characters and download them to the Model 4A printer, you can do so manually. The program
to download a new character set to the Model 4A printer is AIPM4ALD.EXE. This program is in
the \BIN directory where the Toshiba JavaPOS system is installed.
Use the following syntax to run the AIPM4ALD program:

AIPM4ALD -Sslot -Pport -Fx:\dir\font-file [ -Q ]

The parameters for the AIPM4ALD program are:

-S slot
The slot number (in decimal) of the Toshiba Model 4A printer to which the new character
set is to be downloaded.

-P port
The port number (in decimal) of the Toshiba Model 4A printer to which the new
character set is to be downloaded.

-F x:\dir\font-file
The name of the file containing the characters to be downloaded to the Toshiba Model
4A printer. A fully-qualified path name must be specified when this program is run
manually.

-Q
Quiet Mode. Do not display progress information

-V
Verify Characters. Verify each character by printing it on the CR station after all the
characters have been downloaded.

Font File Format

There are three types of records that are allowed in a Model 4A font file. These are:
• Comment Record

336 UnifiedPOS User's Guide

• Keyword Record
• Character Definition Record
A comment record can be either a blank line, or a line with an exclamation point (!) as the first
non-blank character.
A keyword record is a line with one of the keywords defined below followed by one or more blank
characters and ending with a value for the keyword.
A character definition record is a line of hexadecimal ASCII characters. Each pair of characters
defines one byte of the character definition. The first two pairs of characters identify the
character being defined and the remaining characters define the character.

Keywords
To define characters to the Toshiba JavaPOS system for use with the Model 4A printer, the
following keywords and their corresponding values must be defined in the font file along with
the definition of each character. If any of these keywords are omitted, unpredictable results can
occur when your application is using the printer.

CODEPAGE
The code page this font file defines.

HEIGHT
Defines the double-byte character height. The valid values are 9 or 16.

MODE
Defines this code page to be a single-byte, or a double-byte code page. A value of 0
(zero) indicates this is a single-byte code page and a value of 1 (one) indicates this is a
double-byte code page.

SPACE
The number of dot columns to be added to each double-byte character. The valid values
are 0 (zero) through 16.

WIDTH
Defines the double-byte character width. The valid values are 10 through 16.

Character Definition Record

Each character definition record defines one character for the Model 4A printer. Each character on
the line must be a hexadecimal ASCII character. Each pair of characters defines one byte of the
character definition. The first two pairs of characters identify the character being defined and the
remaining characters define the character.

Character Identifier
The first two pairs of characters that identify the character being defined must be between
0x0000 and 0x00FF, or between 0x8000 and 0xFFFF. The characters in the range 0x0000 through
0x00FF define the single-byte characters and there must be 44 hexadecimal ASCII characters (22
bytes). The characters in the range 0x8000 through 0xFFFF define the double-byte characters and
the number of hexadecimal ASCII characters depends upon the width of the character being

Chapter 16. POS printer 337

defined. The number of characters in the line can be calculated by multiplying the character
width, as defined by the WIDTH keyword, by 4 and adding 4. The additional four characters are
for the character identifier.
Note: If you define double-byte characters in your font file, you must define the character
0x8000 to be all zeros. This is because the Toshiba JavaPOS system uses that character for
padding double-byte character print lines when positioning the print head over characters
already printed.

Character Definition
Each dot column on the Model 4A printer has nine print wires for single-byte characters and
between nine to sixteen print wires for double-byte characters.
The definition of each character follows the character identifier on each line. Each pair of
hexadecimal ASCII values defines one byte of the character. For the Model 4A printer, each
pair of bytes (four characters) defines which print wires are turned on for each dot column
to be printed. Within each pair, the first two hexadecimal ASCII characters (first byte) defines
which of the lower eight print wires will be turned on and the second two hexadecimal ASCII
characters (second byte) defines which of the upper eight print wires will be turned on. Within
each byte, the least significant bit represents the top print wire.
For single-byte characters, the least significant bit of the first byte in the pair of dot column bytes
represents print wire number nine. For single-byte characters, this is the only bit used in the first
byte. For double-byte characters, the number of significant bits is determined by the LENGTH
keyword. If the LENGTH keyword is set to 9, the double-byte character definition is the same as
the single-byte character. If the LENGTH keyword is set to 16, then all eight bits of the first byte
is used to define the print wires 9 through 16.

Character Definition Restrictions

The following should be considered when defining characters for the Model 4A printer:
• When defining characters, the same print wire should not be turned on in consecutive dot
columns.
• For single-byte characters, the spacing between characters is included in the character
definition.
• For double-byte characters, the spacing between characters can be either included in the
character definition, or defined by the SPACE keyword.

Barcode printing
The width parameter of the printBarcode method is not a definite value. Since the ratio of the
width of thick and thin lines must be fixed, the width parameter is used to calculate a percentage
of the total line width of the station, such as RecLineWidth. The printer hardware accepts values
of 2 - 4. Therefore, if width is less than 34% of XxxLineWidth, then 2 is used, 34% to 66% sends a
3 and greater than 66% sends a 4.
The height parameter for the Receipt Station accepts 1 - 255 dot rows. On the slip station, it
height parameter is converted to head passes. The acceptable number of head passes is 3 to 5, or

338 UnifiedPOS User's Guide

27 to 45 dots in map mode, when SlpLineSpacing equals 9 dots. The height parameter for Slip
station accepts 3 <= n <= 5.

QR code printing

Creating registry entries

QR code printing requires these 3 REG_DWORD registry values to be present, under
HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\PosPrinter\ThePrinterName:

Table 238. Creating registry entries

Registry value name Description

QRCodeEncodingMode Mode Mode name Mode description

value
Accepted values: 0 to 5
0 Byte Encodes lower case letters, text double-byte
characters, binary data and 8 bit values.

1 Alpha-Numeric Alphanumeric mode encodes data from this set of 45

characters:

10 numeric digits:
Characters: 0 - 9
Byte values: 0x30 to 0x39

26 alphabetic characters:
Characters: A - Z
Byte values: 0x41 to 0x5A

9 symbols:
Characters: SPACE $ % * + - . / :
Byte values: 0x20, 0x24, 0x25,0x2A,
0x2B, 0x2D, 0x2E, 0x2F, 0x3A

2 Numeric This mode encodes data from the decimal digit set:
Characters: 0 - 9 Byte values: 0x30 to 0x39

3 Kanji This mode encodes Kanji characters, subject to these

constraints:
1. The number of data bytes to be encoded must
be an even number.
2. The characters must be from the range: 0x8140
to 0x9FFC, 0xE040 to 0xEBBF.
If the constraints are not met, the command will be
rejected.

4 Extended Channel Interpretation (ECI) This mode allows the encoding of character sets
different than the default.

5 Mixing In this mode, the printer tries to decide whether to

encode the data in Numeric, Alpha-Numeric, Byte or
Kanji mode.

The encoding mode, together with the error correction level determine the maximum number of characters that
can be encoded. Please refer to the description of QRCodeErrorCorrectionLevel for details.

QRCodeErrorCorrectionLevel This value specifies the error correction level for the QR Barcode, with 0 being the lowest quality and 3 being
the highest. Together with the encoding mode, the error correction level is also a factor in determining the
Accepted values: 0 to 3
maximum number of characters that can be encoded. In general, the lower the error correction level, the more
characters can be encoded:

Level Recovery % Maximum number of characters that can be encoded per mode

Chapter 16. POS printer 339

Registry value name Description

0 7 Numeric Alpha- Byte Kanji

Numeric

1 15 1000 1000 919 500

2 25 1000 1000 701 432

3 30 1000 721 499 308

945 566 393 242

QRCodeECIValue This value is used only in Extended Channel Interpretation (ECI) encoding mode (Mode value = 4).
Accepted values: 0 to 26, excluding 14, 19, 21
- 25 Value Encoding
0 CP437
1 ISO8859_1
2 CP437
3 ISO8859_1
4 ISO8859_2
5 ISO8859_3
6 ISO8859_4
7 ISO8859_5
8 ISO8859_6
9 ISO8859_7
10 ISO8859_8
11 ISO8859_9
12 ISO8859_10
13 ISO8859_11
14 Reserved
15 ISO8859_13
16 ISO8859_14
17 ISO8859_15
18 ISO8859_16
19 Reserved
20 SJIS
21 Reserved
22 Reserved
23 Reserved
24 Reserved
25 Reserved
26 UTF-8

Issuing the printBarCode command

After creating the registry entries, QR codes can be printed to the receipt station on supported
printers using the UnifiedPOS method for printing barcodes:
printBarCode (station: int32, data: string, symbology: int32, height: int32, width: int32,
alignment: int32, textPosition: int32)

Table 239. Accepted argument values

Parameter Accepted values
station Receipt. QR code printing is supported on the Receipt station only.
data The input string must already be in the character encoding that
matches the encoding mode.
symbology PTR_BCS_QRCODE (Value = 204).
height Height is used to scale the QR code.
Valid values: 0<= height <= 5
Other values: Auto-scaling where 0 is the minimum scale size,
which translates to 3 dots per pixel.

340 UnifiedPOS User's Guide

Parameter Accepted values

Supported from OPOS1.14.0 and printer FW 15.81 onward.

width Unused. Printer automatically derives QR code dimensions.

alignment As per UnifiedPOS specification.
textPosition Unused.

Rotated printing
On the slip, only the alignment settings are ignored. Bold and Double High attributes are
ignored by the hardware.

DBCS support
Downloading fonts to SureMark printers that support DBCS is described in Point of Sale
Subsystem: Programming Reference and User's Guide, Appendix F.

Color printing
In order to use color printing capability:
• The firmware level must be 33 or greater.
• Supported color thermal paper must be used.
• The CapRec2Color option must be set at configuration time.

Enable GrayScale Printing

See “Enable GrayScale printing” on page 284 for more detail.

User-defined fonts
The SureMark printers support up to four user-defined character sets. For EIA-232 printers, the
user-defined character sets are identified as character sets 102 through 105; for RS-485 and USB
printers, the user-defined character sets are identified as 101 through 104. These character set
identifiers appear in the CharacterSetList property.
Note: For EIA-232 printers, character set 101 is the printer's generic code page. For RS-485 and
USB, the printer's generic code page is not supported.
To define a single proportional font, two of the printer's user-defined character sets are required.
For EIA-232, a user-defined proportional font can be either character set 102 or 104; for RS-485
and USB, a user-defined proportional font can be either character set 101 or 103.
Only two user-defined fonts are supported on the impact station. When using a printer that has
an impact station:

Chapter 16. POS printer 341

1. The odd-numbered user-defined character sets on the receipt station map to user-defined
character set 1 on the slip station; even numbered character sets on the receipt station map
to slip user-defined character set 2.
2. If the application uses user-defined character sets with a printer that has both receipt and
slip stations, then both receipt and slip character sets should be downloaded to the printer.

Proportional font support

The printer drivers default to fixed width. In order to switch between fixed and proportional
fonts, the Font Typeface is used. To illustrate this difference, the FontTypefaceList displays
values ”Fixed, Proportional“ only when the CharacterSet has been set to a Proportional User
Defined Font (101 or 103 for RS-485/USB, or 102 and 104 for EIA-232). This is only valid for User
Defined Proportional Fonts. The resident fonts are fixed width.
The OPOS Specification assumes that all characters are fixed width. Proportional font printing is
supported, providing the following:
1. If a proportional font is active and the current font typeface is set to proportional, all
properties such as RecLineChars, RecLineHeight and RecLineSpacing are set to zero and
RecCharList is set to a null string. The downloaded font determines the properties of the
printed line.
Based on this assumption, we do not wrap lines in proportional mode when the number
of characters on a line is greater than RecLineChars. Instead, it is up to the application
developer to send a line feed when the print line is complete or the printer feeds when it has
reached the end of the line.
2. Text alignment is based on the fact that a fixed number of characters fit on a line. This is
not possible with proportional fonts. Therefore, when the printer is in proportional mode,
instead of formatting the line within the SO, we pass on the Alignment Escape Sequences
within the printer to let the printer format the alignment. This allows the printer to center
text or split left and right aligned text at the hardware.
Finally, if the font typeface is set to Fixed when a proportional font is used, the printer
prints the characters a fixed distance apart, and all of the Line properties are valid.
The actual fixed width is set in the registry entry for the printer, using the keyword
"ProportionalFontFixedWidth". The range of values the printer supports is 8 to 32. If
this value is not specified, the control uses a width of half of the height and then adjust it for
a best fit within the valid range.

Device sharing
Certain models of SureMark printers are equipped with tone devices and may be attached with
cash drawer. While the OPOS model states that tone indicators and cash drawers are shareable
devices, this device cannot be shared from separate applications. Trying to enable this device
from two applications will cause the enable to fail for the second application. If using the tone
indicator or cash drawer from two applications, it is recommended that each application claim
the device before using it.

Code 128 A/B/C support

The Code 128 Bar Code Symbology has three code sets and also includes some special characters
that indicate a change in code set, a function, or a shift from Code Set A to B, or vice versa. Table
240 lists the characters for each code set. Support is only available for the receipt station.

342 UnifiedPOS User's Guide

Table 240. Code 128 character sets
Code set Character set
Code A X'00'-X'5F', FNC1, FNC2, FNC3, FNC4, SHIFT, CODE B, CODE C
Code B X'20'-X'7f', FNC1, FNC2, FNC3, FNC4, SHIFT, CODEA, CODE C
Code C X'00'-X'63' for decimal values 00-99, FNC1, CODE A, CODE B

Characters are mapped from ASCII to the corresponding value for the selected code set. In Code
Sets A and B, this is a one-to-one mapping. In Code Set C, each two digits is converted to a single
value. A sentinel character, the left curly bracket ({ )followed by a particular character, is used to
indicate a special character. A starting code set is required at the start of the data. The symbology
value to use is 123.
Table 241 lists the character pairs for encoding the special characters:

Table 241. Code 128 special character encoding

Special Character pair for encoding
character
SHIFT {S
CODE A {A
CODE B {B
CODE C {C
FNC1 {1
FNC2 {2
FNC3 {3
FNC4 {4
{ {{

SureOne/SurePOS 100 DBCS printer limitations

For a DBCS printer, the printer code page is assumed to be the same as the locale of Windows.

Improving printer performance

When AsyncMode is false, Toshiba's OPOS Printer drivers verify that each print line is printed
on the paper in synchronous mode, not just that it has been sent to the printer. This approach
provides the application with an accurate completion status, but as a result, the drivers appear
to be slower than the rated printer throughput. To improve printer driver throughput, do the
following:
• Set AsyncMode to true so that groups of printer lines are sent out to the printer as they are
received by the driver.
• Use Transaction Mode.
• Group lines in single print command.

Chapter 16. POS printer 343

• Format a full line.

Character sets supported by POSPrinter devices for OPOS

Table 242. Single-byte character sets supported by POSPrinter devices for OPOS
Code
Page -
SBCS Device

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

437 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

775 ✓ ✓ ✓ ✓ ✓

808

819 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

848 ✓ ✓ ✓ ✓ ✓

850 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294

852 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294

855 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294

857 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294

858 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294

860 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294

861 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294

862 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294

863 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on

344 UnifiedPOS User's Guide

Code
Page -
SBCS Device

page
294

864 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294

865 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294

866 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294

867 ✓ ✓ ✓ ✓ ✓

869 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note
1 on
page
294

872 ✓ ✓ ✓ ✓ ✓

874 ✓ ✓
Note
1 on
page
294

897 ✓ ✓
Note
1 on
page
294

998 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

999 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

1116 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

1117 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

1118 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

1250 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

1251 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

1252 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

1253 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

1254 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

1255 ✓ ✓ ✓ ✓ ✓

1256 ✓ ✓ ✓ ✓ ✓

1257 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

1258 ✓ ✓ ✓ ✓ ✓

Note:
1. Standard model only

Chapter 16. POS printer 345

Table 243. Double-byte character sets supported by POSPrinter devices for OPOS
Code
Page -
DBCS Device

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

926

932 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note Note Note Note Note Note Note Note Note Note Note
5 on 5 on 5 on 1 on 6 on 1 on 5 on 5 on 5 on 5 on 5 on
page page page page page page page page page page page
346 346 346 346 346 346 346 346 346 346 346

936

949 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note Note Note Note Note Note Note Note Note
5 on 5 on 5 on 6 on 5 on 5 on 5 on 5 on 5 on
page page page page page page page page page
346 346 346 346 346 346 346 346 346

950 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note Note Note Note Note Note Note Note Note Note Note
5 on 5 on 5 on 2 on 6 on 2 on 5 on 5 on 5 on 5 on 5 on
page page page page page page page page page page page
346 346 346 346 346 346 346 346 346 346 346

951 ✓ ✓ ✓ ✓ ✓
Note Note Note Note Note
5 on 5 on 5 on 5 on 5 on
page page page page page
346 346 346 346 346

1361 ✓ ✓
Note Note
3 on 3 on
page page
346 346

1381 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note Note Note Note Note Note Note Note Note Note Note
5 on 5 on 5 on 4 on 6 on 4 on 5 on 5 on 5 on 5 on 5 on
page page page page page page page page page page page
346 346 346 346 346 346 346 346 346 346 346

Only on:
1. Japanese version.
2. Traditional Chinese version.
3. Korean version.
4. Simplified Chinese version.
5. Available after Font Download.
6. Defaults to a list of SBCS codepages. There is no way to query the hardware for a specific
model, so the default language settings of the operating system are used to determine the
DBCS codepage.

346 UnifiedPOS User's Guide

Chapter 17. Scanner (bar code reader)
Scanner (bar code reader)

Supported devices
Table 244. Scanner supported devices

Device Connectivity
1. Toshiba 1520 Compatible RS-485
Hand-held Scanner

2. Toshiba 4687 Compatible RS-485

Scanner USB (using Protocol Converter)

3. Toshiba 4696 Compatible RS-485

Scanner USB (using Protocol Converter)

4. Toshiba 4697 Compatible RS-485

Scanner USB (using Protocol Converter)

5. Toshiba 4698 Compatible RS-485

Scanner USB (using Protocol Converter)
6. Toshiba HHBCR Compatible RS-485
7. Toshiba HHBCR2 RS-485
Compatible
USB (must conform to Toshiba USB OEM Point-of-Sale Device Interface
8. OEM Scanner
Specification V1.0 or later)
9. Toshiba 4685 Scanner RS-485, USB
10. Kiosk scanner Integrated

Supported properties and methods

Table 245. Scanner common properties

Property JavaPOS OPOS

AutoDisable All
BinaryConversion Not supported All
CapCompareFirmwareVersion False
CapPowerReporting PR_STANDARD All support PR_STANDARD
CapStatisticsReporting True (see Appendix A, JavaPOS False
support for UnifiedPOS device
statistics properties on page 555)

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 347

Property JavaPOS OPOS
CapUpdateFirmware False
CapUpdateStatistics False (see Appendix A, JavaPOS False
support for UnifiedPOS device
statistics properties on page 555)
CheckHealthText All
Claimed All
DataCount All
DataEventEnabled All
DeviceControlDescription All
DeviceControlVersion All
DeviceEnabled All
DeviceServiceDescription All
DeviceServiceVersion All
FreezeEvents All
OpenResult Not supported All
OutputID Not supported
PowerNotify All
PowerState All
PhysicalDeviceDescription All
PhysicalDeviceName All
ResultCode Not supported All
ResultCodeExtended Not supported All
State All

Table 246. Scanner specific properties

Property JavaPOS OPOS

DecodeData All
ScanData All
ScanDataLabel All
ScanDataType All

Table 247. Scanner common methods

Method JavaPOS OPOS

checkHealth All

348 UnifiedPOS User's Guide

Method JavaPOS OPOS
claim All
clearInput All
clearOutput All
close All
compareFirmwareVersion Not supported
directIO Not supported
open All
release All
resetStatistics Not supported
retrieveStatistics True (see Appendix A, JavaPOS Not supported
support for UnifiedPOS device
statistics properties on page 555)
updateFirmware Not supported
updateStatistics Not supported

Table 248. Scanner events

Event JavaPOS OPOS

DataEvent All
DirectIOEvent Not supported
ErrorEvent All
StatusUpdateEvent All

JavaPOS configuration
This section contains device-specific notes for the EIA-232, RS-485 and USB scanners. Scanner
configuration is done through the jpos.xml file. An example of a typical configuration property
is:

<prop name="setEnableCODE39" type="Boolean" value="true"/>

Note:
1. Each scanner's hardware capabilities determine which symbologies it can decode. Enabling
a symbology property does not guarantee that the attached scanner can decode that
symbology. See the Web site of the scanner vendor for more information about the
supported symbologies and hardware capabilities.
2. When RS-485 scanners are attached to the system using a USB protocol converter, the
supported symbologies are unchanged.
3. To read supplemental data on a 4685 scanner, at least one of the labels must be disabled.
For example, setXXX label property to false in JposEntry for this scanner. The only way to
enable all supported labels is to set the scanner to "test mode". In test mode, the 4685 reads

Chapter 17. Scanner (bar code reader) 349

all the supported labels, except for supplementals. To read supplementals, at least one label
must be disabled.
4. If the device JposEntry in the jpos.xml does not contain a specific property, that property
will be initialized to the default value specified in this document. Otherwise the value
specified for that property in the JposEntry will be used.
Table 249 lists the supported symbologies for Toshiba scanners.

Table 249. Supported symbologies for Toshiba scanners

Symbology 1520 4500 4501 4685 4696 4697 4698 USB/RS485 AnyPlace AnyPlace
OEM Kiosk Line Kiosk
Omni
UPC-A ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
UPC-E ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
UPC D1 ✓ ✓ ✓ ✓
UPC D2 ✓ ✓ ✓ ✓
UPC D3 ✓ ✓ ✓ ✓ ✓ ✓
UPC D4 ✓ ✓ ✓ ✓
UPC D5 ✓ ✓ ✓ ✓
EAN/JAN 8 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
EAN/JAN 13 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
ITF ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
CODABAR ✓ ✓ ✓ ✓ ✓ ✓
CODE 39 ✓ ✓ ✓ ✓ ✓ ✓ ✓ Note 1 ✓ ✓
on page
351
CODE 93 ✓ ✓ ✓ ✓ ✓ ✓
CODE 128 ✓ ✓ ✓ ✓ ✓ ✓ ✓
Standard 2 of 5 ✓ ✓
UCC/EAN128 ✓ ✓ ✓
GS1 DataBar ✓ ✓ ✓
Omnidirectional
GS1 DataBar ✓ ✓ ✓
Expanded
PDF-417 ✓ ✓
Maxicode ✓
OCR-A OCR-B ✓
Datamatrix ✓
QR Code ✓
Aztec Code ✓
GS1 DataMatrix ✓

350 UnifiedPOS User's Guide

Symbology 1520 4500 4501 4685 4696 4697 4698 USB/RS485 AnyPlace AnyPlace
OEM Kiosk Line Kiosk
Omni
GS1 QR Code ✓
ISBT 128 ✓

Note:
1. Code 39 includes Code 39 with check character verified and transmitted (Code 39_CK) and
Code 39 with Mod 32 check character (Code 32).
Table 250 lists the configurable parameters for scanners and indicates which parameters are
supported by each scanner model.

Table 250. Scanner configurable parameters

Parameter 1520 4500 4501 4685 4696 4697 4698 USB AnyPlace AnyPlace
OEM Kiosk Line Kiosk Omni

“enableLaserOnOffSwitch” on page 352 ✓

“enableProgrammingViaBarcodes” on page 353 ✓ ✓ ✓ ✓ ✓

“enableSwitchControlledVolumeAdjust ” on page 353 ✓ ✓ ✓ ✓

“setBarCodes1” on page 353 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

“setBarCodes2” on page 354 ✓ ✓ ✓ ✓ ✓

“setBarCodes3” on page 354 ✓ ✓ ✓

“setBarCodes4” on page 355 ✓ ✓ ✓

“setBeeperDuration” on page 355 ✓ ✓ ✓ ✓ ✓

“setBeeperFrequency” on page 355 ✓ ✓ ✓ ✓ ✓

“setBeeperVolume” on page 356 ✓ ✓ ✓ ✓

“setCheckModulo” on page 356 ✓ ✓ ✓

“setCode128ScansPerRead” on page 356 ✓

“setCode39ScansPerRead” on page 357 ✓

“setDecodeAlgorithm” on page 357 ✓ ✓ ✓

“setDoubleReadTimeOut” on page 357 ✓ ✓ ✓ ✓

“setDTouchMode” on page 358 ✓ ✓ ✓

“setEAN13ScansPerRead” on page 358 ✓ ✓ ✓

“setEAN8ScansPerRead” on page 359 ✓ ✓ ✓

“setEnable_2_DigitSupplementals” on page 359 ✓ ✓ ✓ ✓

“setEnable_5_DigitSupplementals” on page 359 ✓ ✓ ✓ ✓

“setEnableCodabar” on page 360 ✓ ✓ ✓ ✓ ✓ ✓

“setEnableCode128” on page 360 ✓ ✓ ✓ ✓ ✓ ✓ ✓

“setEnableCode128Supplementals” on page 360 ✓

“setEnableCODE39” on page 360 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

“setEnableCode39CheckDigit” on page 360 ✓

“setEnableCode93” on page 361 ✓ ✓ ✓ ✓ ✓ ✓

“setEnableEAN_JAN_TwoLabelDecoding” on page 361 ✓ ✓ ✓

“setEnableGoodReadBeep” on page 362 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

“setEnableInterleaved2of5” on page 362 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

Chapter 17. Scanner (bar code reader) 351

Parameter 1520 4500 4501 4685 4696 4697 4698 USB AnyPlace AnyPlace
OEM Kiosk Line Kiosk Omni

“setEnableITFCheckDigit” on page 362 ✓

“setEnablePDF417” on page 362 ✓

“setEnableRSS14 (deprecated)” on page 363 ✓ ✓

“setEnableRSS_Expanded (deprecated)” on page 363 ✓ ✓

“setEnableStandard2of5” on page 364 ✓ ✓

“setEnableUCC_EAN128” on page 364 ✓ ✓ ✓

“setEnableUPC_A_CheckDigit” on page 364 ✓ ✓ ✓

“setEnableUPC_A_To_EAN13Expansion” on page 364 ✓ ✓ ✓ ✓ ✓

“setEnableUPC_E_CheckDigit” on page 364 ✓ ✓ ✓

“setEnableUPC_E_To_EAN13Expansion” on page 365 ✓ ✓ ✓ ✓

“setEnableUPC_E_To_UPC_AExpansion” on page 365 ✓ ✓ ✓

“setEnableUPCAE_EANJAN813” on page 365 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓

“setEnableUPCD1D5” on page 365 ✓ ✓ ✓ ✓ ✓

“setEnableVerificationUPC_A_EAN13_fiveDigit” on page 365 ✓ ✓ ✓ ✓

“setEnableVerificationUPC_A_EAN13_fourDigit” on page ✓ ✓ ✓
✓
366

“setITFLength1” on page 366 ✓ ✓ ✓ ✓ ✓ ✓

“setITFLength2” on page 366 ✓ ✓ ✓ ✓ ✓

“setITFLengths” on page 367 ✓ ✓ ✓

“setITFLengthSpecifiedTwo” on page 367 ✓ ✓ ✓

“setITFScansPerRead” on page 367 ✓

“setLaserTimeOut” on page 367 ✓ ✓ ✓ ✓

“setLED_GoodRead_Duration” on page 368 ✓

“setMotorTimeOut” on page 369 ✓ ✓ ✓ ✓

“setSecurityLevelForInStore” on page 369 ✓

“setSTFLength1” on page 370 ✓ ✓

“setSTFLength2” on page 370 ✓ ✓

“setSTFLengths” on page 370 ✓ ✓

“setStoreScansPerRead” on page 371 ✓ ✓ ✓

“setSupplementals” on page 371 ✓ ✓

“setSupplementalsSecurityLevel” on page 371 ✓ ✓

“setUPCAScansPerRead” on page 372 ✓ ✓ ✓

“setUPCDScansPerRead” on page 372 ✓ ✓ ✓

“setUPCEScansPerRead” on page 372 ✓ ✓ ✓

enableLaserOnOffSwitch
Property Type: boolean
Default: false
Models Supported: USB OEM

352 UnifiedPOS User's Guide

This property controls whether the laser power switch on the scanner unit is enabled or
disabled. When a scanner is on, its motor is running and its laser is active. When a scanner
is off, its motor is not running and its laser is inactive. When the laser power switch is enabled, it
can be used to turn the scanner off. When the laser power switch is disabled, it cannot be used to
turn the scanner off. The laser power switch can always be used to turn the scanner on.

enableProgrammingViaBarcodes

<prop name="enableProgrammingViaBarcodes" type="Boolean"

value="false" />

This property controls whether or not the scanner can be programmed using the manufacturer-
supplied programming bar codes.
Supported on: 4696, 4697, 4698, AnyPlace Kiosk Line scanner, AnyPlace Kiosk Omni scanner.

enableSwitchControlledVolumeAdjust
Property Type: boolean
Default: false
Models Supported: 4696,4697,4698 and USB OEM
This property enables and disables switch-controlled beep volume adjustment.

setBarCodes1
Property Type: byte
Default: 00
Models Supported: 1520, 4500, 4501, 4685, 4696, 4697, 4698, USB OEM
This property is one of several properties which determine what combination of bar code types a
scanner recognizes. When configured in a specific mode, a scanner recognizes and returns all bar
code types that are associated with that mode. Table 251 lists the values that can be given for the
setBarCodes1 property for both RS-485 and USB-attached scanners.

Table 251. setBarCodes1 values

Resource Value Bar Code Types
0 - GROUP_NONE None
1 - GROUP_UPC_EAN_ITF UPC-A, UPC-E, EAN/JAN-8, EAN/JAN-13,
Interleaved 2 of 5 (ITF)
2 - GROUP_UPCAED UPC-A, UPC-E, EAN/JAN-8, EAN/JAN-13
UPC-D1, UPC-D2, UPC-D3, UPC-D4, UPC-
D5

Chapter 17. Scanner (bar code reader) 353

Resource Value Bar Code Types
3 - GROUP_UPC_EAN_CODE128 UPC-A, UPC-E, EAN/JAN-8, EAN/JAN-13
UPC-A, UPC-E, EAN/JAN-8, EAN/JAN-13,
Code128
4 - GROUP_UPC_EAN_CODE93 UPC-A, UPC-E, EAN/JAN-8, EAN/JAN-13
UPC-A, UPC-E, EAN/JAN-8, EAN/JAN-13,
Code93
5 - GROUP_UPC_EAN_CODE39 UPC-A, UPC-E, EAN/JAN-8, EAN/JAN-13
UPC-A, UPC-E, EAN/JAN-8, EAN/JAN-13,
Code39
6 - GROUP_UPC_EAN_CODABAR UPC-A, UPC-E, EAN/JAN-8, EAN/JAN-13
UPC-A, UPC-E, EAN/JAN-8, EAN/JAN-13,
Codabar
7 - GROUP_UPC_EAN_2_5_CODABAR UPC-A, UPC-E, EAN/JAN-8, EAN/JAN-13
UPC-A, UPC-A+2/+5, UPC-E, UPC-
E+2/+5, EAN/JAN-8, EAN/JAN-8+2/+5,
EAN/JAN-13, EAN/JAN-13+2/+5,Codabar
(See Note.)

Note: Different scanners handle supplementals (+2, +5) differently. When supplementals are
enabled, some scanners will only read UPC-A, UPC-E, EAN/JAN-8 and EAN/JAN-13 barcodes
with a supplemental; other scanners will read UPC-A, UPC-E, EAN/JAN-8 and EAN/JAN-13
barcodes with and without a supplemetal.

setBarCodes2
Property Type: byte
Default: 0
Scanner models supported: 1520, 4685, 4697, 4698, USB OEM
This property is one of several properties which determine what combination of bar code types a
scanner recognizes. When configured in a specific mode, a scanner recognizes and returns all bar
code types that are associated with that mode.
The values for the setBarCodes2 property are the same as those for setBarCodes1 property.

setBarCodes3
Property Type: byte
Default: 0
Models Supported: 1520, 4698, USB OEM

354 UnifiedPOS User's Guide

This property is one of several properties which determine what combination of bar code types a
scanner recognizes. When configured in a specific mode, a scanner recognizes and returns all bar
code types that are associated with that mode.
The values for the setBarCodes3 property are the same as those for setBarCodes1 property.

setBarCodes4
Property Type: byte
Default: 0
Models Supported: 1520, 4698, USB OEM
This property is one of several properties which determine what combination of bar code types a
scanner recognizes. When configured in a specific mode, a scanner recognizes and returns all bar
code types that are associated with that mode.
The values for the setBarCodes4 property are the same as those for setBarCodes1 property.

setBeeperDuration
Property Type: byte
Default: 0
Models Supported: USB OEM , 4696, 4697, 4698, AnyPlace Kiosk Line Scanner
This property specifies the duration of the tone that the beeper makes upon a successful read.
This property can have the following values:

0
SHORT: Use the shortest time value for the beeper duration.

1
MEDLONG: Use a medium time value for the beeper duration.

2
LONG: Use a longtime value for the beeper duration.

3
LONGEST: Use the longest time value for the beeper duration.

setBeeperFrequency
Property Type: byte
Default: 0
Models Supported: 4696, 4697, USB OEM, AnyPlace Kiosk Line Scanner, AnyPlace Kiosk Omni
Scanner
This property specifies the frequency of the tone that the beeper makes upon a successful read.

Chapter 17. Scanner (bar code reader) 355

0
Lowest: The beep of the scanner has a very low frequency.

1
Low: The beep of the scanner has a low frequency.

2
High: The beep of the scanner has a high frequency.

3
Highest: The beep of the scanner has a very high frequency.

setBeeperVolume
Property Type: byte
Default: 0
Models Supported: 4696, 4697, 4698, USB OEM
This property specifies the volume of the tone that beeper makes. This property can have the
following values:

0
Lowest: The volume of the beep is set at its lowest level.

1
Low: The volume of the beep is set at a low level.

2
Medium: The volume of the beep is set at a medium level.

3
High: The volume of the beep is set at a high level.

setCheckModulo
Property Type: boolean
Default: false
Models Supported: 4500, 4501, 4685
This property controls whether or not the scanner checks the modulo byte of a bar code to
ensure that it is correct before returning the bar code to an application.

setCode128ScansPerRead
Property Type: byte
Default: 1
Models Supported:4698

356 UnifiedPOS User's Guide

This property controls the minimum number of scans performed for Code 128 labels. This is the
number of scans for a single pass of an item over the scanner window.
The value of this property has a range from 0 (zero) to 4. Any value outside of this range is not
valid. A value of 0 (zero) indicates that the default value should be used.

setCode39ScansPerRead
Property Type: byte
Default: 1
Models Supported:4698
This property controls the minimum number of scans performed for Code 39 labels. This is the
number of scans for a single pass of an item over the scanner window.
The value of this property has a range from 0 (zero) to 4. Any value outside of this range is not
valid. A value of 0 (zero) indicates that the default value should be used.

setDecodeAlgorithm
Property Type: byte
Default: 0
Models Supported: 4696, 4697, 4698
This property controls the use of decode algorithms. These decode algorithms use a complex set
of tests to assemble bar code data from damaged or truncated labels. These techniques also give
faster read performance on good bar codes. This property can have the following values:

0
Label assembly

1
marginless
Note: Label assembly can be selected only if Label assembly was enabled during factory
configuration, if Label assembly was not enabled during factory configuration, the selection
shall be considered valid but the parameter shall be forced to marginless.

setDoubleReadTimeOut
Property Type: byte
Default: 0
Models Supported: 4696, 4697, 4698, USB OEM
This property controls the length of the double-read timeout. Most scanners decode and
recognize a bar code label several times as the bar code is passed through the scanning region.
To prevent a scanner from returning data from the same bar code several times, scanners are
programmed with a double-read timeout. The double-read timeout is the length of time that the
scanner waits before returning the same bar code data twice.
This property can have the following values for 4696, 4697 and 4698:

Chapter 17. Scanner (bar code reader) 357

0
Use 500 ms for the double-read timeout

70
Use 700 ms for the double-read timeout

90
Use 900 ms for the double-read timeout
This property can have the following values for USB:

X'00'
Use the shortest time value for the double-read timeout

X'20'
Use a moderate time value for the double-read timeout

X'40'
Use the longest time value for the double-read timeout

setDTouchMode
Property Type: boolean
Default: false
Models Supported: 4500, 4501, 4685
This property controls the state of the double-touch mode of the scanner. Double-touch mode
allows scanners such as the hand-held bar code reader to read bar codes that are larger than the
reading head. In double-touch mode, when the read head of the scanner is placed over the first
half of the label, the scanner emits a repetitive beeping noise (if the beeper is enabled) to indicate
that the data was read. When the read head is placed over the second half of the label, the data is
sent to the system unit. Putting a scanner in double-touch mode does not prevent it from reading
a bar code in a single touch. Only bar codes such as UPC-A, EAN-13, and UPC-D3 can be read
using double-touch mode. For UPC-D3 bar codes, double-touch mode is automatically enabled
by the scanner and cannot be switched off.

setEAN13ScansPerRead
Property Type: byte
Default: 1
Models Supported: 4696, 4697, 4698
This property controls the minimum number of scans performed for EAN-13 labels. This is the
number of scans for a single pass of an item over the scanner window. The value of this resource
has a range from one to four. Any value outside this range is not valid. A value of one indicates
that the number of scans per read is not specified by the application. In this case, the default
value is used.
This property can have the following values:

1
One scan

358 UnifiedPOS User's Guide

2
Two scans

3
Three scans

4
Four scans

setEAN8ScansPerRead
Property Type: byte
Default: 2
Models Supported: 4696, 4697, 4698
This property controls the minimum number of scans performed for EAN-8 labels.
This resource can have the following values:

1
One scan

2
Two scans

3
Three scans

4
Four scans

setEnable_2_DigitSupplementals
Property Type: boolean
Default: false
Models Supported: 4685, 4698, USB OEM, AnyPlace Kiosk Line scanner
This property controls whether the scanner recognizes 2-digit supplementals for UPC,
UPE, EAN/JAN8, and EAN/JAN13. When enabled, supplementals are optional for all these
symbologies.

setEnable_5_DigitSupplementals
Property Type: boolean
Default: false
Models Supported: , 4685, 4698, USB OEM, AnyPlace Kiosk Line scanner

Chapter 17. Scanner (bar code reader) 359

This property controls whether the scanner recognizes 5-digit supplementals for UPC-A,
UPC-E, EAN/JAN8, and EAN/JAN13. When enabled, supplementals are optional for all these
symbologies.

setEnableCodabar
Property Type: boolean
Default: false
Models Supported: 4501, 4685, 4697, USB OEM, AnyPlace Kiosk Line scanner, AnyPlace Kiosk
Omni Scanner
Enable or disable the CodaBar barcodes.

setEnableCode128
Property Type: boolean
Default: false
Models Supported: 4501, 4685, 4697, 4698, USB OEM, AnyPlace Kiosk Line Scanner, AnyPlace
Kiosk Omni Scanner
Enable or disable the Code128 barcodes.

setEnableCode128Supplementals
Property Type: boolean
Default: false
Models Supported:USB OEM
Enable or disable supplementals for code128 barcodes.

setEnableCODE39
Property Type: boolean
Default: false
Models Supported: 1520, 4500, 4501, 4685, 4697, 4698, USB OEM, AnyPlace Kiosk Line Scanner,
AnyPlace Kiosk Omni Scanner
Enable or disable the Code39 barcodes.

setEnableCode39CheckDigit
Property Type: boolean
Default: false

360 UnifiedPOS User's Guide

Models Supported: USB OEM
Enable or disable if check digits should be transmitted for code39 barcodes.

setEnableCode93
Property Type: boolean
Default: false
Models Supported: 4501, 4685, 4697, USB OEM
Enable or disable the Code93 barcodes.

setEnableEAN_JAN_TwoLabelDecoding
Property Type: boolean
Default: false
Models Supported: 4697, 4698, USB OEM
Enable or disable the EAN/JAN Two-label decoding.

setEnableCompositeCC_A
Property Type: boolean
Default: false
Models Supported: AnyPlace Kiosk Omni Scanner.
Enable or disable decoding of CC_A (or CC_B or CC_C) composite barcodes. As composite
barcodes are 2D barcodes that appear on top of a 1D barcode (such as UPCA, EAN13, EAN128,
and so on), note that the corresponding 1D barcode must be enabled too. Enabling this or any
other 2D barcode disables the omnidirectional feature because 2D barcodes cannot be scanned in
omnidirectional mode.

setEnableCompositeCC_B
Property Type: boolean
Default: false
Models Supported: AnyPlace Kiosk Omni Scanner.
Enable or disable decoding of CC_A (or CC_B or CC_C) composite barcodes. As composite
barcodes are 2D barcodes that appear on top of a 1D barcode (such as UPCA, EAN13, EAN128,
and so on), note that the corresponding 1D barcode must be enabled too. Enabling this or any
other 2D barcode disables the omnidirectional feature because 2D barcodes cannot be scanned in
omnidirectional mode.

Chapter 17. Scanner (bar code reader) 361

setEnableCompositeCC_C
Property Type: boolean
Default: false
Models Supported: AnyPlace Kiosk Omni Scanner.
Enable or disable decoding of CC_A (or CC_B or CC_C) composite barcodes. As composite
barcodes are 2D barcodes that appear on top of a 1D barcode (such as UPCA, EAN13, EAN128,
and so on), note that the corresponding 1D barcode must be enabled too. Enabling this or any
other 2D barcode disables the omnidirectional feature because 2D barcodes cannot be scanned in
omnidirectional mode.

setEnableGoodReadBeep
Property Type: boolean
Default: false
Models Supported: All
Enable or disable GoodReadBeep.

setEnableInterleaved2of5
Property Type: boolean
Default: false
Models Supported: 1520, 4500, 4501, 4685, 4697, 4698, USB OEM, AnyPlace Kiosk Line Scanner,
AnyPlace Kiosk Omni Scanner
Enable or disable the Interleaved 2-of-5 (ITF) barcodes.

setEnableITFCheckDigit
Property Type: boolean
Default: false
Models Supported: USB OEM
Enable or disable if check digits should be transmitted for Interleaved 2-of-5 (ITF) barcodes.

setEnablePDF417
Property Type: boolean
Default: false
Models Supported: AnyPlace Kiosk Omni Scanner

362 UnifiedPOS User's Guide

Enable or disable decoding of PDF417 barcodes. Enabling this or any other 2D barcode disables
the omnidirectional feature because 2D barcodes cannot be scanned in omnidirectional mode.

setEnableMicroPDF417
Property Type: boolean
Default: false
Models Supported: AnyPlace Kiosk Omni Scanner
Enable or disable decoding of Micro PDF417 barcodes. Enabling this or any other 2D barcode
disables the omnidirectional feature because 2D barcodes cannot be scanned in omnidirectional
mode.

setEnableRSS14 (deprecated)
Property Type: boolean
Default: false
Models Supported: AnyPlace Kiosk Line Scanner, AnyPlace Kiosk Omni Scanner
Enables or disables the Reduced Space Symbology RSS14 barcodes.

setEnableGS1Databar
Property Type: boolean
Default: false
Models Supported: AnyPlace Kiosk Line Scanner, AnyPlace Kiosk Omni Scanner
Enables or disables the GS1 Databar barcodes.

setEnableRSS_Expanded (deprecated)
Property Type: boolean
Default: false
Models Supported: AnyPlace Kiosk Line Scanner, AnyPlace Kiosk Omni Scanner
Enables or disables the RSS Expanded barcodes.

setEnableGS1Databar_Expanded
Property Type: boolean
Default: false
Models Supported: AnyPlace Kiosk Line Scanner, AnyPlace Kiosk Omni Scanner

Chapter 17. Scanner (bar code reader) 363

Enables or disables the GS1 Databar Expanded barcodes.

setEnableStandard2of5
Property Type: boolean
Default: false
Models Supported: AnyPlace Kiosk Line scanner, AnyPlace Kiosk Omni scanner
Enable or disable the Standard 2-of-5 (STF) barcodes.

setEnableUCC_EAN128
Property Type: boolean
Default: false
Models Supported: USB OEM, AnyPlace Kiosk Line Scanner, AnyPlace Kiosk Omni Scanner
Enable or disable the UCC/EAN128 barcodes.

setEnableUPC_A_CheckDigit
Property Type: boolean
Default: false
Models Supported: USB OEM, AnyPlace Kiosk Line scanner, AnyPlace Kiosk Omni scanner
Enable or disable if check digits should be transmitted for UPC-A barcodes.

setEnableUPC_A_To_EAN13Expansion
Property Type: boolean
Default: false
Models Supported: 4696, 4697, 4698, USB OEM, AnyPlace Kiosk Line scanner
This property controls the report format for UPC-A labels. UPC-A and EAN-13 are part of the
same numbering system. It is possible to have the scanner report all of these codes in a uniform
format. UPC-A is a 12-digit subset of EAN-13. The scanner can add a leading 0 (zero) to the
UPC-A number, yielding its EAN equivalent.

setEnableUPC_E_CheckDigit
Property Type: boolean
Default: false
Models Supported: USB OEM, AnyPlace Kiosk Line scanner, AnyPlace Kiosk Omni scanner

364 UnifiedPOS User's Guide

Enable or disable if check digits are transmitted for UPC-E barcodes.

setEnableUPC_E_To_EAN13Expansion
Property Type: boolean
Default: false
Models Supported: 4696, 4697, 4698, USB OEM
This property controls the report format for UPC-E labels. UPC-E and EAN-13 are part of the
same numbering system. It is possible to have the scanner report all of these codes in a uniform
format. UPC-E is a short form of a UPC-A number, UPC-A is a 12-digit subset of EAN-13. The
scanner can add a leading 0 (zero) to the UPC-E number, yielding its EAN equivalent.

setEnableUPC_E_To_UPC_AExpansion
Property Type: boolean
Default: false
Models Supported: 4698, USB OEM, AnyPlace Kiosk Omni Scanner
This controls the report format for UPC-E labels. UPC-A, UPC-E, and EAN-13 are all part of the
same numbering system. It is possible to have the scanner report all of these codes in a uniform
format. The scanner can expand UPC-E data to its UPC-A format.

setEnableUPCAE_EANJAN813
Property Type: boolean
Default: false
Models Supported: All
Enable or disable the UPC-A, UPC-E, EAN/JAN 8 and EAN/JAN 13 barcodes.

setEnableUPCD1D5
Property Type: boolean
Default: false
Models Supported: 4501, 4696, 4697, 4698, USB OEM
Enable or disable the UPC D1 to UPC D5 barcodes.

setEnableVerificationUPC_A_EAN13_fiveDigit
Property Type: boolean
Default: false

Chapter 17. Scanner (bar code reader) 365

Models Supported: 4696, 4697, 4698, USB OEM
This controls whether the scanner verifies the 5 digit price check character. UPC and EAN
specifications allow for a price check character to be included in the digits encoded on in-store
random weight items. This property is mutually exclusive with UPC-A, EAN-13 four Digit
Verification.

setEnableVerificationUPC_A_EAN13_fourDigit
Property Type: boolean
Default: false
Models Supported: 4696, 4697, 4698, USB OEM
This property controls whether the scanner verifies the 4 digit price check character. UPC and
EAN specifications allow for a price check character to be included in the digits encoded on
in-store random weight items. This property is mutually exclusive with UPC-A, EAN-13 five
Digit Verification.

setITFLength1
Property Type: byte
Default: 0
Models Supported: 1520, 4697, 4698, USB OEM. AnyPlace Kiosk Line scanner, AnyPlace Kiosk
Omni scanner
For the scanners that support Interleaved 2-of-5 bar codes, this property can be used to specify
one valid length for Interleaved 2-of-5 bar codes. This value indicates the exact length of the
Interleaved 2-of-5 bar codes that the scanner reads. If an Interleaved 2-of-5 bar code is not of
the correct length, then the bar code is not read by the scanner. The value of the setITFLength1
property must be an even number from 4 to 32. (For the Toshiba 1520-A02, the value must be an
even number from 4 to 30.) This value specifies the exact length of the bar code.
If the scanner is not configured to read Interleaved 2-of-5 bar codes, the value of this property
is ignored. This property is provided because scanners are prone to errors when reading
Interleaved 2-of-5 labels. Because these labels are of variable length, it is possible for a scanner to
read only part of a label, but process it as though it had read the complete label. If an application
is only expecting Interleaved 2-of-5 labels of a certain length, this property ensures that the
scanner does not read any partial labels.

setITFLength2
Property Type: byte
Default: 0
Models Supported: 1520, 4697, 4698, USB OEM, AnyPlace Kiosk Line scanner, AnyPlace Kiosk
Omni scanner
For scanners that support Interleaved 2-of-5 bar codes, this property can be used to indicate a
second valid length for Interleaved 2-of-5 bar codes. When reading Interleaved 2-of-5 bar codes,
these scanners can read only bar codes of one or two specific lengths. The setITFLength1 and
setITFLength2 properties are used to specify the Interleaved 2-of-5 lengths to be recognized and

366 UnifiedPOS User's Guide

read by these scanners. The value of the setITFLength2 property must be an even number from
4 to 32. This value specifies the exact length of the bar code. A value of 0 (zero) indicates that
only Interleaved 2-of-5 bar codes of the length specified in the iTFLength1 resource are read by
the scanner. If the scanner is not configured to read Interleaved 2-of-5 bar codes, the value of this
property is ignored.

setITFLengths
Property Type: boolean
Default: false
Models Supported: USB OEM, AnyPlace Kiosk Line scanner, AnyPlace Kiosk Omni scanner
Valid values:

true
ITF lengths represent a range.

false
ITF lengths are discrete.
Note: For the AnyPlace Kiosk Line scanner, true indicates that ITF lengths specifies a minimum
value only (ITFLength1).

setITFLengthSpecifiedTwo
Property Type: boolean
Default: false
Models Supported: 4697, 4698, USB OEM
This property specifies if two ITF lengths are specified.

setITFScansPerRead
Property Type: byte
Default: 1
Models Supported:4698
This property controls the minimum number of scans performed for Interleaved 2-of-5 labels.
This is the number of scans for a single pass of an item over the scanner window.
The value of this property has a range from 0 (zero) to 4. Any value outside of this range is not
valid. A value of 0 (zero) indicates that the default value should be used.

setLaserTimeOut
Property Type: byte
Default: 0

Chapter 17. Scanner (bar code reader) 367

Models Supported: 4696, 4697, 4698, USB OEM
This property specifies the length of the period of inactivity that causes a laser scanner to turn off
its laser. This property can have the following values for 4696, 4697 and 4698:

0
The laser turns off after 15 minutes of inactivity

5
The laser turns off after 5 minutes of inactivity

10
The laser turns off after 10 minutes of inactivity

15
The laser turns off after 15 minutes of inactivity
This property can have the following values for USB OEM:

X'00'
The laser always stays on

X'08'
The laser turns off after 5 minutes of inactivity

X'10'
The laser turns off after 10 minutes of inactivity

X'18'
The laser turns off after 15 minutes of inactivity
Note: For motor-driven laser scanners, the motor is always on if the laser is on.

setLED_GoodRead_Duration
Property Type: byte
Default: 0
Models Supported: USB OEM
This property specifies the LED good read duration This property can have the following values:

X'00'
Use a short time value for LED good read duration

X'01'
Use a medium time value for LED good read duration

X'02'
Use a long time value for LED good read duration

X'03'
Use the longest time value for LED good read duration

368 UnifiedPOS User's Guide

setMotorTimeOut
Property Type: byte
Default: 0
Models Supported: 4696, 4697, 4698, USB OEM
This property specifies the length of the period of inactivity that causes a motorized laser
scanner to turn off its motor. This property can have the following values for 4696, 4697 and
4698:

0
The motor turns off after 60 minutes of inactivity

5
The motor turns off after 5 minutes of inactivity

10
The motor turns off after 10 minutes of inactivity

15
The motor turns off after 15 minutes of inactivity

30
The motor turns off after 30 minutes of inactivity

60
The motor turns off after 60 minutes of inactivity
This property can have the following values for USB OEM:

X'00'
The motor is always on

X'01'
The motor turns off after 5 minutes of inactivity

X'02'
The motor turns off after 10 minutes of inactivity

X'03'
The motor turns off after 15 minutes of inactivity

X'04'
The motor turns off after 30 minutes of inactivity

X'05'
The motor turns off after 60 minutes of inactivity

setSecurityLevelForInStore
Property Type: byte
Default: 0

Chapter 17. Scanner (bar code reader) 369

Models Supported: USB OEM
This property specify the security/integrity level for In-Store labels. This property can have the
following values:

X'00'
Use a low security/integrity level.

X'01'
Use a medium security/integrity level.

X'02'
Use a high security/integrity level.

X'03'
Use the highest security/integrity level.

setSTFLength1
Property Type: byte
Default: 0
Models Supported: AnyPlace Kiosk Line scanner, AnyPlace Kiosk Omni scanner
This property allows you to set the first Standard 2 of 5 length to be accepted if STFLengths =
false (discrete) or the minimum length to be accepted if STFLengths = true (range)

setSTFLength2
Property Type: byte
Default: 0
Models Supported: Line scanner, Omni scanner
This property allows you to set the second Standard 2 of 5 length to be accepted if STFLengths =
false (discrete) If STFLengths = true (range) STFLength2 is the maximum value to be accepted for
the Omni scanner. For the Line scanner, this value is meaningless.

setSTFLengths
Property Type: boolean
Default: false
Models Supported: AnyPlace Kiosk Line scanner, AnyPlace Kiosk Omni scanner
Valid values:
• true (range)
• For Line scanners, STF Length1 represent a minimum length to be accepted. STF Length2
is ignored.
• For Omni scanners, STF Length1/2 represent a minimum/maximum length to be accepted.
• false (discrete) STF Length1 and Length2 are the only lengths to be accepted

370 UnifiedPOS User's Guide

Note: To accept any length STF, this property must be set to true and STFLength1 to 0.

setStoreScansPerRead
Property Type: byte
Default: 1
Models Supported: 4696, 4697, 4698
This property controls the minimum number of scans performed for in-store labels. This is the
number of scans for a single pass of an item over the scanner window.
The value of this property has a range from 0 (zero) to 4. Any value outside of this range is
not valid. A value of 0 (zero) indicates that the number of scans per read is not specified by the
application.

setSupplementals
Property Type: boolean
Default: false
Models Supported: 4698, AnyPlace Kiosk Omni scanner
This property controls whether the scanner recognizes 2-digit supplementals and 5 digit
supplementals for UPCA, UPCE, EAN/JAN8, AND EAN/JAN13. When enabled, supplementals
are optional for all these symbologies.

setSupplementalsSecurityLevel
Property Type: byte
Default: 10
Models Supported: AnyPlace Kiosk Line scanner, AnyPlace Kiosk Omni scanner
This property specify the security level for UPC-A, UPC-E, EAN/JAN-8, and EAN/JAN-13
supplementals. Making this value higher reduces the chance of "short readings" but increases
the difficulty of reading low-quality barcodes. This property can have values in the range 0 - 100.

setTransmitScannerPrefixAndSuffix
Property Type: boolean
Default: false
Models Supported: AnyPlace Kiosk Line scanner, AnyPlace Kiosk Omni scanner.
Scanner data must be transmitted without any prefixes or suffixes. If they are required, set this
property to true. Note that there is no property that allows to set them to a particular char
sequence (such as suffix = CR), so they must be set using barcode programming

Chapter 17. Scanner (bar code reader) 371

setUPCAScansPerRead
Property Type: byte
Default: 1
Models Supported: 4696, 4697, 4698
This property controls the minimum number of scans performed for UPC-A labels. This is the
number of scans for a single pass of an item over the scanner window. The value of this property
has a range from 0 (zero) to 4. Any value outside of this range is not valid. A value of 0 (zero)
indicates that the number of scans per read is not specified by the application.

setUPCDScansPerRead
Property Type: byte
Default: 1
Models Supported: 4696, 4697, 4698
This property controls the minimum number of scans performed for UPC-D labels. This is the
number of scans for a single pass of an item over the scanner window.
The value of this property has a range from 0 (zero) to 4. Any value outside of this range is
not valid. A value of 0 (zero) indicates that the number of scans per read is not specified by the
application.

setUPCEScansPerRead
Property Type: byte
Default: 2
Models Supported: 4696, 4697, 4698
This property controls the minimum number of scans performed for UPC-E labels. This is the
number of scans for a single pass of an item over the scanner window.
The value of this property has a range from 0 (zero) to 4. Any value outside of this range is
not valid. A value of 0 (zero) indicates that the number of scans per read is not specified by the
application. This property can have the following values:

1
One scan

2
Two scans

3
Three scans

4
Four scans

372 UnifiedPOS User's Guide

Additional JavaPOS information

Toshiba 4697 Point of Sale Scanner Configuration

The Toshiba 4697 Point of Sale Scanner Model 1 follows the following rules in the symbology
configuration:
1. No more than 2 of the supported symbology options may be included in the JPOS.XML
entry for the scanner.
2. Only one of these two symbology options is allowed to be an industrial symbology.
Choosing more than one industrial symbology option is considered invalid.
3. One of the non-industrial symbology must be included.
Non-industrial symbologies are considered to be:
• UPC-A/E, EAN/JAN-8/13
• UPC-A/E, EAN/JAN-8/13, UPC-D1..D5
Industrial symbologies are considered to be:
• ITF (Interleaved 2 of 5)
• CODABAR
• CODE 39
• CODE 93
• CODE 128
Example 1 - To enable one symbology with UPC-A/E, EAN/JAN-8/13, UPC-D1..D5 add
following properties to the JposEntry:
<prop name="setEnableUPCAE_EANJAN813" type="Boolean" value="true"/>
<prop name="setEnableUPCD1D5" type="Boolean" value="true"/>

Example 2 - To enable two symbologies with UPC-A/E, EAN/JAN-8-13 and ITF add following
properties to the JposEntry:
<prop name="setEnableUPCAE_EANJAN813" type="Boolean" value="true"/>
<prop name="setEnableInterleaved20f5" type="Boolean" value="true"/>
<prop name="setITFLength1" type="Byte" value="12"/>

USB OEM Scanner and scale configuration

The JavaPOS drivers support OEM USB scanner and scale devices that comply with Toshiba
USB OEM Point-of-Sale Device interface specifications. By default, JavaPOS drivers support a
subset of widely available USB OEM scanners, as described in Table 252. The OEM USB Scanner
and Scale devices will be referenced as USB OEM Device in the following sections.

Table 252. OEM Scanners

OEM Scanners
"JavaxUsb PSC Magellan 8500 =JAVAXUSB_COMPOSITE, USB\VID_05f9&PID_0101
Scanner"
"JavaxUsb PSC Magellan Scanner" =JAVAXUSB_COMPOSITE, USB\VID_05f9&PID_0110
"JavaxUsb Symbol Scanner" =JAVAXUSB_COMPOSITE, USB\VID_05e0&PID_0101

Chapter 17. Scanner (bar code reader) 373

OEM Scanners
"JavaxUsb Symbol LS2104" =JAVAXUSB_COMPOSITE, USB\VID_05E0&PID_0200
"JavaxUsb Symbol M2004-I000" =JAVAXUSB_COMPOSITE, USB\VID_05E0&PID_0300
"JavaxUsb Symbol LS4008I" =JAVAXUSB_COMPOSITE, USB\VID_05E0&PID_038A
"JavaxUsb Symbol LS2280" =JAVAXUSB_COMPOSITE, USB\VID_05E0&PID_1300
"JavaxUsb XAC Protocol Converter" =JAVAXUSB_COMPOSITE, USB\VID_0886&PID_9900
"JavaxUsb IBM Scanner" =JAVAXUSB_COMPOSITE, USB\VID_0886&PID_9901
"JavaxUsb IBM Scanner" =JAVAXUSB_COMPOSITE, USB\VID_0886&PID_9902
"JavaxUsb Magellan 9500 Scanner" =JAVAXUSB_COMPOSITE, USB\VID_05f9&PID_0180
"JavaxUsb Magellan 8502 Scanner" =JAVAXUSB_COMPOSITE, USB\VID_05f9&PID_1101
"JavaxUsb MetroLogic Scanner" =JAVAXUSB_COMPOSITE, USB\VID_0C2E&PID_0009
"JavaxUsb PSC 1000i Scanner" =JAVAXUSB_COMPOSITE, USB\VID_05f9&PID_1601
"JavaxUsb HPP IT5600 Scanner" =JAVAXUSB_COMPOSITE, USB\VID_0536&PID_0163

Use pre-defined configuration files

JavaPOS drivers version 1.14.1 automatically install a set of pre-defined configuration files to
load javaxusb.sys drivers based on USB Vendor ID and Product ID. They are located under a
separate directory for each vendor, as shown in Table 253 below .
Instructions:
1. Check the VID and PID of the USB OEM Device you would like to install. If the
VID and PID pair is found in the following table, then continue to step 2 below. http://
www.toshibacommerce.com/support to obtain a signed javaxusb cat file to support scanner/
scale with new USB VID and PID currently not supported. Otherwise, contact Toshiba at
http://www.toshibacommerce.com/support to obtain a signed javaxusb cat file to support
scanner/scale with new USB VID and PID currently not supported.
2. To install javaxusb.sys driver (Windows only)
• CD into specific vendor directory under c:\pos\drivers\oem.
• Copy C:\POS\drivers\javaxusb\javaxusb.sys driver to that directory.
• Install javaxusb.sys driver. Refer to the “Install javaxusb driver (Windows only)” on
page 375 section below. No updates to posj.properties are needed since it already
includes these VID and PID.

Table 253. USB OEM Devices

Vendor Vendor ID & PID File Location
Datalogic C:\POS\drivers\oem\dat
VID_080C&PID_0500
VID_080C&PID_0600 alogic

Metrologic C:\POS\drivers\oem\met
VID_0C2E&PID_0903
VID_0C2E&PID_0904 rologic
VID_0C2E&PID_0923
VID_0C2E&PID_0924

374 UnifiedPOS User's Guide

Vendor Vendor ID & PID File Location
Mettler-Toledo C:\POS\drivers\oem\mt
VID_0EB8&PID_2200

PSC C:\POS\drivers\oem\psc
VID_05F9&PID_0104
VID_05F9&PID_0120
VID_05F9&PID_0303
VID_05F9&PID_0313
VID_05F9&PID_1102
VID_05F9&PID_1104
VID_05F9&PID_1110
VID_05F9&PID_1111
VID_05F9&PID_1180
VID_05F9&PID_1181
VID_05F9&PID_1120
VID_05F9&PID_1121
VID_05F9&PID_1201
VID_05F9&PID_1202
VID_05F9&PID_1203
VID_05F9&PID_1204
VID_05F9&PID_1205
VID_05F9&PID_1206
VID_05F9&PID_1207
VID_05F9&PID_1208
VID_05F9&PID_1209
VID_05F9&PID_120A
VID_05F9&PID_120B
VID_05F9&PID_120C
VID_05F9&PID_120E
VID_05F9&PID_120F
VID_05F9&PID_1216
VID_05F9&PID_1218
VID_05F9&PID_1501
VID_05F9&PID_1502
VID_05F9&PID_1503
VID_05F9&PID_1504
VID_05F9&PID_1506
VID_05F9&PID_1507
VID_05F9&PID_1508
VID_05F9&PID_1509
VID_05F9&PID_1511
VID_05F9&PID_150A
VID_05F9&PID_150B
VID_05F9&PID_1602
VID_05F9&PID_1603
VID_05F9&PID_4901
VID_05F9&PID_4902

Symbol C:\POS\drivers\oem\sym
VID_05E0&PID_0820
VID_05E0&PID_1200 bol
VID_05E0&PID_1400

Install javaxusb driver (Windows only)

To install javaxusb.sys driver for a given inf file, use c:\pos\bin\aipdifx.exe utility.
Syntax of the utility:
Usage: aipdifx [ -i <inf-file> | -u <inf-file> ] [ -q ] [ -v ]
where:
-i <inf-file> specify full path to Inf file to install
-u <inf-file> specify full path to Inf file to uninstall
-q No installation messages

Chapter 17. Scanner (bar code reader) 375

-v Verbose messages
-f force (hidden)
Note: Requires either "-i" or "-u" option
Examples:
To install a predefined configuration file for psc scanner, enter the following command from
Windows console:
C:\pos\bin\aipdifx.exe –i C:\POS\drivers\oem\psc\javaxusb_oem_psc.inf -
v
To uninstall a predefined configuration file for psc scanner, enter the following command from
Windows console:
C:\pos\bin\aipdifx.exe –u C:\POS\drivers\oem\psc\javaxusb_oem_psc.inf -
v

Known scanner issues

This section contains information on known issues with specific models.

PSC 384 Magellan - USB

SetEnableCodabar and SetEnableCode93 configuration parameters must not be enabled.
The scanner does not work correctly if these are enabled.

Toshiba 4698
• RS-485 through USB protocol converter
• SetEnableCodabar, SetEnableCode93, and SetEnableUCC_EAN128 configuration
parameters must not be enabled. The scanner does not work correctly if these are
enabled.
• Configuration must be correct for the scanner type attached, even though it looks like
a USB scanner.

OPOS configuration
Refer to Table 249 for a list of the supported symbologies for Toshiba scanners.

Scanner programming
RS-485 and USB scanner configuration can be modified programmatically using the resource
file, AIPSYS.RES, as mentioned earlier in “Modifying USB, RS-485, and PS/2 device behavior”
on page 75. This allows the scanner configuration to be changed without having to physically
reprogram every scanner by hand using the manufacturer’s programming barcodes.
The resource file will probably not support every possible configuration option that a particular
scanner supports. The resource file support is based on older scanner hardware specifications
and most scanner manufacturers have added features beyond those specifications. You may still
have to use the manufacturer’s programming barcodes to enable/disable some options for your
scanners.
There are many configuration options or resources that you can set in the resource file for
the scanner. They are all documented in Chapter 21 "Resource Sets" of Point of Sale Subsystem:

376 UnifiedPOS User's Guide

Programming Reference and User’s Guide (SC30-3560). The resources that are typically set for a
scanner are:
*barCodes1
*barCodes2
*barCodes3
*barCodes4
*iTFLength1
*iTFLength2
*iTFLengthType
The barCodesX resources determine what types of barcodes the scanner will read. The
itfLengthXXX resources apply specifically to Interleaved 2 of 5 (ITF) barcodes and determine
what subset of ITF barcodes the scanner will read.
Scanners are identified by the driver as being one of two types, hand-held or flatbed (table top).
Each of these types is further divided into different subtypes based upon which Toshiba scanner
interface is being emulated. For each Toshiba scanner interface, only certain resources can be
used and for each resource, only certain values can be specified.
For example, an RS485 scanner configured for port 17B will report itself to the terminal (and
have different configuration options) than the same physical scanner configured for port 5B.
If the resource file does not contain any scanner configuration information, the driver still sends
a default configuration command to the scanner. See Table 254 and Table 255 for the default
configuration for each scanner subtype.

Table 254. Handheld scanners

Subtype Description Subset of valid resources Default configuration
1 Toshiba Hand Held Bar Code *barCode1 UPC-A, UPC-E, EAN-8,
Reader model 1 (HHBCR1) EAN-13, JAN-8, JAN-13
2 Toshiba Hand Held Bar Code *barCode1 UPC-A, UPC-E, EAN-8,
Reader model 2 (HHBCR2) EAN-13, JAN-8, JAN-13
3 Toshiba Model 1520 *barCode1 UPC-A, UPC-E, UPC-D, UPC-8,
*barCode2 UPC-13
*barCode3
*barCode4
*iTFLength1

4 USB scanner *barCode1 UPC-A, UPC-E, UPC-D, EAN-8,

*barCode2 EAN-13, JAN-8, JAN-13
*barCode3
*barCode4
*iTFLength1
*iTFLength2
*iTFLengthType

Table 255. Flatbed scanners

Subtype Description Subset of valid resources Default configuration
1 Toshiba 4687 Cannot be programmed via the UPC-A, UPC-E, UPC-D, EAN-8,
resource file EAN-13, JAN-8, JAN-13
2 Toshiba 4686 model 1 & 2 *barCode1 UPC-A, UPC-E, UPC-D, EAN-8,
*barCode2 EAN-13, JAN-8, JAN-13

Chapter 17. Scanner (bar code reader) 377

Subtype Description Subset of valid resources Default configuration

*iTFLength1
*iTFLength2

3 Toshiba 4686 model 3 & 4 *barCode1 UPC-A, UPC-E, UPC-D, EAN-8,

*barCode2 EAN-13, JAN-8, JAN-13
*iTFLength1
*iTFLength2

4 Toshiba 4696 *barCode1 UPC-A, UPC-E, UPC-D, EAN-8,

EAN-13, JAN-8, JAN-13
5 Toshiba 4697 *barCode1 UPC-A, UPC-E, UPC-D, EAN-8,
*barCode2 EAN-13, JAN-8, JAN-13
*iTFLength1
*iTFLength2

6 Toshiba 4698 *barCode1 UPC-A, UPC-E, UPC-D, EAN-8,

*barCode2 EAN-13, JAN-8, JAN-13
*barCode3
*barCode4
*iTFLength1
*iTFLength2

7 USB scanner *barCode1 UPC-A, UPC-E, UPC-D, EAN-8,

*barCode2 EAN-13, JAN-8, JAN-13
*barCode3
*barCode4
*iTFLength1
*iTFLength2
*iTFLengthType

Following are several scanner configuration examples:

1. One Toshiba 1520-compatible hand-held scanner is attached and it must be able to read
Code 39 and UPC barcodes. The resource file should contain the following:
*barCodes1: LGROUP_UPC_EAN
*barCodes2: LGROUP_CODE_39

2. One Toshiba USB OEM POS Device Interface-compliant scanner is attached and it needs to
be able to read Code 39, Code 128, UPC, EAN and ITF barcodes (4 to 32 digits (inclusive) in
length). The resource file should contain the following:
*barCodes1: LGROUP_UPC_EAN_D1_TO_D5
*barCodes2: LGROUP_CODE_39
*barCodes3: LGROUP_INT_2_OF_5
*itfLength1: 4
*itfLength2: 32
*itfLengthType: 1

3. One Toshiba USB OEM POS Device Interface-compliant scanner is attached and it needs to
be bale to read Code 39, Code 128, UPC, EAN and ITF barcodes (20 and 24 digits in length
only). The resource file should contain the following:
*barCodes1: LGROUP_UPC_EAN_D1_TO_D5
*barCodes2: LGROUP_CODE_39
*barCodes3: LGROUP_INT_2_OF_5
*itfLength1: 20
*itfLength2: 24
*itfLengthType: 0

378 UnifiedPOS User's Guide

4. One Toshiba HHBCR2-compatible hand-held scanner is attached and it needs to be able to
read ITF barcodes. The resource file should contain the following:
*barCodes1: LGROUP_INT_2_OF_5

5. One Toshiba HHBCR2-compatible hand-held scanner is attached and it needs to be able to

read UPC, EAN and ITF barcodes. The resource file should contain the following:
*barCodes1: LGROUP_UPC_EAN_ITF

6. One Toshiba HHBCR2-compatible hand-held scanner is attached and it needs to be able to

read Code 128, UPC, EAN and ITF barcodes. The resource file should contain the following:
*barCodes1: 0

Note: For Toshiba HHBCR2-compatible scanners, 0 (zero) specifies that the scanner should
be placed in test mode which allows it to read all barcode types that it supports.
7. One RS485 Toshiba HHBCR2-compatible hand-held scanner (OPOS name, HH485) and one
Toshiba USB OEM POS Device Interface-compliant flatbed scanner (OPOS name, FBUSB)
are attached; both scanners must be able to read Code 39, Code 128, UPC, and EAN
barcodes. The resource file should contain the following:
*HH485.barCodes1: 0

*FBUSB.barCodes1: LGROUP_UPC_EAN
*FBUSB.barCodes1: LGROUP_CODE_39_CODE_128

8. One Toshiba 1520-compatible hand-held scanner is attached and it needs to be able to read
Code 39 and 20-digit ITF barcodes. The resource file should contain the following:
*barCodes1: LGROUP_UPC_EAN
*barCodes2: LGROUP_INT_2_OF_5
*itfLength1: 20

Scanner Programming (AnyPlace Kiosk)

The scanners on AnyPlace Kiosk are programmed from the OPOS Configuration Utility.
From the OPOS Configuration utility, click SurePOS 300/500/600 and open the Kiosk tab. Select
AnyPlace Kiosk scanner and click Configure.

Chapter 17. Scanner (bar code reader) 379

Figure 39. AnyPlace Kiosk Scanner

Enter Device Name and select Scanner Type. You can change the value of a property by clicking
on Value and by selecting TRUE or FALSE as shown below.

Figure 40. Scanner Properties

Refer to the table for available properties for AnyPlace scanners.

380 UnifiedPOS User's Guide

Table 256. AnyPlace Scanner Properties
Scanner Type Properties
Anyplace Kiosk - Line Scanner Set to TRUE (default)

BepOnGoodRead, Codabar, Code39, Code93,

Code128, D25, D25Lengths, GS1Databar, GS1DatabarExpanded, I25,
I25Lengths, MicroPDF417,Transmit_UPCA_CheckDigit,
Transmit_UPCE_CheckDigit, UCC/EAN128, UPC/EAN Supplemental,
UPC-A, UPC-E, EAN-8, EAN-13, JAN-8, JAN-13

Set to FALSE (default)

PDF417, CompositeBarcodes, ProgrammingViaBarcode

Anyplace Kiosk - Omni Scanner Set to TRUE (default)

BepOnGoodRead, Codabar, Code128, Code39, Code93, D25,

D25Lengths, GS1Databar, GS1DatabarExpanded, I25, I25Lengths,
MicroPDF417, Transmit_UPCA_CheckDigit, Transmit_UPCE_CheckDigit,
UCC/EAN128, UPC/EAN Supplemental, UPC-A, UPC-E, EAN-8,
EAN-13, JAN-8, JAN-13

Set to FALSE (default)

PDF 417, CompositeBarcodes
ProgrammingViaBarcode

Scanner configurations are created in the following windows registry:

-
HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\Scanner\LogicalNam
e
Note: For 32 bit Applications running on 64 bit Windows use the following path instead.
-
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\OLEforRetail\ServiceOPOS\Scanne
r\LogicalName
"LogicalName" refers to the actual device logical name given by end user at configuration time.

Additional OPOS information

Scanner detection
The Toshiba OPOS driver will control all RS-485 scanners, and can optionally control USB
scanners.
RS-485 scanners are detected automatically by the driver, and do not need any special
programming in order to be detected. The only programming that might be required is to alter
the model of legacy Toshiba scanner that the physical scanner is emulating, since altering the
model of scanner will change what configuration options you can use to program the scanner
through the driver.
USB scanners will be detected automatically if the scanner has been programmed as an Toshiba-
compatible device. If it has not been programmed as such, you must use the scanner vendors
own scanner driver.

Chapter 17. Scanner (bar code reader) 381

Some scanner vendors have implemented their driver with the scanner programmed as an
Toshiba-compatible device. In this situation, both the vendors own driver and the Toshiba driver
will send programming commands to the device, since both drivers recognize the scanner as a
device that they should control.
To work around this problem refer to “Ignoring USB devices” on page 76.

Known scanner issues

This section contains information on known issues with specific models.

Motorola DS9808
There are two issues with scanner support of the 2D barcode symbologies:
• Four types of 2D symbologies can be scanned and return correct encoded information,
but are unable to return correct symbology types:
• Data Matrix
• GS1 Data Matrix
• QR Code
• Aztech Code
• Six types of 2D symbologies are unable to scan:
• MicroPDF
• Maxicode
• OCR-A
• OCR-B
• GS1 QR Code
• Code 49

JavaPOS DirectIO calls

The DirectIO commands in this section are supported for the scanner device. The syntax is as
follows:

directIO (command: int32, inout data: int32, inout obj: object):

void {raises-exception}

To access DirectIO constants, import com.ibm.jpos.services.DirectIO.

Scanner command
Table 257. SCANNER_ID information
Parameter Type Value
command int32 com.ibm.jpos.services.
DirectIO.SCANNER_ID
(0x81)
Data int32 An array of integer containing
directIO commands for

382 UnifiedPOS User's Guide

Parameter Type Value
the Scanner. The direcIO
command can be short or
long.
• For short directIO, total
length is 11 bytes. The
first byte must be 0x30,
followed by 10 bytes of
scanner specific data or
0x00.
• For long directIO, total
length is 240 bytes. The
first byte must be 0x35,
followed by 239 bytes of
scanner specific data or
0x00.

Obj Obj com.ibm.jpos.services.

scanner.ReturnBuffer
object
This object holds the return
code and data returned by
the scanner in response to
directIO command. Refer to
details below.

ReturnBuffer Object:
The ReturnBuffer object provides several methods for data access from the scanner device.

String getReturnBuff(): Returns data from scanner as a String.

byte[] getReturnBuffBytes(): Returns data from the scanner as byte[].
boolean clearReturnBuff(): Clears ReturnBuffer between uses.
int getReturnCode(): Returns return code from the scanner device.
int getLength(): Returns length of data from the scanner device.

Output Models supported:

• Synchronous

Chapter 17. Scanner (bar code reader) 383

384 UnifiedPOS User's Guide
Chapter 18. Scale
Scale

Supported devices
Table 258. Scale supported devices
Device Connectivity Comments
1. Toshiba 4687 Compatible RS-485, USB
Scanner/scale
2. Toshiba 4696 Compatible RS-485, USB
Scanner/scale
3. Toshiba 4698 Compatible RS-485, USB
Scanner/scale
4. OEM Scale USB Must conform to Toshiba USB OEM Point-of-Sale Device
Interface Specification V1.0 or later.

Supported properties and methods

Table 259. Scale common properties

Property JavaPOS OPOS

AutoDisable Not supported
BinaryConversion Not supported All
CapCompareFirmwareVersion False
CapPowerReporting PR_STANDARD All support PR_STANDARD
CapStatisticsReporting True (see Appendix A, JavaPOS False
support for UnifiedPOS device
statistics properties on page 555)
CapUpdateFirmware False
CapUpdateStatistics False (see Appendix A, JavaPOS False
support for UnifiedPOS device
statistics properties on page 555)
CheckHealthText All
Claimed All
DataCount All
DataEventEnabled All
DeviceControlDescription All
DeviceControlVersion All

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 385

Property JavaPOS OPOS
DeviceEnabled All
DeviceServiceDescription All
DeviceServiceVersion All
FreezeEvents All
OpenResult Not supported All
OutputID Not supported
PowerNotify All
PowerState All
PhysicalDeviceDescription All
PhysicalDeviceName All
ResultCode Not supported All
ResultCodeExtended Not supported All
State All

Table 260. Scale specific properties

Property JavaPOS OPOS

AsyncMode All
CapDisplay All
CapDisplayText Not supported
CapFreezeValue False
CapPriceCalculating Not supported
CapReadLiveWeightWithTare False
CapSetPriceCalculationMode False
CapSetUnitPriceWithWeighUnit False
CapSpecialTare False
CapStatusUpdate False
CapTarePriority False
CapTareWeight Not supported
CapZeroScale 4 All except 1
MaxDisplayTextChars Not supported - 0
MaximumWeight All
MinimumWeight Not supported
SalesPrice Not supported

386 UnifiedPOS User's Guide

Property JavaPOS OPOS
ScaleLiveWeight Not supported
StatusNotify Not supported
TareWeight Not supported
UnitPrice Not supported
WeightUnit All

Table 261. Scale common methods

Method JavaPOS OPOS

checkHealth All
claim All
clearInput All
clearOutput All
close All
compareFirmwareVersion Not supported
directIO Not supported
open All
release All
resetStatistics Not supported
retrieveStatistics True (see Appendix A, JavaPOS Not supported
support for UnifiedPOS device
statistics properties on page 555)
updateFirmware Not supported
updateStatistics Not supported

Table 262. Scale specific methods

Method JavaPOS OPOS

displayText Not supported
doPriceCalculating Not supported
freezeValue Not supported
readLiveWeightWithTare Not supported
readWeight All
setPriceCalculationMode Not supported
setSpecialTare Not supported
setTarePriority Not supported

Chapter 18. Scale 387

Method JavaPOS OPOS
setUnitPriceWithWeightUnit Not supported
zeroScale 4 All except 1

Table 263. Scale events

Event JavaPOS OPOS

DataEvent All
DirectIOEvent Not supported Not supported
ErrorEvent All
StatusUpdateEvent All

Power management support for RS-232 fiscal printers

UPOS offers support to suspend a POS terminal (S3) if an RS232 fiscal printer is in use with
UPOS drivers. To access this feature, use the power brick to power on the fiscal printer.
Note: If you have a power cable attached to the POS terminal, power mangement support for
RS232 fiscal printers is not supported.

JavaPOS configuration
Configuration options depend on the hardware capabilities. Table 264 details the configuration
options supported by the scale models.

Table 264. Scale configuration options

Configuration option Toshiba 4687 Toshiba 4698 USB OEM
centerOfZero ✓ ✓
displayRequired ✓ ✓
enforceZeroReturn ✓ ✓
fiveDigitWeight ✓
operationMode ✓ ✓
vibrationSensitivity ✓ ✓
weighMode ✓ ✓

CenterOfZero

<prop name="com.ibm.jpos.sdi.config.Scale.centerOfZero" type="Boolean"

value="false"/>

Indicate center-of-zero with an LED.

388 UnifiedPOS User's Guide

Valid values are TRUE and FALSE. Default is FALSE.

DisplayRequired

<prop name="com.ibm.jpos.sdi.config.Scale.displayRequired"
type="Boolean" value="false"/>

This property specifies whether a remote scale display is required. It is your responsibility to
ensure that a system operating without a remote display meets the applicable weights and
measures regulations.
If the value of this resource is false, but there is a remote display attached to the scale device, the
display might not be used.
If the value of this resource is true but there is no remote display attached to the scale device, the
scale might be unusable.
Valid values are TRUE and FALSE. Default is FALSE.

EnforceZeroReturn

<prop name="com.ibm.jpos.sdi.config.Scale.enforceZeroReturn"
type="Boolean" value="false"/>

This property specifies whether zero protection is required. With zero protection enabled, the
scale does not answer weight requests if a negative weight value is indicated on the display prior
to placing the item for weighing on the scale, or an item is left on the scale for four minutes.
If either of these conditions exists and the value of this property is true, no weight data can be
transmitted to the host until the scale returns to a zero weight (either by resetting the scale or
removing the item).
Valid values are TRUE and FALSE. Default is FALSE

FiveDigitWeight (USB OEM only)

<prop name="com.ibm.jpos.sdi.config.Scale.fiveDigitWeight"
type="Boolean" value="true"/>

This property specifies whether to return 5 digits (units of thousandths of pounds) or 4 digits
(units of hundredths of pounds) for a non-metric weight.
Valid values are TRUE and FALSE. Default is TRUE.

Chapter 18. Scale 389

OperationMode

<prop name="com.ibm.jpos.sdi.config.Scale.operationMode" type="String"

value="US"/>

This property specifies the regulations that the point-of-sale system must conform to. The
weight and measures requirements in various countries differ, and require minor operational
differences.
Valid values are US and UK. Default is US.

US
The scale conforms to regulations specified by the United States NIST Handbook
44 and the Canadian Department of Consumer and Corporate Affairs, Weights and
Measurements Act, Specifications SGM-1.

UK
The scale conforms to regulations specified by the Non-automatic Weighing Instruments
(EEC Requirements) Regulations 1992 (based on OIML R 76-1).

VibrationSensitivity

<prop name="com.ibm.jpos.sdi.config.Scale.vibrationSensitivity"
type="String" value="0"/>

This property controls the scale's sensitivity to vibration. External vibrations can affect the
stability of the scale. There is a programmable vibration filter that allows you to reduce the
scale's sensitivity to vibration. Reducing the scale's sensitivity to vibration increases the scale
settling time slightly, so the higher vibration filter settings should be selected only when testing
reveals a stability problem in the checkstand.
Valid values are 0 (normal sensitivity) to 3 (Ultra low sensitivity). Default is 0.
Default Value: 0

WeighMode

<prop name="com.ibm.jpos.sdi.config.Scale.weighMode" type="String"

value="0"/>

This property determines whether the weight is returned in pounds (Avoirdupois or English
system) or in kilograms (Metric system).
Valid values are 0 and 1. Default is 0.

390 UnifiedPOS User's Guide

0
Weight is given in pounds. For USB OEM compliant scales the fiveDigitWeight property
specifies the number of digits to return for an English weight (pounds). For 4698/4696
scales, four digits represent the weight of the item in hundredths.

1
Weight is given in kilograms. All scales return five digits which represent the weight of
the item in thousandths of kilograms.

Additional JavaPOS information

Known scale issues

This section contains information on known issues with specific models.

PSC 384 Magellan - USB

This model does not support the fiveDigitWeight configuration property. This property
must be set to false; otherwise the Scale configuration fails. For more information, see
“FiveDigitWeight (USB OEM only)” on page 389.

com.ibm.jpos.sdi.config.Scale.NCRCompatibilityMode
If this property is set to true, after the weight timeout limit has been reached the driver
will return a zero weight instead of firing a timeout.
<prop name="com.ibm.jpos.sdi.config.Scale.NCRCompatibilityMode"
type="String" value="false"/>
Values accepted:
• True
• False (default)
Device Support: 1,2,3,4
Since: UPOS 1.9.4
Note:
• If this property is not found in the scale entry, the default value is used: False.
• If this property has a wrong value, the default value is used: False.
• The value of this property will overwrite the default value for the ZeroValid
property from Scale.

ScaleMaxWeightTolerance

This property is used to configure the maximum weight tolerance on the scale:
Used to handle tolerance weight after maximum weight supported by hw
For a system built in scale:

Chapter 18. Scale 391

• Refer to the posj.properties file located at:

com.ibm.posj.ScaleMaxWeightTolerance

• The acceptable values are:

• The default is 30090.
• The maixumum value will be the scale tolerance you need to validate the hardware
specifications of the scale.
• The device support is:
1,2,3,4
• For Versions 1.14. 2 or later

OPOS configuration
In order to apply the configurations shown below, create the keyword of the specified type into
the following windows registry:
-
HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\Scale\LogicalName
Note: For 32 bit Applications running on 64 bit Windows use the following path instead.
-
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\OLEforRetail\ServiceOPOS\Scale\
LogicalName
"LogicalName" refers to the actual device logical name given by end user at configuration time.

Table 265. Service Object settings for scale

Keyword Type Description
weightMode String Unit of weight used by the scale. Valid values are:

0
U.S. pound (default)

1
Kilogram
RemoteDisplayAttached String Whether a Pole Display is attached. Valid values are:

True
Display attached

(other value)
No display (default)
ZeroScale String Whether zeroing the scale is supported. Valid values are:

0
Not supported (default)

1
Supported

392 UnifiedPOS User's Guide

Keyword Type Description
NCRCompatible String Determines how zero weight is handled. Valid values are:

False
Working according to UnifiedPOS specification

True
When stable weight of zero, return OPOS_SUCCESS

Chapter 18. Scale 393

394 UnifiedPOS User's Guide
Chapter 19. Tone indicator
Tone indicator

Supported devices
Note: System Tone is only supported in OPOS.

Table 266. Tone indicator supported devices

Device Connectivity
1. Retail alphanumeric POS keyboard w/Card Reader PS/2, RS-485, USB
2. Retail alphanumeric POS Keyboard with MSR and PS/2
pointing device
3. Retail POS keyboard RS-485, USB
4. Retail POS keyboard with Card Reader RS-485, USB
5. Retail POS keyboard w/Card Reader and Display RS-485, USB
6. Modifiable Layout Keyboard w/Card Reader RS-485, USB
7. SurePoint 4820 integrated Tone Indicator RS-485, USB, PS/2
8. SureOne Integrated Keyboard PS/2
9. POS keyboard V RS-485, USB
10. PC POS Keyboard or PC Point of Sale Keyboard PS/2, RS-485, USB
11. PLU keyboard/Display III RS-485, USB
12. Retail POS keyboard VI RS-485, USB
13. SurePOS 100 Integrated keyboard PS/2
14. 4674 Integrated Keyboard RS-485
15. 4685-KC1 (OPOS only) RS-485
16. 4685-K01 (OPOS only) RS-485
17. 4685–K02 (Ultra7) keyboard with card reader RS-485, USB
18. 4685-K02 with MSR/Encoder and 4 position USB
Keylock
19. 4685-K02 with MSR/Encoder and 6 position USB
Keylock
20. 4685-K03 RS-485, USB
21. 4610 Tx6/Tx7/1NR Printer built-in tone indicator EIA-232, RS-485, USB, Network
22. Internal speaker (OPOS only) Integrated
23. Modular Alphanumeric Keyboard PS/2, USB
24. Modular Compact Alphanumeric Keyboard PS/2, USB
25. Modular 67 Key Keyboard PS/2, USB
26. Modular 67 Key Keyboard with Display USB PS/2, USB

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 395

Device Connectivity
27. TCxDisplay 6149 Tone Indicator USB
28. 6145 Printer built-in tone indicator EIA-232, USB, Network

Supported properties and methods

Table 267. Tone indicator common properties

Property JavaPOS OPOS

AutoDisable Not supported
BinaryConversion Not supported All
CapCompareFirmwareVersion False
CapPowerReporting PR_STANDARD All support PR_STANDARD
CapStatisticsReporting True (see Appendix A, JavaPOS False
support for UnifiedPOS device
statistics properties on page 555)
CapUpdateFirmware False
CapUpdateStatistics False (see Appendix A, JavaPOS False
support for UnifiedPOS device
statistics properties on page 555)
CheckHealthText All
Claimed All
ClearInput Not supported
DataCount Not supported
DataEventEnabled All Not supported
DeviceControlDescription All
DeviceControlVersion All
DeviceEnabled All
DeviceServiceDescription All
DeviceServiceVersion All
FreezeEvents All
OpenResult Not supported All
OutputID All
PowerNotify All
PowerState All
PhysicalDeviceDescription All
PhysicalDeviceName All

396 UnifiedPOS User's Guide

Property JavaPOS OPOS
ResultCode Not supported All
ResultCodeExtended Not supported All
State All

Table 268. Tone indicator specific properties

Property JavaPOS OPOS

AsyncMode All
CapPitch All
CapMelody Not Supported
CapVolume All
InterToneWait All
MelodyType Not Supported
MelodyVolume Not Supported
Tone1Duration All
Tone1Pitch All
Tone1Volume All
Tone2Duration All
Tone2Pitch All
Tone2Volume All

Table 269. Tone indicator common methods

Method JavaPOS OPOS

checkHealth All
claim All
clearOutput All
close All
compareFirmwareVersion Not supported
directIO Not supported
open All
release All
resetStatistics Not supported

Chapter 19. Tone indicator 397

Method JavaPOS OPOS
retrieveStatistics True (see Appendix A, JavaPOS Not supported
support for UnifiedPOS device
statistics properties on page 555)
updateFirmware Not supported
updateStatistics Not supported

Table 270. Tone indicator specific methods

Method JavaPOS OPOS

sound All
soundImmediate All

Table 271. Tone indicator events

Event JavaPOS OPOS

DirectIOEvent Not supported
ErrorEvent All
OutputCompleteEvent All
StatusUpdateEvent All

OPOS configuration
In order to apply the configurations shown below, create the keyword of the specified type into
the following windows registry:
-
HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\ToneIndicator\Logi
calName
Note: For 32 bit Applications running on 64 bit Windows use the following path instead.
-
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\OLEforRetail\ServiceOPOS\ToneIn
dicator\LogicalName
"LogicalName" refers to the actual device logical name given by end user at configuration time.

Table 272. Service Object settings for tone indicator

Keyword Type Description
OnlineTimeout String Time (in milliseconds) to wait for device to come online.
Note: This setting cannot be modified with the Configuration tool.

ToneDurationFWControl String Determine whether the tone duration should be controlled by FW.
Values are:
True - Yes, The duration will be rounded up to the nearest 100 ms

398 UnifiedPOS User's Guide

Keyword Type Description

(other value) - No, the duration is controlled by driver (Default) .

Additional JavaPOS configuration

Enable or disable ELO tone interface

SurePoint 4820 devices with ELO touch screen display have a Tone Indicator interface, but by
default it is disabled. A command line utility is provided to enable or disable the Tone Indicator.
The syntax for the utility is:

java com.tgcs.posj.util.SurePointEloUtility [param]

Where:
• Enable: enables the Tone Interface
• Disable: disable the Tone Interface
• No param: a message that shows the status of the Tone Interface
Devices:
• USB SurePoint 4820-21x/51x with ELO Touch Screen
• USB SurePoint 4820-2Lx/5Lx with ELO Touch Screen
OS supported:
• Linux

JavaPOS ELO tone interface configuration

For Linux environments, the posj.properties file must be updated to include the Vendor ID
and Product ID for the SurePoint 4820 display:
1. Edit the posj.properties file, located at:
• Linux: /opt/tgcs/javapos/etc
2. Add the following entry to the end of the OEM Scanner section:
• com.ibm.posj.bus.hid.javaxusb.factory.knownPosDevices.95 = 0x04e7,0x0030

Chapter 19. Tone indicator 399

400 UnifiedPOS User's Guide
Chapter 20. Lights
Lights

Supported devices
Table 273. Supported devices
Device Connectivity
1. System 7 User Guidance Lights USB
2. System 7 TAL Lights USB

Supported properties and methods

Table 274. Common properties
Property JavaPOS OPOS
AutoDisable Not supported
BinaryConversion Not supported
CapCompareFirmwareVersion False Not supported
CapPowerReporting PR_NONE Not supported
CapStatisticsReporting False Not supported
CapUpdateFirmware False Not supported
CapUpdateStatistics False Not supported
CheckHealthText Not supported Not supported
Claimed All Not supported
DataCount Not supported
DataEventEnabled Not supported
DeviceControlDescription All Not supported
DeviceControlVersion All Not supported
DeviceServiceDescription All Not supported
DeviceServiceVersion All Not supported
FreezeEvents Not supported
OpenResult Not supported
OutputID Not supported
PhysicalDeviceDescription All Not supported
PhysicalDeviceName All Not supported
PowerNotify Not supported
PowerState Not supported

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 401

Property JavaPOS OPOS
State Not supported

Table 275. Specific properties

Property JavaPOS OPOS
CapAlarm 1,2: LGT_ALARM_NOALARM Not supported
CapBlink Not supported
1: False
2: True

CapColor Not supported

1: LGT_COLOR_PRIMARY
| LGT_COLOR_CUSTOM1
| LGT_COLOR_CUSTOM2
| LGT_COLOR_CUSTOM3
| LGT_COLOR_CUSTOM4 |
LGT_COLOR_CUSTOM5

2: LGT_COLOR_PRIMARY

MaxLights Not supported

1: 3
2: 5

Table 276. Lights common methods

Method JavaPOS OPOS
compareFirmwareVersion Not supported
checkHealth Not supported
claim All Not supported
clearInput Not supported
clearOutput Not supported
close All Not supported
directIO 1 Not supported
open All Not supported
release All Not supported
resetStatistics Not supported
retrieveStatistics Not supported
updateFirmware Not supported
updateStatistics Not supported

Table 277. Lights specific methods

Property JavaPOS OPOS
switchOn All Not supported
1:

402 UnifiedPOS User's Guide

Property JavaPOS OPOS
Parameter name Description
lightNumber Light number Description
1 Lane light, printer,
pin pad
2 Coupon box
3 Cash devices
blinkOnCycle Ignored.
blinkOffCycle Ignored.
color It should hold any of the values specified in
CapColor capability.
alarm LGT_ALARM_NOALARM (Not
supported)

2:
Parameter name Description
lightNumber Light number Description
1 Lane light
2 Green
3 Red
4 Yellow
5 White
blinkOnCycle Two values are supported:
0 (zero): No blinking.
> 0 (Greater than zero): Any value greater
than zero will produce a blinking with 500
milliseconds frequency.

blinkOffCycle Ignored.
color The following colors are supported:
• LGT_COLOR_PRIMARY (color
corresponding to light number)

alarm LGT_ALARM_NOALARM (Not

supported)
switchOff All Not supported
1:
Parameter name Description
lightNumber Light number Description
1 Lane light, printer,
pin pad

Chapter 20. Lights 403

Property JavaPOS OPOS
2 Coupon box
3 Cash devices

2:
Parameter name Description
lightNumber Light number Description
1 Lane light
2 Green
3 Red
4 Yellow
5 White

JavaPOS Cofiguration

Color.<Color Name> (Guidance Lights SwitchOn)

<prop name=" com.tgcs.jpos.GuidanceLights.Color.
<Color Name>" type="String" value="<Custom Value>"/>

Use this setting to modify color setting without changing application code. Property should
specify desired color value in the following way:
Where "[COLOR_NAME]” is one of the following values:

Specify Modify behavior of

com.tgcs.jpos.GuidanceLights.Color.Primary LGT_COLOR_PRIMARY
com.tgcs.jpos.GuidanceLights.Color.Custom1 LGT_COLOR_CUSTOM1
com.tgcs.jpos.GuidanceLights.Color.Custom2 LGT_COLOR_CUSTOM2
com.tgcs.jpos.GuidanceLights.Color.Custom3 LGT_COLOR_CUSTOM3
com.tgcs.jpos.GuidanceLights.Color.Custom4 LGT_COLOR_CUSTOM4
com.tgcs.jpos.GuidanceLights.Color.Custom5 LGT_COLOR_CUSTOM5

Custom values format: RRGGBBWW

Where:
• RR is a hexadecimal value representing Red
• GG is a hexadecimal value representing Green
• BB is a hexadecimal value representing Blue
• WW is a hexadecimal value representing White
Supported devices: 1
Example:

404 UnifiedPOS User's Guide

JavaPOS DirectIO calls

DirectIO.LGT_IO_START_SCRIPT
Toshiba JavaPOS provides functionality to turn self-checkout lane lights on and off. Such
a mechanism is based on existing core controller functionality as defined by self-checkout
hardware specifications. The screenshot below depicts a table which shows lights behavior on
the rows and script options on the columns (refer to the “Script” column):

Figure 41. Default script definitions

Figure 41 illustrates that to start animation of the Pay at Pinpad light, script number 5 should be
executed. Figure 41 also indicates animations are fixed and that the end user should download a
new script to the corresponding script number in order to alter its behavior.
Definition of directIO command for user guidance lights is as follows:

Chapter 20. Lights 405

Parameter Definition
command DirectIO_LGT_IO_START_SCRIPT
data Array of int with two elements:
First array element - Identifies the light zone.
See Figure 42 and Table 278 to see the possible
values.
Second array element - Script number as
shown in Figure 41 or 0 (zero) to switch light
off.

obj Null (not used)

Figure 42. First array element light zones

Table 278. Light zone descriptions

Option Description
 A LGT_ZONE_TOP Light located on the top
 B LGT_ZONE_PRINTER Lateral light located on the
right of the display
 B LGT_ZONE_PINPAD Lateral light located on the
right of the display
 C LGT_ZONE_COUPON Located beside the scale

406 UnifiedPOS User's Guide

Option Description
 D LGT_ZONE_CASH Light located on the front
 A, B, C, D LGT_ZONE_ALL All of the above

Additional JavaPOS information

Install driver Windows

To install javaxusb.sys driver for a given inf file, use the c:\pos\bin\aipdifx.exe
utility.
Syntax of the utility:
Usage: aipdifx [ -i <inf-file> | -u <inf-file> ] [ -q ] [ -v ]
Where:
-i <inf-file> specifies full path to inf file to install
-u <inf-file> specifies full path to inf file to uninstall
-q No installation messages
-v Verbose messages
-f force (hidden)
Note: Requires either -i or -u option.
Examples:
To install a predefined configuration file for lights device, follow the steps below:
1. Extract the zip file javaxusb_lights.zip located in the directory:
<INSTALLATIONDIR>\POS\drivers\javaxusb_lights
2. Execute the following command from the Windows console (administrator privileges are
required when running the command line):
C:\pos\bin\aipdifx.exe –u
<INSTALLATIONDIR>\POS\drivers\javaxusb_lights\javaxusb_lights.inf -v

Install driver Linux

To work with Lights device in Linux, it is required to manually create a file named
enableLights.conf in any directory present in the CLASSPATH environment variable (file
may be empty).
Example: /opt/tgcs/javapos/etc/enableLights.conf

Configure Lights device using POS Control Center

Once the JavaPOS driver has been installed on the POS system, the POS Control Center tool can
be used to configure the lights device.
Make sure the Core Controller and the lights device are connected to the POS System.

Chapter 20. Lights 407

1. Open POS Control Center.

Figure 43. Toshiba POS Control Center Application

2. Click AutoDetection.

Figure 44. Save auto-detected devices in jpos.xml

3. Click OK.

Figure 45. Save jpos.xml file

4. Accept or select another location to save the jpos.xml file. The default location is in the
c:\POS\JavaPOS directory.

408 UnifiedPOS User's Guide

The device should be now configured.

Chapter 20. Lights 409

410 UnifiedPOS User's Guide
Part III. Keyboards and code pages
Keyboards and code pages

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 411

412 UnifiedPOS User's Guide
Chapter 21. POS keyboard layouts and scan codes
POS keyboard layouts and scan codes

This chapter contains keyboard layouts and scan codes for Toshiba Point-of-Sale keyboards.
Note: The numeric keypad is shaded in all illustrations.

Understanding scan codes

When a key is pressed on any keyboard (sometimes referred to as, a KEY_DOWN event), the
keyboard device driver receives a code that is called a make scan code. There is a different code
for each key. When a key is released (on some keyboards) sometimes referred to as a KEY_UP
event, the keyboard device driver receives a code that is called a break scan code. These codes are
translated into ASCII character codes by the operating system.
The following scancode tables do not contain values for the OPOS driver, because the OPOS
driver only sends a data event to the application if each individual key has been mapped in the
configuration program. If a key has been mapped by the user the value that will be sent to the
application will be the user-defined mapped value, not the hardware scancode.
For keys that generate different scan codes based on a modifier key (IE, S1 and S2) the scan
code shown in the table below does not include the make scan code or break scan code for the
modifier key, only the scan code for that key.

Checkout Keyboards Layout (50-key and Modular 67 Key)

This section contains illustrations of the layouts for the following keyboards:
• Retail Point of Sale Keyboard (50-key)
• Retail Point of Sale Keyboard with card reader (50-key)
• Retail Point of Sale Keyboard with card reader and display (50-key)
• Point of Sale Keyboard VI
• Modular 67 Key Keyboard

50-Key Modifiable Layout Keyboard

Figure 46 shows the key-switch numbers. The numeric keypad (key switches 18 to 29) is shown
in the shaded area of the illustration.

01 02 03 16 17 30 31 32 33 50

04 05 06 18 19 20 34 35 36 37 51

07 08 09 21 22 23 38 39 40 41

10 11 12 24 25 26 42 43 44 45

13 14 15 27 29 46 47 48 49

Figure 46. Layout for 50-Key Modifiable Keyboard

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 413

50-Key Modifiable Layout Keyboard and Operator Display
Figure 47 shows the key-switch numbers. The numeric keypad (key switches 18 to 29) is shown
in the shaded area of the illustration.

Figure 47. Layout for 50-Key Modifiable Keyboard and Operator Display

Retail Point of Sale Keyboard Layout

Figure 48 shows the key-switch numbers for the Retail Point of Sale Keyboard, both with and
without the card reader. The numeric keypad (key switches 18 to 29) are shown in the shaded
area of the illustration.

50 01 02 03 16 17 30 31 32 33

04 05 06 18 19 20 34 35 36 37

07 08 09 21 22 23 38 39 40 41

10 11 12 24 25 26 42 43 44 45

13 14 15 27 28 29 46 47 48 49

Figure 48. Layout for Retail Point of Sale Keyboard

Retail Point of Sale Keyboard with Card Reader and Display

Figure 49 shows the key-switch numbers for the Retail Point of Sale Keyboard with Card Reader
and Display. The numeric keypad (key switches 18 to 29) is shown in the shaded area of the
illustration.

414 UnifiedPOS User's Guide

01 02 03 16 17 30 31 32 33

04 05 06 18 19 20 34 35 36 37

07 08 09 21 22 23 38 39 40 41

10 11 12 24 25 26 42 43 44 45

50 13 14 15 27 28 29 46 47 48 49

Figure 49. Layout for Retail Point of Sale Keyboard with Card Reader and Display

Point of Sale Keyboard VI Layout

Figure 50 shows the key-switch numbers for the Point of Sale Keyboard VI. The numeric keypad
(key switches 18 to 29) is shown in the shaded area of the illustration.

50 01 02 03 16 17 30 31 32 33

04 05 06 18 19 20 34 35 36 37

07 08 09 21 22 23 38 39 40 41

10 11 12 24 25 26 42 43 44 45

13 14 15 27 28 29 46 47 48 49

Figure 50. Layout for Point of Sale Keyboard VI

Modular 67-Key Keyboard Layout

Figure 51 shows the key-switch numbers for the Modular 67-Key Keyboard. The numeric
keypad (key switches 18 to 29) is shown in the shaded area of the illustration.

Chapter 21. POS keyboard layouts and scan codes 415

Figure 51. Layout for Modular 67 Key Keyboard

Modular 67-Key Keyboard with Display Layout

Figure 52 shows the key-switch numbers for the Retail Point of Sale 67-Key Keyboard with
Display. The numeric keypad (key switches 18 to 29) is shown in the shaded area of the
illustration.

Figure 52. Layout for Retail Point of Sale 67-Key Keyboard with Display

Checkout Keyboards PS/2 or USB (System Keyboard) scan code set

To enable a 67-key keyboard as a system keyboard follow the steps listed below:
• Open the posj.properties file from /opt/tgcs/javapos/etc
• Search for the following two lines and uncomment them:
com.ibm.posj.bus.hid.javaxusb.factory.kbdAsSystemKbd.9 = 0x04b3,0x4606
com.ibm.posj.bus.hid.javaxusb.factory.kbdAsSystemKbd.10 = 0x0f66,0x4606

416 UnifiedPOS User's Guide

In Linux, Modular 67-Key Keyboard scan codes may not match those provided in the table
below until a configuration file is downloaded to the device. Follow the steps listed below to
download the configuration file:
• Copy the aip46013.cfg.winCompatibility file from /opt/tgcs/javapos/config
to /usr/share/pos/config/aip46013.cfg (if the keyboard does not have an MSR).
• Copy the aip46063.cfg.winCompatibility file from /opt/tgcs/javapos/config
to /usr/share/pos/config/aip46063.cfg (if the keyboard has an MSR).
• Reboot the system.
Note:
1. Check tgcsflash.log file from /var/log to verify that the configuration has been
successfully downloaded.
2. The aip46013.cfg and aip46063.cfg files have been created with the version 1130.
3. If configuration file failed to download due to version mismatch, you can change the
configuration file version to a higher number using the Toshiba Modular Device Utility
available on Toshiba Support Site.
Table 279 shows the key scan codes for the Modular 67 Key Keyboard.

Table 279. PS/2 or USB (System Keyboard) scan codes for Modular 67 Key Keyboard
Key switch Hardware make Hardware break JavaPOS –
number code code POSKeyData Comments
1 X'3b' X'bb' X'3b'
2 X'3c' X'bc' X'3c'
3 X'3d' X'bd' X'3d'
4 X'3e' X'be' X'3e'
5 X'3f' X'bf' X'3f'
6 X'40' X'c0' X'40'
7 X'41' X'c1' X'41'
8 X'42' X'c2' X'42'
9 X'43' X'c3' X'43'
10 X'44' X'c4' X'44'
11 X'57' X'd7' X'57'
12 X'58' X'd8' X'58'
13 X'0f' X'8f' X'0f'
14 X'e0' X'5b' X'e0' X'db' X'01' X'5b'
15 X'38' X'b8' X'38'
16 X'46' X'c6' X'46'
17 X'45' X'c5' X'45'
18 X'47' X'c7' X'47'
19 X'48' X'c8' X'48'
20 X'49' X'c9' X'49'

Chapter 21. POS keyboard layouts and scan codes 417

Key switch Hardware make Hardware break JavaPOS –
number code code POSKeyData Comments
21 X'4b' X'cb' X'4b'
22 X'4c' X'cc' X'4c'
23 X'4d' X'cd' X'4d'
24 X'4f' X'cf' X'4f'
25 X'50' X'd0' X'50'
26 X'51' X'd1' X'51'
27 X'64' X'e4' X'64'
28 X'52' X'd2' X'52'
29 X'53' X'd2' X'53'
30 X'29' X'a9' X'29'
31 X'e0' X'e0' X'01' X'37' On Windows,
X'2a'X'e0'X'37' X'b7'X'e0'X'aa' key release only
32 X'e1' X'1d' X'45' X'01' X'45' Key press only
X'e1' X'9d'X'c5'
33 X'0e' X'8e' X'0e'
34 X'0c' X'8c' X'0c'
35 X'0d' X'8d' X'0d'
36 X'28' X'a8' X'28'
37 X'2b' X'ab' X'2b'
38 X'33' X'b3' X'33'
39 X'34' X'b4' X'34'
40 X'35' X'b35' X'35'
41 X'27' X'a7' X'27'
42 X'65' X'e5' X'65'
43 X'66' X'e6' X'66'
44 X'67' X'e7' X'67'
45 X'68' X'e8' X'68'
46 X'1d' X'9d' X'1d'
47 X'39' X'b9' X'39'
48 X'2a' X'aa' X'2a'
49 X'e0' X'1c' X'e0' X'9c' X'01' X'1c'
50 X'01' X'81' X'01'
51 X'1e' X'9e' X'1e'

418 UnifiedPOS User's Guide

Key switch Hardware make Hardware break JavaPOS –
number code code POSKeyData Comments
52 X'30' X'b0' X'30'
53 X'2e' X'ae' X'2e'
54 X'20' X'a0' X'20'
55 X'12' X'92' X'12'
56 X'21' X'a1' X'21'
57 X'22' X'a2' X'22'
58 X'23' X'a3' X'23'
59 X'17' X'97' X'17'
60 X'24' X'a4' X'24'
61 X'25' X'a5' X'25'
62 X'26' X'a6' X'26'
63 X'32' X'b2' X'32'
64 X'31' X'b1' X'31'
65 X'18' X'98' X'18'
66 X'19' X'99' X'19'
67 X'10' X'90' X'10'

Checkout keyboards RS-485/USB scan code set

Table 280 shows the key scan codes
• 50-Key Modifiable Layout Keyboard
• 50-Key Modifiable Layout Keyboard and Operator Display
• Retail Point of Sale Keyboard (50-Key)
• Retail Point of Sale Keyboard with card reader (50-key)
• Retail Point of Sale Keyboard with card reader and display (50-key)
• Point of Sale Keyboard VI
• Modular 67 Key Keyboard
The hardware scan code set for the 50-Key Modifiable Layout Keyboard, and the 50-Key
Modifiable Layout Keyboard and Operator Display is different from the hardware scan code
set for the retail point-of-sale keyboards. In order to allow the application to work with either
keyboard more easily, the hardware scan code set for the 50-Key Modifiable Layout Keyboard
and the 50-Key Modifiable Layout Keyboard and Operator Display is translated to the scan code
set for the retail point-of-sale keyboards.
Note: The 50-Key Modifiable Layout Keyboard and 50-Key Modifiable Layout Keyboard and
Operator Display only generate make scan codes when a key is pressed. In order for your
application to work with either the old or the new keyboards, it must use the make scan codes
from the checkout style keyboards and discard any break scan codes it receives.

Chapter 21. POS keyboard layouts and scan codes 419

Table 280. Checkout keyboards RS-485/USB scan code set
Key switch Hardware Hardware JavaPOS - POSKeyData Comments
number make code break code
1 X'4b' X'f0' X'4b' X'4b'
2 X'3b' X'f0' X'3b' X'3b'
3 X'6b' X'f0' X'6b' X'6b'
4 X'4c' X'f0' X'4c' X'4c'
5 X'3c' X'f0' X'3c' X'3c'
6 X'6c' X'f0' X'6c' X'6c'
7 X'4f' X'f0' X'4f' X'4f'
8 X'3f' X'f0' X'3f' X'3f'
9 X'6f' X'f0' X'6f' X'6f'
10 X'4e' X'f0' X'4e' X'4e'
11 X'3e' X'f0' X'3e' X'3e'
12 X'6e' X'f0' X'6e' X'6e'
13 X'4d' X'f0' X'4d' X'4d'
14 X'3d' X'f0' X'3d' X'3d'
15 X'6d' X'f0' X'6d' X'6d'
16 X'7b' X'f0' X'7b' X'7b'
17 X'1b' X'f0' X'1b' X'1b'
18 X'7c ' X'f0' X'7c' X'7c'
19 X'0c' X'f0' X'0c' X'0c'
20 X'1c' X'f0' X'1c' X'1c'
21 X'7f' X'f0' X'7f' X'7f'
22 X'0f' X'f0' X'0f' X'0f'
23 X'1f' X'f0' X'1f' X'1f'
24 X'7e' X'f0' X'7e' X'7e'
25 X'0e' X'f0' X'0e' X'0e'
26 X'1e' X'f0' X'1e' X'1e'
27 X'7d' X'f0' X'7d' X'7d'
28 X'0d' X'f0' X'0d' X'0d'
29 X'1d' X'f0' X'1d' X'1d'
30 X'8b' X'f0' X'8b' X'8b'
31 X'af' X'f0' X'af' X'af'

420 UnifiedPOS User's Guide

Key switch Hardware Hardware JavaPOS - POSKeyData Comments
number make code break code
32 X'bf' X'f0' X'bf' X'bf'
33 X'bb' X'f0' X'bb' X'bb'
34 X'8c' X'f0' X'8c' X'8c'
35 X'9c' X'f0' X'9c' X'9c'
36 X'ac' X'f0' X'ac' X'ac'
37 X'bc' X'f0' X'bc' X'bc'
38 X'8f' X'f0' X'8f' X'8f'
39 X'9f' X'f0' X'9f' X'9f'
40 X'9b' X'f0' X'9b' X'9b'
41 X'ab' X'f0' X'ab' X'ab'
42 X'8e' X'f0' X'8e' X'8e'
43 X'9e' X'f0' X'9e' X'9e'
44 X'ae' X'f0' X'ae' X'ae'
45 X'be' X'f0' X'be' X'be'
46 X'8d' X'f0' X'8d' X'8d'
47 X'9d' X'f0' X'9d' X'9d'
48 X'ad' X'f0' X'ad' X'ad'
49 X'bd' X'f0' X'bd' X'bd'
50 X'50' X'f0' X'50' X'50'
51 X'5A' X'F0'X'5A' X'5A' 67–Key
52 X'2B' X'F0'X'2B' X'2B' 67–Key
53 X'61' X'F0'X'61' X'61' 67–Key
54 X'62' X'F0'X'62' X'62' 67–Key
55 X'21' X'F0'X'21' X'21' 67–Key
56 X'52' X'F0'X'52' X'52' 67–Key
57 X'53' X'F0'X'53' X'53' 67–Key
58 X'32' X'F0'X'32' X'32' 67–Key
59 X'23' X'F0'X'23' X'23' 67–Key
60 X'2A' X'F0'X'2A' X'2A' 67–Key
61 X'28' X'F0'X'28' X'28' 67–Key
62 X'08' X'F0'X'08' X'08' 67–Key
63 X'56' X'F0'X'56' X'56' 67–Key

Chapter 21. POS keyboard layouts and scan codes 421

Key switch Hardware Hardware JavaPOS - POSKeyData Comments
number make code break code
64 X'07' X'F0'X'07' X'07' 67–Key
65 X'1A' X'F0'X'1A' X'1A' 67–Key
66 X'63' X'F0'X'63' X'63' 67–Key
67 X'64' X'F0'X'64' X'64' 67–Key
+ Ctrl Case
Pressed
with 2
position
Keylock
31 X'f0' X'50' X'00' Key press only
X'00' X'50'
32 X'f0' X'50' X'01' Key press only
X'01' X'50'
+ 4 Keylock
position set
to position
#3
31 X'f0' X'50' X'00' Key press only
X'00' X'50'
32 X'f0' X'50' X'01' Key press only
X'01' X'50'

Note: 67–Key
These keys are present only on the Modular 67 Key Keyboard.
Table 281 explains the scan codes received for the S1 and S2 function keys on the retail point-of-
sale keyboards.
The S1 and S2 function keys send a series of scan codes on the retail point-of-sale keyboards.
These function keys generate a break scan code for the Ctrl key (scan code of 0x50 with
PosKC_KEYUP flag set), a make scan code for the S1 or S2 key and then a make scan code
for the Ctrl key (scan code of 0x50 with PosKC_KEYUP flag reset).
The S1 and S2 function keys can be accessed in 2 different forms:
1. By pressing the Ctrl key. With the Ctrl key pressed, key 31 represents the S1 function and
key 32 represents the S2 function. This applies for the 50 key POSKeyboards and the 67 key
POSKeyboards with 2 position Keylock.
2. Moving the keylock to positions 3. This applies to 67 key POSKeyboards with 4 position
Keylock.
No break scan codes are sent for the 0x00 or 0x01 scan codes.

Table 281. RS-485⁄USB scan codes for the Retail Point of Sale Keyboards
Key switch number Key type Ctrl + scan code
31 S1 X'00'

422 UnifiedPOS User's Guide

Key switch number Key type Ctrl + scan code
32 S2 X'01'

Modifiable-layout keyboard with card reader layout (133-key)

Figure 53 shows the key-switch numbers for the modifiable layout keyboard with card reader.
The three possible locations for the numeric keypad are shown in the shaded area of the
illustration. The default location for the numeric keypad is the right-most shaded area.

135 136 137 138 139

111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22

23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66

67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88

89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110

Figure 53. Modifiable layout keyboard with card reader

Modifiable layout keyboard with card reader RS-485/USB scan code

set
Table 282 shows the key scan codes for the modifiable layout keyboard with card reader.

Table 282. Modifiable layout keyboard RS-485/USB scan code set

Key switch Hardware Hardware JavaPOS - Comments
number make code break code POSKeyData
1 X'b4' X'f0' X'b4' X'b4'
2 X'a4' X'f0' X'a4' X'a4'
3 X'34' X'f0' X'34' X'34'
4 X'44' X'f0' X'44' X'44'
5 X'94' X'f0' X'94' X'94'
6 X'84' X'f0' X'84' X'84'
7 X'14' X'f0' X'14' X'14'
8 X'04' X'f0' X'04' X'04'
9 X'74' X'f0' X'74' X'74'
10 X'64' X'f0' X'64' X'64'
11 X'54' X'f0' X'54' X'54'
12 X'5b' X'f0' X'5b' X'5b'

Chapter 21. POS keyboard layouts and scan codes 423

Key switch Hardware Hardware JavaPOS - Comments
number make code break code POSKeyData
13 X'6b' X'f0' X'6b' X'6b'
14 X'7b' X'f0' X'7b' X'7b'
15 X'0b' X'f0' X'0b' X'0b'
16 X'1b' X'f0' X'1b' X'1b'
17 X'8b' X'f0' X'8b' X'8b'
18 X'9b' X'f0' X'9b' X'9b'
19 X'3b' X'f0' X'3b' X'3b'
20 X'4b' X'f0' X'4b' X'4b'
21 X'ab' X'f0' X'ab' X'ab'
22 X'bb' X'f0' X'bb' X'bb'
23 X'b5' X'f0' X'b5' X'b5'
24 X'a5' X'f0' X'a5' X'a5'
25 X'35' X'f0' X'35' X'35'
26 X'45' X'f0' X'45' X'45'
27 X'95' X'f0' X'95' X'95'
28 X'85' X'f0' X'85' X'85'
29 X'15' X'f0' X'15' X'15'
30 X'05' X'f0' X'05' X'05'
31 X'75' X'f0' X'75' X'75'
32 X'65' X'f0' X'65' X'65'
33 X'55' X'f0' X'55' X'55'
34 X'5a' X'f0' X'5a' X'5a'
35 X'6a' X'f0' X'6a' X'6a'
36 X'7a' X'f0' X'7a' X'7a'
37 X'0a' X'f0' X'0a' X'0a'
38 X'1a' X'f0' X'1a' X'1a'
39 X'8a' X'f0' X'8a' X'8a'
40 X'9a' X'f0' X'9a' X'9a'
41 X'3a' X'f0' X'3a' X'3a'
42 X'4a' X'f0' X'4a' X'4a'
43 X'aa' X'f0' X'aa' X'aa'
44 X'ba' X'f0' X'ba' X'ba'

424 UnifiedPOS User's Guide

Key switch Hardware Hardware JavaPOS - Comments
number make code break code POSKeyData
45 X'b6' X'f0' X'b6' X'b6'
46 X'a6' X'f0' X'a6' X'a6'
47 X'36' X'f0' X'36' X'36'
48 X'46' X'f0' X'46' X'46'
49 X'96' X'f0' X'96' X'96'
50 X'86' X'f0' X'86' X'86'
51 X'16' X'f0' X'16' X'16'
52 X'06' X'f0' X'06' X'06'
53 X'76' X'f0' X'76' X'76'
54 X'66' X'f0' X'66' X'66'
55 X'56' X'f0' X'56' X'56'
56 X'59' X'f0' X'59' X'59'
57 X'69' X'f0' X'69' X'69'
58 X'79' X'f0' X'79' X'79'
59 X'09' X'f0' X'09' X'09'
60 X'19' X'f0' X'19' X'19'
61 X'89' X'f0' X'89' X'89'
62 X'99' X'f0' X'99' X'99'
63 X'39' X'f0' X'39' X'39'
64 X'49' X'f0' X'49' X'49'
65 X'a9' X'f0' X'a9' X'a9'
66 X'b9' X'f0' X'b9' X'b9'
67 X'b3' X'f0' X'b3' X'b3'
68 X'a3' X'f0' X'a3' X'a3'
69 X'33' X'f0' X'33' X'33'
70 X'43' X'f0' X'43' X'43'
71 X'93' X'f0' X'93' X'93'
72 X'83' X'f0' X'83' X'83'
73 X'13' X'f0' X'13' X'13'
74 X'03' X'f0' X'03' X'03'
75 X'73' X'f0' X'73' X'73'
76 X'63' X'f0' X'63' X'63'

Chapter 21. POS keyboard layouts and scan codes 425

Key switch Hardware Hardware JavaPOS - Comments
number make code break code POSKeyData
77 X'53' X'f0' X'53' X'53'
78 X'5c' X'f0' X'5c' X'5c'
79 X'6c' X'f0' X'6c' X'6c'
80 X'7c' X'f0' X'7c' X'7c'
81 X'0c' X'f0' X'0c' X'0c'
82 X'1c' X'f0' X'1c' X'1c'
83 X'8c' X'f0' X'8c' X'8c'
84 X'9c' X'f0' X'9c' X'9c'
85 X'3c' X'f0' X'3c' X'3c'
86 X'4c' X'f0' X'4c' X'4c'
87 X'ac' X'f0' X'ac' X'ac'
88 X'bc' X'f0' X'bc' X'bc'
89 X'b2' X'f0' X'b2' X'b2'
90 X'a2' X'f0' X'a2' X'a2'
91 X'32' X'f0' X'32' X'32'
92 X'42' X'f0' X'42' X'42'
93 X'92' X'f0' X'92' X'92'
94 X'82' X'f0' X'82' X'82'
95 X'12' X'f0' X'12' X'12'
96 X'02' X'f0' X'02' X'02'
97 X'72' X'f0' X'72' X'72'
98 X'62' X'f0' X'62' X'62'
99 X'52' X'f0' X'52' X'52'
100 X'5d' X'f0' X'5d' X'5d'
101 X'6d' X'f0' X'6d' X'6d'
102 X'7d' X'f0' X'7d' X'7d'
103 X'0d' X'f0' X'0d' X'0d'
104 X'1d' X'f0' X'1d' X'1d'
105 X'8d' X'f0' X'8d' X'8d'
106 X'9d' X'f0' X'9d' X'9d'
107 X'3d' X'f0' X'3d' X'3d'
108 X'4d' X'f0' X'4d' X'4d'

426 UnifiedPOS User's Guide

Key switch Hardware Hardware JavaPOS - Comments
number make code break code POSKeyData
109 X'ad' X'f0' X'ad' X'ad'
110 X'bd' X'f0' X'bd' X'bd'
111 X'20' X'f0' X'20' X'20'
112 X'b1' X'f0' X'b1' X'b1'
113 X'a1' X'f0' X'a1' X'a1'
114 X'31' X'f0' X'31' X'31'
115 X'41' X'f0' X'41' X'41'
116 X'91' X'f0' X'91' X'91'
117 X'81' X'f0' X'81' X'81'
118 X'88' X'f0' X'88' X'88'
119 X'18' X'f0' X'18' X'18'
120 X'58' X'f0' X'58' X'58'
121 X'68' X'f0' X'68' X'68'
122 X'78' X'f0' X'78' X'78'
123 X'08' X'f0' X'08' X'08'
124 X'1e' X'f0' X'1e' X'1e'
125 X'8e' X'f0' X'8e' X'8e'
126 X'9e' X'f0' X'9e' X'9e'
127 X'ae' X'f0' X'ae' X'ae'
128 X'be' X'f0' X'be' X'be'
135 X'1f' X'f0' X'1f' X'1f'
136 X'8f' X'f0' X'8f' X'8f'
137 X'9f' X'f0' X'9f' X'9f'
138 X'af' X'f0' X'af' X'af'
139 X'bf' X'f0' X'bf' X'bf'
+ Ctrl Case
Pressed
124 (S2) X'f0' X'20' X'01' Key press only
X'01' X'20'
135 (S1) X'f0' X'20' X'00' Key press only
X'00' X'20'

Table 283 explains the scan codes received for the S1 and S2 function keys on the Modifiable
Layout Keyboard with Card Reader.

Chapter 21. POS keyboard layouts and scan codes 427

The S1 and S2 function keys send a series of scan codes on the Modifiable Layout Keyboard with
Card Reader. These function keys generate a break scan code for the Ctrl key (scan code of 0x20
with PosKC_KEYUP flag set), a make scan code for the S1 or S2 key, and then a make scan code
for the Ctrl key (scan code of 0x20 with the PosKC_KEYUP flag reset). The S1 and S2 function
keys can only be accessed by pressing the Ctrl key. With the Ctrl key pressed, key 135 represents
the S1 function, and key 124 represents the S2 function.
No break scan codes are sent for the 0x00 or 0x01 scan codes.

Table 283. RS-485 Scan Codes – Modifiable Layout Keyboard with Card Reader
Key switch number Key type Ctrl + scan code
124 S2 X'01'
135 S1 X'00'

Alphanumeric Point of Sale keyboards

This section contains illustrations of the layouts for the following keyboards:
• PC Point of Sale Keyboard with Card Reader (ANKPOS)
• Retail Alphanumeric POSKeyboard with Card Reader (NANPOS)
• Modular Alphanumeric POS Keyboard
• Modular Compact Alphanumeric POS Keyboard

PC Point of Sale keyboard with card reader (ANKPOS)

Figure 54 shows the layout and assigned key-switch numbers for the PC Point of Sale Keyboard.
The numeric keypad location is shown in the shaded area of the illustration.

135 136 137 138 139

110 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 75 80 85 90 95 100 105

16 17 18 19 20 21 22 23 24 25 26 27 28 43 76 81 86 91 96 101 106

30 31 32 33 34 35 36 37 38 39 40 41 42 77 82 87 92 97 102 107

44 46 47 48 49 50 51 52 53 54 55 56 57 78 83 88 93 98 103 108

58 60 131 61 132 133 62 64 79 84 89 94 99 104 109

Figure 54. PC Point of Sale keyboard layout

Retail Alphanumeric Point of Sale Keyboard with card reader

(NANPOS)
Figure 55 shows the layout and assigned key-switch numbers for the Retail Alphanumeric Point
of Sale Keyboard with card reader.

428 UnifiedPOS User's Guide

135 136 137 138 139

110 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128

1 2 3 4 5 6 7 8 9 10 11 12 13 14/15 75 80 85 90 95 100 105

16 17 18 19 20 21 22 23 24 25 26 27 28 43 76 81 86 91 96 101 106

30 31 32 33 34 35 36 37 38 39 40 41 42 77 82 87 92 97 102 107

44 45 46 47 48 49 50 51 52 53 54 55 56 57 78 83 88 93 98 103 108

58 60 61 62 64 79 84 89 94 99 104 109

Alternate Primary

Figure 55. Layout and Assigned Switch Numbers

Note:
1. The two possible locations for the numeric keypad are shown in the shaded area of the
illustration. The default location for the numeric keypad is the rightmost shaded area.
2. Key 45 appears as a single key only on non-U.S. keyboards. On U.S. keyboards, key 44 also
covers key 45 (key 44, 45 is a double key).
3. Keys 94 and 99 can have a single, horizontal double-wide key covering both keys, or they
can be split into two individual keys.
4. This keyboard is similar to the 101-enhanced keyboard and the 102-enhanced keyboard.
The following keys are on the Retail Alphanumeric Point of Sale Keyboard with Card
Reader, but not on the 101-enhanced keyboard or the 102-enhanced keyboard. These keys
are referred to as the point-of-sale-unique keys.

77
106

78
107

82
108

87
124

88
125

90
126

95
127

99
128

100
135

105

Chapter 21. POS keyboard layouts and scan codes 429

See Table 284 for the scan codes associated with these keys.

Modular Alphanumeric POS Keyboard

Figure 56 shows the layout and assigned key-switch numbers for the Modular Alphanumeric
POS Keyboard.

Figure 56. Layout and Assigned Switch Numbers for Modular Alphanumeric POS
Keyboard

See Table 284 for the scan codes associated with these keys.

Modular Compact Alphanumeric Point of Sale Keyboard

Figure 57 shows the layout and assigned key-switch numbers for the Modular Compact
Alphanumeric POS Keyboard.

430 UnifiedPOS User's Guide

Figure 57. Layout and Assigned Switch Numbers for the Modular Compact Alphanumeric
POS Keyboard

See Table 287 for the scan codes associated with these keys.

RS-485/USB scan code set for Retail Alphanumeric Point of Sale Keyboard
(NANPOS), PC Point of Sale Keyboard (ANKPOS), USB scan code set for
Modular Alphanumeric Point of Sale Keyboard
Table 284 relates the keyboard key-switch number to the scan codes received when the keyboard
is attached to the RS-485 or USB port.

Table 284. RS-485/USB scan code set

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments

number code code
1 X'51' X'f0' X'51' X'51'
2 X'11' X'f0' X'11' X'11'
3 X'12' X'f0' X'12' X'12'
4 X'13' X'f0' X'13' X'13'
5 X'14' X'f0' X'14' X'14'
6 X'54' X'f0' X'54' X'54'

Chapter 21. POS keyboard layouts and scan codes 431

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
7 X'55' X'f0' X'55' X'55'
8 X'15' X'f0' X'15' X'15'
9 X'18' X'f0' X'18' X'18'
10 X'16' X'f0' X'16' X'16'
11 X'17' X'f0' X'17' X'17'
12 X'57' X'f0' X'57' X'57'
13 X'58' X'f0' X'58' X'58'
14 X'6A' X'f0' X'6A' X'6A' ANKPOS (see Notes)
15 X'7A' X'f0' X'7A' X'7A'
16 X'71' X'f0' X'71' X'71'
17 X'61' X'f0' X'61' X'61'
18 X'62' X'f0' X'62' X'62'
19 X'63' X'f0' X'63' X'63'
20 X'64' X'f0' X'64' X'64'
21 X'74' X'f0' X'74' X'74'
22 X'75' X'f0' X'75' X'75'
23 X'65' X'f0' X'65' X'65'
24 X'68' X'f0' X'68' X'68'
25 X'66' X'f0' X'66' X'66'
26 X'67' X'f0' X'67' X'67'
27 X'77' X'f0' X'77' X'77'
28 X'78' X'f0' X'78' X'78'
30 X'72' X'f0' X'72' X'72'
31 X'81' X'f0' X'81' X'81'
32 X'82' X'f0' X'82' X'82'
33 X'83' X'f0' X'83' X'83'
34 X'84' X'f0' X'84' X'84'
35 X'24' X'f0' X'24' X'24'
36 X'25' X'f0' X'25' X'25'
37 X'85' X'f0' X'85' X'85'
38 X'88' X'f0' X'88' X'88'
39 X'86' X'f0' X'86' X'86'

432 UnifiedPOS User's Guide

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
40 X'87' X'f0' X'87' X'87'
41 X'27' X'f0' X'27' X'27'
42 X'47' X'f0' X'47' X'47'
43 X'4a' X'f0' X'4a' X'4a'
44 X'79' X'f0' X'79' X'79'
45 X'22' X'f0' X'22' X'22' World Trade key (see
Notes)
46 X'41' X'f0' X'41' X'41'
47 X'42' X'f0' X'42' X'42'
48 X'43' X'f0' X'43' X'43'
49 X'44' X'f0' X'44' X'44'
50 X'34' X'f0' X'34' X'34'
51 X'35' X'f0' X'35' X'35'
52 X'45' X'f0' X'45' X'45'
53 X'48' X'f0' X'48' X'48'
54 X'46' X'f0' X'46' X'46'
55 X'37' X'f0' X'37' X'37'
56 X'38' X'f0' X'38' X'38' ANKPOS (see Notes)
57 X'49' X'f0' X'49' X'49'
58 X'50' X'f0' X'50' X'50'
60 X'2d' X'f0' X'2d' X'2d'
61 X'3a' X'f0' X'3a' X'3a'
62 X'3d' X'f0' X'3d' X'3d'
64 X'40' X'f0' X'40' X'40'
75 X'5c' X'f0' X'5c' X'5c'
76 X'5b' X'f0' X'5b' X'5b'
77 X'5a' X'f0' X'5a' X'5a'
78 X'2b' X'f0' X'2b' X'2b'
79 X'3e' X'f0' X'3e' X'3e'
80 X'4b' X'f0' X'4b' X'4b'
81 X'1e' X'f0' X'1e' X'1e'
82 X'7b' X'f0' X'7b' X'7b'

Chapter 21. POS keyboard layouts and scan codes 433

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
83 X'2e' X'f0' X'2e' X'2e'
84 X'3b' X'f0' X'3b' X'3b'
85 X'8f' X'f0' X'8f' X'8f'
86 X'1f' X'f0' X'1f' X'1f'
87 X'7e' X'f0' X'7e' X'7e'
88 X'7f' X'f0' X'7f' X'7f'
89 X'3c' X'f0' X'3c' X'3c'
90 X'9b' X'f0' X'9b' X'9b'
91 X'6b' X'f0' X'6b' X'6b'
92 X'0b' X'f0' X'0b' X'0b'
93 X'8b' X'f0' X'8b' X'8b'
94 X'bb' X'f0' X'bb' X'bb'
95 X'9c' X'f0' X'9c' X'9c'
96 X'6c' X'f0' X'6c' X'6c'
97 X'0c' X'f0' X'0c' X'0c'
98 X'8c' X'f0' X'8c' X'8c'
99 X'bc' X'f0' X'bc' X'bc'
100 X'ae' X'f0' X'ae' X'ae'
101 X'6f' X'f0' X'6f' X'6f'
102 X'0f' X'f0' X'0f' X'0f'
103 X'5f' X'f0' X'5f' X'5f'
104 X'4f' X'f0' X'4f' X'4f'
105 X'3f' X'f0' X'3f' X'3f'
106 X'6e' X'f0' X'6e' X'6e'
107 X'0e' X'f0' X'0e' X'0e'
108 X'8e' X'f0' X'8e' X'8e'
109 X'be' X'f0' X'be' X'be'
110 X'21' X'f0' X'21' X'21'
112 X'52' X'f0' X'52' X'52'
113 X'53' X'f0' X'53' X'53'
114 X'32' X'f0' X'32' X'32'
115 X'23' X'f0' X'23' X'23'

434 UnifiedPOS User's Guide

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
116 X'2a' X'f0' X'2a' X'2a'
117 X'28' X'f0' X'28' X'28'
118 X'08' X'f0' X'08' X'08'
119 X'56' X'f0' X'56' X'56'
120 X'07' X'f0' X'07' X'07'
121 X'1a' X'f0' X'1a' X'1a'
122 X'1b' X'f0' X'1b' X'1b'
123 X'1c' X'f0' X'1c' X'1c'
124 X'1d' X'f0' X'1d' X'1d'
125 X'6d' X'f0' X'6d' X'6d'
126 X'4e' X'f0' X'4e' X'4e'
127 X'4c' X'f0' X'4c' X'4c'
128 X'9e' X'f0' X'9e' X'9e'
131 X'31' X'f0' X'31' X'31' ANKPOS (see Notes)
132 X'26' X'f0' X'26' X'26' ANKPOS (see Notes)
133 X'36' X'f0' X'36' X'36' ANKPOS (see Notes)
135 X'8d' X'f0' X'8d' X'8d'
136 X'ac' X'f0' X'ac' X'ac'
137 X'ab' X'f0' X'ab' X'ab'
138 X'af' X'f0' X'af' X'af'
139 X'bf' X'f0' X'bf' X'bf'
ANKPOS Keylock in system position
+ Left Ctrl Case
Pressed
124 (S2) X'f0' X'50' X'01' X'01' Key press only (ANKPOS
X'50' keylock in system
position)
135 (S1) X'f0' X'50' X'00' X'00' Key press only (ANKPOS
X'50' keylock in system
position)
ANKPOS Keylock in operator/manager position
+Right Ctrl Case
Pressed

Chapter 21. POS keyboard layouts and scan codes 435

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
124 (S2) X'f0' X'40' X'01' X'01' Key press only (ANKPOS
X'40' keylock in system
position)
135 (S1) X'f0' X'40' X'00' X'00' Key press only (ANKPOS
X'40' keylock in system
position)
+ Both Ctrl Case
Pressed
124 (S2) X'f0' X'40' X'f0' X'01' Key press only (ANKPOS
X'50' X'01' X'50' keylock in system
position)
135 (S1) X'f0' X'40' X'f0' X'00' Key press only (ANKPOS
X'50' X'00' X'50' keylock in system
position)
+ Left Ctrl Case
Pressed
124 (S2) X'f0' X'50' X'1d' X'1d' ANKPOS keylock
X'50' in operator/manager
position
135 (S1) X'f0' X'50' X'8d' X'8d' ANKPOS keylock
X'50' in operator/manager
position
+Right Ctrl Case
Pressed
124 (S2) X'f0' X'40' X'1d' X'1d' ANKPOS keylock
X'40' in operator/manager
position
135 (S1) X'f0' X'40' X'8d' X'8d' ANKPOS keylock
X'40' in operator/manager
position
+ Both Ctrl Case
Pressed
124 (S2) X'f0' X'40' X'f0' X'1d' ANKPOS keylock
X'50' X'1d' X'50' in operator/manager
position
135 (S1) X'f0' X'40' X'f0' X'8d' ANKPOS keylock
X'50' X'8d' X'50' in operator/manager
position

Notes:

436 UnifiedPOS User's Guide

ANKPOS
PC Point of Sale Keyboard unique keys. These keys are present only on the PC Point of
Sale (ANKPOS keyboard).

World Trade key

This key is present on all non-U.S. versions of the NANPOS keyboard, but not on the
ANKPOS keyboard.
Table 285 explains the scan codes received for the S1 and S2 function keys on the Retail
Alphanumeric Point of Sale Keyboard with Card Reader.
The S1 and S2 function keys send a series of scan codes on the Retail Alphanumeric Point of
Sale Keyboard with Card Reader. These function keys generate a break scan code for the Ctrl
key pressed (scan code 0x50 or 0x40 with PosKC_KEYUP flag set), a make scan code for the S1
or S2 key and then a make scan code for the Ctrl key pressed (scan code of 0x50 or 0x40 with
PosKC_KEYUP flag reset). The S1 and S2 function keys can only be accessed by pressing the Ctrl
key. With the Ctrl key pressed, key 135 represents the S1 function, and key 124 represents the S2
function.
No break scan codes are sent for the 0x00 or 0x01 scan codes.

Table 285. Point of Sale Scan Codes for Retail Alphanumeric Point of Sale Keyboard with Card
Reader
Key switch number Key type Ctrl + scan code
124 S2 X'01'
135 S1 X'00'

For the PC Point of Sale Keyboard, Table 286 shows the scan codes sent by the S1 and S2
function keys, depending upon the Keylock Positions.

Table 286. Serial I/O Scan Codes– PC Point of Sale Keyboard (ANKPOS) Keyboard
Key switch number Key type Ctrl + scan code Ctrl + scan code
(keylock in system (keylock in operator/
position) manager position)
124 S2 X'01' X'1D'
135 S1 X'00' X'8D'

USB scan code set for the Modular Compact Alphanumeric Point of
Sale Keyboard
Table 287. USB scan codes for Modular Compact Alphanumeric POS Keyboard
Key switch Hardware Hardware JavaPOS -
number make code break code POSKeyData Comments
1 X'51' X'f0' X'51' X'51'
2 X'11' X'f0' X'11' X'11'
3 X'12' X'f0' X'12' X'12'
4 X'13' X'f0' X'13' X'13'
5 X'14' X'f0' X'14' X'14'

Chapter 21. POS keyboard layouts and scan codes 437

Key switch Hardware Hardware JavaPOS -
number make code break code POSKeyData Comments
6 X'54' X'f0' X'54' X'54'
7 X'55' X'f0' X'55' X'55'
8 X'15' X'f0' X'15' X'15'
9 X'18' X'f0' X'18' X'18'
10 X'16' X'f0' X'16' X'16'
11 X'17' X'f0' X'17' X'17'
12 X'57' X'f0' X'57' X'57'
13 X'58' X'f0' X'58' X'58'
15 X'7a' X'f0' X'7a' X'7a'
16 X'71' X'f0' X'71' X'71'
17 X'61' X'f0' X'61' X'61'
18 X'62' X'f0' X'62' X'62'
19 X'63' X'f0' X'63' X'63'
20 X'64' X'f0' X'64' X'64'
21 X'74' X'f0' X'74' X'74'
22 X'75' X'f0' X'75' X'75'
23 X'65' X'f0' X'65' X'65'
24 X'68' X'f0' X'68' X'68'
25 X'66' X'f0' X'66' X'66'
26 X'67' X'f0' X'67' X'67'
27 X'77' X'f0' X'77' X'77'
28 X'78' X'f0' X'78' X'78'
30 X'72' X'f0' X'72' X'72'
31 X'81' X'f0' X'81' X'81'
32 X'82' X'f0' X'82' X'82'
33 X'83' X'f0' X'83' X'83'
34 X'84' X'f0' X'84' X'84'
35 X'24' X'f0' X'24' X'24'
36 X'25' X'f0' X'25' X'25'
37 X'85' X'f0' X'85' X'85'
38 X'88' X'f0' X'88' X'88'
39 X'86' X'f0' X'86' X'86'

438 UnifiedPOS User's Guide

Key switch Hardware Hardware JavaPOS -
number make code break code POSKeyData Comments
40 X'87' X'f0' X'87' X'87'
41 X'27' X'f0' X'27' X'27'
42 X'47' X'f0' X'47' X'47'
43 X'4a' X'f0' X'4a' X'4a'
44 X'79' X'f0' X'79' X'79'
46 X'41' X'f0' X'41' X'41'
47 X'42' X'f0' X'42' X'42'
48 X'43' X'f0' X'43' X'43'
49 X'44' X'f0' X'44' X'44'
50 X'34' X'f0' X'34' X'34'
51 X'35' X'f0' X'35' X'35'
52 X'45' X'f0' X'45' X'45'
53 X'48' X'f0' X'48' X'48'
54 X'46' X'f0' X'46' X'46'
55 X'37' X'f0' X'37' X'37'
57 X'49' X'f0' X'49' X'49'
58 X'50' X'f0' X'50' X'50'
60 X'2d' X'f0' X'2d' X'2d'
61 X'3a' X'f0' X'3a' X'3a'
62 X'3d' X'f0' X'3d' X'3d'
64 X'40' X'f0' X'40' X'40'
75 X'5c' X'f0' X'5c' X'5c'
76 X'5b' X'f0' X'5b' X'5b'
79 X'3e' X'f0' X'3e' X'3e'
80 X'4b' X'f0' X'4b' X'4b'
81 X'1e' X'f0' X'1e' X'1e'
83 X'2e' X'f0' X'2e' X'2e'
84 X'3b' X'f0' X'3b' X'3b'
85 X'8f' X'f0' X'8f' X'8f'
86 X'1f' X'f0' X'1f' X'1f'
89 X'3c' X'f0' X'3c' X'3c'
90 X'bf' X'f0' X'bf' X'bf'

Chapter 21. POS keyboard layouts and scan codes 439

Key switch Hardware Hardware JavaPOS -
number make code break code POSKeyData Comments
91 X'6b' X'f0' X'6b' X'6b'
92 X'0b' X'f0' X'0b' X'0b'
93 X'8b' X'f0' X'8b' X'8b'
95 X'4f' X'f0' X'4f' X'4f'
96 X'6c' X'f0' X'6c' X'6c'
97 X'0c' X'f0' X'0c' X'0c'
98 X'8c' X'f0' X'8c' X'8c'
99 X'bb' X'f0' X'bb' X'bb'
100 X'ae' X'f0' X'ae' X'ae'
101 X'6f' X'f0' X'6f' X'6f'
102 X'0f' X'f0' X'0f' X'0f'
103 X'5f' X'f0' X'5f ' X'5f'
104 X'9c' X'f0' X'9c' X'9c'
105 X'3f' X'f0' X'3f' X'3f'
106 X'6e' X'f0' X'6e' X'6e'
108 X'be' X'f0' X'be' X'be'
110 X'21' X'f0' X'21' X'21'
112 X'52' X'f0' X'52' X'52'
113 X'53' X'f0' X'53' X'53'
114 X'32' X'f0' X'32' X'32'
115 X'23' X'f0' X'23' X'23'
116 X'2a' X'f0' X'2a' X'2a'
117 X'28' X'f0' X'28' X'28'
118 X'08' X'f0' X'08' X'08'
119 X'56' X'f0' X'56' X'56'
120 X'07' X'f0' X'07' X'07'
121 X'1a' X'f0' X'1a' X'1a'
122 X'1b' X'f0' X'1b' X'1b'
123 X'1c' X'f0' X'1c' X'1c'
124 X'ac' X'f0' X'ac' X'ac'
125 X'ab' X'f0' X'ab' X'ab'
126 X'af' X'f0' X'af' X'af'

440 UnifiedPOS User's Guide

Key switch Hardware Hardware JavaPOS -
number make code break code POSKeyData Comments
P01 X'4c' X'f0' X'4c' X'4c'
P02 X'9e' X'f0' X'9e' X'9e'
P03 X'4b' X'f0' X'4b' X'4b'
P04 X'3b' X'f0' X'3b' X'3b'
P05 X'6b' X'f0' X'6f' X'6b'
P06 X'4c' X'f0' X'4c' X'4c'
P07 X'3c' X'f0' X'3c' X'3c'
P08 X'6c' X'f0' X'6c' X'6c'
P09 X'4f' X'f0' X'4f' X'4f'
P10 X'3f' X'f0' X'3f' X'3f'
P11 X'1d' X'f0' X'1d' X'1d'
P12 X'6f' X'f0' X'6f' X'6f'
P13 X'4e' X'f0' X'4e' X'4e'
P14 X'3e' X'f0' X'3e' X'3e'
P15 X'8d' X'f0' X'8d' X'8d'
P16 X'6e' X'f0' X'6e' X'6e'
P17 X'5a' X'f0' X'5a' X'5a'
P18 X'2b' X'f0' X'2b' X'2b'
P19 X'7b' X'f0' X'7b' X'7b'
P20 X'7e' X'f0' X'7e' X'7e'
P21 X'7f' X'f0' X'7f' X'7f'
P22 X'7c' X'f0' X'7c' X'7c'
P23 X'7d' X'f0' X'7d' X'7d'
P24 X'0d' X'f0' X'0d' X'0d'
P25 X'9b' X'f0' X'9b' X'9b'
P26 X'bc' X'f0' X'bc' X'bc'
P27 X'0e' X'f0' X'0e' X'0e'
P28 X'8e' X'f0' X'8e' X'8e'
P29 X'6d' X'f0' X'6d' X'6d'
P30 X'4e' X'f0' X'4e' X'4e'
P31 X'4d' X'f0' X'4d' X'4d'

Chapter 21. POS keyboard layouts and scan codes 441

Key switch Hardware Hardware JavaPOS -
number make code break code POSKeyData Comments
P32 X'3d' X'f0' X'3d' X'3d'

Retail Alphanumeric Point of Sale keyboard with card reader (PS/2 or USB
system attached)
This section contains illustrations of the layouts for the following keyboards:
• Retail Alphanumeric POSKeyboard with card reader (ANKPOS)
• Retail Alphanumeric POSKeyboard with card reader (NANPOS)
• Compact Alphanumeric POSKeyboard (CANPOS)
• Modular Alphanumeric POS Keyboard
• Modular Compact Alphanumeric POS Keyboard

Retail Alphanumeric Point of Sale with card reader or PC Point of

Sale keyboard (ANKPOS) layout keyboard
Figure 58 shows the layout and assigned key-switch numbers for the PC Point of Sale keyboard.
The numeric keypad location is shown in the shaded area of the illustration.

135 136 137 138 139

110 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 75 80 85 90 95 100 105

16 17 18 19 20 21 22 23 24 25 26 27 28 43 76 81 86 91 96 101 106

30 31 32 33 34 35 36 37 38 39 40 41 42 77 82 87 92 97 102 107

44 46 47 48 49 50 51 52 53 54 55 56 57 78 83 88 93 98 103 108

58 60 131 61 132 133 62 64 79 84 89 94 99 104 109

Figure 58. PC Point of Sale keyboard layout

Retail Alphanumeric Point of Sale with card reader (NANPOS)

layout keyboard
Figure 59 shows the layout and assigned key-switch numbers for the Retail Alphanumeric Point
of Sale Keyboard with Card Reader.

442 UnifiedPOS User's Guide

135 136 137 138 139

110 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128

1 2 3 4 5 6 7 8 9 10 11 12 13 14/15 75 80 85 90 95 100 105

16 17 18 19 20 21 22 23 24 25 26 27 28 43 76 81 86 91 96 101 106

30 31 32 33 34 35 36 37 38 39 40 41 42 77 82 87 92 97 102 107

44 45 46 47 48 49 50 51 52 53 54 55 56 57 78 83 88 93 98 103 108

58 60 61 62 64 79 84 89 94 99 104 109

Alternate Primary

Figure 59. Layout and assigned switch numbers

Note:
1. The two possible locations for the numeric keypad are shown in the shaded area of the
illustration. The default location for the numeric keypad is the right-most shaded area.
2. Key 45 appears as a single key only on non-U.S. keyboards. On U.S. keyboards, key 44 also
covers key 45 (key 44, 45 is a double key).
3. Keys 94 and 99 can have a single, horizontal double-wide key covering both keys, or they
can be split into two individual keys.
4. This keyboard is similar to the 101-enhanced keyboard and the 102-enhanced keyboard.
The following keys are on the Retail Alphanumeric Point of Sale Keyboard with Card
Reader, but not on the 101-enhanced keyboard or the 102-enhanced keyboard. These keys
are referred to as the point-of-sale-unique keys.

77
106

78
107

82
108

87
124

88
125

90
126

95
127

99
128

100
135

Chapter 21. POS keyboard layouts and scan codes 443

105

See Table 288 for the scan codes associated with these keys.

Modular Alphanumeric Point of Sale Keyboard

Figure 60 shows the layout and assigned key-switch numbers for the Modular Alphanumeric
Point of Sale Keyboard.

Figure 60. Layout and Assigned Switch Numbers for Modular ANPOS Keyboard

See Table 288 for the scan codes associated with these keys.

Compact Alphanumeric Point of Sale (CANPOS) layout keyboard

Figure 61 shows the layout and assigned key-switch numbers for the Compact Alphanumeric
Point of Sale keyboard with card reader.

444 UnifiedPOS User's Guide

Figure 61. Layout and assigned switch numbers for CANPOS keyboard

Note: See Table 289 for scan codes related to this keyboard.

Modular Compact Alphanumeric Point of Sale Keyboard Layout

Figure 62 shows the layout and assigned key-switch numbers for the Modular Compact
Alphanumeric Point of Sale Keyboard.

Chapter 21. POS keyboard layouts and scan codes 445

Figure 62. Modular CANPOS Keyboard Layout and Assigned Switch Numbers

Note: See Table 289 for scan codes related to this keyboard.

PS/2 or USB (System Attached) scan code set for Retail

Alphanumeric Point of Sale Keyboard (NANPOS), Modular
Alphanumeric Point of Sale Keyboard, PC Point of Sale Keyboard
(ANKPOS)
In Linux, Modular ANPOS Keyboard scan codes may not match those provided in the table
below until a configuration file is downloaded to the device. Follow the steps listed below to
download the configuration file:
• Copy the aip46043.cfg.winCompatibility file from /opt/tgcs/javapos/config to /usr/
share/pos/config/aip46043.cfg.
• Reboot the system.
Table 288 relates the keyboard key-switch number to the scan codes received when the keyboard
is attached to the system keyboard port.

Table 288. PS⁄2 or USB (system attached) scan codes

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
1 X'29' X'A9' X'29'

446 UnifiedPOS User's Guide

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
2 X'02' X'82' X'02'
3 X'03' X'83' X'03'
4 X'04' X'84' X'04'
5 X'05' X'85' X'05'
6 X'06' X'86' X'06'
7 X'07' X'87' X'07'
8 X'08' X'88' X'08'
9 X'09' X'89' X'09'
10 X'0a' X'8a' X'0a'
11 X'0b' X'8b' X'0b'
12 X'0c' X'8c' X'0c'
13 X'0d' X'8d' X'0d'
14 X'7d' X'fd' X'7d' ANKPOS only
15 X'0e' X'8e' X'0e'
16 X'0f' X'8f' X'0f'
17 X'10' X'90' X'10'
18 X'11' X'91' X'11'
19 X'12' X'92' X'12'
20 X'13' X'93' X'13'
21 X'14' X'94' X'14'
22 X'15' X'95' X'15'
23 X'16' X'96' X'16'
24 X'17' X'97' X'17'
25 X'18' X'98' X'18'
26 X'19' X'99' X'19'
27 X'1a' X'9a' X'1a'
28 X'1b' X'9b' X'1b'
30 X'3a' X'ba' X'3a'
31 X'1e' X'9e' X'1e'
32 X'1f' X'9f' X'1f'
33 X'20' X'a0' X'20'
34 X'21' X'a1' X'21'

Chapter 21. POS keyboard layouts and scan codes 447

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
35 X'22' X'a2' X'22'
36 X'23' X'a3' X'23'
37 X'24' X'a4' X'24'
38 X'25' X'a5' X'25'
39 X'26' X'a6' X'26'
40 X'27' X'a7' X'27'
41 X'28' X'a8' X'28'
42 X'2b' X'ab' X'2b'
43 X'1c' X'9c' X'1c'
44 X'2a' X'aa' X'2a'
45 X'56' X'd6' X'56' World Trade key
46 X'2c' X'ac' X'2c'
47 X'2d' X'ad' X'2d'
48 X'2e' X'ae' X'2e'
49 X'2f' X'af' X'2f'
50 X'30' X'b0' X'30'
51 X'31' X'b1' X'31'
52 X'32' X'b2' X'32'
53 X'33' X'b3' X'33'
54 X'34' X'b4' X'34'
55 X'35' X'b5' X'35'
56 X'73' X'f3' X'73' ANKPOS only
57 X'36' X'b6' X'36'
58 X'1d' X'9d' X'1d'
60 X'38' X'b8' X'38'
61 X'39' X'b9' X'39'
62 X'e0' X'38' X'e0' X'b8' X'01' X'38'
64 X'e0' X'1d' X'e0' X'9d' X'01' X'1d'
75 X'e0' X'52' X'e0' X'd2' X'01' X'52'
76 X'e0' X'53' X'e0' X'd3' X'01' X'53'
77 X'6a' X'ea' X'6a'
78 X'6b' X'eb' X'6b'

448 UnifiedPOS User's Guide

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
79 X'e0' X'4b' X'e0' X'cb' X'01' X'4b'
80 X'e0' X'47' X'e0' X'c7' X'01' X'47'
81 X'e0' X'4f' X'e0' X'cf' X'01' X'4f'
82 X'6c' X'ec' X'6c'
83 X'e0' X'48' X'e0' X'c8' X'01' X'48'
84 X'e0' X'50' X'e0' X'd0' X'01' X'50'
85 X'e0' X'49' X'e0' X'c9' X'01' X'49'
86 X'e0' X'51' X'e0' X'd1' X'01' X'51'
87 X'6d' X'ed' X'6d'
88 X'6e' X'ee' X'6e'
89 X'e0' X'4d' X'e0' X'cd' X'01' X'4d'
90 X'6f' X'ef' X'6f'
91 X'47' X'c7' X'47'
92 X'4b' X'cb' X'4b'
93 X'4f' X'cf' X'4f'
94 X'52' X'd2' X'52'
95 X'78' X'f8' X'78'
96 X'48' X'c8' X'48'
97 X'4c' X'cc' X'4c'
98 X'50' X'd0' X'50'
99 X'77' X'f7' X'52'
100 X'65' X'e5' X'65'
101 X'49' X'c9' X'49'
102 X'4d' X'cd' X'4d'
103 X'51' X'd1' X'51'
104 X'53' X'd3' X'53'
105 X'7a' X'fa' X'7a'
106 X'7e' X'fe' X'7e'
107 X'5f' X'df' X'5f' When using a USB
system keyboard with
the OPOS driver the
make code will be
reported as X'66', not
X'5f'.

Chapter 21. POS keyboard layouts and scan codes 449

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
108 X'71' X'f1' X'71'
109 X'e0' X'1c' X'e0' X'9c' X'01' X'1c'
110 X'01' X'81' X'01'
112 X'3b' X'bb' X'3b'
113 X'3c' X'bc' X'3c'
114 X'3d' X'bd' X'3d'
115 X'3e' X'be' X'3e'
116 X'3f' X'bf' X'3f'
117 X'40' X'c0' X'40'
118 X'41' X'c1' X'41'
119 X'42' X'c2' X'42'
120 X'43' X'c3' X'43'
121 X'44' X'c4' X'44'
122 X'57' X'd7' X'57'
123 X'58' X'd8' X'58'
124 X'63' X'e3' X'63'
125 X'74' X'f4' X'74'
126 X'75' X'f5' X'75'
127 X'76' X'f6' X'76'
128 X'59' X'd9' X'59'
131 X'7b' X'fb' X'7b' ANKPOS only
132 X'79' X'f9' X'79' ANKPOS only
133 X'70' X'f0' X'70' ANKPOS only
135 X'72' X'f2' X'72'
136 X'e0' X'2a' X'e0' X'e0' X'b7' X'e0' X'aa X'01' X'37' On Windows, key release
X'37' ' only
137 X'46' X'c6' X'46'
138 X'e1' X'1d' X'45' X'01'X'45' Key press only
X'e1' X'9d' X'c5'
139 X'45' X'c5' X'45'
+ Alt Case
136 X'54' X'd4' X'54' On Windows, key release
only

450 UnifiedPOS User's Guide

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
+ Ctrl Case
Pressed
136 X'e0' X'37' X'e0' X'b7' X'01' X'37' On Windows, key release
only
138 X'e0' X'46' X'e0' none
X'c6'
+ Left Ctrl Case
Pressed
124 X'9d' X'1c' X'1d' X'02' X'1c' Key press only
135 X'9d' X'01' X'1d' X'02' X'01' Key press only
+ Right Ctrl Case
Pressed
124 X'e0' X'9d' X'1c' X'02' X'1c' Key press only
X'e0' X'1d'
135 X'e0' X'9d' X'01' X'02'X'01' Key press only
X'e0' X'1d'
+ Both Ctrl Case
Pressed
124 X'e0' X'9d' X'02' X'1c' Key press only
X'9d' X'1c' X'e0'
X'1d'X'e0'X'1d'
135 X'e0' X'9d' X'02'X'01' Key press only
X'9d' X'01' X'e0'
X'1d'X'e0'X'1d'
+ Shift Case
Pressed
136 X'e0' X'37' X'e0' X'b7' X'01' X'37' On Windows, key release
only
+ Left Shift
Case Pressed,
NUMLOCK OFF
75 X'e0' X'aa' X'e0' X'e0' X'd2' X'e0' X'01' X'52'
X'52' X'2a'
76 X'e0' X'aa' X'e0' X'e0' X'd3' X'e0' X'01' X'53'
X'53' X'2a'
79 X'e0' X'aa' X'e0' X'e0' X'cb' X'e0' X'01' X'4b'
X'4b' X'2a'
80 X'e0' X'aa' X'e0' X'e0' X'c7' X'e0' X'01' X'47'
X'47' X'2a'

Chapter 21. POS keyboard layouts and scan codes 451

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
81 X'e0' X'aa' X'e0' X'e0' X'cf' X'e0' X'2a' X'01' X'4f'
X'4f'
83 X'e0' X'aa' X'e0' X'e0' X'c8' X'e0' X'01' X'48'
X'48' X'2a'
84 X'e0' X'aa' X'e0' X'e0' X'd0' X'e0' X'01' X'50'
X'50' X'2a'
85 X'e0' X'aa' X'e0' X'e0' X'c9' X'e0' X'01' X'49'
X'49' X'2a'
86 X'e0' X'aa' X'e0' X'e0' X'd1' X'e0' X'01' X'51'
X'51' X'2a'
89 X'e0' X'aa' X'e0' X'e0' X'cd' X'e0' X'01' X'4d'
X'4d' X'2a'
+ Right Shift
Case Pressed
NUMLOCK OFF
75 X'e0' X'b6' X'e0' X'e0' X'd2' X'e0' X'01' X'52'
X'52' X'36'
76 X'e0' X'b6' X'e0' X'e0' X'd3' X'e0' X'01' X'53'
X'53' X'36'
79 X'e0' X'b6' X'e0' X'e0' X'cb' X'e0' X'01' X'4b'
X'4b' X'36'
80 X'e0' X'b6' X'e0' X'e0' X'c7' X'e0' X'01' X'47'
X'47' X'36'
81 X'e0' X'b6' X'e0' X'e0' X'cf' X'e0' X'36' X'01' X'4f '
X'4f'
83 X'e0' X'b6' X'e0' X'e0' X'c8' X'e0' X'01' X'48'
X'48' X'36'
84 X'e0' X'b6' X'e0' X'e0' X'd0' X'e0' X'01' X'50'
X'50' X'36'
85 X'e0' X'b6' X'e0' X'e0' X'c9' X'e0' X'01' X'49'
X'49' X'36'
86 X'e0' X'b6' X'e0' X'e0' X'd1' X'e0' X'01' X'51'
X'51' X'36'
89 X'e0' X'b6' X'e0' X'e0' X'cd' X'e0' X'01' X'4d'
X'4d' X'36'
+ Both Shift
Case Pressed
NUMLOCK OFF
75 X'e0' X'aa' X'b6' X'e0' X'd2' X'e0' X'01' X'52'
X'e0' X'52' X'2a' X'e0' X'36'

452 UnifiedPOS User's Guide

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
76 X'e0' X'aa' X'b6' X'e0' X'd3' X'e0' X'01' X'53'
X'e0' X'53' X'2a' X'e0' X'36'
79 X'e0' X'aa' X'b6' X'e0' X'cb' X'e0' X'01' X'4b'
X'e0' X'4b' X'2a' X'e0' X'36'
81 X'e0' X'aa' X'b6' X'e0' X'cf' X'e0' X'2a' X'01' X'4f'
X'e0' X'4f' X'e0' X'36'
83 X'e0' X'aa' X'b6' X'e0' X'c8' X'e0' X'01' X'48'
X'e0' X'48' X'2a' X'e0' X'36'
84 X'e0' X'aa' X'b6' X'e0' X'd0' X'e0' X'01' X'50'
X'e0' X'50' X'2a' X'e0' X'36'
85 X'e0' X'aa' X'b6' X'e0' X'c9' X'e0' X'01' X'49'
X'e0' X'49' X'2a' X'e0' X'36'
86 X'e0' X'aa' X'b6' X'e0' X'd1' X'e0' X'01' X'51'
X'e0' X'51' X'2a' X'e0' X'36'
89 X'e0' X'aa' X'b6' X'e0' X'cd' X'e0' X'01' X'4d'
X'e0' X'4d' X'2a' X'e0' X'36'
+ Shift + NUM
LOCK ON
75 X'e0' X'52' X'e0' X'd2' X'01' X'52'
76 X'e0' X'53' X'e0' X'd3' X'01' X'53'
79 X'e0' X'4b' X'e0' X'cb' X'01' X'4b'
80 X'e0' X'47' X'e0' X'c7' X'01' X'47'
81 X'e0' X'4f' X'e0' X'cf' X'01' X'4f'
83 X'e0' X'48' X'e0' X'c8' X'01' X'48'
84 X'e0' X'50' X'e0' X'd0' X'01' X'50'
85 X'e0' X'49' X'e0' X'c9' X'01' X'49'
86 X'e0' X'51' X'e0' X'd1' X'01' X'51'
89 X'e0' X'4d' X'e0' X'cd' X'01' X'4d'
+ NUM LOCK ON
75 X'e0' X'2a' X'e0' X'e0' X'd2' X'e0' X'01' X'52'
X'52' X'aa'
76 X'e0' X'2a' X'e0' X'e0' X'd3' X'e0' X'01' X'53'
X'53' X'aa'
79 X'e0' X'2a' X'e0' X'e0' X'cb' X'e0' X'01' X'4b'
X'4b' X'aa'
80 X'e0' X'2a' X'e0' X'e0' X'c7' X'e0' X'01' X'47'
X'47' X'aa'

Chapter 21. POS keyboard layouts and scan codes 453

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
81 X'e0' X'2a' X'e0' X'e0' X'cf' X'e0' X'aa' X'01' X'4f'
X'4f'
83 X'e0' X'2a' X'e0' X'e0' X'c8' X'e0' X'01' X'48'
X'48' X'aa'
84 X'e0' X'2a' X'e0' X'e0' X'd0' X'e0' X'01' X'50'
X'50' X'aa'
85 X'e0' X'2a' X'e0' X'e0' X'c9' X'e0' X'01' X'49'
X'49' X'aa'
86 X'e0' X'2a' X'e0' X'e0' X'd1' X'e0' X'01' X'51'
X'51' X'aa'
89 X'e0' X'2a' X'e0' X'e0' X'cd' X'e0' X'01' X'4d'
X'4d' X'aa'

Notes:

ANKPOS
PC Point of Sale Keyboard unique keys. These keys are present only on the PC Point of
Sale (ANKPOS keyboard).

World Trade key

This key is present on all non-U.S. versions of the NANPOS keyboard, but not on the
ANKPOS keyboard.

Double keys
Key switch numbers 94 and 99 are defined as double keys.

PS/2 scan code set for the Compact Alphanumeric Point of

Sale Keyboard (CANPOS), PS/2 / USB (System Attached) Modular
Compact Alphanumeric Point of Sale Keyboard
Table 289 relates the keyboard key-switch number to the scan codes received when the keyboard
is attached to the system keyboard port.

Table 289. PS/2 or USB scan codes for CANPOS keyboard

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
1 X'29' X'A9' X'29'
2 X'02' X'82' X'02'
3 X'03' X'83' X'03'
4 X'04' X'84' X'04'
5 X'05' X'85' X'05'

454 UnifiedPOS User's Guide

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
6 X'06' X'86' X'06'
7 X'07' X'87' X'07'
8 X'08' X'88' X'08'
9 X'09' X'89' X'09'
10 X'0a' X'8a' X'0a'
11 X'0b' X'8b' X'0b'
12 X'0c' X'8c' X'0c'
13 X'0d' X'8d' X'0d'
15 X'0e' X'8e' X'0e'
16 X'0f' X'8f' X'0f'
17 X'10' X'90' X'10'
18 X'11' X'91' X'11'
19 X'12' X'92' X'12'
20 X'13' X'93' X'13'
21 X'14' X'94' X'14'
22 X'15' X'95' X'15'
23 X'16' X'96' X'16'
24 X'17' X'97' X'17'
25 X'18' X'98' X'18'
26 X'19' X'99' X'19'
27 X'1a' X'9a' X'1a'
28 X'1b' X'9b' X'1b'
29 X'2b' X'ab' X'2b'
30 X'3a' X'ba' X'3a'
31 X'1e' X'9e' X'1e'
32 X'1f' X'9f' X'1f'
33 X'20' X'a0' X'20'
34 X'21' X'a1' X'21'
35 X'22' X'a2' X'22'
36 X'23' X'a3' X'23'
37 X'24' X'a4' X'24'
38 X'25' X'a5' X'25'

Chapter 21. POS keyboard layouts and scan codes 455

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
39 X'26' X'a6' X'26'
40 X'27' X'a7' X'27'
41 X'28' X'a8' X'28'
42 X'2b' X'ab' X'2b'
43 X'1c' X'9c' X'1c'
44 X'2a' X'aa' X'2a'
45 X'56' X'd6' X'56'
46 X'2c' X'ac' X'2c'
47 X'2d' X'ad' X'2d'
48 X'2e' X'ae' X'2e'
49 X'2f' X'af' X'2f'
50 X'30' X'b0' X'30'
51 X'31' X'b1' X'31'
52 X'32' X'b2' X'32'
53 X'33' X'b3' X'33'
54 X'34' X'b4' X'34'
55 X'35' X'b5' X'35'
56 X'73' X'f3' X'73'
57 X'36' X'b6' X'36'
58 X'1d' X'9d' X'1d'
60 X'38' X'b8' X'38'
61 X'39' X'b9' X'39'
62 X'e0' X'38' X'e0' X'b8' X'01' X'38'
64 X'e0' X'1d' X'e0' X'9d' X'01' X'1d'
75 X'e0' X'52' X'e0' X'd2' X'01' X'52'
76 X'e0' X'53' X'e0' X'd3' X'01' X'53'
79 X'e0' X'4b' X'e0' X'cb' X'01' X'4b'
80 X'e0' X'47' X'e0' X'c7' X'01' X'47'
81 X'e0' X'4f' X'e0' X'cf' X'01' X'4f'
83 X'e0' X'48' X'e0' X'c8' X'01' X'48'
84 X'e0' X'50' X'e0' X'd0' X'01' X'50'
85 X'e0' X'49' X'e0' X'c9' X'01' X'49'

456 UnifiedPOS User's Guide

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
86 X'e0' X'51' X'e0' X'd1' X'01' X'51'
89 X'e0' X'4d' X'e0' X'cd' X'01' X'4d'
90 X'45' X'c5' X'45'
91 X'47' X'c7' X'47'
92 X'4b' X'cb' X'4b'
93 X'4f' X'cf' X'4f'
95 X'e0' X'35' X'e0' X'b5' X'01' X'35' See Note.
96 X'48' X'c8' X'48'
97 X'4c' X'cc' X'4c'
98 X'50' X'd0' X'50'
99 X'52' X'd2' X'52'
100 X'37' X'b7' X'37' See Note.
101 X'49' X'c9' X'49'
102 X'4d' X'cd' X'4d'
103 X'51' X'd1' X'51'
104 X'53' X'd3' X'53' See Note.
105 X'4a' X'ca' X'4a' See Note.
106 X'4e' X'ce' X'4e' See Note.
107 X'7e' X'fe' X'7e'
108 X'e0' X'1c' X'e0' X'9c' X'01' X'1c'
109 X'78' X'f8' X'78'
110 X'01' X'81' X'01'
112 X'3b' X'bb' X'3b'
113 X'3c' X'bc' X'3c'
114 X'3d' X'bd' X'3d'
115 X'3e' X'be' X'3e'
116 X'3f' X'bf' X'3f'
117 X'40' X'c0' X'40'
118 X'41' X'c1' X'41'
119 X'42' X'c2' X'42'
120 X'43' X'c3' X'43'
121 X'44' X'c4' X'44'

Chapter 21. POS keyboard layouts and scan codes 457

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
122 X'57' X'd7' X'57'
123 X'58' X'd8' X'58'
124 X'e0' X'2a' X'e0' X'e0' X'b7' X'e0' X'01' X'37' On Windows, key release
X'37' X'aa' only
125 X'46' X'c6' X'46'
126 X'e1' X'1d' X'45' X'01'X'45' Key press only
X'e1' X'9d' X'c5'
+ Alt Case
124 X'54' X'd4' X'54' On Windows, key release
only
+ Left or Right
Ctrl Pressed
126 X'e0' X'46' X'e0' none On Windows, key release
X'c6' only
+ Left Ctrl
or Shift Case
Pressed
124 X'e0' X'37' X'e0' X'b7' X'01' X'37' On Windows, key release
only
+ Right Ctrl
or Shift Case
Pressed
124 X'e0' X'37' X'e0' X'b7' X'01' X'37' On Windows, key release
only
+ Both Ctrl
or Shift Case
Pressed
124 X'e0' X'37' X'e0' X'b7' X'01' X'37' On Windows, key release
only
+ Left Shift Case
Pressed
75 X'e0' X'aa' X'e0' X'e0' X'd2' X'e0' X'01' X'52'
X'52' X'2a'
76 X'e0' X'aa' X'e0' X'e0' X'd3' X'e0' X'01' X'53'
X'53' X'2a'
79 X'e0' X'aa' X'e0' X'e0' X'cb' X'e0' X'01' X'4b'
X'4b' X'2a'
80 X'e0' X'aa' X'e0' X'e0' X'c7' X'e0' X'01' X'47'
X'47' X'2a'

458 UnifiedPOS User's Guide

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
81 X'e0' X'aa' X'e0' X'e0' X'cf' X'e0' X'01' X'4f '
X'4f' X'2a'
83 X'e0' X'aa' X'e0' X'e0' X'c8' X'e0' X'01' X'48'
X'48' X'2a'
84 X'e0' X'aa' X'e0' X'e0' X'd0' X'e0' X'01' X'50'
X'50' X'2a'
85 X'e0' X'aa' X'e0' X'e0' X'c9' X'e0' X'01' X'49'
X'49' X'2a'
86 X'e0' X'aa' X'e0' X'e0' X'd1' X'e0' X'01' X'51'
X'51' X'2a'
89 X'e0' X'aa' X'e0' X'e0' X'cd' X'e0' X'01' X'4d'
X'4d' X'2a'
124 X'e0' X'37' X'e0' X'b7' X'01' X'37' On Windows, key release
only
+ Right Shift Case
Pressed
75 X'e0' X'b6' X'e0' X'e0' X'd2' X'e0' X'01' X'52'
X'52' X'36'
76 X'e0' X'b6' X'e0' X'e0' X'd3' X'e0' X'01' X'53'
X'53' X'36'
79 X'e0' X'b6' X'e0' X'e0' X'cb' X'e0' X'01' X'4b'
X'4b' X'36'
80 X'e0' X'b6' X'e0' X'e0' X'c7' X'e0' X'01' X'47'
X'47' X'36'
81 X'e0' X'b6' X'e0' X'e0' X'cf' X'e0' X'01' X'4f'
X'4f' X'36'
83 X'e0' X'b6' X'e0' X'e0' X'c8' X'e0' X'01' X'48'
X'48' X'36'
84 X'e0' X'b6' X'e0' X'e0' X'd0' X'e0' X'01' X'50'
X'50' X'36'
85 X'e0' X'b6' X'e0' X'e0' X'c9' X'e0' X'01' X'49'
X'49' X'36'
86 X'e0' X'b6' X'e0' X'e0' X'd1' X'e0' X'01' X'51'
X'51' X'36'
89 X'e0' X'b6' X'e0' X'e0' X'cd' X'e0' X'01' X'4d'
X'4d' X'36'
124 X'e0' X'37' X'e0' X'b7' X'01' X'37' On Windows, key release
only

Chapter 21. POS keyboard layouts and scan codes 459

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
+ Both Shift Case
Pressed
75 X'e0' X'aa' X'b6' X'e0' X'd2' X'e0' X'01' X'52'
X'e0' X'52' X'2a' X'e0' X'36'
76 X'e0' X'aa' X'b6' X'e0' X'd3' X'e0' X'01' X'53'
X'e0' X'53' X'2a' X'e0' X'36'
79 X'e0' X'aa' X'b6' X'e0' X'cb' X'e0' X'01' X'4b'
X'e0' X'4b' X'2a' X'e0' X'36'
81 X'e0' X'aa' X'b6' X'e0' X'cf' X'e0' X'01' X'4f'
X'e0' X'4f' X'2a' X'e0' X'36'
83 X'e0' X'aa' X'b6' X'e0' X'c8' X'e0' X'01' X'48'
X'e0' X'48' X'2a' X'e0' X'36'
84 X'e0' X'aa' X'b6' X'e0' X'd0' X'e0' X'01' X'50'
X'e0' X'50' X'2a' X'e0' X'36'
85 X'e0' X'aa' X'b6' X'e0' X'c9' X'e0' X'01' X'49'
X'e0' X'49' X'2a' X'e0' X'36'
86 X'e0' X'aa' X'b6' X'e0' X'd1' X'e0' X'01' X'51'
X'e0' X'51' X'2a' X'e0' X'36'
89 X'e0' X'aa' X'b6' X'e0' X'cd' X'e0' X'01' X'4d'
X'e0' X'4d' X'2a' X'e0' X'36'
124 X'e0' X'37' X'e0' X'b7' X'01' X'37' On Windows, key release
only
+ Shift + NUM
LOCK ON
75 X'e0' X'52' X'e0' X'd2' X'01' X'52'
76 X'e0' X'53' X'e0' X'd3' X'01' X'53'
79 X'e0' X'4b' X'e0' X'cb' X'01' X'4b'
80 X'e0' X'47' X'e0' X'c7' X'01' X'47'
81 X'e0' X'4f' X'e0' X'cf' X'01' X'4f'
83 X'e0' X'48' X'e0' X'c8' X'01' X'48'
84 X'e0' X'50' X'e0' X'd0' X'01' X'50'
85 X'e0' X'49' X'e0' X'c9' X'01' X'49'
86 X'e0' X'51' X'e0' X'd1' X'01' X'51'
89 X'e0' X'4d' X'e0' X'cd' X'01' X'4d'
+ NUM LOCK
ON

460 UnifiedPOS User's Guide

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
75 X'e0' X'2a' X'e0' X'e0' X'd2' X'e0' X'01' X'52'
X'52' X'aa'
76 X'e0' X'2a' X'e0' X'e0' X'd3' X'e0' X'01' X'53'
X'53' X'aa'
79 X'e0' X'2a' X'e0' X'e0' X'cb' X'e0' X'01' X'4b'
X'4b' X'aa'
80 X'e0' X'2a' X'e0' X'e0' X'c7' X'e0' X'01' X'47'
X'47' X'aa'
81 X'e0' X'2a' X'e0' X'e0' X'cf' X'e0' X'01' X'4f'
X'4f' X'aa'
83 X'e0' X'2a' X'e0' X'e0' X'c8' X'e0' X'01' X'48 '
X'48' X'aa'
84 X'e0' X'2a' X'e0' X'e0' X'd0' X'e0' X'01' X'50'
X'50' X'aa'
85 X'e0' X'2a' X'e0' X'e0' X'c9' X'e0' X'01' X'49'
X'49' X'aa'
86 X'e0' X'2a' X'e0' X'e0' X'd1' X'e0' X'01' X'51'
X'51' X'aa'
89 X'e0' X'2a' X'e0' X'e0' X'cd' X'e0' X'01' X'4d'
X'4d' X'aa'
Programmable
Keys 201 - 232
201 X'e0' X'0b' X'e0' X'8b' X'01' X'0b'
202 X'e0' X'02' X'e0' X'82' X'01' X'02'
203 X'e0' X'03' X'e0' X'83' X'01' X'03'
204 X'e0' X'04' X'e0' X'84' X'01' X'04'
205 X'e0' X'05' X'e0' X'85' X'01' X'05'
206 X'e0' X'06' X'e0' X'86' X'01' X'06'
207 X'e0' X'07' X'e0' X'87' X'01' X'07'
208 X'e0' X'08' X'e0' X'88' X'01' X'08'
209 X'e0' X'09' X'e0' X'89' X'01' X'09'
210 X'e0' X'0a' X'e0' X'8a' X'01' X'0a'
211 X'e0' X'1e' X'e0' X'9e' X'01' X'1e'
212 X'e0' X'30' X'e0' X'b0' X'01' X'30'
213 X'e0' X'2e' X'e0' X'ae' X'01' X'2e'
214 X'e0' X'20' X'e0' X'a0' X'01' X'20'

Chapter 21. POS keyboard layouts and scan codes 461

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
215 X'e0' X'12' X'e0' X'92' X'01' X'12'
216 X'e0' X'21' X'e0' X'a1' X'01' X'21'
217 X'e0' X'22' X'e0' X'a2' X'01' X'22'
218 X'e0' X'23' X'e0' X'a3' X'01' X'23'
219 X'e0' X'17' X'e0' X'97' X'01' X'17'
220 X'e0' X'24' X'e0' X'a4' X'01' X'24'
221 X'e0' X'25' X'e0' X'a5' X'01' X'25'
222 X'e0' X'26' X'e0' X'a6' X'01' X'26'
223 X'e0' X'32' X'e0' X'b2' X'01' X'32'
224 X'e0' X'31' X'e0' X'b1' X'01' X'31'
225 X'e0' X'18' X'e0' X'98' X'01' X'18'
226 X'e0' X'19' X'e0' X'99' X'01' X'19'
227 X'e0' X'10' X'e0' X'90' X'01' X'10'
228 X'e0' X'13' X'e0' X'93' X'01' X'13'
229 X'e0' X'1f' X'e0' X'9f' X'01' X'1f'
230 X'e0' X'14' X'e0' X'94' X'01' X'14'
231 X'e0' X'16' X'e0' X'96' X'01' X'16'
232 X'e0' X'2f' X'e0' X'af' X'01' X'2f '

Note: Linux: When connected as USB System, the Modular CANPOS Keyboard will return the
following JavaPOS POS key data for the following keys:
Key 95 - X'53'
Key 100 - X'65'
Key 104 - X'78'''
Key 105 - X'7a'''
Key 106 - X'7e'

Point of Sale Keyboard V

Figure 63 shows the Keyboard V layout.

462 UnifiedPOS User's Guide

Figure 63. Point of Sale Keyboard V layout

Note:
1. The single asterisk (*) in the top-left portion of the keyboard indicates the S1 key.
2. The double asterisk (**) in the top-left portion of the keyboard indicates the S2 key.
3. The triple asterisk (***) indicates that a 1×5 dummy cap covers those key switches.
4. The two possible locations for the numeric keypad are shown in the shaded area of the
illustration. The default location for the numeric keypad is the right-most shaded area.

Keyboard V scan codes

Figure 64 shows the key scan codes for the Keyboard-V.

Figure 64. Keyboard-V scan code set

Note:
1. ‘( )’ indicates that these scan codes can be generated when the layout is changed.
2. ‘{ }’ indicates these scan codes will be generated only when the keylock is in the system
position.
3. Each double key produces only one scan code (the key scan code without parentheses in the
illustration), unlike the single-byte character set (SBCS) keyboards.
4. Return only make scan codes.

PLU Keyboard and Display III

Figure 65 shows the PLU Keyboard and Display-III layout and scan codes.
The two possible locations for the numeric keypad are shaded in Figure 65. The default location
for the numeric keypad is the right-most shaded area.

Chapter 21. POS keyboard layouts and scan codes 463

7F 7E 7D 79 78 77 7C 7B 7A 76 75 74 73 72 71 70

6F 6E 6D 69 68 67 6C 6B 6A 66 65 64 63 62 61 60

5F 5E 5D 59 58 57 5C 5B 5A 56 55 54 53 52 51 50

4F 4E 4D 49 48 47 4C 4B 4A 46 45 (44) 43 42 41 40

3F 3E 3D 39 38 37 3C 3B 3A (36) 35 34 33 (32) 31 30

2F 2E 2D 29 28 27 2C 2B 2A 26 25 24 23 22 21 20

1F 1E 1D 19 18 17 1C 1B (1A) (16) 15 14 13 12 (11) (10)

0F 0E 0D 09 08 07 0C 0B 0A 06 05 (04) 03 02 01 00

Figure 65. PLU Keyboard and Display-III layout

Note:
1. “( )” indicates that these scan codes can be generated when the layout is changed.
2. Each double key produces only one scan code (the key scan code without parentheses in the
illustration), unlike the single-byte character set keyboards.
3. Return only make scan codes.
4. Only double keys are shown in the figure.

4674 Point of Sale Keyboard (built-in)

Figure 66 shows the layout of the keyboard.

*** *** *

**
7 8 9

4 5 6

1 2 3

0 00

Figure 66. 4674 Point of Sale Keyboard (built-in)

Note:
1. A single asterisk (*) indicates the S1 key.
2. Double asterisks (**) indicate the S2 key.
3. Triple asterisks (***) indicates that a 1×5 dummy cap covers those key switches.

4674 POS Keyboard (built-in) scan codes

Figure 67 provides the scan codes.

464 UnifiedPOS User's Guide

6Ah 69h 68h 67h 66h 65h 64h 63h 62h 6Fh 6Eh 6Dh

5Ah 59h 58h 57h 56h 55h 54h 53h 52h 5Fh 5Eh 5Dh

4Ah 49h 48h 47h 46h 45h 44h 43h 42h 4Fh 4Eh 4Dh
(00)

3Ah 39h 38h 37h 36h 35h 34h 33h 32h 3Fh 3Eh 3Dh
(01)

2Ah 29h 28h 27h 26h 25h 24h 23h 22h 2Fh 2Eh 2Dh

1Ah 19h 18h 17h 16h 15h 14h 13h 12h 1Fh 1Eh 1Dh

0Ah 09h 08h 07h 06h 05h 04h 03h 02h 0Fh 0Eh 0Dh

Figure 67. Scan codes for 4674 built-in keyboard

xxh
Indicates scan codes that are generated in the default keyboard configuration

()
Indicates scan codes that are generated only when the keylock is in the System position.
Note: Return only make scan codes.

4685 keyboards
This section describes all of the 4685 keyboards.
All 4685 keyboards return only make scan codes.

4685 Point of Sale Keyboard Model K01

Figure 68 shows the layout of the 4685 Keyboard Model K01.

***

*** *** *

**
7 8 9

4 5 6

1 2 3

0 00

Figure 68. 4685 Point of Sale Keyboard Model K01 layout

Note:
1. The numeric keypad location is shaded in the illustration.
2. The single asterisk (*) in the middle-right portion of the keyboard indicates the S1 key.
3. The double asterisk (**) in the middle-right portion of the keyboard indicates the S2 key.

Chapter 21. POS keyboard layouts and scan codes 465

4. The triple asterisk (***) indicates that a 1×5 dummy cap covers those key switches.

4685 Keyboard Model K01 scan code set

Figure 69 shows the key scan codes for the 4685 Keyboard Model K01.

6B 6A 69 68 67 66 65 64 63 62 6F 6E 6D

***
5B 5A 59 58 57 56 55 54 53 52 5F 5E 5D

*** *** *
4B 4A 49 48 47 46 45 44 43 42 4F 4E 4D
(00)
**
3B 3A 39 38 37 36 35 34 33 32 3F 3E 3D
(01)

2B 2A 29 28 27 26 25 24 23 22 2F 2E 2D

1B 1A 19 18 17 16 15 14 13 12 1F 1E 1D

0B 0A 09 08 07 06 05 04 03 02 0F 0E 0D

Figure 69. 4685 Keyboard Model K01 scan code set

Note:
1. “( )” indicates these scan codes will be generated only when the keylock is in the “system”
position.
2. Each double key produces only one scan code.
3. The single asterisk (*) in the middle-right portion of the keyboard indicates the S1 key.
4. The double asterisk (**) in the middle-right portion of the keyboard indicates the S2 key.
5. The triple asterisk (***) indicates that a 1×5 dummy cap covers those key switches.

4685 Keyboard K02 Ultra 7 (four-position keylock)

Figure 70 shows the layout of the keyboard.

***

*** *** *

**
7 8 9

4 5 6

1 2 3

0 00

Figure 70. 4685 Keyboard K02 Ultra 7 with 4-position keylock

Note:
1. A single asterisk (*) indicates the S1 key.
2. Double asterisks (**) indicate the S2 key.

466 UnifiedPOS User's Guide

3. Triple asterisks (***) indicate dummy keys.

4685 Keyboard K02 Ultra 7 scan codes

Figure 71 shows the scan codes for the 4685 Keyboard K02 Ultra 7.

6Ch 6Bh 6Ah 69h 68h 67h 66h 65h 64h 63h 62h 6Fh 6Eh 6Dh

5Ch 5Bh 5Ah 59h 58h 57h 56h 55h 54h 53h 52h 5Fh 5Eh 5Dh

4Ch 4Bh 4Ah 49h 48h 47h 46h 45h 44h 43h 42h 4Fh 4Eh 4Dh
(00)

3Ch 3Bh 3Ah 39h 38h <37h> 36h 35h 34h 33h 32h 3Fh 3Eh 3Dh
(01)

2Ch 2Bh 2Ah 29h 28h 27h 26h 25h 24h 23h 22h 2Fh 2Eh 2Dh

1Ch 1Bh 1Ah 19h <18h> <17h> 16h 15h 14h 13h 12h 1Fh 1Eh 1Dh

0Ch 0Bh 0Ah 09h 08h 07h 06h 05h 04h 03h 02h 0Fh 0Eh 0Dh

Figure 71. 4685 Keyboard K02 Ultra 7 scan codes

Note:
1. < > indicates these are dummy keys at default
2. ( ) indicates scan codes that are generated only when the keylock is in the System position.

4685 Keyboard Model K02 Ultra 7 with MSR/E (four or six position
keylock)
Figure 72 shows the layout of the keyboard.

*** *** *

**
7 8 9

4 5 6

1 2 3

0 00

Figure 72. 4685 Keyboard K02 Ultra 7 with MSR/E (4 or 6 position keylock)

Note:
1. A single asterisk (*) indicates the S1 key.
2. Double asterisks (**) indicate the S2 key.
3. Triple asterisks (***) indicate dummy keys.

Chapter 21. POS keyboard layouts and scan codes 467

4685 Keyboard K02 Ultra 7 with MSR/E scan codes
Figure 73 provides the scan codes.

6Ch 6Bh 6Ah 69h 68h 67h 66h 65h 64h 63h 62h 6Fh 6Eh 6Dh

5Ch 5Bh 5Ah 59h 58h 57h 56h 55h 54h 53h 52h 5Fh 5Eh 5Dh

4Ch 4Bh 4Ah 49h 48h 47h 46h 45h 44h 43h 42h 4Fh 4Eh 4Dh
(00)

3Ch 3Bh 3Ah 39h 38h 37h 36h 35h 34h 33h 32h 3Fh 3Eh 3Dh
(01)

2Ch 2Bh 2Ah 29h 28h 27h 26h 25h 24h 23h 22h 2Fh 2Eh 2Dh

1Ch 1Bh 1Ah 19h 18h 17h 16h 15h 14h 13h 12h 1Fh 1Eh 1Dh

0Ch 0Bh 0Ah 09h 08h 07h 06h 05h 04h 03h 02h 0Fh 0Eh 0Dh

Figure 73. 4685 Keyboard K02 Ultra 7 with MSR/E scan codes

xxh
Indicates scan codes that are generated in the default keyboard configuration

()
Indicates scan codes that are generated only when the keylock is in the System position.

4685 Keyboard Model KC1

Figure 74 shows the keyboard layout.

* ***

*
7 8 9

4 5 6

1 2 3

0 00

Figure 74. 4685 Model KC1

Note:
1. A single asterisk (*) indicates the S1 key.
2. Double asterisks (**) indicate the S2 key.
3. Triple asterisks (***) indicate dummy keys.

4685 Keyboard Model KC1 scan codes

Figure 75 provides the scan codes.

468 UnifiedPOS User's Guide

4Ch 4Fh 4Eh 4Dh 49h 48h 47h 4Bh 4Ah 46h 45h 44h 43h 42h 41h 40h 50h
(00)
3Ch
3Fh 3Eh 3Dh 39h 38h 37h 3Bh 3Ah 36h 35h 34h 33h 32h 31h 30h 51h
(00)

2Ch 2Fh 2Eh 2Dh 29h 28h 27h 2Bh 2Ah 26h 25h 24h 23h 22h 21h 20h 52h

1Ch 1Fh 1Eh 1Dh 19h 18h 17h 1Bh 1Ah 16h 15h 14h 13h 12h 11h 10h 53h

0Ch 0Fh 0Eh 0Dh 09h 08h 07h 0Bh 0Ah 06h 05h 04h 03h 02h 81h 80h 54h

Figure 75. Scan codes for Model 4685-KC1

xxh
Indicates scan codes that are generated in the default keyboard configuration

()
Indicates scan codes that are generated only when the keylock is in the System position.

4685 Keyboard Model K03

Figure 76 shows the layout of the keyboard.
*

**

*** ***

7 8 9

4 5 6

1 2 3

0 00

Figure 76. 4685 Keyboard Model K03 layout

Note:
1. A single asterisk (*) indicates the S1 key.
2. Double asterisks (**) indicate the S2 key.
3. Triple asterisks (***) indicate dummy keys.

4685 Keyboard Model K03 scan codes

Figure 77 provides the scan codes.

Chapter 21. POS keyboard layouts and scan codes 469

0x6A 0x69 0x68 0x67 0x66 0x62 0x6E 0x6D
0x65 0x64 0x63 0x6F
(0x00)

0x5A 0x59 0x58 0x57 0x56 0x54 0x53 0x52 0x5F 0x5E 0x5D
0x55
(0x01)

0x4A 0x49 0x48 0x47 <0x46> 0x45 <0x44> 0x43 <0x42> 0x4F 0x4E 0x4D

0x3A 0x39 0x38 0x37 <0x36> 0x35 0x34 0x33 <0x32> <0x3F> 0x3E 0x3D

0x2A 0x29 0x28 0x27 <0x26> 0x25 0x24 0x23 <0x22> 0x2F 0x2E 0x2D

0x1A 0x19 0x18 0x17 <0x16> 0x15 0x14 0x13 <0x12> <0x1F> <0x1E> <0x1D>

0x0A 0x09 0x08 0x07 <0x06> 0x05 0x04 0x03 <0x02> 0x0F 0x0E 0x0D

Figure 77. 4685 Keyboard Model K03 scan codes

Note:
1. <> indicates these are dummy keys at default.
2. () indicates scan codes that are generated only when the keylock is in the System position.
3. RS-485 connectivity returns only make scan codes.

4820 Toshiba SurePoint Solution Keypad

Figure 78 shows the layout of the key-switch numbers for the 4820 Keypad.

1 2 3 4*

5 6 7 8**

9 10 11 12

13 14 15 16

21 22 23 24

25 26 27 28

29 30 31 32

33 34 35 36

Figure 78. 4820 Keypad key-switch layout

Note:
1. A single asterisk (*) indicates the S1 key.
2. Double asterisks (**) indicate the S2 key.
Table 290 relates the keyboard key-switch number to the scan codes received when the keyboard
is attached to the RS-485 or USB port.

470 UnifiedPOS User's Guide

Table 290. 4820 RS-485/USB Toshiba SurePoint Solution keypad scan codes
Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
1 X'4b' X'f0' X'4b' X'4b'
2 X'3b' X'f0' X'3b' X'3b'
3 X'6b' X'f0' X'6b' X'6b'
4 X'8b' X'f0' X'8b' X'8b' This is the S1 key
5 X'4c' X'f0' X'4c' X'4c'
6 X'3c' X'f0' X'3c' X'3c'
7 X'6c' X'f0' X'6c' X'6c'
8 X'8c' X'f0' X'8c' X'8c' This is the S2 key.
9 X'4f' X'f0' X'4f' X'4f'
10 X'3f' X'f0' X'3f' X'3f'
11 X'6f' X'f0' X'6f' X'6f'
12 X'8f' X'f0' X'8f' X'8f'
13 X'4e' X'f0' X'4e' X'4e'
14 X'3e' X'f0' X'3e' X'3e'
15 X'6e' X'f0' X'6e' X'6e'
16 X'8e' X'f0' X'8e' X'8e'
21 X'7c' X'f0' X'7c' X'7c'
22 X'0c' X'f0' X'0c' X'0c'
23 X'1c' X'f0' X'1c' X'1c'
24 X'50' X'f0' X'50' X'50'
25 X'7f' X'f0' X'7f' X'7f'
26 X'0f' X'f0' X'0f' X'0f'
27 X'1f' X'f0' X'1f' X'1f'
28 X'9f' X'f0' X'9f' X'9f'
29 X'7e' X'f0' X'7e' X'7e'
30 X'0e' X'f0' X'0e' X'0e'
31 X'1e' X'f0' X'1e' X'1e'
32 X'9e' X'f0' X'9e' X'9e'
33 X'7d' X'f0' X'7d' X'7d'
34 X'0d' X'f0' X'0d' X'0d'
35 X'1d' X'f0' X'1d' X'1d'

Chapter 21. POS keyboard layouts and scan codes 471

Key switch Hardware make Hardware break JavaPOS - POSKeyData Comments
number code code
36 X'9d' X'f0' X'9d' X'9d'
+ Ctrl Case Pressed
4 X'f0' X'50' X'00' X'00' Key press only
X'50'
8 X'f0' X'50' X'01' X'01' Key press only
X'50'

4820 Toshiba SurePoint Solution Keypad (system-attached)

Figure 79 shows the layout of the key-switch numbers for the 4820 Keypad.

1 2 3 4*

5 6 7 8**

9 10 11 12

13 14 15 16

21 22 23 24

25 26 27 28

29 30 31 32

33 34 35 36

Figure 79. 4820 Keypad (system-attached) key-switch layout

Table 291 relates the keyboard key-switch number to the scan codes received when the keyboard
is attached to the system keyboard port.

Table 291. 4820 Toshiba SurePoint Solution Keypad (system-attached) scan codes
Key switch Hardware make code Hardware break code JavaPOS - POSKeyData
number
1 X'3b' X'bb' X'3b'
2 X'3c' X'bc' X'3c'
3 X'3d' X'bd' X'3d'
4 X'3e' X'be' X'3e'

472 UnifiedPOS User's Guide

Key switch Hardware make code Hardware break code JavaPOS - POSKeyData
number
5 X'3f' X'bf' X'3f'
6 X'40' X'c0' X'40'
7 X'41' X'c1' X'41'
8 X'42' X'c2' X'42'
9 X'43' X'c3' X'43'
10 X'44' X'c4' X'44'
11 X'57' X'd7' X'57'
12 X'58' X'd8' X'58'
13 X'01' X'81' X'01'
14 X'4e' X'ce' X'4e'
15 X'4a' X'ca' X'4a'
16 X'0e' X'8e' X'0e'
21 X'47' X'c7' X'47'
22 X'48' X'c8' X'48'
23 X'49' X'c9' X'49'
24 X'1d' X'9d' X'1d'
25 X'4b' X'cb' X'4b'
26 X'4c' X'cc' X'4c'
27 X'4d' X'cd' X'4d'
28 X'38' X'b8' X'38'
29 X'4f' X'cf' X'4f'
30 X'50' X'd0' X'50'
31 X'51' X'd1' X'51'
32 X'39' X'b9' X'39'
33 X'52' X'd2' X'52'
34 X'e0' X'35' X'e0' X'b5' X'01' X'35'
35 X'37' X'b7' X'37'
36 X'e0' X'1c' X'e0' X'9c' X'01' X'1c'

SureOne model 4614/4615 and SurePOS 100 model 4613 keyboard (built-in)
SureOne supports only the 101-key layout.
SurePOS 100 supports 101-, 102-, and 103-key layouts.
Note:

Chapter 21. POS keyboard layouts and scan codes 473

1. When the keyboard is configured to be in POS mode, the application program must use
standard PC Keyboard interfaces to intercept the keystrokes (scan codes) and perform the
appropriate translation and detection.
2. JavaPOS does not support POS mode.
Figure 80 shows the layout of the key-switch numbers for the SureOne/SurePOS 100 keyboards.

Ins Home PgUp

Esc F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12
PrtScr ScrLk Pause
~ ! @ # $ % ^ & * ( ) _ +
Delete End PgDn
` 1 2 3 4 5 6 7 8 9 0 - =
| Bk
Tab Q W E R T Y U I O P \ Space 7 8 9

Cap : "
A S D F G H J K L ; 4 5 6
Lock '
Enter
< >
Shift Z X C V B N M , . 1 2 3

[ ] Pos ?
Ctrl Alt Space Alt Ctrl 0 .
Shift /

Figure 80. SureOne/SurePOS 100 keyboard (built-in) keyboard layout

SureOne model 4614/4615 and SurePOS 100 model 4613 keyboard

(built-in) scan codes
Figure 81 provides the key switch numbers for the SureOne/SurePOS 100 101-key keyboard.

474 UnifiedPOS User's Guide

Figure 81. SureOne/SurePOS 100 101-key keyboard switches

Figure 82 provides the key switch numbers for the SurePOS 100 102-key keyboard.

Chapter 21. POS keyboard layouts and scan codes 475

Figure 82. SurePOS 100 102-key keyboard switches

Figure 83 provides the key switch numbers for the SurePOS 100 103-key keyboard.

476 UnifiedPOS User's Guide

Figure 83. SurePOS 100 103-key keyboard switches

Table 292 shows the key scan codes for the SureOne and SurePOS 100 keyboards.

Table 292. SureOne/SurePOS 100 keyboard scan codes

Key switch Hardware make Hardware break JavaPOS - Comments
number code code POSKeyData
1 0x29 0xA9 0x29
2 0x02 0x82 0x02
3 0x03 0x83 0x03
4 0x04 0x84 0x04
5 0x05 0x85 0x05
6 0x06 0x86 0x06
7 0x07 0x87 0x07
8 0x08 0x88 0x08
9 0x09 0x89 0x09
10 0x0a 0x8a 0x0a
11 0x0b 0x8b 0x0b
12 0x0c 0x8c 0x0c

Chapter 21. POS keyboard layouts and scan codes 477

Key switch Hardware make Hardware break JavaPOS - Comments
number code code POSKeyData
13 0x0d 0x8d 0x0d
15 0x0e 0x8e 0x0e
16 0x0f 0x8f 0x0f
17 0x10 0x90 0x10
18 0x11 0x91 0x11
19 0x12 0x92 0x12
20 0x13 0x93 0x13
21 0x14 0x94 0x14
22 0x15 0x95 0x15
23 0x16 0x96 0x16
24 0x17 0x97 0x17
25 0x18 0x98 0x18
26 0x19 0x99 0x19
27 0x1a 0x9a 0x1a
28 0x1b 0x9b 0x1b
29 0x2b 0xab 0x2b
30 0x3a 0xba 0x3a
31 0x1e 0x9e 0x1e
32 0x1f 0x9f 0x1f
33 0x20 0xa0 0x20
34 0x21 0xa1 0x21
35 0x22 0xa2 0x22
36 0x23 0xa3 0x23
37 0x24 0xa4 0x24
38 0x25 0xa5 0x25
39 0x26 0xa6 0x26
40 0x27 0xa7 0x27
41 0x28 0xa8 0x28
43 0x1c 0x9c 0x1c
44 0x2a 0xaa 0x2a
46 0x2c 0xac 0x2c
47 0x2d 0xad 0x2d

478 UnifiedPOS User's Guide

Key switch Hardware make Hardware break JavaPOS - Comments
number code code POSKeyData
48 0x2e 0xae 0x2e
49 0x2f 0xaf 0x2f
50 0x30 0xb0 0x30
51 0x31 0xb1 0x31
52 0x32 0xb2 0x32
53 0x33 0xb3 0x33
54 0x34 0xb4 0x34
55 0x35 0xb5 0x35
58 0x1d 0x9d 0x1d
60 0x38 0xb8 0x38
61 0x39 0xb9 0x39
62 0xe0 0x38 0xe0 0xb8 0x01 0x38
64 0xe0 0x1d 0xe0 0x9d 0x01 0x1d
75 0xe0 0x52 0xe0 0xd2 0x01 0x52
76 0xe0 0x53 0xe0 0xd3 0x 010x53
79 0xe0 0x4b 0xe0 0xcb 0x01 0x4b
80 0xe0 0x47 0xe0 0xc7 0x01 0x47
81 0xe0 0x4f 0xe0 0xcf 0x01 0x4f
83 0xe0 0x48 0xe0 0xc8 0x01 0x48
84 0xe0 0x50 0xe0 0xd0 0x01 0x50
85 0xe0 0x49 0xe0 0xc9 0x01 0x49
86 0xe0 0x51 0xe0 0xd1 0x01 0x51
89 0xe0 0x4d 0xe0 0xcd 0x01 0x4d
91 0x47 0xc7 0x47
92 0x4b 0xcb 0x4b
93 0x4f 0xcf 0x4f
94 0x52 0xd2 0x52 Double "00"
disabled in BIOS
94 0x52 0x52 0xd2 0x52 SureOne:
Double'00'
enabled in BIOS
94 0x0b 0x8b 0x0b 0x0b(down) SurePOS 100:
0x8b 0x0b(up) Double'00'
enabled in BIOS

Chapter 21. POS keyboard layouts and scan codes 479

Key switch Hardware make Hardware break JavaPOS - Comments
number code code POSKeyData
0x0b(down)
0x0b(up)
96 0x48 0xc8 0x48
97 0x4c 0xcc 0x4c
98 0x50 0xd0 0x50
99 0x52 0xd2 0x52
101 0x49 0xc9 0x49
102 0x4d 0xcd 0x4d
103 0x51 0xd1 0x51
104 0x53 0xd3 0x53
110 0x01 0x81 0x01
112 0x3b 0xbb 0x3b
113 0x3c 0xbc 0x3c
114 0x3d 0xbd 0x3d
115 0x3e 0xbe 0x3e
116 0x3f 0xbf 0x3f
117 0x40 0xc0 0x40
118 0x41 0xc1 0x41
119 0x42 0xc2 0x42
120 0x43 0xc3 0x43
121 0x44 0xc4 0x44
122 0x57 0xd7 0x57
123 0x58 0xd8 0x58
Pos Shift + Ins 0xe0 0xb7 0xe0 0x0137 Key release only
0xaa
Pos Shift + 0x46 0xc6 0x46
Home
Pos Shift + PgUp 0xe1 0x1d 0x45 0x0145 Key press only
0xe1 0x9d 0xc5
Pos Shift + Esc 0xe1 0x1d 0x45 0x0145 Key press only
0xe1 0x9d 0xc5 (SurePOS 100
only)
+ Ins = (136-
PrtScr)

480 UnifiedPOS User's Guide

Key switch Hardware make Hardware break JavaPOS - Comments
number code code POSKeyData
(*1) Pos Shift 0xe0 0xb7 0xe0 0x0137 Key release only
0xaa
+ Home = (137-
ScrLk)
(*1) 0x46 0xc6 0x46
+ PgUp = (138-
pause)
(*1) 0xe1 0x1d 0x45 0x0145 Key press only
0xe1 0x9d 0xc5

Alphanumeric Point-of-Sale (NANPOS) country-dependent keyboards

The following pages illustrate the keyboards for all the supported NANPOS keyboards.

Canadian French keyboard layout

French keyboard layout

Chapter 21. POS keyboard layouts and scan codes 481

German keyboard layout

Italian keyboard layout

Spanish keyboard layout

482 UnifiedPOS User's Guide

U.K. English keyboard layout

U.S. English keyboard layout

Retail Alphanumeric Point of Sale country dependent keyboards

The following pages illustrate the keyboards for all the supported Retail Alphanumeric Point of
Sale Keyboards.

Chapter 21. POS keyboard layouts and scan codes 483

Brazil-Portuguese keyboard layout

Canadian French keyboard layout

484 UnifiedPOS User's Guide

Danish keyboard layout

French keyboard layout

Chapter 21. POS keyboard layouts and scan codes 485

German keyboard layout

Italian keyboard layout

486 UnifiedPOS User's Guide

Norwegian keyboard layout

/ Shift
7
{ AltGr

§ ! " # ¤ % & / ( ) = ?
½ 1 2 3 4 5 6 7 8 9 0 +
@ £ $ { [ ] }
Q W E R T Y U I O P Å
7 8 9
¨~
A S D F G H J K L Ö Ä *
’
4 5 6

> Z X C V B N M ; : —
< , . - 1 2 3

Alt AltGr 0 /

Spanish keyboard layout

Chapter 21. POS keyboard layouts and scan codes 487

Swedish and Finnish keyboard layout

U.K. English keyboard layout

488 UnifiedPOS User's Guide

U.S. English keyboard layout

Compact Alphanumeric Point-of-Sale (CANPOS) keyboard

This section describes the layout and assigned key-switch numbers for the CANPOS keyboards

CANPOS keyboards by country

This section describes the keyboard layout for the Compact Alphanumeric Point of Sale
(CANPOS) keyboard.

Scan code keyboard assignments

This section shows the CANPOS scan code keyboard assignment by country.

Chapter 21. POS keyboard layouts and scan codes 489

Brazilian keyboard

European keyboard

490 UnifiedPOS User's Guide

Japanese keyboard

U.S. English keyboard

Chapter 21. POS keyboard layouts and scan codes 491

CANPOS country-dependent keyboards
The following pages illustrate the keyboards for all the supported CANPOS keyboards.

Brazilian keyboard

492 UnifiedPOS User's Guide

European keyboard

Japanese keyboard

Chapter 21. POS keyboard layouts and scan codes 493

U.S. English keyboard

494 UnifiedPOS User's Guide

Chapter 22. Character sets for terminal printers and displays
Character sets for terminal printers and displays

This chapter contains the character sets used by Toshiba UnifiedPOS drivers.
Codepage definitions can be found on the following Toshiba website:

www.toshibacommerce.com

Code page implementations may differ across hardware; line displays and printers may not
implement characters in exactly the same way.

Table 293. Single-byte character set:

Code Page Name
101 OEM 7-Segment Alphanumeric font for Line Display
437 U.S. English
737 MSDOS GREEK
775 MS-DOS Baltic Rim
808 Cyrillic (with Euro)
813 ISO/IEC 8859-7 Latin/Greek alphabet
819 ISO/ANSI Multilingual
848 Ukrainian (with Euro)
850 Personal Computer - Multilingual
852 Latin-2 - PC
853 TURKISH PC-DATA
855 Cyrillic - PC
857 Latin #5, Turkey – PC
858 Personal Computer - Multilingual (with Euro)
860 Portugal - Personal Computer
861 Iceland - Personal Computer
862 Israel - Personal Computer
863 Canadian French - Personal Computer
864 Arabic - Personal Computer
865 Nordic - Personal Computer
866 PC Data, Cyrillic, Russian
867 Israel - Personal Computer
869 Greece - Personal Computer
872 Cyrillic - PC with euro

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 495

Code Page Name
874 Thai with Low Tone Marks & Ancient Chars - PC
912 ISO/IEC 8859-2 Latin alphabet No. 2
913 ISO/IEC 8859-3 Latin alphabet No. 3
914 ISO/IEC 8859-4 Latin alphabet No. 4
915 ISO/IEC 8859-5 Latin/Cyrillic alphabet
916 ISO/IEC 8859-8 Latin/Hebrew alphabet
920 ISO/IEC 8859-9 Latin alphabet No. 5
921 ISO/IEC 8859-13 Latin alphabet No. 7 (Baltic Rim)
998 The ASCII character set, supporting the ASCII characters (see Note 1 on page 497)
999 The ANSI character set (see Note 1 on page 497)
1116 Estonia – Personal Computer
1117 Latvia – Personal Computer
1118 Lithuania– Personal Computer
1089 ISO/IEC 8859-6 Latin/Arabic alphabet
1250 Microsoft Windows - Central Europe
1251 Microsoft Windows - Cyrillic
1252 Microsoft Windows - Latin 1
1253 Microsoft Windows - Greek
1254 Microsoft Windows - Turkish
1255 Microsoft Windows - Hebrew
1256 Microsoft Windows - Arabic
1257 Microsoft Windows - Baltic
1258 Microsoft Windows - Vietnam

Table 294. Double-byte character set:

Code Page Name
926 Korean Hangul
932 Japanese Shift-JIS (see Note 3 on page 497)
936 Simplified Chinese
949 Korean Hangul (see Note 3 on page 497)
950 Traditional Chinese Big5 (see Note 3 on page 497)
951 Hong Kong Supplementary Character Set - 2004 (see Note 3 on page 497)
1361 Korean Johab

496 UnifiedPOS User's Guide

Code Page Name
1381 Simplified Chinese GB2312 (see Note 3 on page 497, and Note 4 on page 497

Note:
1. Defined by the UnifiedPOS Specification, located at https://www.omg.org/retail/unified-
pos.htm
2. See the “Character sets supported” section in each device chapter for the list of supported
code pages by device type.
3. Code pages 932, 949, 951 and 1381 are double-byte code pages that are made up of
one single-byte character set (SBCS) codepage and one double-byte character set (DBCS)
codepage.

Table 295. Codepages

Codepage Members
932 Toshiba SBCS codepage 897

Toshiba DBCS codepage 301

949 Toshiba SBCS codepage 1088

Toshiba DBCS codepage 951

950 Toshiba SBCS codepage 1114

Toshiba SBCS codepage 947

951 Microsoft DBCS codepage HKSCS (CP951)

1381 Toshiba SBCS codepage 1115

Toshiba DBCS codepage 1380

4. Code pages 950 and 1381 are supported, but are too large to document in this book.

Chapter 22. Character sets for terminal printers and displays 497
Code Page 101

LED 1X11 LINE DISPLAY CHARACTER SET AND EXPECTED OUTPUT

00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F
-
2
0 ¯
H
0 1 2 3 4 5 6 7 8 9 =
3 |¯| | ¯| ¯| | | |¯ |¯ ¯| |¯| |¯|
0 | | | |¯ ¯| ¯| ¯| |¯| | |¯| ¯| ¯
H ¯ ¯ ¯ ¯ ¯ ¯ ¯ ¯
A B C D E F G H I J L N O
4 |¯| | |¯ | |¯ |¯ |¯ | | | | |
0 |¯| |¯| | |¯| |¯ |¯ | | |¯| | | | | |¯| |¯|
H ¯ ¯ ¯ ¯ ¯ ¯ ¯ ¯
P Q R S T U Y _
5 |¯| |¯| |¯ | | | | |
0 |¯ ¯| |¯ ¯| |¯ | | ¯|
H ¯ ¯ ¯ ¯ ¯
a b c d e f g h i j l n o
6 |¯| | |¯ | |¯ |¯ |¯ | | | | |
0 |¯| |¯| | |¯| |¯ |¯ | | |¯| | | | | |¯| |¯|
H ¯ ¯ ¯ ¯ ¯ ¯ ¯ ¯
p q r s t u y
7 |¯| |¯| |¯ | | | | |
0 |¯ ¯| |¯ ¯| |¯ | | ¯|
H ¯ ¯ ¯ ¯

Figure 84. Code page 101 chart

498 UnifiedPOS User's Guide

Code Page 437

Chapter 22. Character sets for terminal printers and displays 499
Code Page 737

500 UnifiedPOS User's Guide

Code Page 775
HEX
DIGITS

1ST 0- 1- 2- 3- 4- 5- 6- 7- 8- 9- A- B- C- D- E- F-
2ND

-0 SM590000 SP010000 ND100000 SM050000 LP020000 SD130000 LP010000 LC120000 LE120000 LA320000 SF140000 SF020000 LA430000 LO120000 SP320000

-1 SS000000 SM630000 SP020000 ND010000 LA020000 LQ020000 LA010000 LQ010000 LU170000 LA510000 LI320000 SF150000 SF070000 LC210000 LS610000 SA020000

-2 SS010000 SM760000 SP040000 ND020000 LB020000 LR020000 LB010000 LR010000 LE110000 LA520000 LO110000 SF160000 SF060000 LE430000 LO320000 SP210000

-3 SS020000 SP330000 SM010000 ND030000 LC020000 LS020000 LC010000 LS010000 LA310000 LO310000 LZ300000 SF110000 SF080000 LE290000 LN120000 NF050000

-4 SS030000 SM250000 SC030000 ND040000 LD020000 LT020000 LD010000 LT010000 LA170000 LO170000 LZ290000 SF090000 SF100000 LI430000 LO190000 SM250000

-5 SS040000 SM240000 SM020000 ND050000 LE020000 LU020000 LE010000 LU010000 LG410000 LG420000 LZ110000 LA440000 SF050000 LS210000 LO200000 SM240000

-6 SS050000 SM700000 SM030000 ND060000 LF020000 LV020000 LF010000 LV010000 LA270000 SC040000 SP220000 LC220000 LU440000 LU430000 SM170000 SA060000

-7 SM570000 SM770000 SP050000 ND070000 LG020000 LW020000 LG010000 LW010000 LC110000 LS120000 SM650000 LE440000 LU320000 LU310000 LN110000 SP230000

-8 SM570001 SM320000 SP060000 ND080000 LH020000 LX020000 LH010000 LX010000 LL610000 LS110000 SM520000 LE300000 SF380000 LZ210000 LK420000 SM190000

-9 SM750000 SM330000 SP070000 ND090000 LI020000 LY020000 LI010000 LY010000 LE310000 LO180000 SM530000 SF230000 SF390000 SF040000 LK410000 SA790000

-A SM750002 SM310000 SM040000 SP130000 LJ020000 LZ020000 LJ010000 LZ010000 LR420000 LU180000 SM660000 SF240000 SF400000 SF010000 LL420000 SD630000

-B SM280000 SM300000 SA010000 SP140000 LK020000 SM060000 LK010000 SM110000 LR410000 LO610000 NF010000 SF250000 SF410000 SF610000 LL410000 ND011000

-C SM290000 SA420000 SP080000 SA030000 LL020000 SM070000 LL010000 SM130000 LI310000 SC020000 NF040000 SF260000 SF420000 SF570000 LN410000 ND031000

-D SM930000 SM780000 SP100000 SA040000 LM020000 SM080000 LM010000 SM140000 LZ120000 LO620000 LL620000 LI440000 SF430000 SF580000 LE320000 ND021000

-E SM910000 SM600000 SP110000 SA050000 LN020000 SD150000 LN010000 SD190000 LA180000 SA070000 SP170000 LS220000 SF440000 SF590000 LN420000 SM470000

-F SM690000 SV040000 SP120000 SP150000 LO020000 SP090000 LO010000 SM790000 LA280000 SC010000 SP180000 SF030000 LZ220000 SF600000 SP200000 SP300000

Figure 85. Code page 775 chart

Chapter 22. Character sets for terminal printers and displays 501
Code Page 808
HEX
DIGITS

1ST 0- 1- 2- 3- 4- 5- 6- 7- 8- 9- A- B- C- D- E- F-
2ND

-0 SM590000 SP010000 ND100000 SM050000 LP020000 SD130000 LP010000 KA020000 KR020000 KA010000 SF140000 SF020000 SF460000 KR010000 KE180000

-1 SS000000 SM630000 SP020000 ND010000 LA020000 LQ020000 LA010000 LQ010000 KB020000 KS020000 KB010000 SF150000 SF070000 SF470000 KS010000 KE170000

-2 SS010000 SM760000 SP040000 ND020000 LB020000 LR020000 LB010000 LR010000 KV020000 KT020000 KV010000 SF160000 SF060000 SF480000 KT010000 KE160000

-3 SS020000 SP330000 SM010000 ND030000 LC020000 LS020000 LC010000 LS010000 KG020000 KU020000 KG010000 SF110000 SF080000 SF490000 KU010000 KE150000

-4 SS030000 SM250000 SC030000 ND040000 LD020000 LT020000 LD010000 LT010000 KD020000 KF020000 KD010000 SF090000 SF100000 SF500000 KF010000 KI180000

-5 SS040000 SM240000 SM020000 ND050000 LE020000 LU020000 LE010000 LU010000 KE020000 KH020000 KE010000 SF190000 SF050000 SF510000 KH010000 KI170000

-6 SS050000 SM700000 SM030000 ND060000 LF020000 LV020000 LF010000 LV010000 KZ220000 KC020000 KZ210000 SF200000 SF360000 SF520000 KC010000 KU240000

-7 SM570000 SM770000 SP050000 ND070000 LG020000 LW020000 LG010000 LW010000 KZ020000 KC220000 KZ010000 SF210000 SF370000 SF530000 KC210000 KU230000

-8 SM570001 SM320000 SP060000 ND080000 LH020000 LX020000 LH010000 LX010000 KI020000 KS220000 KI010000 SF220000 SF380000 SF540000 KS210000 SM190000

-9 SM750000 SM330000 SP070000 ND090000 LI020000 LY020000 LI010000 LY010000 KJ120000 KS160000 KJ110000 SF230000 SF390000 SF040000 KS150000 SA790000

-A SM750002 SM310000 SM040000 SP130000 LJ020000 LZ020000 LJ010000 LZ010000 KK020000 KU220000 KK010000 SF240000 SF400000 SF010000 KU210000 SD630000

-B SM280000 SM300000 SA010000 SP140000 LK020000 SM060000 LK010000 SM110000 KL020000 KY020000 KL010000 SF250000 SF410000 SF610000 KY010000 SA800000

-C SM290000 SA420000 SP080000 SA030000 LL020000 SM070000 LL010000 SM130000 KM020000 KX120000 KM010000 SF260000 SF420000 SF570000 KX110000 SM000000

-D SM930000 SM780000 SP100000 SA040000 LM020000 SM080000 LM010000 SM140000 KN020000 KE140000 KN010000 SF270000 SF430000 SF580000 KE130000 SC200000

-E SM910000 SM600000 SP110000 SA050000 LN020000 SD150000 LN010000 SD190000 KO020000 KU160000 KO010000 SF280000 SF440000 SF590000 KU150000 SM470000

-F SM690000 SV040000 SP120000 SP150000 LO020000 SP090000 LO010000 SM790000 KP020000 KA160000 KP010000 SF030000 SF450000 SF600000 KA150000 SP300000

Figure 86. Code page 808 chart

502 UnifiedPOS User's Guide

Code Page 813

Chapter 22. Character sets for terminal printers and displays 503
Code Page 819
HEX
DIGITS

1ST 0- 1- 2- 3- 4- 5- 6- 7- 8- 9- A- B- C- D- E- F-
2ND

-0 SP010000 ND100000 SM050000 LP020000 SD130000 LP010000 SP300000 SM190000 LA140000 LD620000 LA130000 LD630000

-1 SP020000 ND010000 LA020000 LQ020000 LA010000 LQ010000 SP030000 SA020000 LA120000 LN200000 LA110000 LN190000

-2 SP040000 ND020000 LB020000 LR020000 LB010000 LR010000 SC040000 ND021000 LA160000 LO140000 LA150000 LO130000

-3 SM010000 ND030000 LC020000 LS020000 LC010000 LS010000 SC020000 ND031000 LA200000 LO120000 LA190000 LO110000

-4 SC030000 ND040000 LD020000 LT020000 LD010000 LT010000 SC010000 SD110000 LA180000 LO160000 LA170000 LO150000

-5 SM020000 ND050000 LE020000 LU020000 LE010000 LU010000 SC050000 SM170000 LA280000 LO200000 LA270000 LO190000

-6 SM030000 ND060000 LF020000 LV020000 LF010000 LV010000 SM650000 SM250000 LA520000 LO180000 LA510000 LO170000

-7 SP050000 ND070000 LG020000 LW020000 LG010000 LW010000 SM240000 SD630000 LC420000 SA070000 LC410000 SA060000

-8 SP060000 ND080000 LH020000 LX020000 LH010000 LX010000 SD170000 SD410000 LE140000 LO620000 LE130000 LO610000

-9 SP070000 ND090000 LI020000 LY020000 LI010000 LY010000 SM520000 ND011000 LE120000 LU140000 LE110000 LU130000

-A SM040000 SP130000 LJ020000 LZ020000 LJ010000 LZ010000 SM210000 SM200000 LE160000 LU120000 LE150000 LU110000

-B SA010000 SP140000 LK020000 SM060000 LK010000 SM110000 SP170000 SP180000 LE180000 LU160000 LE170000 LU150000

-C SP080000 SA030000 LL020000 SM070000 LL010000 SM130000 SM660000 NF040000 LI140000 LU180000 LI130000 LU170000

-D SP100000 SA040000 LM020000 SM080000 LM010000 SM140000 SP320000 NF010000 LI120000 LY120000 LI110000 LY110000

-E SP110000 SA050000 LN020000 SD150000 LN010000 SD190000 SM530000 NF050000 LI160000 LT640000 LI150000 LT630000

-F SP120000 SP150000 LO020000 SP090000 LO010000 SM150000 SP160000 LI180000 LS610000 LI170000 LY170000

Figure 87. Code page 819 chart

504 UnifiedPOS User's Guide

Code Page 848
HEX
DIGITS

1ST 0- 1- 2- 3- 4- 5- 6- 7- 8- 9- A- B- C- D- E- F-
2ND

-0 SM590000 SP010000 ND100000 SM050000 LP020000 SD130000 LP010000 KA020000 KR020000 KA010000 SF140000 SF020000 SF460000 KR010000 KE180000

-1 SS000000 SM630000 SP020000 ND010000 LA020000 LQ020000 LA010000 LQ010000 KB020000 KS020000 KB010000 SF150000 SF070000 SF470000 KS010000 KE170000

-2 SS010000 SM760000 SP040000 ND020000 LB020000 LR020000 LB010000 LR010000 KV020000 KT020000 KV010000 SF160000 SF060000 SF480000 KT010000 KG300000

-3 SS020000 SP330000 SM010000 ND030000 LC020000 LS020000 LC010000 LS010000 KG020000 KU020000 KG010000 SF110000 SF080000 SF490000 KU010000 KG290000

-4 SS030000 SM250000 SC030000 ND040000 LD020000 LT020000 LD010000 LT010000 KD020000 KF020000 KD010000 SF090000 SF100000 SF500000 KF010000 KE160000

-5 SS040000 SM240000 SM020000 ND050000 LE020000 LU020000 LE010000 LU010000 KE020000 KH020000 KE010000 SF190000 SF050000 SF510000 KH010000 KE150000

-6 SS050000 SM700000 SM030000 ND060000 LF020000 LV020000 LF010000 LV010000 KZ220000 KC020000 KZ210000 SF200000 SF360000 SF520000 KC010000 KI120000

-7 SM570000 SM770000 SP050000 ND070000 LG020000 LW020000 LG010000 LW010000 KZ020000 KC220000 KZ010000 SF210000 SF370000 SF530000 KC210000 KI110000

-8 SM570001 SM320000 SP060000 ND080000 LH020000 LX020000 LH010000 LX010000 KI020000 KS220000 KI010000 SF220000 SF380000 SF540000 KS210000 KI180000

-9 SM750000 SM330000 SP070000 ND090000 LI020000 LY020000 LI010000 LY010000 KJ120000 KS160000 KJ110000 SF230000 SF390000 SF040000 KS150000 KI170000

-A SM750002 SM310000 SM040000 SP130000 LJ020000 LZ020000 LJ010000 LZ010000 KK020000 KU220000 KK010000 SF240000 SF400000 SF010000 KU210000 SA060000

-B SM280000 SM300000 SA010000 SP140000 LK020000 SM060000 LK010000 SM110000 KL020000 KY020000 KL010000 SF250000 SF410000 SF610000 KY010000 SA020000

-C SM290000 SA420000 SP080000 SA030000 LL020000 SM070000 LL010000 SM130000 KM020000 KX120000 KM010000 SF260000 SF420000 SF570000 KX110000 SM000000

-D SM930000 SM780000 SP100000 SA040000 LM020000 SM080000 LM010000 SM140000 KN020000 KE140000 KN010000 SF270000 SF430000 SF580000 KE130000 SC200000

-E SM910000 SM600000 SP110000 SA050000 LN020000 SD150000 LN010000 SD190000 KO020000 KU160000 KO010000 SF280000 SF440000 SF590000 KU150000 SM470000

-F SM690000 SV040000 SP120000 SP150000 LO020000 SP090000 LO010000 SM790000 KP020000 KA160000 KP010000 SF030000 SF450000 SF600000 KA150000 SP300000

Figure 88. Code page 848 chart

Chapter 22. Character sets for terminal printers and displays 505
Code Page 850

506 UnifiedPOS User's Guide

Code Page 852

Chapter 22. Character sets for terminal printers and displays 507
Code Page 855
HEX
DIGITS

1ST 0- 1- 2- 3- 4- 5- 6- 7- 8- 9- A- B- C- D- E- F-
2ND

-0 SM590000 SP010000 ND100000 SM050000 LP020000 SD130000 LP010000 KD610000 KL410000 KA010000 SF140000 SF020000 KL010000 KA160000 SP320000

-1 SS000000 SM630000 SP020000 ND010000 LA020000 LQ020000 LA010000 LQ010000 KD620000 KL420000 KA020000 SF150000 SF070000 KL020000 KR010000 KY010000

-2 SS010000 SM760000 SP040000 ND020000 LB020000 LR020000 LB010000 LR010000 KG110000 KN110000 KB010000 SF160000 SF060000 KM010000 KR020000 KY020000

-3 SS020000 SP330000 SM010000 ND030000 LC020000 LS020000 LC010000 LS010000 KG120000 KN120000 KB020000 SF110000 SF080000 KM020000 KS010000 KZ010000

-4 SS030000 SM250000 SC030000 ND040000 LD020000 LT020000 LD010000 LT010000 KE170000 KC110000 KC010000 SF090000 SF100000 KN010000 KS020000 KZ020000

-5 SS040000 SM240000 SM020000 ND050000 LE020000 LU020000 LE010000 LU010000 KE180000 KC120000 KC020000 KH010000 SF050000 KN020000 KT010000 KS210000

-6 SS050000 SM700000 SM030000 ND060000 LF020000 LV020000 LF010000 LV010000 KE150000 KK110000 KD010000 KH020000 KK010000 KO010000 KT020000 KS220000

-7 SM570000 SM770000 SP050000 ND070000 LG020000 LW020000 LG010000 LW010000 KE160000 KK120000 KD020000 KI010000 KK020000 KO020000 KU010000 KE130000

-8 SM570001 SM320000 SP060000 ND080000 LH020000 LX020000 LH010000 LX010000 KZ150000 KU230000 KE010000 KI020000 SF380000 KP010000 KU020000 KE140000

-9 SM750000 SM330000 SP070000 ND090000 LI020000 LY020000 LI010000 LY010000 KZ160000 KU240000 KE020000 SF230000 SF390000 SF040000 KZ210000 KS150000

-A SM750002 SM310000 SM040000 SP130000 LJ020000 LZ020000 LJ010000 LZ010000 KI110000 KG210000 KF010000 SF240000 SF400000 SF010000 KZ220000 KS160000

-B SM280000 SM300000 SA010000 SP140000 LK020000 SM060000 LK010000 SM110000 KI120000 KG220000 KF020000 SF250000 SF410000 SF610000 KV010000 KC210000

-C SM290000 SA420000 SP080000 SA030000 LL020000 SM070000 LL010000 SM130000 KI170000 KU150000 KG010000 SF260000 SF420000 SF570000 KV020000 KC220000

-D SM930000 SM780000 SP100000 SA040000 LM020000 SM080000 LM010000 SM140000 KI180000 KU160000 KG020000 KJ110000 SF430000 KP020000 KX110000 SM240000

-E SM910000 SM600000 SP110000 SA050000 LN020000 SD150000 LN010000 SD190000 KJ010000 KU210000 SP170000 KJ120000 SF440000 KA150000 KX120000 SM470000

-F SM690000 SV040000 SP120000 SP150000 LO020000 SP090000 LO010000 SM790000 KJ020000 KU220000 SP180000 SF030000 SC010000 SF600000 SM000000 SP300000

508 UnifiedPOS User's Guide

Code Page 857

Chapter 22. Character sets for terminal printers and displays 509
Code Page 858

510 UnifiedPOS User's Guide

Code Page 860

Chapter 22. Character sets for terminal printers and displays 511
Code Page 861

512 UnifiedPOS User's Guide

Code Page 862

Chapter 22. Character sets for terminal printers and displays 513
Code Page 863

514 UnifiedPOS User's Guide

Code Page 864

Chapter 22. Character sets for terminal printers and displays 515
Code Page 865

516 UnifiedPOS User's Guide

Code Page 866

Chapter 22. Character sets for terminal printers and displays 517
Code Page 867
HEX
DIGITS

1ST 0- 1- 2- 3- 4- 5- 6- 7- 8- 9- A- B- C- D- E- F-
2ND

-0 SM590000 SP010000 ND100000 SM050000 LP020000 SD130000 LP010000 HX330000 HN010000 SP5500Z0 SF140000 SF020000 SF460000 GA010000 SA480000

-1 SS000000 SM630000 SP020000 ND010000 LA020000 LQ020000 LA010000 LQ010000 HB010000 HS010000 SP5600Z0 SF150000 SF070000 SF470000 LS610000 SA020000

-2 SS010000 SM760000 SP040000 ND020000 LB020000 LR020000 LB010000 LR010000 HG010000 HX350000 SP5700Z0 SF160000 SF060000 SF480000 GG020000 SA530000

-3 SS020000 SP330000 SM010000 ND030000 LC020000 LS020000 LC010000 LS010000 HD010000 HP610000 SP5800Z0 SF110000 SF080000 SF490000 GP010000 SA520000

-4 SS030000 SM250000 SC030000 ND040000 LD020000 LT020000 LD010000 LT010000 HH010000 HP010000 SP6000Z0 SF090000 SF100000 SF500000 GS020000 SS260000

-5 SS040000 SM240000 SM020000 ND050000 LE020000 LU020000 LE010000 LU010000 HW010000 HS610000 SP6100Z0 SF190000 SF050000 SF510000 GS010000 SS270000

-6 SS050000 SM700000 SM030000 ND060000 LF020000 LV020000 LF010000 LV010000 HZ010000 HS450000 SP5900Z0 SF200000 SF360000 SF520000 GM010000 SA060000

-7 SM570000 SM770000 SP050000 ND070000 LG020000 LW020000 LG010000 LW010000 HH450000 HQ010000 SF210000 SF370000 SF530000 GT010000 SA700000

-8 SM570001 SM320000 SP060000 ND080000 LH020000 LX020000 LH010000 LX010000 HT450000 HR010000 SF220000 SF380000 SF540000 GF020000 SM190000

-9 SM750000 SM330000 SP070000 ND090000 LI020000 LY020000 LI010000 LY010000 HY010000 HS210000 SM680000 SF230000 SF390000 SF040000 GT620000 SA790000

-A SM750002 SM310000 SM040000 SP130000 LJ020000 LZ020000 LJ010000 LZ010000 HK610000 HT010000 SM660000 SF240000 SF400000 SF010000 GO320000 SD630000

-B SM280000 SM300000 SA010000 SP140000 LK020000 SM060000 LK010000 SM110000 HK010000 SC040000 NF010000 SF250000 SF410000 SF610000 GD010000 SA800000

-C SM290000 SA420000 SP080000 SA030000 LL020000 SM070000 LL010000 SM130000 HL010000 SC020000 NF040000 SF260000 SF420000 SF570000 SA450000 LN011000

-D SM930000 SM780000 SP100000 SA040000 LM020000 SM080000 LM010000 SM140000 HM610000 SC050000 SC200000 SF270000 SF430000 SF580000 GF010001 ND021000

-E SM910000 SM600000 SP110000 SA050000 LN020000 SD150000 LN010000 SD190000 HM010000 SP170000 SF280000 SF440000 SF590000 GE010000 SM470000

-F SM690000 SV040000 SP120000 SP150000 LO020000 SP090000 LO010000 SM790000 HN610000 SC170000 SP180000 SF030000 SF450000 SF600000 SA380000 SP300000

Figure 89. Code page 867 chart

518 UnifiedPOS User's Guide

Code Page 869

Chapter 22. Character sets for terminal printers and displays 519
Code Page 872
HEX
DIGITS

1ST 0- 1- 2- 3- 4- 5- 6- 7- 8- 9- A- B- C- D- E- F-
2ND

-0 SM590000 SP010000 ND100000 SM050000 LP020000 SD130000 LP010000 KD610000 KL410000 KA010000 SF140000 SF020000 KL010000 KA160000 SP320000

-1 SS000000 SM630000 SP020000 ND010000 LA020000 LQ020000 LA010000 LQ010000 KD620000 KL420000 KA020000 SF150000 SF070000 KL020000 KR010000 KY010000

-2 SS010000 SM760000 SP040000 ND020000 LB020000 LR020000 LB010000 LR010000 KG110000 KN110000 KB010000 SF160000 SF060000 KM010000 KR020000 KY020000

-3 SS020000 SP330000 SM010000 ND030000 LC020000 LS020000 LC010000 LS010000 KG120000 KN120000 KB020000 SF110000 SF080000 KM020000 KS010000 KZ010000

-4 SS030000 SM250000 SC030000 ND040000 LD020000 LT020000 LD010000 LT010000 KE170000 KC110000 KC010000 SF090000 SF100000 KN010000 KS020000 KZ020000

-5 SS040000 SM240000 SM020000 ND050000 LE020000 LU020000 LE010000 LU010000 KE180000 KC120000 KC020000 KH010000 SF050000 KN020000 KT010000 KS210000

-6 SS050000 SM700000 SM030000 ND060000 LF020000 LV020000 LF010000 LV010000 KE150000 KK110000 KD010000 KH020000 KK010000 KO010000 KT020000 KS220000

-7 SM570000 SM770000 SP050000 ND070000 LG020000 LW020000 LG010000 LW010000 KE160000 KK120000 KD020000 KI010000 KK020000 KO020000 KU010000 KE130000

-8 SM570001 SM320000 SP060000 ND080000 LH020000 LX020000 LH010000 LX010000 KZ150000 KU230000 KE010000 KI020000 SF380000 KP010000 KU020000 KE140000

-9 SM750000 SM330000 SP070000 ND090000 LI020000 LY020000 LI010000 LY010000 KZ160000 KU240000 KE020000 SF230000 SF390000 SF040000 KZ210000 KS150000

-A SM750002 SM310000 SM040000 SP130000 LJ020000 LZ020000 LJ010000 LZ010000 KI110000 KG210000 KF010000 SF240000 SF400000 SF010000 KZ220000 KS160000

-B SM280000 SM300000 SA010000 SP140000 LK020000 SM060000 LK010000 SM110000 KI120000 KG220000 KF020000 SF250000 SF410000 SF610000 KV010000 KC210000

-C SM290000 SA420000 SP080000 SA030000 LL020000 SM070000 LL010000 SM130000 KI170000 KU150000 KG010000 SF260000 SF420000 SF570000 KV020000 KC220000

-D SM930000 SM780000 SP100000 SA040000 LM020000 SM080000 LM010000 SM140000 KI180000 KU160000 KG020000 KJ110000 SF430000 KP020000 KX110000 SM240000

-E SM910000 SM600000 SP110000 SA050000 LN020000 SD150000 LN010000 SD190000 KJ010000 KU210000 SP170000 KJ120000 SF440000 KA150000 KX120000 SM470000

-F SM690000 SV040000 SP120000 SP150000 LO020000 SP090000 LO010000 SM790000 KJ020000 KU220000 SP180000 SF030000 SC200000 SF600000 SM000000 SP300000

Figure 90. Code page 872 chart

520 UnifiedPOS User's Guide

Code Page 874
HEX
DIGITS

1ST 0- 1- 2- 3- 4- 5- 6- 7- 8- 9- A- B- C- D- E- F-
2ND

-0 SP010000 ND100000 SM050000 LP020000 SD130000 LP010000 BZ100300 BT200000 BP400000 BA200000 BE200000 ND100002

-1 SP020000 ND010000 LA020000 LQ020000 LA010000 LQ010000 BK100000 BT300000 BM100000 BA100000 BE300000 ND010002

-2 SP040000 ND020000 LB020000 LR020000 LB010000 LR010000 BK200000 BT400000 BY200000 BA300000 BO200000 ND020002

-3 SM010000 ND030000 LC020000 LS020000 LC010000 LS010000 BK300000 BN200000 BR100000 BA400000 BA500000 ND030002

-4 SC030000 ND040000 LD020000 LT020000 LD010000 LT010000 BK400000 BD200000 BR200000 BI100000 BA600000 ND040002

-5 SM020000 ND050000 LE020000 LU020000 LE010000 LU010000 BK500000 BT500000 BL100000 BI200000 BA700000 ND050002

-6 SM030000 ND060000 LF020000 LV020000 LF010000 LV010000 BK600000 BT600000 BL200000 BU100000 BQ100000 ND060002

-7 SP050000 ND070000 LG020000 LW020000 LG010000 LW010000 BN100000 BT700000 BW100000 BU200000 BE100000 ND070002

-8 SP060000 ND080000 LH020000 LX020000 LH010000 LX010000 BC100000 BT800000 BS200000 BU300000 BZ100000 ND080002

-9 SP070000 ND090000 LI020000 LY020000 LI010000 LY010000 BX100000 BN300000 BS300000 BU400000 BZ200000 ND090002

-A SM040000 SP130000 LJ020000 LZ020000 LJ010000 LZ010000 BS100000 BB100000 BS400000 BQ300000 BZ300000 BQ500000

-B SA010000 SP140000 LK020000 SM060000 LK010000 SM110000 BX200000 BP100000 BH100000 BZ200300 BZ400000 BQ600000

-C SP080000 SA030000 LL020000 SM070000 LL010000 SM130000 BX300000 BP200000 BL300000 BZ300300 BZ500000 SC040000

-D SP100000 SA040000 LM020000 SM080000 LM010000 SM140000 BY100000 BF100000 BO100000 BZ400300 BN400000 SM660000

-E SP110000 SA050000 LN020000 SD150000 LN010000 SD190000 BD100000 BP300000 BH200000 BZ500300 BE400000 SM650000

-F SP120000 SP150000 LO020000 SP090000 LO010000 BT100000 BF200000 BQ200000 SC130000 BQ400000 SP300000

Figure 91. Code page 874 chart

Chapter 22. Character sets for terminal printers and displays 521
Code Page 912

522 UnifiedPOS User's Guide

Code Page 914

Chapter 22. Character sets for terminal printers and displays 523
Code Page 915

524 UnifiedPOS User's Guide

Code Page 921

Chapter 22. Character sets for terminal printers and displays 525
Code Page 1116
HEX
DIGITS

1ST 0- 1- 2- 3- 4- 5- 6- 7- 8- 9- A- B- C- D- E- F-
2ND

-0 SM590000 SP010000 ND100000 SM050000 LP020000 SD130000 LP010000 LC420000 LE120000 LA110000 SF140000 SF020000 LS210000 LO120000 SP320000

-1 SS000000 SM630000 SP020000 ND010000 LA020000 LQ020000 LA010000 LQ010000 LU170000 LA510000 LI110000 SF150000 SF070000 LS220000 LS610000 SA020000

-2 SS010000 SM760000 SP040000 ND020000 LB020000 LR020000 LB010000 LR010000 LE110000 LA520000 LO110000 SF160000 SF060000 LE160000 LO160000 SM100000

-3 SS020000 SP330000 SM010000 ND030000 LC020000 LS020000 LC010000 LS010000 LA150000 LO150000 LU110000 SF110000 SF080000 LE180000 LO140000 NF050000

-4 SS030000 SM250000 SC030000 ND040000 LD020000 LT020000 LD010000 LT010000 LA170000 LO170000 LN190000 SF090000 SF100000 LE140000 LO190000 SM250000

-5 SS040000 SM240000 SM020000 ND050000 LE020000 LU020000 LE010000 LU010000 LA130000 LO130000 LN200000 LA120000 SF050000 LI610000 LO200000 SM240000

-6 SS050000 SM700000 SM030000 ND060000 LF020000 LV020000 LF010000 LV010000 LA270000 LU150000 SM210000 LA160000 LA190000 LI120000 SM170000 SA060000

-7 SM570000 SM770000 SP050000 ND070000 LG020000 LW020000 LG010000 LW010000 LC410000 LU130000 SM200000 LA140000 LA200000 LI160000 LZ210000 SD410000

-8 SM570001 SM320000 SP060000 ND080000 LH020000 LX020000 LH010000 LX010000 LE150000 LY170000 SP160000 SM520000 SF380000 LI180000 LZ220000 SM190000

-9 SM750000 SM330000 SP070000 ND090000 LI020000 LY020000 LI010000 LY010000 LE170000 LO180000 SM530000 SF230000 SF390000 SF040000 LU120000 SD170000

-A SM750002 SM310000 SM040000 SP130000 LJ020000 LZ020000 LJ010000 LZ010000 LE130000 LU180000 SM660000 SF240000 SF400000 SF010000 LU160000 SD630000

-B SM280000 SM300000 SA010000 SP140000 LK020000 SM060000 LK010000 SM110000 LI170000 LO610000 NF010000 SF250000 SF410000 SF610000 LU140000 ND011000

-C SM290000 SA420000 SP080000 SA030000 LL020000 SM070000 LL010000 SM130000 LI150000 SC020000 NF040000 SF260000 SF420000 SF570000 LY110000 ND031000

-D SM930000 SM780000 SP100000 SA040000 LM020000 SM080000 LM010000 SM140000 LI130000 LO620000 SP030000 SC040000 SF430000 SM650000 LY120000 ND021000

-E SM910000 SM600000 SP110000 SA050000 LN020000 SD150000 LN010000 SD190000 LA180000 SA070000 SP170000 SC050000 SF440000 LI140000 SM150000 SM470000

-F SM690000 SV040000 SP120000 SP150000 LO020000 SP090000 LO010000 SM790000 LA280000 SC070000 SP180000 SF030000 SC010000 SF600000 SD110000 SP300000

Figure 92. Code page 1116 chart

526 UnifiedPOS User's Guide

Code Page 1117
HEX
DIGITS

1ST 0- 1- 2- 3- 4- 5- 6- 7- 8- 9- A- B- C- D- E- F-
2ND

-0 SM590000 SP010000 ND100000 SM050000 LP020000 SD130000 LP010000 LC120000 LE120000 LA320000 SF140000 SF020000 SF460000 LO120000 SP320000

-1 SS000000 SM630000 SP020000 ND010000 LA020000 LQ020000 LA010000 LQ010000 LU170000 LZ300000 LI320000 SF150000 SF070000 SF470000 LS610000 SA020000

-2 SS010000 SM760000 SP040000 ND020000 LB020000 LR020000 LB010000 LR010000 LE110000 LZ290000 LO110000 SF160000 SF060000 SF480000 LO320000 LA510000

-3 SS020000 SP330000 SM010000 ND030000 LC020000 LS020000 LC010000 LS010000 LA310000 LO310000 LU430000 SF110000 SF080000 SF490000 LN120000 LA520000

-4 SS030000 SM250000 SC030000 ND040000 LD020000 LT020000 LD010000 LT010000 LA170000 LO170000 LA440000 SF090000 SF100000 SF500000 LO190000 SM250000

-5 SS040000 SM240000 SM020000 ND050000 LE020000 LU020000 LE010000 LU010000 LG410000 LG420000 LA430000 SF190000 SF050000 SF510000 LO200000 SC010000

-6 SS050000 SM700000 SM030000 ND060000 LF020000 LV020000 LF010000 LV010000 LA270000 LU310000 LZ220000 SF200000 SF360000 SF520000 LS220000 SA060000

-7 SM570000 SM770000 SP050000 ND070000 LG020000 LW020000 LG010000 LW010000 LC110000 LS120000 LZ210000 SF210000 SF370000 SF530000 LS210000 LO610000

-8 SM570001 SM320000 SP060000 ND080000 LH020000 LX020000 LH010000 LX010000 LL610000 LS110000 LE440000 SF220000 SF380000 SF540000 LK420000 SM190000

-9 SM750000 SM330000 SP070000 ND090000 LI020000 LY020000 LI010000 LY010000 LE310000 LO180000 LE430000 SF230000 SF390000 SF040000 LK410000 LO620000

-A SM750002 SM310000 SM040000 SP130000 LJ020000 LZ020000 LJ010000 LZ010000 LE290000 LU180000 LE300000 SF240000 SF400000 SF010000 LU320000 SD630000

-B SM280000 SM300000 SA010000 SP140000 LK020000 SM060000 LK010000 SM110000 LI430000 LN110000 LZ110000 SF250000 SF410000 SF610000 LU440000 LR410000

-C SM290000 SA420000 SP080000 SA030000 LL020000 SM070000 LL010000 SM130000 LI310000 LL420000 LC220000 SF260000 SF420000 SF570000 LL410000 LR420000

-D SM930000 SM780000 SP100000 SA040000 LM020000 SM080000 LM010000 SM140000 LZ120000 LL620000 LI440000 SF270000 SF430000 SF580000 LE320000 SP230000

-E SM910000 SM600000 SP110000 SA050000 LN020000 SD150000 LN010000 SD190000 LA180000 SA070000 SP170000 SF280000 SF440000 SF590000 LN420000 SP210000

-F SM690000 SV040000 SP120000 SP150000 LO020000 SP090000 LO010000 LA280000 LC210000 SP180000 SF030000 SF450000 SF600000 LN410000 SP300000

Figure 93. Code page 1117 chart

Chapter 22. Character sets for terminal printers and displays 527
Code Page 1118
HEX
DIGITS

1ST 0- 1- 2- 3- 4- 5- 6- 7- 8- 9- A- B- C- D- E- F-
2ND

-0 SM590000 SP010000 ND100000 SM050000 LP020000 SD130000 LP010000 LC420000 LE120000 LA110000 SF140000 SF020000 LA430000 GA010000 SA480000

-1 SS000000 SM630000 SP020000 ND010000 LA020000 LQ020000 LA010000 LQ010000 LU170000 LA510000 LI110000 SF150000 SF070000 LC210000 GB010000 SA020000

-2 SS010000 SM760000 SP040000 ND020000 LB020000 LR020000 LB010000 LR010000 LE110000 LA520000 LO110000 SF160000 SF060000 LE430000 GG020000 SA530000

-3 SS020000 SP330000 SM010000 ND030000 LC020000 LS020000 LC010000 LS010000 LA150000 LO150000 LU110000 SF110000 SF080000 LE290000 GP010000 SA520000

-4 SS030000 SM250000 SC030000 ND040000 LD020000 LT020000 LD010000 LT010000 LA170000 LO170000 LN190000 SF090000 SF100000 LI430000 GS020000 SP230000

-5 SS040000 SM240000 SM020000 ND050000 LE020000 LU020000 LE010000 LU010000 LA130000 LO130000 LN200000 LA440000 SF050000 LS210000 GS010000 SP210000

-6 SS050000 SM700000 SM030000 ND060000 LF020000 LV020000 LF010000 LV010000 LA270000 LU150000 SM210000 LC220000 LU440000 LU430000 SM170000 SA060000

-7 SM570000 SM770000 SP050000 ND070000 LG020000 LW020000 LG010000 LW010000 LC410000 LU130000 SM200000 LE440000 LU320000 LU310000 GT010000 SA700000

-8 SM570001 SM320000 SP060000 ND080000 LH020000 LX020000 LH010000 LX010000 LE150000 LY170000 SP160000 LE300000 SF380000 LZ210000 GF020000 SM190000

-9 SM750000 SM330000 SP070000 ND090000 LI020000 LY020000 LI010000 LY010000 LE170000 LO180000 SM680000 SF230000 SF390000 SF040000 GT620000 SA790000

-A SM750002 SM310000 SM040000 SP130000 LJ020000 LZ020000 LJ010000 LZ010000 LE130000 LU180000 SM660000 SF240000 SF400000 SF010000 GO320000 SD290000

-B SM280000 SM300000 SA010000 SP140000 LK020000 SM060000 LK010000 SM110000 LI170000 SC040000 NF010000 SF250000 SF410000 SF610000 GD010000 SA800000

-C SM290000 SA420000 SP080000 SA030000 LL020000 SM070000 LL010000 SM130000 LI150000 SC020000 NF040000 SF260000 SF420000 SF570000 SA450000 LN011000

-D SM930000 SM780000 SP100000 SA040000 LM020000 SM080000 LM010000 SM140000 LI130000 SC050000 SP030000 LI440000 SF430000 SF580000 GF010000 ND021000

-E SM910000 SM600000 SP110000 SA050000 LN020000 SD150000 LN010000 SD190000 LA180000 SC060000 SP170000 LS220000 SF440000 SF590000 GE010000 SM470000

-F SM690000 SV040000 SP120000 SP150000 LO020000 SP090000 LO010000 SM790000 LA280000 SC070000 SP180000 SF030000 LZ220000 SF600000 SA140000 SP300000

Figure 94. Code page 1118 chart

528 UnifiedPOS User's Guide

Code Page 1250

Figure 95. Code page 1250 chart

Chapter 22. Character sets for terminal printers and displays 529
Code Page 1251

Figure 96. Code page 1251 chart

530 UnifiedPOS User's Guide

Code Page 1252

Figure 97. Code page 1252 chart

Chapter 22. Character sets for terminal printers and displays 531
Code Page 1253

Figure 98. Code page 1253 chart

532 UnifiedPOS User's Guide

Code Page 1254

Figure 99. Code page 1254 chart

Chapter 22. Character sets for terminal printers and displays 533
Code Page 1255

Figure 100. Code page 1255 chart

534 UnifiedPOS User's Guide

Code Page 1256

Figure 101. Code page 1256 chart

Chapter 22. Character sets for terminal printers and displays 535
Code Page 1257

Figure 102. Code page 1257 chart

536 UnifiedPOS User's Guide

Code Page 1258

Chapter 22. Character sets for terminal printers and displays 537
Code Page 932

Figure 103. Code page 932 chart

538 UnifiedPOS User's Guide

Code Page 936

Figure 104. Code page 936 chart

Chapter 22. Character sets for terminal printers and displays 539
Code Page 949

Figure 105. Code page 949 chart

540 UnifiedPOS User's Guide

Code Page 950

Figure 106. Code page 950 chart

Chapter 22. Character sets for terminal printers and displays 541
Code Page 951

Figure 107. Special Symbols Alphanumeric⁄Numerics⁄Jamo⁄Hiragana⁄Hanja (1 of 3)

542 UnifiedPOS User's Guide

Figure 108. Special Symbols Alphanumeric⁄Numerics⁄Jamo⁄Hiragana⁄Hanja (2 of 3)

Chapter 22. Character sets for terminal printers and displays 543
Figure 109. Special Symbols Alphanumeric⁄Numerics⁄Jamo⁄Hiragana⁄Hanja (3 of 3)

544 UnifiedPOS User's Guide

Figure 110. Hangeul (1 of 10)

Chapter 22. Character sets for terminal printers and displays 545
Figure 111. Hangeul (2 of 10)

546 UnifiedPOS User's Guide

Figure 112. Hangeul (3 of 10)

Chapter 22. Character sets for terminal printers and displays 547
Figure 113. Hangeul (4 of 10)

548 UnifiedPOS User's Guide

Figure 114. Hangeul (5 of 10)

Chapter 22. Character sets for terminal printers and displays 549
Figure 115. Hangeul (6 of 10)

550 UnifiedPOS User's Guide

Figure 116. Hangeul (7 of 10)

Chapter 22. Character sets for terminal printers and displays 551
Figure 117. Hangeul (8 of 10)

552 UnifiedPOS User's Guide

Figure 118. Hangeul (9 of 10)

Figure 119. Hangeul (10 of 10)

Chapter 22. Character sets for terminal printers and displays 553
Code Page 1381
HEX
DIGITS

1ST 0- 1- 2- 3- 4- 5- 6- 7- 8- 9- A- B- C- D- E- F-
2ND

-0 SF440000 SP010000 ND100000 SM050000 LP020000 SD130000 LP010000 SC020000

-1 SF390000 SF570000 SP020000 ND010000 LA020000 LQ020000 LA010000 LQ010000 SM660000

-2 SF250000 SM760000 SP040000 ND020000 LB020000 LR020000 LB010000 LR010000 SC120000

-3 SF380000 SP330000 SM010000 ND030000 LC020000 LS020000 LC010000 LS010000 SM150000

-4 SF260000 SF160000 SC030000 ND040000 LD020000 LT020000 LD010000 LT010000 SM650000

-5 SF240000 SF400000 SM020000 ND050000 LE020000 LU020000 LE010000 LU010000

-6 SF430000 SF410000 SM030000 ND060000 LF020000 LV020000 LF010000 LV010000

-7 SM330000 SF230000 SP050000 ND070000 LG020000 LW020000 LG010000 LW010000

-8 SM570001 SP060000 ND080000 LH020000 LX020000 LH010000 LX010000

-9 SM750000 SF420000 SP070000 ND090000 LI020000 LY020000 LI010000 LY010000

-A SM750002 SF140000 SM040000 SP130000 LJ020000 LZ020000 LJ010000 LZ010000

-B SP500000 SM720000 SA010000 SP140000 LK020000 SM060000 LK010000 SM110000

-C SF610000 SM320000 SP080000 SA030000 LL020000 SM070000 LL010000 SM130000

-D SF150000 SF110000 SP100000 SA040000 LM020000 SM080000 LM010000 SM140000

-E SM470000 SM310000 SP110000 SA050000 LN020000 SD150000 LN010000 SD190000

-F SM690000 SM300000 SP120000 SP150000 LO020000 SP090000 LO010000

Figure 120. Code page 1381 chart

554 UnifiedPOS User's Guide

Appendix A. JavaPOS support for UnifiedPOS device statistics
properties
JavaPOS support for UnifiedPOS device statistics properties

Common properties
Table 296. Description of common properties
Common Properties Description Value
UnifiedPOSVersion Version of the UnifiedPOS UnifiedPOS Version (for example:
specification supported 1.9.1)
DeviceCategory Device category (for example: [Corresponding category]
POSPrinter)
ManufacturerName Device manufacturer's name Toshiba
ModelName Device model name See the section for the specific
device.
SerialNumber Device serial number [Serial_Number]
ManufactureDate Device manufacture date See the section for the specific
device.
FirmwareRevision Device firmware revision [Firmware_Version]
Interface Device hardware interface (for RS232/RS485/USB/Proprietary
example: USB)
InstallationDate Device installation date Not supported
HoursPoweredCount Number of hours powered On Not supported
CommunicationErrorCount Number of communication errors Not supported

Note:
1. Interface property used the Proprietary value for PS/2 and Embedded devices.
2. SerialNumber property for USB devices may not match the device label, except for the 4610
POSPrinter.
3. The ManufactureDate format for the [Printer/MICR/CheckScanner/CashDrawer] is WWYY,
where WW is a two-digit representation for the week of the year the printer was
manufactured, and YY is the last two digits of the year it was manufactured.
4. EIA232 hardware interface use RS232 as a value.
Support for the following properties applies to all devices:
• CapStatisticsReporting: Yes
• CapUpdateStatistics: No

Cash drawer
Table 297. Cash drawer
System/device Bus Model name value

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 555

Port 3A Port 3B Port 3C Port 3D
SurePOS 730/750 USB 4800-73X/75X - A 4800-73X/75X - B
POSPrinter 4610 USB / EIA232 / 4610 - A 4610 - B
RS485, Network
SurePOS 300 Embedded 4800-72x/74x/78x, 4810-3xx 4800-72x/74x/78x, 4810-3xx
SurePOS EIA232 500/600 - A 500/600 - B
500/600/Kiosk
SurePOS Embedded 4800-72x/74x/78x, 4810-3xx 4800-72x/74x/78x, 4810-3xx
72x/74x/78x -A -B
SurePOS 4694 RS485 4694-2xx/3xx - A 4694-2xx/3xx - B
SurePOS 4674 Embedded 4674 - A 4674 - B
SureOne Embedded 461x
4614/4615
SurePOS 100
AnyPlace POS USB AnyPlace Hub
Hub
Toshiba Cash USB Toshiba Cash Drawer - A Toshiba Cash Drawer - B
Drawer
TCx 700 USB / Embedded 4900-7x6-A 4900-7x6-B
POSPrinter 6145 USB 6145-A 6145-B
TCx 800 USB 6200-A 6200-B 6200-C 6200-D
TCx 300 Embedded 4800-72x/74x/ 4800-72x/74x/
78x,4810-3xx-A 78x,4810-3xx-B
TCx 810 USB 6201-A 6201-B
TCx 810E USB 4828-A 4828-B

Table 298. Cash drawer common properties

Common Properties SurePOS POS SurePOS SurePOS SurePOS SurePOS SurePOS SureOne/ AnyPlace Toshiba TCx 300
Printer 300 500/ 600/ 72x/ 74x/ 4694 - 4674 SurePOS POS Cash Embed-
730/750 Embed- Kiosk 78x RS485 Embed- 100 Hub - Drawer ded
USB 4610 ded EIA232 Embed- ded Embed- USB USB/
EIA232/ ded ded TCx 700
RS485/
USB/
Network

UnifiedPOSVersion Y Y Y Y Y Y Y Y Y Y Y

DeviceCategory Y Y Y Y Y Y Y Y Y Y Y

ManufacturerName Y Y Y Y Y Y Y Y Y Y Y

ModelName Y Y Y Y Y Y Y Y Y Y Y

SerialNumber Y Y N N N N N N Y Y N

ManufactureDate N N N N N N N N N N N

Mechanical N N N N N N N N N N N
Revision

556 UnifiedPOS User's Guide

Common Properties SurePOS POS SurePOS SurePOS SurePOS SurePOS SurePOS SureOne/ AnyPlace Toshiba TCx 300
Printer 300 500/ 600/ 72x/ 74x/ 4694 - 4674 SurePOS POS Cash Embed-
730/750 Embed- Kiosk 78x RS485 Embed- 100 Hub - Drawer ded
USB 4610 ded EIA232 Embed- ded Embed- USB USB/
EIA232/ ded ded TCx 700
RS485/
USB/
Network

FirmwareRevision Y Y N N N N N N Y Y N

Interface Y Y Y Y Y Y Y Y Y Y Y

InstallationDate N N N N N N N N N N N

HoursPowered N N N N N N N N N N N
Count

Communication N N N N N N N N N N N
ErrorCount

Table 299. Cash drawer specific properties

POS
Printer

4610 SurePOS SureOne/ Any- Toshiba

EIA232/ SurePOS SurePOS 72x/ 74x/ SurePOS SurePOS Place Cash
SurePOS RS485/ 300 500/ 600/ 78x SurePOS 4674 100 POS Drawer TCx 300
730/750 USB Embed- Kiosk Embed- 4694 - Embed- Embed- Hub - USB/ Embed-
Specific Properties USB Network ded EIA232 ded RS485 ded ded USB TCx 700 ded

DrawerGoodOpen N N N N N N N N N N N
Count

DrawerFailedOpen N N N N N N N N N Y (1) N
Count

IBM_DrawerOpen N N N N N N N N N Y (2) N
CloseCycleCount

Note: 730/750 USB devices use BCD level for Firmware Revision.
Note:
1. The DrawerFailedOpenCount will be reported in 10s (1 = 10), only after 3 concurrent open
failures the device will count that as 1 open failure.
It could be reported two extra errors values:
a. FF: indicates an error condition into the device.
b. FE: indicates a counter overflow condition.
2. The Open/Close cycle count increments in 1 after 100 cycles have been completed (open
then close.)
It could be reported two extra errors values:
a. FFFF: indicates an error condition into the device.
b. FFFE: indicates a counter overflow condition.

Check scanner
Check Scanner is only available on Toshiba 4610 POSPrinter models T18 and T19.

Appendix A. JavaPOS support for UnifiedPOS device statistics properties 557

Table 300. Check scanner
Device Bus Model name value
POSPrinter 4610-TI8/TI9 USB / EIA232 / RS485 4610

Table 301. Check scanner common properties

POSPrinter 4610 -TI8/TI9 - EIA232/
Common Properties Description RS485/USB Supported:
UnifiedPOSVersion Version of UnifiedPOS specification Y
supported
DeviceCategory Device Category Y
ManufacturerName Device manufacturer's name Y
ModelName Device model name Y
SerialNumber Device serial number Y
ManufactureDate (WWYY format) Device manufacture date Y
MechanicalRevision Device hardware revision N
FirmwareRevision Device firmware revision Y
Interface Device hardware interface Y
InstallationDate Device installation date N
HoursPoweredOn Number of hours powered On N
CommunicationErrorCount Number of communication errors N

Table 302. Check scanner manufacturer properties

POSPrinter 4610 -
TI8/TI9 - EIA232/
Manufacturer properties Unit of measure Description RS485/USB supported:
IBM_CheckScannedCount "" - empty Number of checks Y
scanned
IBM_ChecksFailedQualityCount "" - empty Number of scanned Y
checks failed to meet
internal image quality
test
IBM_CheckScannerBrightnessQuali "" - empty Check Scanner Y
ty Brightness Quality
IBM_CheckScannerContrastQuality "" - empty Check Scanner Y
Contrast Quality
IBM_CheckScannerFocusQuality "" - empty Check Scanner Focus Y
Quality

Note:
1. CheckScanner microcode level used for firmware revision

558 UnifiedPOS User's Guide

2. ManufacturerDate is only available for new POSPrinters (after December, 2005). Older ones
are not supported.
3. The CheckScanner should be cleaned or recalibrated if the following values are not met:
• IBM_CheckScannerBrightnessQuality: 90 decimal
• IBM_CheckScannerContrastQuality: 90 decimal
• IBM_CheckScannerFocusQuality: 77 decimal
4. For 4689 USB and RS485 models, PaperCutCount increments its value by 10 after 10 cuts,
not one by one.

Fiscal printer
Table 303. Fiscal printer
Device Bus Model name value
4610-GX3 EIA232/USB/RS485 Gx3
4610-GX4 EIA232/USB/RS485 Gx4
4610-GX5 EIA232/USB/RS485 Gx5
4610-KX3 EIA232/USB/RS485 Kx3
4610-KX4 EIA232/USB/RS485 Kx4
4610-KX5 EIA232/USB/RS485 Kx5
4610-SJ6 EIA232/USB SJ6
4610-3XX RS485 3xx
4610-1NF EIA232/USB 1NF

4610-2CF EIA232/USB 2CF

4610-2NF 2NF

Table 304. Fiscal printer common properties

Common Properties USB EIA232 RS485
UnifiedPOSVersion Y Y Y
DeviceCategory Y Y Y
ManufacturerName Y Y Y
ModelName Y Y Y
SerialNumber Y N N
ManufactureDate N N N
MechanicalRevision N N N
FirmwareRevision Y N N
Interface Y Y Y
InstallationDate N N N
HoursPoweredOn N N N

Appendix A. JavaPOS support for UnifiedPOS device statistics properties 559

Common Properties USB EIA232 RS485
CommunicationErrorCount N N N

Table 305. Fiscal printer specific properties

Specific Properties USB EIA232 RS485
BarcodePrintedCount N N N
FormInsertionCount N N N
HomeErrorCount N N N

JournalCharacterPrinted N N N
Count

JournalLinePrintedCount N N N

MaximumTempReached N N N
Count

NVRAMWriteCount N N N
PaperCutCount N N N
FailedPaperCutCount N N N
PrinterFaultCount N N N
PrintSideChangeCount N N N

FailedPrintSideChange N N N
Count

ReceiptCharacterPrinted N N N
Count

ReceiptCoverOpenCount N N N
ReceiptLineFeedCount N N N
ReceiptLinePrintedCount N N N
SlipCharacterPrintedCount N N N
SlipCoverOpenCount N N N
SlipLineFeedCount N N N
SlipLinePrintedCount N N N
StampFiredCount N N N

Note: USB devices use BCD level for firmware revision.

560 UnifiedPOS User's Guide

Hard totals
Table 306. Hard Totals
Device Bus Model name value
NVRAM 730/750 USB 4800-73x/75x
NVRAM 72X/74X/78X Embedded 4800-72x/74x/78x
4694 Embedded 4694
4674 Embedded 4674
SurePOS 300 4810-35x Embedded 4810–35x
TCx 300 Series Embedded 4810-3x/1
TCx 700 Series Embedded 4900-7x6, 4900-7x7

Table 307. Hard totals common properties

Common properties Description Support USB Support embedded
UnifiedPOSVersion Version of the UnifiedPOS Y Y
specification supported
DeviceCategory Device category Y Y
ManufacturerName Device manufacturer's Y Y
name
ModelName Device model name Y Y
SerialNumber Device serial number Y N
ManufactureDate Device manufacture date N N
MechanicalRevision Device hardware revision N N
FirmwareRevision Device firmware revision Y N
Interface Device hardware interface Y Y
InstallationDate Device installation date N N
HoursPoweredCount Number of hours powered N N
On
CommunicationErrorCou Number of N N
nt communication errors

Note: USB devices use BCD level for firmware revision.

Keylock
Table 308. Keylock
Device Bus Model name value
NANPOS Keylock USB/RS485 NANPOS

Appendix A. JavaPOS support for UnifiedPOS device statistics properties 561

Device Bus Model name value
NANPOS Keylock as System USB/PS2 NANPOS
attached
4820 Keylock (SurePoint) USB/RS485/PS2 4820
50-key Keylock SBCS/DBCS USB/RS485 50-key
ANKPOS - DBCS USB/RS485 ANKPOS
ANKPOS - DBCS as System USB/PS2 ANKPOS
Keyboard
133-key or Matrix - SBCS USB/RS485 133-key
Keyboard 4685 K02 Ultra VI USB/RS485 4685
Keyboard 4685 K02 Ultra VI with RS485 4685
MSR/E
Keyboard V USB/RS485 Kbd-V
SurePOS 4674 Keylock RS485 4674
SureOne 4614 / 4615 Keylock Embedded 461x
SurePOS 100 – Keylock
Keyboard 4685-K03 USB 4685-K03
Keyboard 4685-K03 RS-485 4674/4685-K03
ANPOS Keylock PS/2, USB Modular ANPOS
Modular CANPOS Keylock PS/2, USB Modular CANPOS
Modular 67 Key Keylock PS/2, USB Modular 67 Key
Modular 67 Key Keyboard with USB Modular 67 Key
Display Keylock
TCxWave Electronic Keylock USB Electronic
4820 Integrated Keylock USB 4820
4820 Integrated Electronic Keylock USB Electronic
6149 Integrated Keylock USB 6149

Table 309. Keylock common properties

USB RS485 PS2
Common properties Description supported supported supported Embedded
UnifiedPOSVersion Version of the UnifiedPOS Y Y Y Y
specification supported
DeviceCategory Device category Y Y Y Y
ManufacturerName Device manufacturer's Y Y Y Y
name
ModelName Device model name Y Y Y Y

562 UnifiedPOS User's Guide

USB RS485 PS2
Common properties Description supported supported supported Embedded
SerialNumber Device serial number Y N N N
ManufactureDate Device manufacture date. Y¹ N N N
In WWYY format.
MechanicalRevision Device hardware revision N N N N
FirmwareRevision Device firmware revision Y N N N
Interface Device hardware interface Y Y Y Y
InstallationDate Device installation date N N N N
HoursPoweredCount Number of hours powered Y¹ N N N
On
CommunicationErrorCou Number of N N N N
nt communication errors

¹ Supported by USB Modular ANPOS, Modular CANPOS, Modular 67 Key Keyboards and
SurePoint EC Level >= 400

Table 310. Keylock manufacturer properties table

Manufacturer properties Description USB RS485 PS2 Embedded
IBM_PowerCycleCount Number of Y¹ N N N
power on/off
cycles
IBM_UnexpectedResetsCount Number of Y¹ N N N
unexpected resets

¹ Supported by USB Modular ANPOS, Modular CANPOS, Modular 67 Key Keyboards and
SurePoint EC Level >= 400

Table 311. Keylock specific properties

USB RS485 PS2
Specific properties Description supported supported supported Embedded
LockPositionChangeCoun Number of lock position Y¹ N N N
t changes

¹ Supported by USB Modular ANPOS, Modular CANPOS, Modular 67 Key Keyboards and
SurePoint EC Level >= 400
Note: USB devices use BCD level for firmware revision.

Line display
Table 312. Line display
Device Bus Model name value
2X20 VFD 1-sided USB/EIA232/RS485 2X20 VFD
2X20 VFD 2-sided USB/RS485 2X20 VFD - A or 2X20 VFD - B

Appendix A. JavaPOS support for UnifiedPOS device statistics properties 563

Device Bus Model name value
2X20 LCD USB/RS485 2X20 LCD
APA Display USB/EIA232/RS485 APA
50-key Keyboard Display LCD USB/RS485 2X20 LCD on 50-key
PLU Keyboard III with APA USB/RS485 APA
Display
67-key Keyboard Display LCD USB 2X20 LCD on 67-key
TCxWave 6140 Integrated 2X20 USB 2X20 LCD
LCD
TCx 2x20 Single-sided LCD USB 2X20 LCD
TCx 2x20 Double-sided LCD USB 2X20 LCD - A or 2X20 LCD - B
TCx APA Single-sided USB APA
TCx 800 2x20 Single-sided LCD USB 2x20 LCD
TCx 800 APA Single-sided USB APA

Table 313. Line Display common properties

USB EIA232 RS485
Common properties Description supported supported supported
UnifiedPOSVersion Version of the UnifiedPOS Y Y Y
specification supported
DeviceCategory Device category Y Y Y
ManufacturerName Device manufacturer's name Y Y Y
ModelName Device model name Y Y Y
SerialNumber Device serial number Y N N
ManufactureDate Device manufacture date Y1 N N
MechanicalRevision Device hardware revision N N N
FirmwareRevision Device firmware revision Y N N
Interface Device hardware interface Y Y Y
InstallationDate Device installation date N N N
HoursPoweredCount Number of hours powered On N N N
CommunicationErrorCount Number of communication N N N
errors
1Supported by TCxWave 6140

564 UnifiedPOS User's Guide

Table 314. Line Display specific properties
USB EIA232 RS485
Specific properties Description supported supported supported
OnlineTransitionCount Number of online transitions N N N
(on after screen blanking)

Note: USB devices use BCD level for firmware revision.

Table 315. Line Display manufacturer properties

USB EIA232 RS485
Manufacturer properties Description supported supported supported
IBM_PowerCycleCount Number of power on/off Y1 N N
cycles
IBM_UnexpectedResetsCo Number of unexpected Y1 N N
unt resets
1Supported by TCxWave 6140

MICR
Table 316. MICR
Device Bus Model name value
POSPrinter 4610-TI4/5/8/9/2CR EIA232/RS485/USB/Network 4610
POSPrinter 6145-2TC USB 6145

Table 317. MICR common properties

EIA232/RS485/USB
Common properties Description supported
UnifiedPOSVersion Version of the UnifiedPOS specification Y
supported
DeviceCategory Device category Y
ManufacturerName Device manufacturer's name Y
ModelName Device model name Y
SerialNumber Device serial number Y
ManufactureDate (WWYY format) Device manufacture date Y
MechanicalRevision Device hardware revision N
FirmwareRevision Device firmware revision Y
Interface Device hardware interface Y
InstallationDate Device installation date N
HoursPoweredCount Number of hours powered On N

Appendix A. JavaPOS support for UnifiedPOS device statistics properties 565

EIA232/RS485/USB
Common properties Description supported
CommunicationErrorCount Number of communication errors N

Table 318. MICR specific properties

EIA232/RS485/USB
Specific properties Description supported
GoodReadCount Number of successful reads Y
FailedReadCount Number of failed reads Y
FailedDateParseCount Number of failed data parses N

Table 319. MICR manufacturer properties

EIA232/RS485/USB
Manufacturer Properties Description supported
IBM_CurrentMICRNoiseValu Value of the MICR Noise on Y (Only 2CR model)
e the last read operation

Note:
1. POSPrinter microcode level used for Firmware Revision.
2. ManufacturerDate is only available for newer POSPrinters (after December 2005). Older
ones are not supported.
3. DeviceCategory value is taken from the programmatic name.

Motion sensor
Table 320. Motion sensor
Device Bus Model name value
SurePOS 500/600/AnyPlace Kiosk Embedded Toshiba Generic Motion Sensor

Table 321. Motion sensor common properties

Embedded
Common Properties Description Supported

UnifiedPOSVersion Version of the UnifiedPOS Y

specification supported
DeviceCategory Device category Y
ManufacturerName Device manufacturer's name Y
ModelName Device model name Y
SerialNumber Device serial number N
ManufactureDate Device manufacture date N
MechanicalRevision Device hardware revision N
FirmwareRevision Device firmware revision N

566 UnifiedPOS User's Guide

Embedded
Common Properties Description Supported

Interface Device hardware interface Y

InstallationDate Device installation date N
HoursPoweredCount Number of hours powerd On N
CommunicationErrorCount Number of communication errors N

Table 322. Motion Sensor specific properties

Specific properties Description Supported
MotionEventCount Number of motion occurrences N

MSR
Table 323. MSR
Device Bus Model name value
ANPOS ISO MSR USB NANPOS - ISO
ANPOS as System attached ISO PS2/USB NANPOS - ISO
MSR
4820 ISO MSR (SurePoint) USB 4820 - ISO
4820 JUCC MSR (SurePoint) USB 4820 - JUCC
4820/AnyPlace Kiosk/SurePOS EIA232 4820/500/600/AnyPlace Kiosk – ISO
500/600 ISO MSR
4820/AnyPlace Kiosk/SurePOS EIA232 4820/500/600/AnyPlace Kiosk –
500/600 JUCC MSR JUCC
50-key ISO MSR USB 50-key - ISO
CANPOS ISO MSR PS2 CANPOS - ISO
ANKPOS JUCC MSR USB ANKPOS - JUCC
ANKPOS as System keyboard JUCC PS2/USB ANKPOS - JUCC
MSR
133-key or Matrix - ISO MSR USB 133-key ISO
Keyboard 4685 K02 Ultra VII - RS485/USB 4685/Kbd V JUCC
JUCC MSR 4 pos
Keyboard 4685 K02 Ultra VII - RS485 4685 JUCC with Encoder
JUCC MSR/E 4 pos
Keyboard 4685 K02 Ultra VII - RS485 4685 JUCC with Encoder
JUCC MSR/E 6 pos
Keyboard V JUCC MSR RS485/USB 4685/Kbd V - JUCC

Appendix A. JavaPOS support for UnifiedPOS device statistics properties 567

Device Bus Model name value
133-key/4820/50-key/NANPOS ISO RS485 Toshiba MSR - ISO
MSR
SurePOS 4674/4820/50-key/ RS485 Toshiba MSR - JUCC
ANKPOS JUCC MSR
SureOne 4614/4615 ISO MSR PS2 461x - ISO
SurePOS 100 ISO MSR
50-key JUCC MSR USB 50-key - JUCC
Keyboard 4685 K03 JUCC MSR USB 4685-K03 - JUCC
Keyboard 4685 K03 JUCC MSR RS485 4685 / Kbd V - JUCC
Modular ANPOS with ISO MSR PS/2, USB Modular ANPOS-ISO
Modular ANPOS with JUCC MSR PS/2, USB Modular ANPOS-JUCC
Modular CANPOS with ISO MSR PS/2, USB Modular CANPOS-ISO
Modular CANPOS with JUCC MSR PS/2, USB Modular CANPOS-JUCC
Modular 67 Key with ISO MSR PS/2, USB Modular 67 Key-ISO
Modular 67 Key with JUCC MSR PS/2, USB Modular 67 Key-JUCC
Modular 67-Key/Display ISO MSR USB Modular 67 Key-ISO
TCx Wave 6140 Integrated MSR USB TCxWave 6140-ISO
TCx 800 Integrated MSR USB ISO
6149 Integrated MSR USB 6149-ISO
TCx Display Integrated MSR USB ISO

Table 324. MSR common properties

USB PS2 EIA232 RS485
Common properties Description supported supported supported supported
UnifiedPOSVersion Version of the UnifiedPOS Y Y Y Y
specification supported
DeviceCategory Device category Y Y Y Y
ManufacturerName Device manufacturer's Y Y Y Y
name
ModelName Device model name Y Y Y Y
SerialNumber Device serial number Y N N N
ManufactureDate Device manufacture date. Y¹ N N N
In WWYY format.
MechanicalRevision Device hardware revision N N N N
FirmwareRevision Device firmware revision Y N N N
Interface Device hardware interface Y Y Y Y

568 UnifiedPOS User's Guide

USB PS2 EIA232 RS485
Common properties Description supported supported supported supported
InstallationDate Device installation date N N N N
HoursPoweredCount Number of hours powered Y¹ N N N
On
CommunicationErrorCou Number of N N N N
nt communication errors

¹ Supported by USB Modular ANPOS, Modular CANPOS, Modular 67 Key Keyboards and
SurePoint EC Level >= 400, TCxWave 6140

Table 325. MSR manufacturer properties table

Manufacturer properties Description USB RS485 EIA232
IBM_PowerCycleCount Number of power on/off cycles Y¹ N N
IBM_UnexpectedResetsCount Number of unexpected resets Y¹ N N

¹ Supported by USB Modular ANPOS, Modular CANPOS, Modular 67 Key Keyboards and
SurePoint EC Level >= 400, TCxWave 6140

Table 326. MSR specific properties

USB PS2 EIA232 RS485
Specific properties Description supported supported supported supported
GoodReadCount Number of Y¹ N N N
successful
reads
FailedReadCount Number of Y¹ N N N
failed reads
UnreadableCardCount Number of Y¹ N N N
failed data
parses
MissingStartSentinelTrack1Count Number of Y¹ N N N
Reads that
Miss Start
Stentinel
ParityLRCErrorTrack1Count Number of Y¹ N N N
LRC Error
MissingStartSentinelTrack2Count Number of Y¹ N N N
Reads that
Miss Start
Stentinel
ParityLRCErrorTrack2Count Number of Y¹ N N N
LRC Error
MissingStartSentinelTrack3Count Number of Y¹ N N N
Reads that

Appendix A. JavaPOS support for UnifiedPOS device statistics properties 569

USB PS2 EIA232 RS485
Specific properties Description supported supported supported supported
Miss Start
Stentinel
ParityLRCErrorTrack3Count Number of Y¹ N N N
LRC Error
MissingStartSentinelTrack4Count Number of Y¹ N N N
Reads that
Miss Start
Stentinel
ParityLRCErrorTrack4Count Number of Y¹ N N N
LRC Error

¹ Supported by USB Modular ANPOS, Modular CANPOS, Modular 67 Key Keyboards and
SurePoint EC Level >= 400
Note: USB devices use BCD level for firmware revision.

POS keyboard
Table 327. POS keyboard
Device Bus Model name value
NANPOS POSKeyboard - SBCS RS485/USB NANPOS
NANPOS POSKeyboard - System PS2/USB NANPOS
attached
4820 POSKeyboard (SurePoint- PS2/RS485/USB Keypad
keypad)
50-key POSKeyboard - SBCS RS485/USB 50-key
CANPOS POSKeyboard - SBCS PS2 CANPOS
ANKPOS - DBCS RS485/USB ANKPOS
ANKPOS - DBCS System Keyboard PS2/USB ANKPOS
133-key or Matrix - SBCS RS485/USB 133-key
PLU Keyboard III with Display RS485/USB PLU
Keyboard 4685 K02 Ultra VII - 4 pos RS485/USB 4685
Keylock
Keyboard 4685 K02 Ultra VII - RS485 4685
MSR/E 4 pos Keylock
Keyboard 4685 K02 Ultra VII - RS485 4685
MSR/E 6 pos Keylock
Keyboard V RS485/USB Kbd V
SurePOS 4674 POSKeyboard RS485 4674/4685-K03

570 UnifiedPOS User's Guide

Device Bus Model name value
SureOne 4614/4615 Keyboard PS2 461x
SurePOS 100 – Keyboard
50-key POSKeyboards JUCC MSR - RS485/USB 50-key
DBCS
Keyboard 4685 K03 USB 4685-K03
Keyboard 4685 K03 RS485 4674/4685-K03
Modular ANPOS Keyboard PS/2, USB Modular ANPOS
Modular CANPOS Keyboard PS/2, USB Modular CANPOS
Modular 67 Key Keyboard USB Modular 67 Key
Modular 67 Key Keyboard with USB Modular 67 Key
Display
32-Key programmable keypad with USB Keypad with Keylock
Keylock
32-Key programmable keypad with USB Keypad with Electronic Keylock
Electronic Keylock
32-Key programmable keypad with USB Keypad with Keylock and MSR
Keylock and MSR

Table 328. POS Keyboard common properties

USB PS2 RS485
Common properties Description supported supported supported
UnifiedPOSVersion Version of the UnifiedPOS Y Y Y
specification supported
DeviceCategory Device category Y Y Y
ManufacturerName Device manufacturer's name Y Y Y
ModelName Device model name Y Y Y
SerialNumber Device serial number Y N N
ManufactureDate Device manufacture date. In Y¹ N N
WWYY format
MechanicalRevision Device hardware revision N N N
FirmwareRevision Device firmware revision Y N N
Interface Device hardware interface Y Y Y
InstallationDate Device installation date N N N
HoursPoweredCount Number of hours powered On Y¹ N N
CommunicationErrorCount Number of communication N N N
errors

Appendix A. JavaPOS support for UnifiedPOS device statistics properties 571

¹ Supported by USB Modular ANPOS, Modular CANPOS, Modular 67 Key Keyboards and
SurePoint EC Level >= 400

Table 329. POS keyboard manufacturer properties table

Manufacturer properties Description USB PS2 RS485
IBM_PowerCycleCount Number of power on/off cycles Y¹ N N
IBM_UnexpectedResetsCount Number of unexpected resets Y¹ N N
IBM_ConfigurationVersion Device configuration version Y¹ N N

¹ Supported by USB Modular ANPOS, Modular CANPOS, Modular 67 Key Keyboards and
SurePoint EC Level >= 400

Table 330. POS Keyboard specific properties

USB PS2 RS485
Specific properties Description supported supported supported
KeyPressedCount Number of keys pressed Y¹ N N

¹ Supported by USB Modular ANPOS, Modular CANPOS, Modular 67 Key Keyboards and
SurePoint EC Level >= 400
Note: USB devices use BCD level for firmware revision.

POS printer
Table 331. POS printer
Device Bus Model name value
4610 TI3 (thermal/impact) EIA232/RS485/USB 4610-TI3/4
Device: 4610 2NR (thermal/impact) - EIA232/RS485/USB 4610-2NR-SBCS
SBCS
4610 2CR (2NR+flipper/MICR) - EIA232/RS485/USB 4610-2CR-SBCS
SBCS
4610 2NR (Thermal/impact) - DBCS EIA232/RS485/USB 4610-2NR-DBCS
4610 2CR (2NR+flipper/MICR) - EIA232/RS485/USB 4610-2CR-DBCS
DBCS
4610 TI4 (TI3+flipper/MICR) EIA232/RS485/USB 4610-TI3/4
4610 TI5 (DBCD TI3) EIA232/RS485/USB 4610-TI5
4610 TI8 EIA232/RS485/USB 4610-TI8
4610 TI9 EIA232/RS485/USB 4610-TI9
4610 TI1/2 (thermal/impact) EIA232/RS485 4610-TI1/2
4610 Tx6 (SS thermal) EIA232/RS485/USB 4610-Tx6
4610 Tx7 (SS thermal DBCS) EIA232/RS485/USB 4610-Tx7
4689 TI5 all except 001 and 002 RS485/USB 4689
(DBCS)

572 UnifiedPOS User's Guide

Device Bus Model name value
4674 Embedded Printer - same as RS485 4674
4689

SureOne 4614/4615 Thermal EIA232 461x-Thermal

SurePOS 100 – Thermal

SureOne 4613/4614/4615 Impact EIA232 461x-Impact

SurePOS 100 – Impact

6145 2TN (thermal/impact) - SBCS USB 6145-2TN-SBCS

6145 2TC (2DR+flipper/MICR) - USB 6145-2TC-SBCS
SBCS
6145 2TN (thermal/impact) - DBCS USB 6145-2TN-DBCS
6145 2TC (2DR+flipper/MICR) - USB 6145-2TC-DBCS
DBCS

Table 332. POS printer common properties

6145 and 4610 SureONE
Supported 4674/4689 Impact /
Common properties Description Buses RS485 4689 USB Thermal
UnifiedPOSVersion Version of the UnifiedPOS Y Y Y Y
specification supported
DeviceCategory Device category Y Y Y Y
ManufacturerName Device manufacturer's name Y Y Y Y
ModelName Device model name Y Y Y Y
SerialNumber Device serial number Y N Y N
ManufactureDate (WWYY Device manufacture date Y N N N
format)
MechanicalRevision Device hardware revision N N N N
FirmwareRevision Device firmware revision Y Y Y N
Interface Device hardware interface Y Y Y Y
InstallationDate Device installation date N N N N
HoursPoweredCount Number of hours powered N N N N
On
CommunicationErrorCount Number of communication N N N N
errors

Appendix A. JavaPOS support for UnifiedPOS device statistics properties 573

Table 333. POS printer specific properties
6145 and 4610
Supported 4674/4689 SureONE
Specific properties Description Buses RS485 4689 USB Thermal
BarCodePrintedCount Number of barcodes printed Y N N N
FormInsertionCount Number of forms inserted Y N N N
into the document/slip
station
HomeErrorCount Number of home errors Y N N N
JournalCharacterPrintedCou Number of journal characters N N N N
nt printed
JournalLinePrintedCount Number of journal lines N N Y N
printed
MaximumTempReachedCou Number of times maximum Y N N N
nt temperature reached
NVRAMWriteCount Number or times NVRAM is Y N N N
written to
PaperCutCount Number of paper cuts Y Y Y N
FailedPaperCutCount Number of failed paper cuts Y N N N
(See note 6.)

PrinterFaultCount Number of printer faults N N N N

PrintSideChangeCount Number of print side changes Y N N N
(or check flips) performed
(See note 5.)

FailedPrintSideChangeCount Number of print side change Y N N N

(of check flip) failures
(See note 5.)

ReceiptCharacterPrinted Number of receipt characters Y N N N

Count printed

ReceiptCoverOpenCount Number of times receipt Y N N N

cover was opened
ReceiptLineFeedCount Number of receipt line feeds Y N N N
performed
ReceiptLinePrintedCount Number of receipt lines N Y Y N
printed
SlipCharacterPrintedCount Number of document/slip Y N N N
characters printed
SlipCoverOpenCount Number of times the Y N N N
document/slip station cover
opened

574 UnifiedPOS User's Guide

6145 and 4610
Supported 4674/4689 SureONE
Specific properties Description Buses RS485 4689 USB Thermal
SlipLineFeedCount Number of document/slip Y N N N
line feeds performed
SlipLinePrintedCount Number of document/slip N N N N
lines printed
StampFiredCount Number of stamps fired N N N N

Note:
1. POSPrinter microcode level used for firmware revision.
2. ManufacturerDate is only available for newer POSPrinters (after December 2005). Older
ones are not supported.
3. For 4689 USB and RS485 models, PaperCutCount increments by 10 after 10 cuts.
4. In some cases a tag <Value/> may be retrieved, indicating that the requested statistic is not
supported for the printer firmware, or it has never been initialized.
5. Only valid on 4610-TI4/8/9/2xR and 6145-2TN.
6. Only valid on Tx6/Tx7/2xR/1NR models.

Table 334. POS printer manufacturer properties

RS232/
Manufacturer Properties RS485/USB
Name Description Supported
IBM_ReceiptPaperRemaining Number of mm of paper left in the Yes, see note²
printer
IBM_UnexpectedSlipCoverOpenCount Number of times the Slip cover Yes, see note¹
was opened without an error
condition
IBM_SlipFeedErrorCount Number of Slip Feed errors Yes, see note¹
IBM_ReceiptPaperJamCount Number of Receipt Paper Jams Yes, see note²
IBM_FlashWriteFailedCount Number of failed flash writes Yes, see note²
IBM_UnexpectedRecCoverOpenCount Number of times the Receipt cover Yes, see note²
was opened without an error
condition
IBM_ImpactHeadFailedCount Number of Impact head failed Yes, see note¹
coils
IBM_ThermalPrintHeadElementFailure Number of the Thermal Head Yes, see note²
element that is failing (Can be
more than 1)

¹Only valid on 4610-2xR and 6145-2TC models.

²Only valid on 4610-2xR/1NR and 6145-2Tx/1TN models.

Appendix A. JavaPOS support for UnifiedPOS device statistics properties 575

Scale
Table 335. Scale
Device Bus Model name value Manufacturer
OEM PSC Magellan USB OEM - Scale OEM
Scanner/Scale Model 384
OEM PSC Magellan USB OEM - Scale OEM
Scanner/Scale Model 8201
Toshiba 469x Model 1 RS485 469x OEM
Toshiba 469x Model 2 RS485 469x OEM

Table 336. Scale common properties

RS485
Common properties Description USB supported supported
UnifiedPOSVersion Version of the UnifiedPOS Y Y
specification supported
DeviceCategory Device category Y Y
ManufacturerName Device manufacturer's name Y Y
ModelName Device model name Y Y
SerialNumber Device serial number Y N
ManufactureDate Device manufacture date N N
MechanicalRevision Device hardware revision N N
FirmwareRevision Device firmware revision Y N
Interface Device hardware interface Y Y
InstallationDate Device installation date N N
HoursPoweredCount Number of hours powered On N N
CommunicationErrorCount Number of communication errors N N

Table 337. Scale specific properties

RS485
Specific properties Description USB supported supported
GoodWeightReadCount Number of successful weight reads N N

Note: USB devices use BCD level for Firmware Revision.

576 UnifiedPOS User's Guide

Scanner
Table 338. Scanner
Device Bus Model name value Manufacturer
OEM PSC Magellan USB OEM-Scanner OEM
Scanner/Scale - Model 384
OEM PSC Magellan USB OEM-Scanner OEM
Scanner/Scale - Model 8201
OEM Symbol Hand Held - USB OEM-Scanner OEM
Model LS4804
OEM Symbol Hand Held - USB OEM-Scanner OEM
Model LS2104
OEM Symbol Hand Held - RS485 OEM-Scanner OEM
Model M2004
Toshiba Hand Held BCR RS485 4500 OEM
Model 1 (4500)
Toshiba Hand Held BCR RS485 4501 OEM
Model 2 (4501)
Toshiba 1520 Hand Held RS485 1520 OEM
Model A02
Toshiba 4685 Hand Held RS485 4685 OEM
Model 001/K001
Toshiba 4696 Scanner/Scale RS485 4696 OEM
Model 1
Toshiba 4697 Model 1 RS485 4697 OEM
Toshiba 4698 Model 1/2 RS485 4698 OEM
AnyPlace Kiosk - 4838 Line EIA232 Line OEM
AnyPlace Kiosk - Omni EIA232 Omni OEM

Note: When RS485 Scanners do not have a JposEntry configuration properties the “OEM-
Scanner” Model Name value will be in use (Except 1520 model).

Table 339. Scanner common properties

USB RS485
Common properties Description supported supported EIA232
UnifiedPOSVersion Version of the UnifiedPOS Y Y Y
specification supported
DeviceCategory Device category Y Y Y
ManufacturerName Device manufacturer's name Y Y Y
ModelName Device model name Y Y Y
SerialNumber Device serial number Y N N

Appendix A. JavaPOS support for UnifiedPOS device statistics properties 577

USB RS485
Common properties Description supported supported EIA232
ManufactureDate Device manufacture date N N N
MechanicalRevision Device hardware revision N N N
FirmwareRevision Device firmware revision Y N N
Interface Device hardware interface Y Y Y
InstallationDate Device installation date N N N
HoursPoweredCount Number of hours powered On N N N
CommunicationErrorCount Number of communication N N N
errors

Table 340. Scanner specific properties

USB RS485
Specific properties Description supported supported EIA232
GoodScanCount Number of successful scans N N N

Note:
1. USB devices use BCD level for firmware revision.
2. DeviceCategory value is taken from programmatic name.

Tone indicator
Table 341. Tone indicator
Device Bus Model name value
NANPOS Tone Indicator - SBCS RS485/USB NANPOS
NANPOS Tone Indicator as System PS2/USB NANPOS
Keyboard
4820 Tone Indicator (SurePoint) PS2/RS485/USB 4820
50-key Tone Indicator - SBCS RS485/USB 50-key
ANKPOS - DBCS RS485/USB ANKPOS
ANKPOS - DBCS as System PS2/USB ANKPOS
Keyboard
133-key or Matrix - SBCS RS485/USB 133-key
PLU Keyboard III with Display RS485/USB PLU
Keyboard 4685 K02 Ultra VII - 4 pos RS485/USB 4685
Keylock
Keyboard 4685 K02 Ultra VII - USB 4685
MSR/E 4 pos
Keyboard 4685 K02 Ultra VII - USB 4685
MSR/E 6 pos

578 UnifiedPOS User's Guide

Device Bus Model name value
Keyboard V RS485/USB Kbd V
SurePOS 4674 Tone Indicator RS485 4674/4685-K03
50-key POSKeyboard JUCC MSR - USB 50-key
DBCS
4610 Tx6/Tx7 Printer ToneIndicator EIA232/RS485/USB 4610-Tx6/Tx7
Keyboard 4685 K03 USB 4685-K03
Keyboard 4685 K03 RS485 4674/4685-K03
Modular ANPOS Keyboard PS/2, USB Modular ANPOS
Modular CANPOS Keyboard PS/2, USB Modular CANPOS
Modular 67 Key Keyboard PS/2, USB Modular 67 Key
Modular 67 Key Keyboard with USB Modular 67 Key
Display
TCxDisplay 6149 Tone Indicator USB 6149
4610 1NR Printer Tone Indicator EIA232/RS485/USB 4610-1NR
6145 2Tx Printer Tone Indicator USB 6145-2Tx

Table 342. Tone indicator common properties

4610
Printer
built-in
tone USB PS2 RS485
Common properties Description indicator supported supported supported
UnifiedPOSVersion Version of the UnifiedPOS Y Y Y Y
specification supported
DeviceCategory Device category Y Y Y Y
ManufacturerName Device manufacturer's Y Y Y Y
name
ModelName Device model name Y Y Y Y
SerialNumber Device serial number Y Y N N
ManufactureDate Device manufacture date. Y¹ N N N
In WWYY format.
MechanicalRevision Device hardware revision N N N N
FirmwareRevision Device firmware revision Y Y N N
Interface Device hardware interface Y Y Y Y
InstallationDate Device installation date N N N N
HoursPoweredCount Number of hours powered Y¹ N N N
On

Appendix A. JavaPOS support for UnifiedPOS device statistics properties 579

4610
Printer
built-in
tone USB PS2 RS485
Common properties Description indicator supported supported supported
CommunicationErrorCou Number of N N N N
nt communication errors

¹ Supported by USB Modular ANPOS, Modular CANPOS, Modular 67 Key Keyboards and
SurePoint EC Level >= 400

Table 343. Tone Indicator manufacturer properties table

4610 Printer built-in
Manufacturer properties Description tone indicator USB PS2 Embedded
IBM_PowerCycleCount Number of power on/off N Y¹ N N
cycles
IBM_UnexpectedResetsCount Number of unexpected N Y¹ N N
resets

¹ Supported by USB Modular ANPOS, Modular CANPOS, Modular 67 Key Keyboards and
SurePoint EC Level >= 400

Table 344. Tone indicator specific properties

4610
Printer
built-in
tone USB PS2 RS485
Specific properties Description indicator supported supported supported
ToneSoundedCount Number of tones played N Y¹ N N

¹ Supported by USB Modular ANPOS, Modular CANPOS, Modular 67 Key Keyboards and
SurePoint EC Level >= 400
Note: USB devices use BCD level for firmware revision.

580 UnifiedPOS User's Guide

Appendix B. Java Web Start configuration to access the POS
Control Center
Java Web Start configuration to access the POS Control Center

Install Java Development Kit and JavaPOS driver

Make sure you have installed the Web Plugin designed for the Java JDK you are using. To
validate that you have it installed just run the following command: javaws.

Create a KeyStore
To create a store key:
1. Change to webstart directory.
For Windows: cd c:\POS\JavaPOS\webstart
Note: It is assumed that the product is installed in the default directory.
For Linux: cd /opt/tgcs/javapos/webstart
Note: This and following steps is assumed they are executed with root user.
2. For Windows:
Execute keytool.exe -genkey -keystore jposKeyStore -alias jposAlias
For Linux:
Execute keytool -genkey -keystore jposKeyStore -alias jposAlias
Expected input:

Enter keystore password: “keyStorePassword”

What is your first and last name?

[Unknown]: “userName”

What is the name of your organizational unit?

[Unknown]: “yourOrganizationalUnit”

What is the name of your organization?

[Unknown]: “yourOrganization”

What is the name of your City or Locality?

[Unknown]: “yourCity”

What is the name of your State or Province?

[Unknown]: “yourState”

What is the two-letter country code for this unit?

[Unknown]: “us”

Is CN=userName, OU=yourOrganizationUnit, O=yourOrganization,

L=yourCity, ST=yourState, C=us correct?
type "yes" or "no") [no]: yes

Enter key password

for <jposAlias>: RETURN if same as keystore password):”aliasPassword”

Create a self-signed certificate

To create a self-signed certificate:

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 581

1. Execute this command, keytool.exe -list -v -keystore jposKeyStore .
2. Enter keystore password: keyStorePassword
Expected input:

Keystore type: jks

Keystore provider: IBMJCE

Your keystore contains 1 entry

Alias name: jposAlias

Creation date: Apr 9, 2008
Entry type: keyEntry
Certificate chain length: 1
Certificate[1]:
Owner: CN=userName, OU=yourOrganizationUnit,
O=yourOrganization, L=yourCity, ST=yourState, C=us
Issuer: CN=userName, OU= yourOrganizationUnit,
O= yourOrganization, L= yourCity, ST= yourState, C=us
Serial number: 47fcfb8e
Valid from: 4/9/08 2:23 PM until: 7/8/08 2:23 PM
Certificate fingerprints:
MD5: BB:A4:36:45:C4:0D:FD:A0:0D:66:12:4F:D0:B3:D8:EE
SHA1:
BE:D4:D4:7A:50:A6:A3:8B:F9:D6:38:2E:0E:BD:15:D1:9B:83:B7:24

Create jpos.xml
Create jpos.xml and save in the following directory:
For Windows: cd c:\POS\JavaPOS\config
For Linux: cd /opt/tgcs/javapos/etc

Create the resource JAR

To create the resource JAR:
1. Change directory
Windows: cd c:\POS\JavaPOS\config
Linux: cd /opt/tgcs/javapos/etc
2. Execute the appropriate command:
Windows: jar -cvf c:\POS\JavaPOS\webstart\tgcsjpos_resources.jar *.*
Linux: jar -cvf /opt/tgcs/javapos/webstart/tgcsjpos_resources.jar *.*
3. Change directory (only for Linux)

Windows
No action is necessary

Linux
cd /opt/javax-usb/etc
4. Execute the appropriate command (Only for Linux)

Windows
No action is necessary

582 UnifiedPOS User's Guide

Linux
jar -uf /opt/tgcs/javapos/webstart/tgcsjpos_resources.jar
javax.usb.properties

Sign the all JARs file with the test certificate

To sign the all JARs file with the test certificate
1. Copy all the jars located in:
Windows: C:\POS\JavaPOS\lib to C:\POS\JavaPOS\webstart directory.
Linux: /opt/tgcs/javapos/lib and /opt/javax-usb/lib to /opt/tgcs/javapos/
webstart directory.
Note: It is necessary to copy all the jar files for the JavaPOS device drivers to the webstart
directory. Otherwise, once the existing jar files are signed, a Java application that is not
launched through the webstart interface will not be able to use the JavaPOS device drivers.
2. Sign all jars located at webstart directory.
For example, to sign the jtux.jar use the following command: jarsigner.exe
-keystore jposKeyStore –storepass “keyStorePassword” -keypass
“aliasPassword” tgcsjavapos.jar jposAlias

Run JNLP file

To run the JNLP file
1. Move to:
Windows: cd c:\POS\JavaPOS\webstart
Linux: cd /opt/tgcs/javapos/webstart
2. Run.
For Windows or Linux: Javaws ToshibaJavaPOS.jnlp.
Note: When UnifiedPOS was installed without "System Management Support",
edit ToshibaJavaPOS.jnlp and comment out the following line: <!jar
href="jpos_sysmgmt.jar" download="eagerly" />

Appendix B. Java Web Start configuration to access the POS Control Center 583
584 UnifiedPOS User's Guide
Appendix C. Additional information for SUSE Linux Enterprise
(SLE)
Additional information for SUSE Linux Enterprise (SLE)

USB Alphanumeric POS Keyboard does not receive scan codes

Although this problem can be caused by multiple issues, the most common problem is
that the /dev/input/event<number> does not have the correct permissions. Follow this
procedure to validate that this is the problem:
1. List the USB devices and identify the event associated with your keyboard:
a. Run cat /proc/bus/input/devices and search for an entry for your
POSKeyboard. It should look similar to the following:

I: Bus=0003 Vendor=04b3 Product=4604 Version=0100

N: Name="(c) Copyright IBM Corp. 2008 IBM Retail USB Alphanumeric POS
Keyboard "
P: Phys=usb-0000:00:1d.0-1.4/input0
S: Sysfs=/devices/pci0000:00/0000:00:1d.0/usb4/4-1/4-1.4/4-1.4:1.0/input/
input4
U: Uniq=
H: Handlers=kbd event0
B: EV=120013
B: KEY=10000 7 ff9f207a c14057ff febeffdf ffefffff ffffffff fffffffe
B: MSC=10
B: LED=1f

b. The ‘event0’ is associated with the POS Keyboard.

2. Review the event node and verify that it has the correct permissions. It should have 666:
a. Run ls -la /dev/input/event?
3. Manual Fix: Add permissions to the event node.
a. Run chmod 666 /dev/input/event0
4. Automatic fix: Add a udev rule to set the permissions when the USB keyboard is hot-
plugged.
a. Create a file named 83-tgcsjavapos.rules at /etc/udev/rules.d
b. Add the following line to the file:
KERNEL=="event*", NAME="input/%k", MODE="0666", GROUP="users"
c. Restart your system

Known GUI issues

On certain systems, such as SurePOS 300 (4810-34x), GUI applications may not display correctly.
This could be due to conflicts with JVM and Desktop Effects, which are enabled on SLE 11 SP2
by default.
To resolve this issue, disable Desktop Effects on SLE 11 SP3:
1. Go to Computers –> More Applications –> Desktop Effects.
2. Under Tools, uncheck Enable Desktop Effects.

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 585

Power management

JavaPOS drivers support the Suspend to RAM (S3) option for SUSE Linux Enterprise (SLE), also
referred to as Stand-by or Sleep. This section details the ways in which a system should be
suspended.

SLE 11 and PM Utils package

For SLE 11 (without service pack and newer), the JavaPOS driver requires the pm-utils package
to be installed. The system can be suspended in the following ways:
• Log in as root to X-Windows. Click Menu > Shutdown > Suspend.
• Log in as root to X-Windows. Open x terminal and execute pm-suspend.
Note: X-Windows may not work on all systems.
Make sure that the system has been updated with the latest video drivers and BIOS version, as
described in the POS Linux Operating System Configuration Guide: https://
tgcs04.toshibacommerce.com/cs/idcplg?
IdcService=FLD_BROWSE&path=%2fpublications%2fSW%2fOS%2fLinux%2fSLE11SP3&doMar
kSubscribed=1.
Important: The use of the s2ram command to suspend to RAM is not supported. JavaPOS
drivers require pm-suspend.

SLE 12

For more information, see the following documents:

• https://tgcs04.toshibacommerce.com/cs/idcplg?
IdcService=GET_FILE&fldFile=fFileGUID:A125C751BF52C0FF4D08A127C1AAD21F&fldBro
wsingMode=contribution
• https://tgcs04.toshibacommerce.com/cs/idcplg?
IdcService=FLD_BROWSE&path=%2fpublications%2fSW%2fOS%2fLinux%2fSLE11SP3&do
MarkSubscribed=1

586 UnifiedPOS User's Guide

Appendix D. JavaPOS device configuration for Linux
JavaPOS device configuration for Linux

Serial ports configuration

Serial port enumeration utility

The Toshiba SurePOS 300, 500, and 700 systems may require the configuration of additional
COM ports beyond COM1 and COM2. By default, /dev/ttyS0 (COM1) and /dev/ttyS1
(COM2) are configured by the operating system.
To configure the additional COM ports available on SurePOS 300, 500,
and 700 systems, a setserial utility is provided. This utility configures
additional COM ports correctly and remaps them starting with /dev/ttyS2
(COM3). The setserial configuration utility is available for download from the
following link: www.toshibacommerce.com/wps/myportal/?urile=wcm:path:/en/home/support/
knowledgebase/software-kb/slepos/11/r1004425&mapping=SupportDetail .
Version tested: Toshiba_setserial-1.0.0-3.i586.rpm or higher.
On SurePOS 500 systems, the integrated MSR and Touch devices are mapped to the following
COM ports:
• TOUCH device: /dev/ttyS4 (COM 5)
• MSR device: /dev/ttyS5 (COM 6)
This means that the portName for the integrated RS-232 MSR in jpos.xml must be set to COM6,
as shown:
<prop name="portName" type="String" value="COM6"/>

Toshiba systems and COM port assignments reference

Table 345 provides default mapping information for additional COM ports on Toshiba systems.
The table shows the ports assigments after installing Toshiba_setserial-<Version>.rpm
or higher.

Table 345. Mapping of additional COM ports

COM
Port JavaPOS Device Mapping
System/Model Label COM Port Assignment (jpos.xml)

All POS Systems

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 587

COM
Port JavaPOS Device Mapping
System/Model Label COM Port Assignment (jpos.xml)

Common A /dev/ttyS0 COM1

B /dev/ttyS1 COM2

SurePOS 700

4800-7x5 C /dev/ttyS4 COM5

4800-7x4 D /dev/ttyS5 COM6
4800-7x3
4800-7x2

4800-7x1 C /dev/ttyS5 COM6

D /dev/ttyS4 COM5

4800-7x5 (with EIA232 IO card) E /dev/ttyS6 COM7

4800-7x4 (with EIA232 IO card) F /dev/ttyS7 COM8
4800-7x3 (with EIA232 IO card) H /dev/ttyS3 COM4
4800-7x2 (with EIA232 IO card)
4800-7x1 (with EIA232 IO card)

SurePOS 500

4846-545/565 C /dev/ttyS5 COM6

D /dev/ttyS3 COM4

4851-514 C /dev/ttyS4 COM5

D /dev/ttyS3 COM4

4840-5x3 C <TBD> <TBD>

D /dev/ttyS5 COM6

SurePOS 300

4810-34x (with EIA232 IO card) C /dev/ttyS7 COM8

4810-35x (with EIA232 IO card) D /dev/ttyS4 COM5
E /dev/ttyS5 COM6
F /dev/ttyS6 COM7

4810-33x C /dev/ttyS6 COM7

4810-32x D /dev/ttyS7 COM8
E /dev/ttyS4 COM5
F /dev/ttyS5 COM6

4810-34x ( with USB IO card) C /dev/ttyS7 COM8

TCx 300

4810-36x (with EIA232 IO card 9 C /dev/ttyS2 COM3

pin) D /dev/ttyS3 COM4
4810-37x (with EIA232 IO card 9 E /dev/ttyS4 COM5
pin) F /dev/ttyS5 COM6

588 UnifiedPOS User's Guide

COM
Port JavaPOS Device Mapping
System/Model Label COM Port Assignment (jpos.xml)

4810-38x ((with EIA232 IO card 9

pin)

TCx 700
4900-7x6 C /dev/ttyS2 COM3
D /dev/ttyS3 COM4

4900-7x6 (with EIA232 IO card 9 E /dev/ttyS4 COM5

pin) F /dev/ttyS5 COM6
H /dev/ttyS7 COM8

4900-7x6 (with EIA232 IO card 15 E /dev/ttyS4 COM5

pin) F /dev/ttyS5 COM6
H /dev/ttyS7 COM8

TCx 800
TCx 800 (with EIA232 IO card A /dev/ttyS0 COM1
Head Card) B /dev/ttyS1 COM2

TCx 800 (with EIA232 IO card C /dev/ttyUSB2 COM5

Base Card) D /dev/ttyUSB3 COM6
E /dev/ttyUSB1 COM4
F /dev/ttyUSB0 COM3

Serial port access

The operating system does not, by default, provide users with access to serial ports. You must
provide access to the non-root users. You must also set the raw mode in the serial port so that
the device will work properly:
Manual configuration
1. TCx800 only: Create a symbolic link
• Run ln –sf /dev/ttyUSB? /dev/ttyS?
2. Add permissions to serial ports:
• Run chmod 666 /dev/ttyS?
3. Set RAW mode (for the RS-232 port, execute the following):
• Run /bin/stty –F /dev/ttyS? raw
Automatic configuration using udev a rule
1. Create a file with the name 83-toshibajavapos.rules at /etc/udev/rules.d
2. Add the following lines to the file:
KERNEL=="ttyS*", MODE="0666", GROUP="users"

Appendix D. JavaPOS device configuration for Linux 589

KERNEL=="ttyS*", RUN+="/bin/stty -F /dev/%k raw"
3. Restart your system.

TCxWave USB to RS-232 adapter

On TCxWave systems, the USB to RS-232 adapter uses the FTDI drivers to communicate with
serial devices. The FTDI drivers are included in the operative system, but JavaPOS drivers
require that the /dev/ttyUSB0 port is mapped to /dev/ttyS0(COM1).
To manually configure this port:
1. Remove the default serial port:
Run rm /dev/ttyS0(COM1)
2. Create a symbolic link:
Run ln –sf /dev/ttyUSB0 /dev/ttyS0
3. Add permissions to serial ports:
Run chmod 666 /dev/ttyS?
4. Set RAW mode:
Run /bin/stty –F /dev/ttyS0 raw
Important: This configuration must be done every time the device goes to Offline status.
Note: The last digit of the mapping on the ttyUSB may change depending on the previous USB
devices connected to the system.

USB device access

The operating system does not, by default, provide users with access to USB devices. The
JavaPOS RPM automatically enables USB device user access on your system.
If the default automatic configuration is unsuccessful, try the steps for manual configuration.

SLE 11 without Service Pack and newer SLE 11 versions

Automatic configuration using udev a rule

1. Create a file with the name 83-tgcsjavapos.rules at /etc/udev/rules.d
2. Add the following lines to the file:
ENV{SUBSYSTEM}=="input", ENV{DEVNAME}=="input/event*", MODE="0660", GROUP="users"
ENV{SUBSYSTEM}=="usb", ENV{DEVTYPE}=="usb_device", MODE="0674", OWNER="root",
GROUP="users"
BUS=="usb", SYSFS{idVendor}=="04b3", SYSFS{idProduct}=="*", MODE="0660",
GROUP="users"

3. Restart your system.

Manual configuration

590 UnifiedPOS User's Guide

To access Toshiba USB devices via javax.usb, create a rule in the udev directory.
For example, to provide access to all USB devices:
1. Edit the /etc/udev/rules.d/55-libsane.rules rule file.
2. Directly after the LABEL="libsane_rules_begin line add the following:

ATTR{idVendor}=="*", ATTR{idProduct}=="*", MODE="0666",

GROUP="users",ENV{libsane_matched}="yes"

PS/2 keyboard configuration

No additional configuration is required to enable PS/2 scan codes.

Background information
The following information is provided for debug purposes in case of issues with the
Toshiba PS/2 attached POS Keyboard.

/etc/ps2kbd.conf file
The ps2kbd.conf file is installed by default in the /etc directory. This file allows the
JavaPOS driver to enumerate the Toshiba PS/2 keyboard as a system attached keyboard.

Enabling raw scan codes

To support Toshiba PS/2 keyboard scan codes, the raw scan codes must be enabled. By
default, the raw scan codes are disabled by the OS. The JavaPOS RPM will automatically
enable raw scan codes on your system.

How to verify the status of atkbd.softraw

Run the command: cat /sys/bus/serio/drivers/atkbd/serio0/softraw. To
get raw scan codes, the atkbd.softraw should be set to 0.

Automatic configuration updating grub

Edit /boot/grub/menu.1st and add the atkbd.softraw=0 argument to the kernel
line. For example:
title SUSE Linux2 enterprise Desktop 11 - 2.6.<version>
root (hd0,6)
kernel /boot/vmlinuz-2.6.<version> root=/dev/disk/by-id/ata-
WDC_WD800BB-23FRA0_WD-WCAJD1482394
-part7 resume=/dev/disk/by-id/ata-WDC_WD800BB-23FRA0_WD-WCAJD1482394-part6
splash=silent
showopts vga=0x34b atkbd.softraw=0
initrd /boot/initrd-3.0.<version>

USB system attached POS keyboard configuration

For the Toshiba USB POS alphanumeric keyboard to function as a system attached keyboard, the
following configuration file must be present:
/opt/tgcs/javapos/etc/usbkbd.conf
If the configuration file for the USB system keyboard is not present, the Toshiba Alphanumeric
USB Keyboard will be enumerated in Point of Sale mode. This means that the scan codes will not
be available to the normal system keyboard mechanism.

Appendix D. JavaPOS device configuration for Linux 591

Touch device configuration

Please refer to the following documentation for configuration of Toshiba touch devices.
SLED/SLES/SLEPOS 11 SP3: https://tgcs04.toshibacommerce.com/cs/idcplg?
IdcService=FLD_BROWSE&path=%2fpublications%2fSW%2fOS%2fLinux%2fSLE11SP3&doMar
kSubscribed=1

592 UnifiedPOS User's Guide

Notices
This information was developed for products and services offered in the U.S.A.
Toshiba Global Commerce Solutions, Inc. (Toshiba Global Commerce Solutions) may not offer
the products, services, or features discussed in this document in other countries. Consult your
local Toshiba Global Commerce Solutions representative for information on the products and
services currently available in your area. Any reference to a Toshiba Global Commerce Solutions
product, program, or service is not intended to state or imply that only that Toshiba Global
Commerce Solutions product, program, or service may be used. Any functionally equivalent
product, program, or service that does not infringe any Toshiba Global Commerce Solutions
intellectual property right may be used instead. However, it is the user's responsibility to
evaluate and verify the operation of any non-Toshiba Global Commerce Solutions product,
program, or service.
Toshiba Global Commerce Solutions may have patents or pending patent applications covering
the subject matter in this document. The furnishing of this document does not give you any
license to these patents. You can send license inquiries, in writing, to:

Toshiba Global Commerce Solutions, Inc.

Attn: General Counsel
3901 South Miami Blvd.
Durham, NC 27703
United States of America

The following paragraph does not apply to the United Kingdom or any other country where
such provisions are inconsistent with local law: TOSHIBA GLOBAL COMMERCE SOLUTIONS
PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR
PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain
transactions, therefore, this statement may not apply to you.
This information could include technical inaccuracies or typographical errors. Changes are
periodically made to the information herein; these changes will be incorporated in new editions
of the publication. Toshiba Global Commerce Solutions may make improvements and/or
changes in the product(s) and/or program(s) described in this publication at any time without
notice.
Toshiba Global Commerce Solutions may use or distribute any of the information you supply in
any way it believes appropriate without incurring any obligation to you.
Any references in this information to non-Toshiba Global Commerce Solutions Web sites are
provided for convenience only and do not in any manner serve as an endorsement of those
Web sites. The materials at those Web sites are not part of the materials for this Toshiba Global
Commerce Solutions product and use of those Web sites is at your own risk.
Information concerning non-Toshiba Global Commerce Solutions products was obtained from
the suppliers of those products, their published announcements or other publicly available
sources. Toshiba Global Commerce Solutions has not tested those products and cannot confirm
the accuracy of performance, compatibility or any other claims related to non-Toshiba Global
Commerce Solutions products. Questions on the capabilities of non-Toshiba Global Commerce
Solutions products should be addressed to the suppliers of those products.
This information is for planning purposes only. The information herein is subject to change
before the products described become available.

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 593

Telecommunication regulatory statement
This product is not intended to be connected directly or indirectly by any means whatsoever
to interfaces of public telecommunications networks, nor is it intended to be used in a public
services network.

Electronic emission notices

When you attach a monitor to the equipment, you must use the designated monitor cable and
any interference suppression devices that are supplied with the monitor.

Federal Communications Commission (FCC) statement

This equipment has been tested and found to comply with the limits for a Class A digital device,
pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection
against harmful interference when the equipment is operated in a commercial environment.
This equipment generates, uses, and can radiate radio frequency energy and, if not installed
and used in accordance with the instruction manual, may cause harmful interference to radio
communications. Operation of this equipment in a residential area is likely to cause harmful
interference, in which case the user will be required to correct the interference at his own
expense. There is no guarantee that interference will not occur in a particular installation. If
this equipment does cause harmful interference to radio or television reception, which can be
determined by turning the equipment off and on, the user is encouraged to try to correct the
interference by one or more of the following measures:
1. Reorient or relocate the receiving antenna.
2. Increase the separation between the equipment and receiver.
3. Connect the equipment into an outlet on a circuit different from that to which the receiver is
connected.
4. Consult the dealer or experienced radio TV technician for help.
Properly shielded and grounded cables and connectors must be used in order to meet
FCC emission limits. Toshiba Global Commerce Solutions is not responsible for any radio
or television interference caused by using other than recommended cables and connectors
or by unauthorized changes or modifications to this equipment. Unauthorized changes or
modifications could void the user's authority to operate the equipment.
This device complies with part 15 of the FCC Rules. Operation is subject to the following two
conditions:
1. This device may not cause harmful interference, and
2. This device must accept any interference received, including interference that may cause
undesired operation.
The Product Unique Identifier
The Contact Information of Responsible Party in U.S.
Note: This equipment has been tested and found to comply with the limits for a Class A digital
device, pursuant to part 15 of the FCC Rules. These limits are designed to provide reasonable
protection against harmful interference when the equipment is operated in a commercial
environment. This equipment generates, uses, and can radiate radio frequency energy and, if not
installed and used in accordance with the instruction manual, may cause harmful interference
to radio communications. Operation of this equipment in a residential area is likely to cause
harmful interference in which case the user will be required to correct the interference at his own
expense.
Caution: When using IEEE 802.11a wireless LAN, this product is restricted to indoor use, due
to its operation in the 5.15- to 5.25-GHz frequency range. FCC/Industry Canada requires this
product to be used indoors for the frequency range of 5.15 GHz to 5.25 GHz to reduce the

594 UnifiedPOS User's Guide

potential for harmful interference to co-channel mobile satellite systems. High-power radar
is allocated as the primary user of the 5.25- to 5.35-GHz and 5.65- to 5.85-GHz bands. These
radar stations can cause interference with and/or damage to this device. The antennas for this
device are not replaceable. Any attempt at user access will damage your computer.

FCC Radiation Exposure Statement

To comply with the FCC RF exposure compliance requirements, the separation distance between
the antenna and the body of all persons must be at least 20 cm (8 inches).

Industry Canada Statement / Règlement d’Industry Canada

This Class A digital apparatus complies with Canadian ICES-003 and RSS247. This device
contains licence-exempt transmitter(s)/receiver(s) that comply with Innovation, Science and
Economic Development Canada’s licence-exempt RSS(s). Operation is subject to the following
two conditions:
1. This device may not cause interference.
2. This device must accept any interference, including interference that may cause undesired
operation of the device.
Cet appareil numérique de la classe A est conforme aux normes NMB-003 et RSS247 du Canada.
Le fonctionnement est soumis aux conditions suivantes:
1. Cet appareil ne doit pas provoquer d'interférences.
2. Cet appareil doit accepter toute interférence, y compris les interférences pouvant entraîner
un fonctionnement indésirable de l'appareil.

Industry Canada Radiation Exposure Statement

This equipment complies with IC radiation exposure limits set forth for an uncontrolled
environment. This equipment should be installed and operated with a minimum distance of
20 cm (8 inches) from the body of all persons.

Aviso para los usuarios de México

La operación de este equipo está sujeta a las siguientes dos condiciones:
1. Es posible que este equipo o dispositivo no cause interferencia prejudicial.
2. Este equipo o dispositivo debe aceptar cualquier interferencia. Incluyendo la que pueda
causar su operación no deseada.
Para saber el modelo de la tarjeta inalámbrica utilizada, revise la etiqueta regulatoria de la
impresora.

Notices 595
European Union Electromagnetic Compatibility (EMC) Directive
Conformance Statement
This product is in conformity with the protection requirements of EU Council Directive
2014/30/EU on the approximation of the laws of the Member States relating to electromagnetic
compatibility. Toshiba Global Commerce Solutions cannot accept responsibility for any failure
to satisfy the protection requirements resulting from a non-recommended modification of the
product, including the fitting of non-Toshiba Global Commerce Solutions option cards.
This product has been tested and found to comply with the limits for Class A Information
Technology Equipment according to CISPR 32/European Standard EN 55032. The limits for Class
A equipment were derived for commercial and industrial environments to provide reasonable
protection against interference with licensed communication equipment.
Attention: This is a Class A product. In a domestic environment this product may cause radio
interference, in which case the user may be required to take adequate measures.
Responsible manufacturer:
Toshiba Global Commerce Solutions, Inc.
3901 South Miami Blvd.
Durham, NC 27703
United States of America
European Community contact:
Toshiba Global Commerce Solutions, Inc.
Brand Manager - Europe, Middle East & Africa
Z.1 Researchpark 160, 1731 Asse, Belgium
Tel: +43 676 9077970
e-mail: [email protected]

This device operates in the 5150 – 5350 MHz frequency range and is restricted to indoor use
only. Outdoor operation in this range is prohibited.

United Kingdom Electromagnetic Compatibility (EMC) Directive

Conformance Statement
This product is in conformity with the protection requirements of Electromagnetic Compatibility
Regulations 2016 on the approximation of the laws of the United Kingdom relating to
electromagnetic compatibility. Toshiba Global Commerce Solutions cannot accept responsibility

596 UnifiedPOS User's Guide

for any failure to satisfy the protection requirements resulting from a non-recommended
modification of the product, including the fitting of non-Toshiba Global Commerce Solutions
option cards.
This product has been tested and found to comply with the limits for Class A Information
Technology Equipment according to CISPR 32 / BS EN 55032. The limits for Class A equipment
were derived for commercial and industrial environments to provide reasonable protection
against interference with licensed communication equipment.
Attention: This is a Class A product. In a domestic environment this product may cause radio
interference, in which case the user may be required to take adequate measures.
Responsible manufacturer:
Toshiba Global Commerce Solutions, Inc.
3901 South Miami Blvd.
Durham, NC 27703
United States of America
United Kingdom Contact:
Toshiba Global Commerce Solutions, Inc.
Charlie Templeton
Custom House Quay | Greenock, PA15 1EQ | United Kingdom
Tel: +44 1475 880 103
e-mail: [email protected]

This device operates in the 5150 – 5350 MHz frequency range and is restricted to indoor use
only. Outdoor operation in this range is prohibited.

Germany Class A statement

Deutschsprachiger EU Hinweis: Hinweis für Geräte der Klasse A EU-Richtlinie zur
Elektromagnetischen Verträglichkeit
Dieses Produkt entspricht den Schutzanforderungen der EU-Richtlinie 2014/30/EU zur
Angleichung der Rechtsvorschriften über die elektromagnetische Verträglichkeit in den EU-
Mitgliedsstaaten und hält die Grenzwerte der EN 55032 Klasse A ein.
Um dieses sicherzustellen, sind die Geräte wie in den Handbüchern beschrieben zu
installieren und zu betreiben. Des Weiteren dürfen auch nur von der Toshiba Global
Commerce Solutions empfohlene Kabel angeschlossen werden. Toshiba Global Commerce
Solutions übernimmt keine Verantwortung für die Einhaltung der Schutzanforderungen, wenn
das Produkt ohne Zustimmung der Toshiba Global Commerce Solutions verändert bzw.
wenn Erweiterungskomponenten von Fremdherstellern ohne Empfehlung der Toshiba Global
Commerce Solutions gesteckt/eingebaut werden.
EN 55032 Klasse A Geräte müssen mit folgendem Warnhinweis versehen werden: “Warnung:
Dieses ist eine Einrichtung der Klasse A. Diese Einrichtung kann im Wohnbereich Funk-

Notices 597
Störungen verursachen; in diesem Fall kann vom Betreiber verlangt werden, angemessene
Maβnahmen zu ergreifen und dafür aufzukommen.”
Deutschland: Einhaltung des Gesetzes über die elektromagnetische Verträglichkeit von
Geräten
Dieses Produkt entspricht dem “Gesetz über die elektromagnetische Verträglichkeit von
Geräten (EMVG)”. Dies ist die Umsetzung der EU-Richtlinie 2014/30/EU in der Bundesrepublik
Deutschland.
Zulassungsbescheinigung laut dem Deutschen Gesetz über die elektromagnetische
Verträglichkeit von Geräten (EMVG) (bzw. der EMC EG Richtlinie 2014/30/EU) für Geräte
der Klasse A
Dieses Gerät ist berechtigt, in Übereinstimmung mit dem Deutschen EMVG das EG-
Konformitätszeichen - CE - zu führen.
Verantwortlich für die Einhaltung der EMV Vorschriften ist der Hersteller:
Toshiba Global Commerce Solutions, Inc.
3901 South Miami Blvd.
Durham, NC 27703
United States of America
Der verantwortliche Ansprechpartner des Herstellers in der EU ist:
Toshiba Global Commerce Solutions, Inc.
Brand Manager - Europe, Middle East & Africa
Z.1 Researchpark 160, 1731 Asse, Belgium
Tel: +43 676 9077970
e-mail: [email protected]
Generelle Informationen:
Das Gerät erfüllt die Schutzanforderungen nach EN 55035 und EN 55032 Klasse A.

Australia and New Zealand Class A statement

Attention: This is a Class A product. In a domestic environment this product may cause radio
interference, in which case the user may be required to take adequate measures.

Brasil INFORMAÇÕES REGULAMENTARES:

Este equipamento opera em caráter secundário, isto é, não tem direito a proteção contra
interferência prejudicial, mesmo de estações do mesmo tipo, e não pode causar interferência
a sistemas operando em caráter primário.

People's Republic of China Class A electronic emission statement

Attention: This is a Class A product. In a domestic environment this product may cause radio
interference, in which case the user may be required to take adequate measures.

598 UnifiedPOS User's Guide

!"#$%&'()*+,'，./01*2%&34
CCC56789:;<=>'()*+

Russian Electromagnetic Interference (EMI) Class A statement

Japanese Electrical Appliance and Material Safety Law statement

Japanese power line harmonics compliance statement

Japan Voluntary Control Council for Interference Class A statement

Notices 599
Attention: This is a Class A product based on the standard of the Voluntary Control Council for
Interference (VCCI). If this equipment is used in a domestic environment, radio interference may
occur, in which case, the user may be required to take corrective actions.

Japan Electronics and Information Technology Industries

Association (JEITA) statement

Japan Electronics and Information Technology Industries Association (JEITA) Confirmed

Harmonics Guidelines with Modifications (products greater than 20 A per phase).

Korean communications statement

This is electromagnetic wave compatibility equipment for business (Type A). Sellers and users
need to pay attention to it. This is for any areas other than home.

600 UnifiedPOS User's Guide

Taiwan Class A compliance statement

Taiwan contact information

Toshiba Global Commerce Solutions Taiwan Product Service Contact Info:

Toshiba Global Commerce Solutions, Inc.
Rm. 1, 5F., No.3-2, Park St., Nangang Dist., Taipei City, Taiwan
Telephone: 0800-001-939

Cable ferrite requirement

All cable ferrites are required to suppress radiated EMI emissions and must not be removed.

Electrostatic discharge (ESD)

Attention: Electrostatic discharge (ESD) damage can occur when there is a difference in charge
between the part, the product, and the service person. No damage will occur if the service
person and the part being installed are at the same charge level.
ESD damage prevention
Anytime a service action involves physical contact with logic cards, modules, back-panel pins,
or other ESD sensitive (ESDS) parts, the service person must be connected to an ESD common
ground point on the product through the ESD wrist strap and cord.

Notices 601
The ESD ground clip can be attached to any frame ground, ground braid, green wire ground,
or the round ground prong on the AC power plug. Coax or connector outside shells can also be
used.
Handling removed cards
Logic cards removed from a product should be placed in ESD protective containers. No other
object should be allowed inside the ESD container with the logic card. Attach tags or reports that
must accompany the card to the outside of the container.

Product recycling and disposal

This unit must be recycled or discarded according to applicable local and national regulations.
Toshiba Global Commerce Solutions encourages owners of information technology (IT)
equipment to responsibly recycle their equipment when it is no longer needed. Toshiba Global
Commerce Solutions offers a variety of product return programs and services in several
countries to assist equipment owners in recycling their IT products. Information on Toshiba
Global Commerce Solutions product recycling offerings can be found on the Toshiba Global
Commerce Solutions product recycling programs website.
Español: Esta unidad debe reciclarse o desecharse de acuerdo con lo establecido en la normativa
nacional o local aplicable. Toshiba Global Commerce Solutions recomienda a los propietarios
de equipos de tecnología de la información (TI) que reciclen responsablemente sus equipos
cuando éstos ya no les sean útiles. Toshiba Global Commerce Solutions dispone de una serie
de programas y servicios de devolución de productos en varios países, a fín de ayudar a los
propietarios de equipos a reciclar sus productos de TI. Se puede encontrar información sobre las
ofertas de reciclado de productos de Toshiba Global Commerce Solutions en el sitio web Toshiba
Global Commerce Solutions product recycling programs.

Note: This mark applies only to countries within the European Union (EU) and Norway.
Appliances are labeled in accordance with European Directive 2012/19/EU concerning waste
electrical and electronic equipment (WEEE). The Directive determines the framework for the
return and recycling of used appliances as applicable throughout the European Union. This label
is applied to various products to indicate that the product is not to be thrown away, but rather
reclaimed upon end of life per this Directive.
Remarque : Cette marque s’applique uniquement aux pays de l’Union Européenne et à la
Norvège. L’etiquette du système respecte la Directive européenne 2012/19/EU en matière de
Déchets des Equipements Electriques et Electroniques (DEEE), qui détermine les dispositions
de retour et de recyclage applicables aux systèmes utilisés à travers l’Union européenne.
Conformément à la directive, ladite étiquette précise que le produit sur lequel elle est apposée ne
doit pas être jeté mais être récupéré en fin de vie.

In accordance with the European WEEE Directive, electrical and electronic equipment (EEE) is
to be collected separately and to be reused, recycled, or recovered at end of life. Users of EEE
with the WEEE marking per Annex IV of the WEEE Directive, as shown above, must not dispose
of end of life EEE as unsorted municipal waste, but use the collection framework available to
customers for the return, recycling, and recovery of WEEE. Customer participation is important

602 UnifiedPOS User's Guide

to minimize any potential effects of EEE on the environment and human health due to the
potential presence of hazardous substances in EEE. For proper collection and treatment, contact
your local Toshiba Global Commerce Solutions representative.
Disposal of IT products should be in accordance with local ordinances and regulations.

Battery safety

FG：!"#$%&。()*+,，-./0"#1234"。
-.：6"#78198:;、6"#=>? 100°C (212°F) @A、BC1DE。 (C003)

Caution: Risk of explosion if battery is replaced by an incorrect type. Dispose of used

batteries according to the instructions.

Battery return program

This product may contain sealed lead acid, nickel cadmium, nickel metal hydride, lithium, or
lithium ion battery. Consult your user manual or service manual for specific battery information.
The battery must be recycled or disposed of properly. Recycling facilities may not be available
in your area. For information on disposal of batteries outside the United States, go to the Battery
disposal website or contact your local waste disposal facility.

For Taiwan:

Notices 603
Please recycle batteries.

For the European Union:

Notice: This mark applies only to countries within the European Union (EU)
Batteries or packaging for batteries are labeled in accordance with European Directive
2013/56/EU concerning batteries and accumulators and waste batteries and accumulators.
The Directive determines the framework for the return and recycling of used batteries and
accumulators as applicable throughout the European Union. This label is applied to various
batteries to indicate that the battery is not to be thrown away, but rather reclaimed upon end of
life per this Directive.
Les batteries ou emballages pour batteries sont étiquetés conformément aux directives
européennes 2013/56/EU, norme relative aux batteries et accumulateurs en usage et aux batteries
et accumulateurs usés. Les directives déterminent la marche à suivre en vigueur dans l'Union
Européenne pour le retour et le recyclage des batteries et accumulateurs usés. Cette étiquette est
appliquée sur diverses batteries pour indiquer que la batterie ne doit pas être mise au rebut mais
plutôt récupérée en fin de cycle de vie selon cette norme.

In accordance with the European Directive 2013/56/EU, batteries and accumulators are labeled
to indicate that they are to be collected separately and recycled at end of life. The label on
the battery may also include a chemical symbol for the metal concerned in the battery (Pb
for lead, Hg for mercury and Cd for cadmium). Users of batteries and accumulators must
not dispose of batteries and accumulators as unsorted municipal waste, but use the collection
framework available to customers for the return, recycling and treatment of batteries and
accumulators. Customer participation is important to minimize any potential effects of batteries
and accumulators on the environment and human health due to the potential presence of
hazardous substances. For proper collection and treatment, contact your local Toshiba Global
Commerce Solutions representative.

604 UnifiedPOS User's Guide

This notice is provided in accordance with Royal Decree 106/2008 of Spain: The retail price of
batteries, accumulators and power cells includes the cost of the environmental management of
their waste.

For California:
Perchlorate material – special handling may apply
Refer to www.dtsc.ca.gov/hazardouswaste/perchlorate.
The foregoing notice is provided in accordance with California Code of Regulations Title 22,
Division 4.5, Chapter 33: Best Management Practices for Perchlorate Materials. This product/part
includes a lithium manganese dioxide battery which contains a perchlorate substance.

Flat panel displays

The fluorescent lamp in the liquid crystal display contains mercury. Dispose of it as required by
local ordinances and regulations.

Monitors and workstations

Connecticut: Visit the website of the Department of Energy & Environmental Protection at
www.ct.gov/deep for information about recycling covered electronic devices in the State
of Connecticut, or telephone the Connecticut Department of Environmental Protection at
1-860-424-3000.
Oregon: For information regarding recycling covered electronic devices in the state of
Oregon, go to the Oregon Department of Environmental Quality site at www.deq.state.or.us/lq/
electronics.htm.
Washington: For information about recycling covered electronic devices in the State of
Washington, go to the Department of Ecology Website at fortress.wa.gov/ecy/recycle/ or
telephone the Washington Department of Ecology at 1-800-Recycle.

Trademarks
The following are trademarks or registered trademarks of Toshiba, Inc. in the United States or
other countries, or both:
Toshiba
The Toshiba logo
The following are trademarks of Toshiba Global Commerce Solutions in the United States or
other countries, or both:
AnyPlace
SureMark
SurePoint
SurePOS
TCxWave
TCxFlight
TCx
The following are trademarks of International Business Machines Corporation in the United
States or other countries, or both:

Notices 605
DB2
DB2 Universal Database
IBM and the IBM logo
PS/2
Wake on LAN
WebSphere
Linux is a trademark of Linus Torvalds in the United States, other countries, or both.
Magellan is a registered trademark of Datalogic Scanning, Inc.
SYMBOL a registered trademark of Symbol Technologies, Inc.
Microsoft, Windows, Windows NT, and the Windows 95 logo are trademarks of Microsoft
Corporation in the United States, other countries, or both.
Celeron and Intel are trademarks of Intel corporation in the United States, or other countries.
Java and all Java-based trademarks and logos are trademarks of Oracle, Inc. in the United States,
or other countries, or both.
Android is a registered trademark of Google LLC.
Other company, product, or service names may be trademarks or service marks of others.

606 UnifiedPOS User's Guide

Glossary
administered code assigned to each device,
This glossary includes terms and definitions from: or workstation connected to a network. A
• American National Standard Dictionary for character, group of characters, or a value
Information Systems, ANSI X3.172-1990, copyright that identifies a register, a particular part
1990 by the American National Standards of storage, a data source, or a data link.
Institute (ANSI). Copies may be purchased from The value is represented by one or more
the American National Standards Institute, 11 characters. To refer to a device, or an item
West 42nd Street, New York, New York 10036. of data by its address. The location in the
Definitions are identified by the symbol (A) after storage of a computer where data is stored.
the definition.
• The Information Technology Vocabulary, developed address space
by Subcommittee 1, Joint Technical Committee The complete range of addresses that is
1, of the International Organization available to a programmer.
for Standardization and the International
Electrotechnical Commission (ISO/IEC JTC1/ all points addressable (APA)
SC1). Definitions of published parts of this In computer graphics, pertaining to the
vocabulary are identified by the symbol (I) ability to address and display or not display
after the definition; definitions taken from draft each picture element (pel) on a display
international standards, committee drafts, and surface.
working papers being developed by ISO/IEC
JTC1/SC1 are identified by the symbol (T) after alphanumeric
the definition, indicating that final agreement has Pertaining to a character set containing
not yet been reached among the participating letters, digits, and other characters, such as
National Bodies of SC1. punctuation marks.

A Alphanumeric point-of-sale keyboard (NANPOS

keyboard)
active This keyboard consists of a section of
Able to communicate on the network. A alphanumeric keys, a programmable set of
token-ring network adapter is active if it point-of-sale keys, a numeric keypad, and
is able to transmit and receive on the system function keys.
network. Operational. Pertaining to a node,
or device that is connected or is available American National Standard Code for
for connection to another node or device. Information Interchange (ASCII)
Currently transmitting or receiving. The standard code, using a coded character
set consisting of 7-bit coded characters (8 bits
adapter including parity check), used for information
In the point-of-sale terminal, a circuit card interchange among data processing systems,
that, with its associated software, enables data communication systems, and associated
the terminal to use a function or feature. In equipment. The ASCII set consists of control
a LAN, within a communicating device, a characters and graphics characters.
circuit card that, with its associated software
and/or microcode, enables the device to American National Standards Institute (ANSI)
communicate over the network. An organization for the purpose of
establishing voluntary industry standards.
address
In data communication, the IEEE-assigned NANPOS keyboard
unique code, or the unique locally Alphanumeric point-of-sale Keyboard.

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 607

ANSI backup
American National Standards Institute. Pertaining to a system, device, file, or facility
that can be used in the event of a malfunction
APA or the loss of data.
all points addressable.
backup copy
API A copy, usually of a program or of a library
Application program interface. member, that is kept in case the original or
the working copy is unintentionally altered
application program or destroyed.
A program written for or by a user that
applies to the user’s own work. A program bar code
written for or by a user that applies to A code representing characters by sets
a particular application. A program used of parallel bars of varying thickness and
to connect and communicate with stations separation that are read optically by
in a network, enabling users to perform transverse scanning.
application-oriented activities.
BCD
application program interface (API) Binary-coded decimal notation.
The formally defined programming language
interface that is between a Toshiba system binary
control program or a licensed program and Pertaining to a system of numbers to the base
the user of the program. two; the binary digits are 0 and 1. Pertaining
to a selection, choice, or condition that has
array two possible different values or states.
An arrangement of elements in one or more
dimensions. binary-coded decimal notation (BCD)
A binary-coded notation in which each of
ASCII the decimal digits is represented by a binary
American National Standard Code for numeral. For example, in binary-coded
Information Interchange. decimal notation that uses the weights 8, 4, 2,
1, the number “twenty three” is represented
asynchronous by 0010 0011. In the pure binary numeration
Pertaining to two or more processes that do system, its representation is 10111.
not depend upon the occurrence of specific
events such as timing signals. Without bit
regular time relationship; unexpected or Either of the binary digits: a 0 or 1.
unpredictable with respect to the execution
of program instructions. bit map
A coded representation in which each bit or
attach group of bits represents or corresponds to
To connect a device physically. To make a an item; for example, a configuration of bits
device a part of a network logically. Compare in main storage in which each bit indicates
with connect. whether a peripheral device or a storage
block is available or in which each group
attaching device of bits corresponds to one pixel of a display
Any device that is physically connected to image.
a network and can communicate over the
network. bits per second (bps)
The rate at which bits are transmitted per
B second.

608 UnifiedPOS User's Guide

block size cash drawer
The minimum size that frames are grouped A drawer at a point-of-sale terminal that can
into for retransmission. The number of data be programmed to open automatically. See
elements (such as bits, bytes, characters, or till.
records) that are recorded or transmitted as a
unit. channel
A functional unit, controlled by a host
break scan code computer, that handles the transfer of
The hardware scan code received by the data between processor storage and local
keyboard device driver when a key on the peripheral equipment. A path along which
keyboard is physically pressed. signals can be sent. The portion of a storage
medium that is accessible to a given reading
bps or writing station.
Bits per second.
clear
Bps To delete data from a screen or from
Bytes per second. memory.

buffer code page

A portion of storage used to hold input or A particular assignment of hexadecimal
output data temporarily. A routine or storage identifiers to graphic characters.
used to compensate for a difference in data
rate or time of occurrence of events, when code point
transferring data from one device to another. A 1-byte code representing one of 256
potential characters.
byte
A string that consists of a number of command
bits, treated as a unit, and representing a A request for performance of an operation or
character. A binary character operated upon execution of a program. A character string
as a unit and usually shorter than a computer from a source external to a system that
word. A string that consists of a particular represents a request for system action.
number of bits, usually 8, that is treated as a
unit, and that represents a character. A group compile
of 8 adjacent binary digits that represent one To translate all or part of a program
extended binary-coded decimal interchange expressed in a high-level language
code (EBCDIC). See n-bit byte. into a computer program expressed in
an intermediate language, an assembly
C language, or a machine language. To
prepare a machine language program from
C a computer program written in another
A high-level programming language programming language by making use of
designed to optimize run time, size, and the overall logic structure of the program,
efficiency. or generating more than one computer
instruction for each symbolic statement, or
call both, as well as performing the function of an
The action of bringing a function or assembler. To translate a source program into
subprogram into effect, usually by specifying an executable program (an object program).
the entry conditions and jumping to an entry To translate a program written in a high-
point. level programming language into a machine
language program.
card reader
See magnetic stripe reader, (MSR).

Glossary 609
compiler D
A program that decodes instructions written
as pseudo codes and produces a machine data
language program to be executed at a later A representation of facts, concepts, or
time. Contrast with interpretive routine. instructions in a formalized manner
suitable for communication, interpretation, or
component processing by human or automatic means.
Any part of a network other than an Any representations such as characters or
attaching device, such as an IBM® 8228 analog quantities to which meaning is or
Multistation Access Unit. Hardware or might be assigned.
software that is part of a functional unit.
data communication
configuration Transfer of information between functional
The group of devices, options, and programs units by means of data transmission
that make up a data processing system or according to a protocol. The transmission,
network as defined by the nature, number, reception, and validation of data.
and chief characteristics of its functional
units. More specifically, the term refer to data file
a hardware configuration or a software A collection of related data records organized
configuration. See also system configuration. in a specific manner; for example, a
payroll file (one record for each employee,
configuration file showing such information as rate of pay
The collective set of definitions that describes and deductions) or an inventory file (one
a configuration. record for each inventory item, showing such
information as cost, selling price, and number
connect in stock.) See also data set, file.
In a LAN, to physically join a cable from
a station to an access unit or network data set
connection point. Contrast with attach. Logically related records treated as a single
unit. See also file.
constant
String or numeric value that does not change data terminal equipment (DTE)
throughout program execution. That part of a data station that serves
as a data source, data receiver, or both.
control character Equipment that sends or receives data, or
A character whose occurrence in a particular both.
context initiates, modifies, or stops a control
operation. A control character may be data transmission
recorded for use in a subsequent action, and The conveying of data from one place
it may have a graphic representation in some for reception elsewhere by means of
circumstances. telecommunications.

CRC data type

Cyclic redundancy check. The mathematical properties and internal
representation of data and functions.
customize
To tailor a program or store system through DBCS
option selection. Double-byte character set.

cyclic redundancy check (CRC) DCE

Synonym for frame check sequence (FCS). Data circuit-terminating equipment.

610 UnifiedPOS User's Guide

default blocks of data that are stored in separate
Pertaining to an attribute, value, or option areas of a data set in direct access storage.
that is assumed when none is explicitly
specified. disabled
Pertaining to a state of a processing unit that
default value prevents the occurrence of certain types of
The value the system supplies when the user interruptions. Pertaining to the state in which
does not specify a value. a transmission control unit or audio response
unit cannot accept incoming calls on a line.
device
disk
A mechanical, electrical, or electronic
contrivance with a specific purpose. An A round, flat plate coated with a magnetic
input/output unit such as a terminal, display, substance that is used to store computer data.
or printer. See also attaching device. See also integrated disk, fixed disk.

device connection Disk Operating System (DOS)

The connection between an application and An operating system for computer systems
a hardware device created by the Toshiba that use disks and diskettes for auxiliary
JavaPOS system when the application opens storage of programs and data.
a device.
display
device descriptor A visual presentation of data. A device that
An identifier that represents a device to presents visual information to the point-of-
the Toshiba JavaPOS system application sale terminal operator and to the customer, or
programming interface. This identifier is to the display station operator.
created by the Toshiba JavaPOS system when
the application opens a device. distributed
Physically separate but connected by cables.
device driver
The code needed to attach and use a device DLL
on a computer or a network. See dynamic link library.

digital DOS
Pertaining to data in the form of digits. Disk Operating System.
Contrast with analog. Pertaining to data
consisting of numerical values or discrete double-byte character set (DBCS)
units. A set of characters in which each character
is represented by 2 bytes. Languages
direct file such as Japanese, Chinese, and Korean,
A file in which records are assigned specific which contain more symbols than can be
record positions. No matter what order the represented by 256 code points, require
records are put in a direct file, they always double-byte character sets. Because each
occupy the assigned position. A direct file is character requires 2 bytes, the typing,
the same as a random file except that a direct display, and printing of DBCS characters
file contains no delimiting characters, such as requires hardware and programs that
quotes enclosing string fields. support DBCS. Contrast with single-byte
character set.
directory
A table of identifiers and references that DRAM
correspond to items of data. An index that a Dynamic RAM. See RAM.
control program uses to locate one or more

Glossary 611
driver response unit can accept incoming calls on a
Software component that controls a device. line.

DTE end-of-file
Data terminal equipment. An internal label, immediately following the
last record of a file, signaling the end of that
dump file.
To write at a particular instant the contents
error message
of storage, or part of storage, onto another
data medium for the purpose of safeguarding A message that is issued because an error has
or debugging the data. Data that has been been detected.
dumped.
escape character
duplex Code extension character used, in some cases,
In data communication, pertaining to with one or more succeeding characters to
a simultaneous two-way independent indicate by some convention that the coded
transmission in both directions. Synonymous representation following the character or the
with full-duplex. contrast with half-duplex. group of characters are to be interpreted
according to a different code or different
DVD-ROM character set.
Digital-video-disk read-only memory.
European article number (EAN)
dynamic link library (DLL) A number that is assigned to and encoded
In the Windows operating systems, the on an article of merchandise for scanning in
delayed connection of a library to a routine some countries.
until load time or run time.
event
E Processing unit containing price changes and
item file updates. All records in an event
EAN share common characteristics such as type of
change and event due date. An occurrence
European article number.
of significance to a task; for example, the
EIA completion of an asynchronous operation,
such as an I/O operation.
Electronics Industries Association.
exception
EIA-232
An abnormal condition such as an I/O error
In data communications, a specification of
encountered in processing a data set or a
the Electronic Industries Association (EIA)
file. See also overflow exception and underflow
that defines the interface between data
exception.
terminal equipment (DTE) and data circuit-
terminating equipment (DCE) using serial exit
binary data interchange. Formerly known as
RS-232. To execute an instruction or statement within
a portion of a program in order to terminate
enabled the execution of that portion. Note: Such
portions of programs include loops, routines,
On a LAN, pertaining to an adapter
subroutines, and modules.
or device that is active, operational, and
able to receive frames from the network. expansion board
Pertaining to a state of a processing unit
that allows the occurrence of certain types In a Toshiba Personal Computer, a panel
of interruptions. Pertaining to the state in containing microchips that a user can install
which a transmission control unit or an audio in an expansion slot to add memory or

612 UnifiedPOS User's Guide

special features. Synonymous with expansion larger storage capacity than a diskette and is
card, extender card. permanently installed.

expansion card flag

Synonym for expansion board. A character or indicator that signals the
occurrence of some condition, such as the
extender card setting of a switch, or the end of a word.
Synonym for expansion board.
flash memory
F A data-storage device that is programmable,
erasable, and does not require continuous
fat-finger power. The chief benefit of flash memory
When two keys are pressed faster over other programmable and erasable
than the value specified using the data storage devices is that it can be
PosNfatFingerTimeOut resource. This could reprogrammed without being removed from
occur under any of the following conditions: the circuit board.
1) Two keys on the keyboard were pressed
at the same time. 2) The operator is keying frame
faster than 25 keys per second. 3) A double The unit of transmission in some LANs,
key is not defined to the keyboard device including the Toshiba Token-Ring Network
handler. and the Toshiba PC Network. It includes
delimiters, control characters, information,
field and checking characters. On a token-ring
On a data medium or a storage medium, a network, a frame is created from a token
specified area used for a particular category when the token has data appended to it. On
of data; for example, a group of character a token-bus network (Toshiba PC Network),
positions used to enter or display wage rates all frames including the token frame contain
on a panel. a preamble, start delimiter, control address,
optional data and checking characters, end
FIFO delimiter, and are followed by a minimum
First-in–first-out. silence period. A housing for machine
elements. In synchronous data link control
file (SDLC), the vehicle for every command,
A named set of records stored or processed every response, and all information that is
as a unit. For example, an invoice form a transmitted using SDLC procedures. Each
record and the complete set of such records frame begins and ends with a flag.
form a file. See also data file and data set.
frequency
file name The rate of signal oscillation, expressed in
A name assigned or declared for a file. The hertz (cycles per second).
name used by a program to identify a file.
full-duplex
first-in–first-out (FIFO) Synonym for duplex.
A queuing technique in which the next item
function
to be retrieved is the item that has been in the
queue for the longest time. A specific purpose of an entity, or its
characteristic action. A subroutine that
fixed disk (drive) returns the value of a single variable. In data
In a personal computer system unit, a disk communications, a machine action such as a
storage device that reads and writes on carriage return or line feed.
rigid magnetic disks. It is faster and has a
G

Glossary 613
GCGID hot plug
See Graphic Character Global Identifier. To connect a USB I/O device to the universal
serial bus without powering the host system
global down.
Pertaining to that which is defined in one
subdivision of a computer program and used hot unplug
in at least one other subdivision of that To disconnect a USB I/O device from the
computer program. universal serial bus without powering the
host system down.
Graphic Character Set Global Identifier (GCGID)
A 4- to 8-character identifier assigned to Hz
a registered graphic character in a Toshiba See hertz.
registry.
I
group
A set of related records that have the same identifier
value for a particular field in all records. String of characters used to name elements of
A collection of users who can share access a program, such as variable names, reserved
authorities for protected resources. A list of words, and user-defined function names.
names that are known together by a single
name. inactive
Not operational. Pertaining to a node or
H device not connected or not available for
connection to another node or device. In the
half-duplex Toshiba Token-Ring Network, pertaining to
In data communication, pertaining to a station that is only repeating frames or
transmission in only one direction at a time. tokens, or both.
Contrast with duplex.
information (I) frame
hardware A frame in I format used for numbered
Physical equipment as opposed to information transfer. See also supervisory
programs, procedures, rules, and associated frame, unnumbered frame.
documentation.
initialize
hertz (Hz) In a LAN, to prepare the adapter (and
A unit of frequency equal to one cycle adapter support code, if used) for use by an
per second. Note: In the United States, line application program.
frequency is 60Hz or a change in voltage
polarity 120 times per second; in Europe, line initial program load (IPL)
frequency is 50Hz or a change in voltage The initialization procedure that causes an
polarity 100 times per second. operating system to begin operation.

hexadecimal notation input device

Notation for the base-16 number system Synonym for input unit.
using the symbols 0, 1, 2, 3, 4, 5, 6, 7, 8, 9,
A, B, C, D, E, and F to represent values from input/output device
0 to 15 (decimal). See I/O device.

hot key input/output (I/O)

The key combination used to change from Pertaining to a device whose parts can
one session to another on a workstation. perform an input process and an output
process at the same time. Pertaining to

614 UnifiedPOS User's Guide

a functional unit or channel involved in International Organization for Standardization
an input process, output process, or both, (ISO)
concurrently or not, and to the data involved An organization of national standards
in such a process. bodies from various countries established
to promote development of standards to
input unit facilitate international exchange of goods
A device in a data processing system that and services, and develop cooperation in
is used to enter data into the system. intellectual, scientific, technological, and
Synonymous with input device. economic activity.

instance interpretive routine

An occurrence of a particular device or A routine that decodes instructions written as
object. For example, two instances of the pseudocodes and immediately executes the
PosDisplay class name can be Shopper1 instructions. Contrast with compile.
and Shopper2, where these instances refer
to the same physical display. I/O
Input/output.
integrated
Arranged together as one unit. I/O device
Equipment for entering and receiving data
integrated disk from the system.
An integral part of the processor that is used
for magnetically storing files, application IPL
programs, and diagnostics. Synonymous Initial program load.
with disk.
ISO
interaction
International Organization for
A basic unit used to record system activity, Standardization.
consisting of the acceptance of a line of
terminal input, processing of the line, and a item
response, if any. One member of a group. In a store, one unit
of a commodity, such as one box, one bag, or
interface
one can. Usually an item is the smallest unit
A shared boundary between two functional of a commodity to be sold.
units, defined by functional characteristics,
common physical interconnection J
characteristics, signal characteristics, and
other characteristics as appropriate. A shared JIS
boundary. An interface may be a hardware Japanese Industrial Standard
component to link two devices or a portion of
storage or registers accessed by two or more JUCC
computer programs. Hardware, software,
Japanese Unified Cash Card
or both, that links systems, programs, or
devices. K
interleave
keyboard
To insert segments of one program into
A group of numeric keys, alphabetic keys,
another program so that the two programs
special character keys, or function keys used
can, in effect, be executed at the same time.
for entering information into the terminal
and into the system.

Glossary 615
kHz logical connection
Kilohertz. See also hertz. In a network, devices that can communicate
or work with one another because they
kilohertz (kHz) share the same protocol. See also physical
A thousand hertz. See also hertz. connection.

L logon (n)
The procedure for starting up a point-of-
LED sale terminal or store controller for normal
Light-emitting diode. sales operations by sequentially entering
the correct security number and transaction
lift-off number. Synonymous with sign-on.
When a pointing device is removed from a
touch-sensitive surface. log on (v)
To initiate a session. In SNA products, to
light-emitting diode (LED) initiate a session between an application
A semiconductor chip that gives off visible or program and a logical unit (LU).
infrared light when activated. Synonymous with sign-on.

line loop
On a terminal, one or more characters A set of instructions that may be executed
entered before a return to the first printing repeatedly while a certain condition prevails.
or display position. See also store loop. A closed unidirectional
signal path connecting input/output devices
link to a network.
The combination of physical media,
M
protocols, and programming that connects
devices on a network. In computer
programming, the part of a program, in macro
some cases a single instruction or an address, An instruction that causes the execution of
that passes control and parameters between a predefined sequence of instructions in the
separate portions of the computer program. same source language.
To interconnect items of data or portions of
one or more computer programs. magnetic stripe
The magnetic material (similar to recording
listing tape) on merchandise tickets, credit cards,
A printout, usually prepared by a language and employee badges. Information is
translator, that lists the source code. recorded on the stripe for later “reading” by
the magnetic stripe reader (MSR) or magnetic
load wand reader attached to the point-of-sale
In computer programming, to enter data into terminal.
memory or working registers.
magnetic stripe reader (MSR)
lock A device that reads coded information from
To disable a device, such as a scanner or a magnetic stripe on a card, such as a credit
MSR, so that it cannot receive input. See also card, as it passes through a slot in the reader.
unlock.
make scan code
logging The hardware scan code received by the
The chronological recording of events keyboard device driver when a key on the
occurring in a system or a subsystem for keyboard is physically pressed.
accounting or data collection purposes.

616 UnifiedPOS User's Guide

Mb modem (Modulator/DEModulator)
Megabit. A device that converts digital data from a
computer to an analog signal that can be
MB transmitted in a telecommunication line, and
Megabyte. converts the analog signal received to data
for the computer.
megabit (Mb)
A unit of measure for throughput. 1 megabit modulo check
= 1,048,576 bits. A function designed to detect most common
input errors by performing a calculation on
megabyte (MB) values entered into a system by an operator
A unit of measure for data. 1 megabyte = or scanning device.
1,048,576 bytes.
monitor
memory A functional unit that observes and records
Program-addressable storage from which selected activities for analysis within a data
instructions and other data can be loaded processing system. Possible uses are to show
directly into registers for subsequent significant departures from the norm, or to
execution or processing. determine levels of utilization of particular
functional units. Software or hardware that
message observes, supervises, controls, or verifies
An arbitrary amount of information operations of a system.
whose beginning and end are defined or
implied. A group of characters and control MSR
bit sequences transferred as an entity. Magnetic stripe reader.
In telecommunication, a combination of
characters and symbols transmitted from N
one point to another. A logical partition of
the user device’s data stream to and from name
the adapter. See also error message, operator An alphanumeric term that identifies a
message. data set, statement, program, or cataloged
procedure.
microcode
One or more microinstructions. A code, n-bit byte
representing the instructions of an instruction A string that consists of n bits.
set, that is implemented in a part of
storage that is not program-addressable. To network
design, write, and also test one or more A configuration of data processing devices
microinstructions. and software connected for information
interchange. An arrangement of nodes and
microprocessor connecting branches. Connections are made
An integrated circuit that accepts coded between data stations.
instructions for execution. The instructions
may be entered, integrated, or stored noise
internally. A disturbance that affects a signal and that
can distort the information carried by the
migration signal. Random variations of one or more
Installation of a new version of a release of characteristics of any entity, such as voltage,
a program to replace an earlier version or current, or data. Loosely, any disturbance
release. tending to interfere with normal operation of
a device or system.

Glossary 617
nonvolatile random access memory (NVRAM) a specific condition within the system, such
Random access memory that retains its as an error condition.
contents after electrical power is shut off.
option
NVRAM A specification in a statement, a selection
nonvolatile random access memory. from a menu, or a setting of a switch, that
may be used to influence the execution of a
O program. A hardware or software function
that may be selected or enabled as part of a
offline configuration process. A piece of hardware
(such as a network adapter) that can be
Operation of a functional unit without the
installed in a device to modify or enhance
control of a computer or control unit.
device function.
online
output device
Operation of a functional unit that is under
A device in a data processing system by
the continual control of a computer or control
which data can be received from the system.
unit. The term also describes a user’s access
Synonymous with output unit.
to a computer using a terminal.
output unit
open
Synonym for output device.
To make an adapter ready for use. A break in
an electrical circuit. To make a file ready for
overflow exception
use.
A condition caused by the result of an
operating system arithmetic operation having a magnitude that
exceeds the largest possible number. See also
Software that controls the execution of
underflow exception.
programs. An operating system provides
services such as resource allocation,
P
scheduling, input/output control, and data
management.
parameter
operation A name in a procedure that is used to refer
A defined action, namely, the act of obtaining to an argument passed to that procedure. A
a result from one or more operands in variable that is given a constant value for a
accordance with a rule that completely specified application and that may denote the
specifies the result for any permissible application. An item in a menu or for which
combination of operands. A program step the user specifies a value or for which the
undertaken or executed by a computer. An system provides a value when the menu is
action performed on one or more data items, interpreted. Data passed between programs
such as adding, multiplying, comparing, or or procedures.
moving.
parity bit
operator A binary digit appended to a group of binary
A symbol that represents the action being digits to make the sum of all the digits
performed in a mathematical operation. A (including the appended binary digit) either
person who operates a machine. always odd (odd parity) or always even
(even parity).
operator message
parity (even)
A message from the operating system or a
program telling the operator to perform a A condition when the sum of all of the digits
specific function or informing the operator of in an array of binary digits is even.

618 UnifiedPOS User's Guide

parity (odd) port
A condition when the sum of all of the digits An access point for data entry or exit.
in an array of binary digits is odd. A connector on a device to which cables
for other devices such as display stations
physical connection and printers are attached. Synonymous with
The ability of two connectors to mate socket.
and make electrical contact. In a network,
devices that are physically connected can post
communicate only if they share the same To affix to a usual place. To provide items
protocol. See also logical connection. such as return code at the end of a command
or function. To define an appendage routine.
PLD To note the occurrence of an event.
Power line disturbance.
POST
PLU Power-On Self Test.
Price Look Up.
power line disturbance (PLD)
plug Interruption or reduction of electrical power.
A connector for attaching wires from a device
to a cable, such as a store loop. A plug is Power-On Self Test (POST)
inserted into a receptacle or plug. To insert a A series of diagnostic tests that are run
connector into a receptacle or socket. automatically each time the computer’s
power is switched on.
pointer
An identifier that indicates the location of problem determination
an item of data in memory. A data element The process of determining the source of a
that indicates the location of another data problem as being a program component, a
element. A physical or symbolic identifier of machine failure, a change in the environment,
a unique target. a common-carrier link, a user-supplied
device, or a user error.
point-of-sale terminal
A unit that provides point-of-sale transaction, procedure
data collection, credit authorization, price A set of related control statements that cause
look-up, and other inquiry and data entry one or more programs to be performed. In
functions. a programming language, a block, with or
without formal parameters, whose execution
polling is invoked by means of a procedure call.
Interrogation of devices for purposes such as A set of instructions that gives a service
to avoid contention, to determine operational representative a step-by-step procedure for
status, or to determine readiness to send tracing a symptom to the cause of failure.
or receive data. In data communication,
the process of inviting data stations to process
transmit, one at a time. The polling process An instance of an executing application and
usually involves the sequential interrogation the resources it is using.
of several data stations.
processor
polling characters (address) In a computer, a functional unit that
A set of characters specific to a terminal interprets and executes instructions.
and the polling operation; response to these
characters indicates to the computer whether
the terminal has a message to enter.

Glossary 619
prompt values during the execution of a program.
A character or word displayed by the A storage device having a specified storage
operating system to indicate that it is ready capacity such as bit, byte, or computer word,
to accept input. and usually intended for a special purpose.
In theToshiba Store System, a term that refers
Q to the point-of-sale terminal.

queue remove
A line or list formed by items in a system To take an attaching device off a network.
waiting for service; for example, tasks to be To stop an adapter from participating in data
performed or messages to be transmitted in a passing on a network.
message routing system.
resource
R An element that affects the way devices
behave.
RAM
resource set
Random access memory.
The set of resources associated with a device.
random access
response
An access mode in which specific logical
records are obtained from or placed into a The information the network control
mass storage file in a nonsequential manner. program sends to the access method, usually
in answer to a request received from the
random access memory (RAM) access method. (Some responses, however,
result from conditions occurring within
A computer’s or adapter’s volatile storage
the network control program, such as
area into which data may be entered and
accumulation of error statistics.)
retrieved in a nonsequential manner.
retry
read
In data communication, sending the current
To acquire or to interpret data from a storage
block of data a prescribed number of times or
device, from a data medium, or from another
until it is entered correctly and accepted.
source.
return code
read-only memory (ROM)
A value (usually hexadecimal) provided by
A computer’s or adapter’s storage area
whose contents cannot be modified by the an adapter or a program to indicate the
result of an action, command, or operation.
user except under special circumstances.
A code used to influence the execution of
receive succeeding instructions. A value established
by the programmer to be used to influence
To obtain and store information transmitted
subsequent program action. This value can be
from a device.
printed as output or loaded in a register.
record
ROM
A collection of related items of data, treated
Read-only memory.
as a unit; for example, in stock control,
each invoice could constitute one record. A routine
complete set of such records form a file.
Part of a program, or a sequence of
register instructions called by a program, that may
have some general or frequent use.
A storage area in a computer's memory
where specific data is stored. Registers are S
used in the actual manipulation of data

620 UnifiedPOS User's Guide

satellite a call or link between two devices. The
A computer that is under the control of period of time during which a user of a
another computer and performs subsidiary node can communicate with an interactive
operations. An offline auxiliary computer. system, usually the elapsed time between
log on and log off. In network architecture,
SBCS an association of facilities necessary for
Single-byte character set. establishing, maintaining, and releasing
connections for communication between
scan stations.
To pass an item over or through the scanner
signal
so that the encoded information is read. See
also wanding. A time-dependent value attached to a
physical phenomenon for conveying data.
scan codes A variation of a physical quantity, used to
convey data.
When a key is pressed on any keyboard, the
keyboard device driver receives a code that
sign-on
is called a make scan code. Each key has a
different code. When a key is released on A procedure to be followed at a terminal or
some keyboards, the keyboard device driver workstation to establish a link to a computer.
receives a code that is called a break scan To begin a session at a workstation.
code. These codes are translated into ASCII
single-byte character set (SBCS)
character codes using the code page that the
application is using. A character set in which each character is
represented by a one-byte code. Contrast
scanner with double-byte character set.
A device that examines the bar code
SLRS
on merchandise tickets, credit cards, and
employee badges and generates analog or SUSE LINUX Retail Solution.
digital signals corresponding to the bar code.
socket
scroll Synonym for port (2).
To move all or part of the display image
vertically or horizontally to display data that state transition
cannot be observed within a single display The act of moving from one conversation
image. See also page (2). state to another.

segment station
See cable segment, LAN segment, ring segment. A point-of-sale terminal that consists of a
processing unit, a keyboard, and a display.
sequential file It can also have input/output devices, such
A disk file in which records are read from as a printer, a magnetic stripe reader or cash
or placed into the file according to the order drawers. A communication device attached
they are processed. to a network. The term used most often in
LANs is an attaching device or workstation.
session An input or output point of a system
A connection between two application that uses telecommunication facilities; for
programs that allows them to communicate. example, one or more systems, computers,
In SNA, a logical connection between terminals, devices, and associated programs
two network addressable units that can at a particular location that can send or
be activated, tailored to provide various receive data over a telecommunication line.
protocols, and deactivated as requested. The See also attaching device, workstation.
data transport connection resulting from

Glossary 621
subdirectory terminal
Any level of file directory lower than the root In data communication, a device, usually
directory within a hierarchical file system. equipped with a keyboard and a display,
capable of sending and receiving information
subroutine over a communication channel.
Section of code that performs a specific task
and is logically separate from the rest of the thread
program. A unit of execution within a process. It uses
the resources of the process.
subsystem
A secondary or subordinate system, or throughput
programming support, usually capable A measure of the amount of work performed
of operating independently of or by a computer system over a given period
asynchronously with a controlling system. of time, for example, number of jobs per
day. A measure of the amount of information
summary journal transmitted over a network in a given period
A record of the terminal operational activity of time. For example, a network’s data
that is printed at the terminal. transfer rate is usually measured in bits per
second.
switch
On an adapter, a mechanism used to select till
a value for, enable, or disable a configurable A tray in the cash drawer of the point-of-
option or feature. sale terminal, used to keep the different
denominations of bills and coins separated
system and easily accessible.
In data processing, a collection of people,
machines, and methods organized to Toshiba Disk Operating System (DOS)
accomplish a set of specific functions. See A disk operating system based on MS-DOS.1
also data processing system and operating
system. touch-down
When contact is made with a touch-sensitive
system configuration surface.
A process that specifies the devices and
programs that form a particular data trace
processing system. A record of the execution of a computer
program. It exhibits the sequences in which
system unit the instructions were executed. A record
A part of a computer that contains the of the frames and bytes transmitted on a
processing unit, and may contain devices network.
such as disk and diskette drives. In a
Toshiba Personal Computer, the unit that transaction
contains the processor circuitry, read-only The process of recording item sales,
memory (ROM), random access memory processing refunds, recording coupons,
(RAM), and the I/O channel. It may have handling voids, verifying checks before
one or more disk or diskette drives. In a tendering, and arriving at the amount to
Toshiba 4683/4684 terminal, the part of the be paid by or to a customer. The receiving
terminal that contains the processing unit, of payment for merchandise or service is
ROM, RAM, disk and diskette drives, and the also included in a transaction. In an SNA
I/O channel. network, an exchange between two programs
that usually involves a specific set of initial
T input data that causes the execution of a
1 MS-DOS is a trademark of the Microsoft® Corporation.

622 UnifiedPOS User's Guide

specific task or job. Examples of transactions UDC
include the entry of a customer’s deposit User defined character.
that results in the updating of the customer’s
balance, and the transfer of a message to one UPC
or more destination points. Universal product code.
transition user
See state transition. Category of identification defined for file
access protection. A person using a program
transmission
or system.
The sending of data from one place for
reception elsewhere. user defined character (UDC)
User defined character.
transmit
To send information from one place for user interface
reception elsewhere. Hardware, software, or both that allows a
user to interact with and perform operations
typematic
on a system, program, or device.
A keyboard button that will continue to enter
characters or repeat its function as long as the V
button is held down.
variable
U
A named entity that is used to refer to
data and to which values can be assigned.
underflow exception
Its attributes remain constant, but it can
A condition caused by the result of an refer to different values at different times.
arithmetic operation having a magnitude less In computer programming, a character or
than the smallest possible nonzero number. group of characters that refers to a value
See also overflow exception. and, in the execution of a computer program,
corresponds to an address. A quantity that
unlock can assume any of a given set of values.
To enable a device, such as a scanner or MSR,
so that it can read data. See also lock. version
A separate Toshiba-licensed program, based
universal product code (UPC) on an existing Toshiba-licensed program, that
An encoded number that can be assigned to usually has significant new code or new
and printed on or attached to an article of function.
merchandise for scanning.
W
Universal Serial Bus (USB)
A serial interface standard for telephony wanding
and multimedia connections to personal Passing the tip of the wand reader over
computers. information encoded on a merchandise ticket,
credit card, or employee badge.
Universal Serial Bus (USB), powered
A powered-USB connector provides workstation
additional power from the host system. An I/O device that allows either transmission
A powered-USB receptacle consists of two of data or the reception of data (or both)
connectors stacked vertically inside the from a host system, as needed to perform
common housing. The upper connector a job: for example, a display station or
contains four contacts that are used for printer. A configuration of I/O equipment
powering the attached device. at which an operator works. A terminal or

Glossary 623
microcomputer, usually one connected to a
mainframe or network, at which a user can
perform tasks.

624 UnifiedPOS User's Guide

Index
Canadian French keyboard layout (continued) code pages (continued)
Numerics Alphanumeric Point of Sale, country 437 499
dependent 481 475 500
4674 POS Keyboard (built-in) 464 Retail Alphanumeric Point of Sale, 775 501
4674 POS Keyboard (built-in) scan country dependent 484, 485 808 502
codes 464 CANPOS keyboard 216 813 503
4685 keyboards CANPOS keyboard layout 444 819 504
4685 keyboard K02 Ultra 7 466 capability definitions 175 848 505
4685 keyboard K02 Ultra 7 scan cash drawer 850 506
codes 467 JavaPOS configuration 83 852 507
4685 keyboard K02 Ultra 7 with MSR/ OEM support 90 855 508
E 467 OPOS configuration 89 857 509
4685 keyboard K02 Ultra 7 with MSR/E supported properties and methods 81, 858 510
scan codes 468 91 860 511
4685 Keyboard Model K01 scan code USB support 90 861 512
set 466 Cash Drawer 862 513
4685 keyboard Model KC1 468 UnifiedPOS device statistics 863 514
4685 keyboard Model KC1 scan properties 555 864 515
codes 468 cash drawer device driver 86 865 516
4685 Point of Sale Keyboard Model CashDrawer.DisableCDStatus 85 866 517
K01 465 CenterOfZero 388 867 518
4685 Point of Sale Keyboard Model K01 character sets and code pages 495 869 519
layout 465 CharacterSet 173 872 520
4820 Toshiba SurePoint Solution CharacterSetASCIIBehavior 173 874 521
Keypad 470 check flipping support 285 912 522
4820 Toshiba SurePoint Solution Keypad check scanner 914 523
(system-attached) 472 calibration command 99 915 524
get check side 100 921 525
JavaPOS DirectIO calls 99 932 538
A scanner image quality 101 936 539
set check side 100 949 540, 542
additional JavaPOS information 222, 274, supported devices 95 950 541
373, 391 supported properties and methods 95 951 542
additional OPOS information Check Scanner code pages and character sets 495
scanner detection 381 UnifiedPOS device statistics color printing 341
AddLineFeed 256 properties 557 color support 257
Alphanumeric Point of Sale (NANPOS) check scanner statistics 95 command format
Keyboard check scanning support 315 direct I/O, keyboard 220
country dependent 481 checkout keyboards common properties 67
layout 489 layouts 413 common settings 67
Arabic code page support Class A compliance statement configurable parameters, scanner 351, 352
JavaPOS 255 Australia and New Zealand 598 configuration utility, OPOS 50
OPOS 297 China 598 configuring devices 43
European Union 596 configuring devices for OPOS 49
FCC (USA) 594 configuring the Alphanumeric Point of Sale
B Germany 597
Japan 599
keyboard 230
connectivity testing 54
bar code reader statistics 347 Russia 599 Control Center utility 48
barcode printing 338 code pages CursorState 173
battery return program 603 1116 526
baudRate 67 1117 527
bitmap print quality 257 1118 528
1250 529
D
bitmap printing 283
Brazil-Portuguese keyboard layout 484 1251 530 damage from electrostatic discharge 601
break scan code 413 1252 531 Danish keyboard layout 485
1253 532 DBCS printer limitations 343
1254 533 DBCS support 341
C 1255 534 Default8LPI 258
1256 535 DefaultCharacterSet 258
cable ferrite requirement 601 1257 536 DefaultLargeFont 258
Canadian French keyboard layout 1258 537 deployment 57
1381 554 descriptors 175

© Copyright Toshiba Global Commerce Solutions, Inc. 2008, 2021 625

device configuration 43 French keyboard layout JavaPOS (continued)
device sharing 342 Alphanumeric Point of Sale, country FISCAL_DATA_AVAIL
deviceBus 68 dependent 481 DirectIOEvent 124
deviceNumber 84 Retail Alphanumeric Point of Sale, FISCAL_ERROR DirectIOEvent 123
DirectIO.GET_FONT_INFO_ID 274 country dependent 485 FISCAL_IPL_END_STATUS event 125
DisplayRequired 389 FISCAL_RAW_STATUS event 125
disposal of equipment 602 FISCAL_STATUS DirectIOEvent 124
DocAdvance 258
Double key support 225
G supported methods 67
supported properties 67
DoubleHighAndDoubleWideIsQuad 259 German keyboard layout JavaPOS configuration
Alphanumeric Point of Sale, country cash drawer 83
dependent 482 fiscal printer 121
E Retail Alphanumeric Point of Sale, keylock 158
line display 173
country dependent 486
EIA-232 device communication 45 MICR 188
EIA-232 PosPrinter device detection 72 JavaPOS configuration file update 223
JavaPOS DirectIO calls 174, 220, 270
electromagnetic Interference statement
Russia 599
H JavaPOS Firmware Update 222
electronic emissions notices hard totals JavaPOS problems 59
Australia and New Zealand 598 OPOS configuration 149 JavaPOS support
China 598 supported properties and methods 147 Cash Drawer 555
European Union 596 Hard Totals Check Scanner 557
FCC (USA) 594 UnifiedPOS device statistics Fiscal Printer 559
Germany 597 properties 561 Hard Totals 561
Japan 599 hardware requirements 27 Keylock 561
Korea 600 hart totals 147 Line Display 563
electrostatic discharge (ESD) 601 MICR 565
Enable/Disable Partial Cut Detection 259 Motion Sensor 566
enableLaserOnOffSwitch 352 MSR 567
enableOnlineWatcher 206
I POSKeyboard 570
enableProgrammingViaBarcodes 353 POSPrinter 572
iButton 156
enableSwitchControlledVolumeAdjust 353 Scale 576
impClass 68
end of life disposal 602 Scanner 577
installation
EnforceZeroReturn 389 Tone Indicator 578
interactive upgrade 32
equipment disposal 602 Javax.usb for Linux 60
Linux 33
ER_CLEAR in the POSPrinter 290 jpos.xml file 43
silent upgrade 33
escape sequence handling 280 upgrade 32
European Union battery recycling Windows 29
statement 604 Windows interactive 29 K
Windows silent 31
installation package 35 kernel mode drivers
F Installing UnifiedPOS 29 SLE 11 SP3/SP4 38
keyboard configuration 231
installing USB System attached
ferrite requirement 601 keyboard 216 Keyboard definition file 224
Finnish keyboard layout 488 interactive installation, Windows 29 Keyboard V layout 462
fiscal printer Introduction 27 keyboards
device sensing 125 Italian keyboard layout 4685 Point of Sale Keyboard Model K01,
JavaPOS configuration 121 Alphanumeric Point of Sale, country layout 465
JavaPOS DirectIO calls 121 dependent 482 50-Key Modifiable Layout Keyboard
monitor detection 121 Retail Alphanumeric Point of Sale, and Operator Display, layout 414
supported devices 103 country dependent 486, 487 50-Key Modifiable Layout Keyboard,
supported properties and methods 104 layout 413
Fiscal Printer Alphanumeric Point of Sale (CANPOS)
UnifiedPOS device statistics Keyboard, layout 489
properties 559
J Modifiable Layout Keyboard with Card
FISCAL_INFORMATION Reader, layout 423
Japan Electronics and Information
subcommand 121 PC Point of Sale Keyboard, layout 428
Technology Industries Association
FISCAL_Notify subcommand 123 Retail Alphanumeric Point of Sale
statement 600
FISCAL_READ subcommand 122 country dependent keyboards 483
Japanese Electrical Appliance and Material
FISCAL_WRITE subcommand 122 Retail Alphanumeric Point of Sale
Safety Law statement 599
FiveDigitWeight 389 Keyboard, 428
Japanese power line harmonics compliance
flat panel displays 605 Retail Point of Sale Keyboard VI,
statement 599
flowControl 68 layout 415
Japanese VCCI Council Class A
fonts 335 Retail Point of Sale Keyboard with Card
statement 599
format 1 189 Reader and Display, layout 414
JavaPOS
format 2 191 Retail Point of Sale Keyboard,
format 3 191 layout 414

626 UnifiedPOS User's Guide

keylock MSR (continued) POS keyboard (continued)
five-position 155 additional JavaPOS information 208 KeyTranslationFile 218
four-position 154 additional OPOS information 211 supported devices 213
iButton 156 JavaPOS DirectIO calls 207 supported properties and methods 214
JavaPOS configuration 158 OPOS configuration 208 Typematic 218
OPOS configuration 159 UnifiedPOS device statistics TypematicDelay 219
PositionCount 158 properties 567 POS printer 235
six-position 155 msrID 206 POS printer statistics 235
supported devices 151 POS terminals supported 27
supported properties and methods 156 position count 161
three-position 153
two-position 152
N POSKeyboard
UnifiedPOS device statistics
Keylock Norwegian keyboard layout 487 properties 570
UnifiedPOS device statistics notices POSPrinter
properties 561 battery recycling 603, 604 UnifiedPOS device statistics
Knowledgebase 63 cable ferrites 601 properties 572
Known Scanner Issues 376 electronic emissions 594 printer performance, improving 343
Korean communications statement 600 electrostatic discharge (ESD) 601 printer-attached cash drawer 86
end of life disposal 602 problem determination
Toshiba 593 logging 59
L NumberOfRows 173 properties, methods, events
check scanner 95
layouts, point-of-sale keyboards 413 POS printer 235
Scale 385
line display
JavaPOS configuration 173
O Scanner 347
OPOS configuration 179 OEM Scanner support 373 ToneIndicator 395
supported devices 163 OPOS property definitions 176
supported properties and configuration options 73 proportional font support 342
methods 163, 169 configuration utility 50 ProportionalFontFixedWidth 263
Line Display configuring devices 49 ProprietaryBusSubType 69
UnifiedPOS device statistics FISCAL_INFORMATION pulse width 85
properties 563 subcommand 128
line wrapping 281 FISCAL_NOTIFY subcommand 129
lineDisplayId 173 FISCAL_READ subcommand 128 R
Linux installation 33 FISCAL_WRITE subcommand 128
network device communication 49 remove devices 57
OPOS configuration requirements
M cash drawer 89 hardware 27
POS terminals 27
hard totals 149
Magnetic Ink Character Recognition 185 keylock 159 software 28
magnetic stripe reader line display 179 requirements for system 27
JavaPOS configuration 206 OPOS configuration file update 229 rotated printing 341
supported devices 201 OPOS Firmware Update 229
supported properties and methods 202 OPOS problems 62
make scan code 413 OptimizedBaudRate 261 S
mapping POS keys 231
mercury-added statement 605 safety information 19
MICR
data 187
P Scale
UnifiedPOS device statistics
exception file 193 page mode printing 321 properties 576
exceptions 193 page mode support 285 Scale statistics 385
JavaPOS configuration 188 PDF417AspectHeight 262 scan codes 413
supported devices 185 PDF417AspectWidth 262 Scanner
supported properties and methods 185 PDF417ECCLevel 262 UnifiedPOS device statistics
UnifiedPOS device statistics PDF417Truncation 263 properties 577
properties 565 perchlorate 605 Scanner configuration 349
MICR exception tables 189 PLU Keyboard and Display III 463 Scanner statistics 347
Model 4A font file format 335 point-of-sale keyboard layouts 413 Scanner support 373
modifying device behavior 75 portName 69 service object settings
motion sensor POS Control Center utility 48 hard totals 149
Linux driver 198 POS keyboard Service Object settings
supported devices 197 click 217 cash drawer 89
supported properties and methods 197 ExtendedKeyMapping 217 POS keyboard, RS-485/USB 226
Motion Sensor FatFingerTimeout 217 POS printer, SureOne devices 295, 296
UnifiedPOS device statistics JavaPOS configuration 217 Scale, RS-485/USB 392
properties 566 KbdScanning 218 Tone indicator (keyboard tone), RS-485/
MSR USB 398

Index 627
Service Object settings (continued) setTransmitScannerPrefixAndSuffix 371 tracing, OPOS 62
Unsupported settings, RS-485/USB 298 setUPCAScansPerRead 372 trademarks 605
setBarCodes1 353 setUPCDScansPerRead 372 TranslateCharacter 269
setBarCodes2 354 setUPCEScansPerRead 372 two-position keylock
setBarCodes3 354 signalsReversed 84 NANPOS 160
setBarCodes4 355 silent installation, Windows 31 TypematicRate 219
setBeeperDuration 355 SIO scan code sets
setBeeperFrequency 355 50-Key Modifiable Layout
setBeeperVolume 356
setCheckModulo 356
Keyboard 419
50-Key Modifiable Layout Keyboard
U
setCode128ScansPerRead 356 and Operator Display 419 U.K. English keyboard layout
setCode39ScansPerRead 357 Modifiable Layout Keyboard with Card Alphanumeric Point of Sale, country
SetCompatibilityMode 268 Reader 423 dependent 483
setDecodeAlgorithm 357 Point of Sale Keyboard VI 419 Retail Alphanumeric Point of Sale,
setDoubleReadTimeOut 357 Retail Alphanumeric Point of Sale country dependent 488
setDTouchMode 358 Keyboard with Card Reader 431 U.S. English keyboard layout
setEAN13ScansPerRead 358 Retail Point of Sale Keyboard 419 Alphanumeric Point of Sale, country
setEAN8ScansPerRead 359 Retail Point of Sale Keyboard with Card dependent 483
setEnable_2_DigitSupplementals 359 Reader and Display 419 CANPOS, country dependent 491, 494
setEnable_5_DigitSupplementals 359 sioDeviceNumber 69 Retail Alphanumeric Point of Sale,
setEnableCodabar 360 sioPortNumber 70 country dependent 489
setEnableCode128 360 sioSlotNumber 70 UnifiedPOS device statistics properties 555
setEnableCode128Supplementals 360 SLE11 SP3 33 uninstallation
setEnableCODE39 360 SLE12 SP2 34 Windows 7 32
setEnableCode39CheckDigit 360 SlpLineSpacing 268 upgrade 32
setEnableCode93 361 software requirements 28 USB
setEnableCompositeCC_A 361 Spanish keyboard layout checkout keyboard scan code set 419
setEnableCompositeCC_B 361 Alphanumeric Point of Sale, country retail point-of-sale keyboard scan
setEnableCompositeCC_C 362 dependent 482 codes 422
setEnableEAN_JAN_TwoLabelDecoding Retail Alphanumeric Point of Sale, USB device access
361 country dependent 487, 488 Linux 48
setEnableGoodReadBeep 362 statistics properties, UnifiedPOS device 555 USB devices, ignoring 76
setEnableGS1Databar_Expanded 363 storage string remarks 318 USB firmware update files for JPOS 70
setEnableInterleaved2of5 362 support website 63 USB firmware update files for OPOS 74
setEnableITFCheckDigit 362 supported devices USB system attached keyboard 77
setEnableMicroPDF417 363 cash drawer 81 USB System attached keyboard, Linux 226
setEnablePDF417 362 supported POS terminals 27 user-defined fonts 341
setEnableRSS_Expanded 363 supported properties and methods 236, 347,
setEnableRSS14 363 385, 396
setEnableStandard2of5 364 SureOne keyboard (built-in) 473
setEnableUCC_EAN128 364 SureOne MSR 208
V
setEnableUPC_A_CheckDigit 364 SureOne/SurePOS 100 keyboard 231 VibrationSensitivity 390
setEnableUPC_A_To_EAN13Expansion 364 SureOneVersion 268 Virtual key codes 224
setEnableUPC_E_CheckDigit 364 SUSE Linux Enterprise 11 SP3 33
setEnableUPC_E_To_EAN13Expansion 365 SUSE Linux Enterprise 12 SP2 34
setEnableUPC_E_To_UPC_AExpansion 365 Swedish keyboard layout 488
setEnableUPCAE_EANJAN813 365 symbology, scanner 350, 351 W
setEnableUPCD1D5 365 system requirements 27
waitForDrawerClose method 87
setEnableVerificationUPC_A_EAN13_fiveDi Systems Management
WeighMode 390
git 365 installation 39
Windows installation 29
setEnableVerificationUPC_A_EAN13_fourDi validating 40
git 366
setITFLength1 366
setITFLength2 366
setITFLengths 367
T
setITFLengthSpecifiedTwo 367 Taiwanese battery recycling statement 603
setITFScansPerRead 367 Telecommunications regulatory
setLaserTimeOut 367 statement 594
setLED_GoodRead_Duration 368 testing connectivity 54
setMotorTimeOut 369 Tone Indicator
setSecurityLevelForInStore 369 UnifiedPOS device statistics
setSTFLength1 370 properties 578
setSTFLength2 370 ToneIndicator statistics 395
setSTFLengths 370 Toshiba support 63
setStoreScansPerRead 371 touch support 48
setSupplementals 371 tracing
setSupplementalsSecurityLevel 371 EIA-232 and USB 59

628 UnifiedPOS User's Guide

GC30-4078-31