Page 2 - Date Version
CITIZEN OPOS DRIVER 1.8 Application Development Guide 2 Revision Record Date Version Description 07/07/26 V1.00 New issue
Page 3 - Notes; trademarks of respective companies.
CITIZEN OPOS DRIVER 1.8 Application Development Guide 3 Notes 1. Unauthorized use of all or any part of this document is prohibited. 2. The information in this document is subject to change without prior notice. 3. This document has been created with full attention. If, however, you find an error or...
Page 4 - CITIZEN OPOS PRINTER SERVICE OBJECT
CITIZEN OPOS DRIVER 1.8 Application Development Guide 4 1. INTRODUCTION ........................................................................................................................................... 6 1.2. CITIZEN OPOS D RIVER ...............................................................
Page 5 - CapPowerReporting/ Powermotify/ PowerState Property
CITIZEN OPOS DRIVER 1.8 Application Development Guide 5 3.3. C ASH D RAWER S ERVICE O BJECT AND P ROPERTY R ELATIONS ....................................................................53 CBM-1000TypeII ....................................................................................................
Page 6 - connected to it; Object Operating System; This driver supports the following Windows operating systems.; Object Models; For details of each model, refer to the Printer User’s Guide.
CITIZEN OPOS DRIVER 1.8 Application Development Guide 6 1. Introduction The OPOS Driver complies with OPOS1.8. This document provides the explanation of device (POS printer)-dependent specifications and precautions. When you want to develop applications by using this driver, refer to “OpenPOS for OL...
Page 7 - OPOS1.8 specifications; Device Class; OPOS
CITIZEN OPOS DRIVER 1.8 Application Development Guide 7 1.4. Application Developer Application developer who wants to use this driver must be familiar with the following items. ・ OPOS1.8 specifications ・ General characteristics of CITIZEN POS printer ・ Terms and structure of ActiveX control and OLE ...
Page 8 - CITIZEN OPOS Driver Registry Structure; One “default value” defined by string-type data.
CITIZEN OPOS DRIVER 1.8 Application Development Guide 8 Service Object (SO) Service Object is called by Control Object and executes the function specified by OPOS for each device. It is implemented as automation server and provides the set of methods called by CO. This driver provides the processing...
Page 9 - Registry Operation
CITIZEN OPOS DRIVER 1.8 Application Development Guide 9 [HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\POSPrinter] @="" "PRN001"="CT-S2000_1" [HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\POSPrinter\CT-S2000_1] @="CBM.Thermal.POSPrinter" "PhysicalDe...
Page 10 - Also refer to the notes in each chapter.
CITIZEN OPOS DRIVER 1.8 Application Development Guide 10 1.7. CITIZEN OPOS Driver Precautions ・ If the printer power is turned off/on while connection to the printer is being established, acquiring status of printer or cash drawer may become unsuccessful. In this case, close SO once and then open SO...
Page 11 - CITIZEN OPOS Printer Service Object
CITIZEN OPOS DRIVER 1.8 Application Development Guide 11 2. CITIZEN OPOS Printer Service Object For the details, method of use, etc. of property, method and event, refer to “OpenPOS for OLE Application Programmer's Guide, Japanese Edition, Version 1.8”. 2.2. POS Printer Service Object and Method Rel...
Page 16 - POS Printer Service Object and Property Relations
CITIZEN OPOS DRIVER 1.8 Application Development Guide 16 2.3. POS Printer Service Object and Property Relations CBM-1000TypeII Property Notes Attribu te Supporting status (CBM1000TYPEII_*) AutoDisable Not applicable with OPOSPrinter R/W × Not supported BinaryConversion (Refer to BinaryConversion in ...
Page 36 - POS Printer Service Object and OPOS Escape Sequence
CITIZEN OPOS DRIVER 1.8 Application Development Guide 36 2.4. POS Printer Service Object and OPOS Escape Sequence Relations CBM-1000TypeII Escape Sequence Notes Supporting status (CBM-1000TYPEII_*) Paper cut ESC|#P { 0-100 Full cut/Partial cut depends on the model. Feed and paper cut ESC|#fP { 0-100...
Page 41 - POS Printer Service Object and Event Relations
CITIZEN OPOS DRIVER 1.8 Application Development Guide 41 2.5. POS Printer Service Object and Event Relations CBM-1000TypeII Event Notes Supporting status (CBM1000TYPEII_*) DataEvent Not applicable with OPOSPrinter × DirectIOEvent × ErrorEvent { OutputCompleteEvent 222 (Refer to OutPutID property/ Ou...
Page 43 - POS Printer Service Object and Precautions; ClaimDevice Method; Supported barcodes; RotatePrint Method
CITIZEN OPOS DRIVER 1.8 Application Development Guide 43 2.6. POS Printer Service Object and Precautions ClaimDevice Method No identical serial port (COM*) specified by the Windows driver is not usable in the connection of serial interface. When this method is executed in this connection, “OPOS_E_TI...
Page 44 - Raster bit image mode
CITIZEN OPOS DRIVER 1.8 Application Development Guide 44 SetBitmap Method/ESC|#B Escape Sequence Bitmap is registered by specifying Bitmap number (1 - 20) using the SetBitmap method and bitmap printing is carried out by specifying the registered number in the ESC|#B escape sequence. This driver has ...
Page 45 - AsyncMode Property; TRUE; ErrorLevel Property; Indicated when error is not detected.; BinaryConversion Property; Each byte is converted to two characters.
CITIZEN OPOS DRIVER 1.8 Application Development Guide 45 AsyncMode Property ・ TRUE Output method (PrintNormal, PrintTwoNormal, CutPaper, RotatePrint, PrintBarCode, and PrintBitmap) is executed asynchronously. ・ FALSE Output method is printed synchronously. When error occurs at the asynchronous outpu...
Page 47 - OutPutID Property/ OutputCompleteEvent Event
CITIZEN OPOS DRIVER 1.8 Application Development Guide 47 OutPutID Property/ OutputCompleteEvent Event Identifier of asynchronous output started just before is retained and incremented by +1 with the following output. <Visual Basic installation example: Output subroutine> Dim i as Integer Dim R...
Page 48 - RecLineChars/ RecLineCharsList Property; specified paper size.; TypeII
CITIZEN OPOS DRIVER 1.8 Application Development Guide 48 RecLineChars/ RecLineCharsList Property The number of one-byte characters of the font printed in one line on the paper is specified. ・ RecLineChars property: Specifies the maximum number of digits of FontA corresponding to the specified paper ...
Page 50 - RecSidewaysMaxChars Property
CITIZEN OPOS DRIVER 1.8 Application Development Guide 50 RecSidewaysMaxChars Property Calculated based on one-byte character. Kanji font (KANJI) is basically treated as two characters but some font selected by the value of the RecLineChars property may not correspond to two characters simply. RecSid...
Page 51 - Cash Drawer Service Object
CITIZEN OPOS DRIVER 1.8 Application Development Guide 51 3. Cash Drawer Service Object For the details, method of use, etc. of property, method and event, refer to “OpenPOS for OLE Application Programmer's Guide, Japanese Edition, Version 1.8”. 3.2. Cash Drawer Service and Object Method Relations CB...
Page 53 - Cash Drawer Service Object and Property Relations
CITIZEN OPOS DRIVER 1.8 Application Development Guide 53 3.3. Cash Drawer Service Object and Property Relations CBM-1000TypeII Property Notes Attri bute Supporting status (CBM1000TYPEII_*.CD*) AutoDisable Not applicable with OPOSDrawer. R/W × BinaryConversion Not applicable with OPOSDrawer. R/W × OP...
Page 58 - Cash Drawer Service Object and Event Relations
CITIZEN OPOS DRIVER 1.8 Application Development Guide 58 3.4. Cash Drawer Service Object and Event Relations CBM-1000TypeII Event Notes Supporting status (CBM1000TYPEII_*.CD*) DataEvent Not applicable with OPOSDrawer. × Not supported DirectIOEvent × Not supported ErrorEvent Not applicable with OPOSD...
Page 60 - Cash Drawer Service Object and Precautions
CITIZEN OPOS DRIVER 1.8 Application Development Guide 60 3.5. Cash Drawer Service Object and Precautions CapPowerReporting/ Powermotify/ PowerState Property This service object supports only cash drawer connected to the drawer kick connector at the back of the printer. Therefore the value of the Cap...