Loading...Citizen OPOS DRIVER User Manual
Loading...
CITIZEN OPOS DRIVER 1.8
Application Development Guide
'07/07/26 Ver1.00
CITIZEN OPOS DRIVER 1.8 Application Development Guide
Revision Record |
|
|
|
|
|
|
Description |
Date |
|
Version |
|
07/07/26 |
|
V1.00 |
New issue |
|
|
|
|
2
CITIZEN OPOS DRIVER 1.8 Application Development Guide
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 question, please contact us.
4.We shall not be liable for any effect resulting from operation regardless of the above item 3.
5.If you do not agree with the above terms, you are not permitted to use this driver.
Trademark
Microsoft, Windows 2000, Windows XP, Visual Basic, and Visual C++ are registered trademarks of Microsoft Corporation in the United States and/or other countries. (Official name for Windows is Microsoft Windows Operating System.)
Company names and product names appearing on this document are trademarks and/or registered trademarks of respective companies.
CITIZEN is a registered trademark of Citizen Holdings Co., Ltd.
3
CITIZEN OPOS DRIVER 1.8 Application Development Guide
1. INTRODUCTION ........................................................................................................................................... |
6 |
1.2. CITIZEN OPOS DRIVER.............................................................................................................................. |
6 |
1.3. OPERATING ENVIRONMENT .......................................................................................................................... |
6 |
1.4. APPLICATION DEVELOPER ............................................................................................................................ |
7 |
1.5. OPOS CONTROL ........................................................................................................................................... |
7 |
1.6. CITIZEN OPOS DRIVER REGISTRY STRUCTURE......................................................................................... |
8 |
Registry Operation........................................................................................................................................... |
9 |
1.7. CITIZEN OPOS DRIVER PRECAUTIONS .................................................................................................... |
10 |
2. CITIZEN OPOS PRINTER SERVICE OBJECT ........................................................................................... |
11 |
2.2. POS PRINTER SERVICE OBJECT AND METHOD RELATIONS ....................................................................... |
11 |
CBM-1000TypeII ........................................................................................................................................... |
11 |
CT-S300/CT-S310.......................................................................................................................................... |
12 |
CT-S2000....................................................................................................................................................... |
13 |
CT-S4000....................................................................................................................................................... |
14 |
CD-S500 ........................................................................................................................................................ |
15 |
2.3. POS PRINTER SERVICE OBJECT AND PROPERTY RELATIONS..................................................................... |
16 |
CBM-1000TypeII ........................................................................................................................................... |
16 |
CT-S300/CT-S310.......................................................................................................................................... |
20 |
CT-S2000....................................................................................................................................................... |
24 |
CT-S4000....................................................................................................................................................... |
28 |
CD-S500 ........................................................................................................................................................ |
32 |
2.4. POS PRINTER SERVICE OBJECT AND OPOS ESCAPE SEQUENCE RELATIONS ........................................... |
36 |
CBM-1000TypeII ........................................................................................................................................... |
36 |
CT-S3000/CT-S310........................................................................................................................................ |
37 |
CT-S2000....................................................................................................................................................... |
38 |
CT-S4000....................................................................................................................................................... |
39 |
CD-S500 ........................................................................................................................................................ |
40 |
2.5. POS PRINTER SERVICE OBJECT AND EVENT RELATIONS........................................................................... |
41 |
CBM-1000TypeII ........................................................................................................................................... |
41 |
CT-S 00/CT-S310 ........................................................................................................................................ |
41 |
CT-S2000....................................................................................................................................................... |
41 |
CT-S4000....................................................................................................................................................... |
42 |
CD-S500 ........................................................................................................................................................ |
42 |
2.6. POS PRINTER SERVICE OBJECT AND PRECAUTIONS .................................................................................. |
43 |
ClaimDevice Method...................................................................................................................................... |
43 |
PrintBarCode Method/RotateSpecial ............................................................................................................. |
43 |
RotatePrint Method ....................................................................................................................................... |
43 |
SetBitmap Method/ESC|#B Escape Sequence .............................................................................................. |
44 |
AsyncMode Property...................................................................................................................................... |
45 |
ErrorLevel Property ....................................................................................................................................... |
45 |
BinaryConversion Property ............................................................................................................................ |
45 |
OutPutID Property/ OutputCompleteEvent Event ......................................................................................... |
47 |
CapRecEmptySensor/ RecEmpty Property .................................................................................................... |
47 |
RecLineChars/ RecLineCharsList Property..................................................................................................... |
48 |
RecSidewaysMaxChars Property.................................................................................................................... |
50 |
RecSidewaysMaxLines Property .................................................................................................................... |
50 |
ResultCode/ ResultCodeExtended Property .................................................................................................. |
50 |
3. CASH DRAWER SERVICE OBJECT............................................................................................................ |
51 |
3.2. CASH DRAWER SERVICE AND OBJECT METHOD RELATIONS ...................................................................... |
51 |
CBM-1000TypeII ........................................................................................................................................... |
51 |
CT-S300/ CT-S310......................................................................................................................................... |
51 |
CT-S2000....................................................................................................................................................... |
51 |
CT-S4000....................................................................................................................................................... |
52 |
CD-S500 ........................................................................................................................................................ |
52 |
4
CITIZEN OPOS DRIVER 1.8 Application Development Guide
3.3. CASH DRAWER SERVICE OBJECT AND PROPERTY RELATIONS.................................................................... |
53 |
CBM-1000TypeII ........................................................................................................................................... |
53 |
CT-S300/CT-S310.......................................................................................................................................... |
54 |
CT-S2000....................................................................................................................................................... |
55 |
CT-S4000....................................................................................................................................................... |
56 |
CD-S500 ........................................................................................................................................................ |
57 |
3.4. CASH DRAWER SERVICE OBJECT AND EVENT RELATIONS ......................................................................... |
58 |
CBM-1000TypeII ........................................................................................................................................... |
58 |
CT-S300/CT-S310.......................................................................................................................................... |
58 |
CT-S2000....................................................................................................................................................... |
58 |
CT-S4000....................................................................................................................................................... |
58 |
CD-S500 ........................................................................................................................................................ |
59 |
3.5. CASH DRAWER SERVICE OBJECT AND PRECAUTIONS................................................................................. |
60 |
CapPowerReporting/ Powermotify/ PowerState Property ............................................................................. |
60 |
5
CITIZEN OPOS DRIVER 1.8 Application Development Guide
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 OLE Application Programmer’s Guide, Japanese Edition, Version 1.8” beforehand.
Reference link (as of July 17, 2007) https://www.microsoft.com/japan/business/industry/retail/opos/download.mspx
1.2. CITIZEN OPOS Driver
This driver provides an open device driver architecture that can easily integrate the CITIZEN POS printer and the cash drawer connected to it by the POS system based on Microsoft Windows Operating System. This driver has been developed for the following purpose.
Definition of architecture for accessing the Win32-based POS printer and cash drawer connected to it
Definition of interface of CITIZEN POS printer supporting POS solution and cash drawer
connected to it
1.3. Operating Environment
Object Operating System
This driver supports the following Windows operating systems.
Windows 2000
Windows XP
Object Models
Object models of this driver and the corresponding drivers are as shown below. For details of each model, refer to the Printer User’s Guide.
|
Object Model |
|
|
Function |
|
|
Applicable driver |
|
|
Applicable driver |
|
|
|
|
|
|
(Printer) |
|
|
(Drawer) |
|
||
|
|
|
|
|
|
|
|
|
|
||
|
CBM-1000TypeII |
|
Standard |
|
CBM1000TYPEII_* |
CBM1000TYPEII_*.C |
|||||
|
CBM-1000TypeII- L |
|
Blackmark paper and label paper are |
|
|||||||
|
|
|
D* |
||||||||
|
|
|
|
supported. |
|
|
|
||||
|
|
|
|
|
|
|
|
|
|
||
|
CT-S300 |
Standard (Paper with blackmark on front side |
|
|
|
|
|
|
|||
|
|
|
|
is supported) |
|
CT-S300_* |
CT-S300_*.CD* |
||||
|
CT-S300-M1/M2 |
|
Paper with blackmark on back side is |
|
|||||||
|
|
|
|
|
|
|
|
||||
|
|
|
|
supported. |
|
|
|
|
|
|
|
|
CT-S310 |
|
Standard (Paper with blackmark on front side |
|
|
|
|
|
|
||
|
|
|
|
is supported) |
|
CT-S310_* |
CT-S310_*.CD* |
||||
|
CT-S310-M1/M2 |
|
Paper with blackmark on back side is |
|
|||||||
|
|
|
|
|
|
|
|
||||
|
|
|
|
supported. |
|
|
|
|
|
|
|
|
CT-S2000 |
|
Standard |
|
CT-S2000_* |
|
CT-S2000_*.CD* |
||||
|
CT-S2000-M |
Blackmark paper is supported. |
|
|
|||||||
|
CT-S2000-L |
Label paper is supported. |
|
|
|
|
|
|
|||
|
CT-S4000 |
Standard (Paper with blackmark on front side |
|
|
|
|
|
|
|||
|
|
|
|
is supported) |
|
CT-S4000_* |
|
CT-S4000_*.CD* |
|||
|
CT-S4000-M |
|
Paper with blackmark on back side is |
|
|
||||||
|
|
|
|
supported. |
|
|
|
|
|
|
|
|
CT-S4000-L |
Label paper is supported. |
|
|
|
|
|
|
|||
|
CD-S500 |
Standard type (Without cutting feature) |
|
CD-S500_* |
CD-S500_*.CD* |
||||||
|
CD-S501 |
|
With cutting feature |
|
|||||||
|
CD-S503 |
Rewinder equipped (With cutting feature) |
|
|
|
|
|
|
|||
6
CITIZEN OPOS DRIVER 1.8 Application Development Guide
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 automation
ActiveX control container development environment such as Microsoft Visual Basic and Microsoft Visual C++, etc.
1.5. OPOS Control
The OPOS control, conforming to ActiveX control specifications, provides the application with property, method, and/or event. It consists of control object (CO) for device class and service object (SO). CO supplies application interface (API) and SO executes the API,
The OPOS software us implemented by the use of the layer shown in the following figure.
Application
|
|
|
Method |
|
|
|||||||
|
Interface |
|
Property |
|
|
|||||||
|
ActiveX |
|
|
|
|
|
|
|
|
|
Event |
|
|
Control |
|
|
|
|
|
|
|
|
|
||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Control Object |
|
|
|
|
OPOS |
|||||
|
|
Device class support |
|
Control |
||||||||
System |
|
Device independent |
|
|||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
Registration |
|
|
|
|
|
|||||||
Interface |
|
Method |
|
|
|
|||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
Mapping |
ActiveX |
|
|
|
|
|
|
|
|
|
Event |
|
|
|
|
|
|
|
|
|
|
||||
Automation |
|
|
|
|
|
|
|
|
|
|||
Parameter |
|
|
|
|
|
|
|
|
|
|
Method |
|
|
|
Service Object |
|
|
||||||||
|
|
Device dependent |
|
|
||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Operating System/Driver
Printer |
Cash Drawer |
|
|
Device Class
This is a category of the POS device sharing the set of property, method and event.
Control Object (CO)
Control Object provides the application with a set of property, method and event for each device class. CO is a standard Active (OLE 32 bit) control and is not visible at the time of execution. As a rule, this driver uses OPOS standard CO. (OPOS standard CO is installed automatically at the installation of this driver.)
7
CITIZEN OPOS DRIVER 1.8 Application Development Guide
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 dependent on the CITIZEN POS printer and cash drawer connected to the printer.
1.6. CITIZEN OPOS Driver Registry Structure
In order for Control Object to be connected to Service Object exactly and initialize the corresponding device, the OPOS control requires data for the system registry. The registry has a hierarchical structure with levels called “key”. Each key consists of the following.
Additional key (also called sub-key)
Named value (“Data” of string, binary, or double-word type is defined for each value.)
One “default value” defined by string-type data.
OPOS defines only string data.
The following is a registry structure taking CT-S2000 (printer and cash drawer) as an example.
[HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail] @=""
[HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceInfo]
[HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceInfo\OposCCOs] "Version"="1.8.001"
"Company"="Research Computer Services, Inc; Dayton OH" "Directory"="C:\\Program Files\\CITIZEN\\CITIZEN Service Objects\\" "Author"="Curtiss R. Monroe"
@="OPOS Common Control Objects -- Public Binaries. Source (c) RCS-Dayton."
[HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS] @=""
[HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\CashDrawer] @=""
"DRW001"="CT-S2000_1.CD1"
[HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\CashDrawer\CT-S2000_1.CD1] @="CBM.Thermal.CashDrawer"
"PhysicalDeviceID"="CITIZENCT-S2000" "Version"="1008009" "WriteTimeout"="5000"
"Pin3"="001"
"StatusBackInterval"="200"
"Service"="C:\\Program Files\\CITIZEN\\CITIZEN Service Objects\\CBMTSO.dll" "Port"="COM1:"
"BaudRate"="19200"
"HandShake"="000"
"BitLength"="008"
"Parity"="000"
"ServiceObjectDescription"="Citizen Systems Service Object for CT-S2000_1 Printer Cash Drawer No.1 ver 1.08.09"
"DrawerName"="CTS2000.CITIZEN.CD1"
"DeviceDescription"="Citizen Systems Thermal POSPrinter's Cash Drawer 1" "OnTime"="005"
"PrinterID"="CT-S2000_1" "CapStatus"="001"
8
CITIZEN OPOS DRIVER 1.8 Application Development Guide
[HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\POSPrinter] @=""
"PRN001"="CT-S2000_1"
[HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\POSPrinter\CT-S2000_1] @="CBM.Thermal.POSPrinter"
"PhysicalDeviceID"="CITIZENCT-S2000" "Version"="1008009" "WriteTimeout"="5000"
"Pin3"="001"
"StatusBackInterval"="200"
"Service"="C:\\Program Files\\CITIZEN\\CITIZEN Service Objects\\CBMTSO.dll" "Port"=" COM1:"
"BaudRate"="19200"
"HandShake"="000"
"BitLength"="008"
"Parity"="000"
"FamilyID"="001"
"MapResolution"="001"
"PrinterName"="CTS2000.CITIZEN.POSPrinter" "DeviceDescription"="Citizen Systems Thermal POSPrinter."
"ServiceObjectDescription"="Citizen Systems Service Object for Thermal PosPrinters ver 1.08.09." "PrinterMode"="000"
"BitmapMode"="000"
"PrinterLanguageModel"="008"
"PaperSensor"="000"
"PaperModel"="003"
"Column"="001"
"UseNVRAM"="000"
Registry Operation
Writing illegal value in a registry may cause serious trouble in the system. Therefore, Close attention is required in handling a registry. When handling a registry, the following registrysetting tool (Configuration Utility) shall be used as a rule. For the method of using this tool, refer to “Setup Guide” of this driver.
(Configuration Utility)
9
CITIZEN OPOS DRIVER 1.8 Application Development Guide
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 again.
Though cash drawer SO can be opened singly without opening the corresponding printer SO, opening/closing the corresponding printer SO thereafter impossibility in acquiring cash drawer status may result. In this case, close cash drawer SO once and then open the cash drawer SO again.
When printing on label paper, use MarkFeed method (handling of marked paper).
For the method of using this method, refer to “OpenPOS for OLE Application Programmer's Guide Japanese Versin Rev. 18”.
Also refer to the notes in each chapter.
10
CITIZEN OPOS DRIVER 1.8 Application Development Guide
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 Relations
CBM-1000TypeII
|
Method |
|
Notes |
|
|
Supporting status |
|
|
|
|
|
(CBM1000TYPEII_*) |
|
||
|
|
|
|
|
|
|
Open
Close
ClaimDevice
ReleaseDevice
CheckHealth
ClearInput
ClearOutput
DirectIO
ResetStatistics
RetrieveStatistics
UpdateStatistics
PrintNormal
PrintTwoNormal
PrintImmediate
BeginInsertion
EndInsertion
BeginRemoval
EndRemoval
CutPaper
RotatePrint
PrintBarCode
PrintBitmap
TransactionPrint
ValidateData
SetBitmap
SetLogo
ChangePrintSide
MarkFeed
Notes on Serial I/F connection
(Refer to RotatePrint in 2.6 POS Printer Service Object and Precautions.)
OPOS_CH_EXTERNAL
Only (self diagnostic printing) is supported.
Not applicable with OPOSPrinter
Data being transmitted cannot be stopped.
(Refer to RotatePrint in 2.6 POS Printer Service Object and Precautions.)
(Refer to PrintBarcode in 2.6 POS Printer Service Object and Precautions.)
(Refer to SetBitmap Method/ESC|#B Escape Sequence in 2.6 POS Printer Service Object and Precautions.)
{
{
{
{
UOPOS_CH_EXTERNAL
×Not applied because no input device is used.
{
×Not supported
×Not supported (OPOS_E_ILLEGAL)
×Not supported (OPOS_E_ILLEGAL)
×Not supported (OPOS_E_ILLEGAL)
{
×Not supported
{
×Not supported
×Not supported
×Not supported
×Not supported
Partial cut (0-100)
{Full cut (0-100) provided hardware change is required.
U
{
{ Raster bit image printing
{
{
Raster bit image mode
{NV bit image mode
{
×Not supported
{Blackmarksupported. paper and label paper are
11
CITIZEN OPOS DRIVER 1.8 Application Development Guide
CT-S300/CT-S310
|
Method |
|
Notes |
|
Supporting status |
|
|
|
|
(CT-S300_*/CT-S310_*) |
|
||
|
|
|
|
|
|
Open
Close
ClaimDevice
ReleaseDevice
CheckHealth
ClearInput
ClearOutput
DirectIO
ResetStatistics
RetrieveStatistics
UpdateStatistics
PrintNormal
PrintTwoNormal
PrintImmediate
BeginInsertion
EndInsertion
BeginRemoval
EndRemoval
CutPaper
RotatePrint
PrintBarCode
PrintBitmap
TransactionPrint
ValidateData
SetBitmap
SetLogo
ChangePrintSide
MarkFeed
Notes on Serial I/F connection
(Refer7 to ClaimDevice in 2.6. POS Printer
Service Object and Precautions.)
OPOS_CH_EXTERNAL
Only (self diagnostic printing) is supported.
Not applicable with OPOSPrinter
Data being transmitted cannot be stopped.
(Refer7 to RotatePrint in 2.6 POS Printer
Service Object and Precautions.)
(Refer7 to PrintBarcode in 2.6 POS Printer
Service Object and Precautions.)
(Refer8 to SetBitmap Method/ESC|#B
Escape Sequence in 2.6 POS Printer
Service Object and Precautions.)
{
{
{
{
UOPOS_CH_EXTERNAL
× |
Not applied because no input device is used. |
{ |
|
|
|
× |
Not supported |
× |
Not supported (OPOS_E_ILLEGAL) |
× Not supported (OPOS_E_ILLEGAL) |
|
× |
Not supported (OPOS_E_ILLEGAL) |
{ |
|
× |
Not supported |
{ |
|
× |
Not supported |
× |
Not supported |
× |
Not supported |
× |
Not supported |
{ |
Partial cut (0-99) |
Full cut (100) |
|
U |
|
|
|
{ |
|
|
|
{ |
Raster bit image printing |
{ |
|
{ |
|
|
Raster bit image mode |
{NV bit image mode
{
×Not supported
{Blackmark paper is supported.
12
CITIZEN OPOS DRIVER 1.8 Application Development Guide
CT-S2000
|
Method |
|
Notes |
|
Supporting status |
|
|
|
|
(CT-S200_*) |
|
||
|
|
|
|
|
|
Open
Close
ClaimDevice
ReleaseDevice
CheckHealth
ClearInput
ClearOutput
DirectIO
ResetStatistics
RetrieveStatistics
UpdateStatistics
PrintNormal
PrintTwoNormal
PrintImmediate
BeginInsertion
EndInsertion
BeginRemoval
EndRemoval
CutPaper
RotatePrint
PrintBarCode
PrintBitmap
TransactionPrint
ValidateData
SetBitmap
SetLogo
ChangePrintSide
MarkFeed
Notes on Serial I/F connection
(Refer8 to ClaimDevice in 2.6. POS Printer
Service Object and Precautions.)
OPOS_CH_EXTERNAL
Only (self diagnostic printing) is supported.
Not applicable with OPOSPrinter
Data being transmitted cannot be stopped.
(Refer8 to RotatePrint in 2.6 POS Printer
Service Object and Precautions.)
(Refer8 to PrintBarcode in 2.6 POS Printer
Service Object and Precautions.)
(Refer8 to SetBitmap Method/ESC|#B
Escape Sequence in 2.6 POS Printer
Service Object and Precautions.)
{
{
{
{
UOPOS_CH_EXTERNAL
× |
Not applied because no input device is used. |
{ |
|
|
|
× |
Not supported |
× |
Not supported (OPOS_E_ILLEGAL) |
× Not supported (OPOS_E_ILLEGAL) |
|
× |
Not supported (OPOS_E_ILLEGAL) |
{ |
|
× |
Not supported |
{ |
|
× |
Not supported |
× |
Not supported |
× |
Not supported |
× |
Not supported |
{ |
Partial cut (0-99) |
Full cut (100) |
|
U |
|
|
|
○ |
|
|
|
{ |
Raster bit image printing |
{ |
|
{ |
|
|
Raster bit image mode |
{NV bit image mode
{
×Not supported
{Blackmarksupported.paper and label paper are
13
CITIZEN OPOS DRIVER 1.8 Application Development Guide
CT-S4000
|
Method |
|
Notes |
|
Supporting status |
|
|
|
|
(CT-S4000_*) |
|
||
|
|
|
|
|
|
Open
Close
ClaimDevice
ReleaseDevice
CheckHealth
ClearInput
ClearOutput
DirectIO
ResetStatistics
RetrieveStatistics
UpdateStatistics
PrintNormal
PrintTwoNormal
PrintImmediate
BeginInsertion
EndInsertion
BeginRemoval
EndRemoval
CutPaper
RotatePrint
PrintBarCode
PrintBitmap
TransactionPrint
ValidateData
SetBitmap
SetLogo
ChangePrintSide
MarkFeed
Notes on Serial I/F connection
(Refer9 to ClaimDevice in 2.6. POS Printer
Service Object and Precautions.)
OPOS_CH_EXTERNAL
Only (self diagnostic printing) is supported.
Not applicable with OPOSPrinter
Data being transmitted cannot be stopped.
(Refer9 to RotatePrint in 2.6 POS Printer
Service Object and Precautions.)
(Refer9 to PrintBarcode in 2.6 POS Printer
Service Object and Precautions.)
(Refer9 to SetBitmap Method/ESC|#B
Escape Sequence in 2.6 POS Printer
Service Object and Precautions.)
{
{
{
{
UOPOS_CH_EXTERNAL
× |
Not applied because no input device is used. |
{ |
|
|
|
× |
Not supported |
× |
Not supported (OPOS_E_ILLEGAL) |
× Not supported (OPOS_E_ILLEGAL) |
|
× |
Not supported (OPOS_E_ILLEGAL) |
{ |
|
× |
Not supported |
{ |
|
× |
Not supported |
× |
Not supported |
× |
Not supported |
× |
Not supported |
{ |
Partial cut (0-99) |
Full cut (100) |
|
U |
|
|
|
{ |
|
|
|
{ |
Raster bit image printing |
{ |
|
{ |
|
|
Raster bit image mode |
{NV bit image mode
{
×Not supported
{Blackmarksupported.paper and label paper are
14
CITIZEN OPOS DRIVER 1.8 Application Development Guide
CD-S500
|
Method |
|
Notes |
|
Supporting status |
|
|
|
|
(CD-S500_*) |
|
||
|
|
|
|
|
|
Open
Close
ClaimDevice
ReleaseDevice
CheckHealth
ClearInput
ClearOutput
DirectIO
ResetStatistics
RetrieveStatistics
UpdateStatistics
PrintNormal
PrintTwoNormal
PrintImmediate
BeginInsertion
EndInsertion
BeginRemoval
EndRemoval
CutPaper
RotatePrint
PrintBarCode
PrintBitmap
TransactionPrint
ValidateData
SetBitmap
SetLogo
ChangePrintSide
MarkFeed
Notes on Serial I/F connection
(Refer9 to ClaimDevice in 2.6. POS Printer
Service Object and Precautions.)
OPOS_CH_EXTERNAL
Only (self diagnostic printing) is supported.
Not applicable with OPOSPrinter
Data being transmitted cannot be stopped.
(Refer1 to RotatePrint in 2.6 POS Printer
Service Object and Precautions.)
(Refer1 to SetBitmap Method/ESC|#B
Escape Sequence in 2.6 POS Printer
Service Object and Precautions.)
{
{
{
{
UOPOS_CH_EXTERNAL
× |
Not applied because no input device is used. |
{ |
|
|
|
× |
Not supported |
× |
Not supported (OPOS_E_ILLEGAL) |
× Not supported (OPOS_E_ILLEGAL) |
|
× |
Not supported (OPOS_E_ILLEGAL) |
{ |
|
× |
Not supported |
{ |
|
× |
Not supported |
× |
Not supported |
× |
Not supported |
× |
Not supported |
{ |
Partial cut (0-100) |
Full cut (100) |
|
U |
|
|
|
× |
Not supported |
{ |
Raster bit image printing |
{ |
|
{ |
|
|
Raster bit image mode |
{NV bit image mode
{
×Not supported
{Blackmark paper is supported.
15
CITIZEN OPOS DRIVER 1.8 Application Development Guide
2.3. POS Printer Service Object and Property Relations
CBM-1000TypeII
Property
AutoDisable
BinaryConversion
CapPowerReporting
CapstatisticsReporting
CapUpdateStatistics
CheckHealthText
Claimed
DataCount
DataEventEnabled
DeviceEnabled
FreezeEvents
OpenResult
OutputID
PowerNotify
PowerState
ResultCode
ResultCodeExtended
State
ControlObjectDescripti on
ControlObjectVersion
ServiceObjectDescripti on
ServiceObjectVersion
DeviceDescription
DeviceName
CapCharacterSet
|
|
Notes |
|
Attribu |
|
|
|
Supporting status |
|
||
|
|
|
te |
|
|
|
(CBM1000TYPEII_*) |
|
|||
|
|
|
|
|
|
|
|
|
|
||
Not applicable with OPOSPrinter |
|
R/W |
|
× |
Not supported |
|
|||||
|
(Refer to BinaryConversion in 2.6 |
|
R/W |
{ |
OPOS_BC_NONE (Default value) |
|
|||||
|
POS Printer Service Object and |
|
|
|
|
|
OPOS_BC_NIBBLE |
|
|||
|
Precautions.) |
|
|
|
|
|
OPOS_BC_DECIMAL |
|
|||
|
|
|
|
|
|
R |
{ |
OPOS_PR_STANDARD |
|
||
|
|
|
|
|
|
R |
|
× |
FALSE |
|
|
|
|
|
|
|
|
R |
|
× |
FALSE |
|
|
|
|
|
|
|
|
R |
|
{ |
External HCheck: Successful |
|
|
|
|
|
|
|
|
R |
{ |
ClaimeDevice → True |
|
||
|
|
|
|
|
|
|
|
|
|
ReleaseDevice → False |
|
Not applicable with OPOSPrinter |
|
R |
|
× |
Not applied because no input device is used. |
|
|||||
Not applicable with OPOSPrinter |
|
R/W |
|
× |
Not applied because no input device is used. |
|
|||||
|
|
|
|
|
|
R/W |
{ |
TRUE DataEvent notified |
|
||
|
|
|
|
|
|
|
|
|
|
False: DataEvent not notified |
|
|
|
|
|
|
|
R/W |
{ |
TRUE Event notification disabled |
|
||
|
|
|
|
|
|
|
|
|
|
FALSE: Event notification enabled |
|
|
|
|
|
|
|
R |
{ |
In other than OPOS_SUCCESS, refer to |
|
||
|
|
|
|
|
|
|
|
|
|
OpenResult properties in “OPENPOS FOR OLE |
|
|
|
|
|
|
|
|
|
|
|
APPLICATION PROGRAMMER’S GUIDE |
|
|
|
|
|
|
|
|
|
|
|
Japanese-edition Specification Version 1.8”. |
|
|
(Refer11 |
to OutPutID property/ |
|
|
R |
{ |
Increment (+1) |
|
|||
|
OutputCompleteEvent event in 2.6 |
|
|
|
|
|
|
|
|||
|
POS Printer Service Object and |
|
|
|
|
|
|
|
|||
|
Precautions.) |
|
|
|
|
|
|
|
|||
|
|
|
|
|
|
R/W |
{ |
OPOS_PN_DISABLE |
|
||
|
|
|
|
|
|
|
|
|
|
(Power notification is not supplied.) |
|
|
|
|
|
|
|
|
|
|
|
OPOS_PN_ENABLE |
|
|
|
|
|
|
|
|
|
|
|
(Information on power notification is |
|
|
|
|
|
|
|
|
|
|
|
supplied.) |
|
|
|
|
|
|
|
R |
{ |
OPOS_ONLINE(2001) |
|
||
|
|
|
|
|
|
|
|
|
|
Online and Ready state |
|
|
|
|
|
|
|
|
|
|
|
OPOS_PS_OFFLINE(2003) |
|
|
|
|
|
|
|
|
|
|
|
Not Ready state |
|
|
(Refer to ResultCode/ |
|
R |
{ |
In other than OPOS_SUCCESS, refer to |
|
|||||
|
ResultCodeExtended Property in |
|
|
|
|
|
ResulCode properties in “OPENPOS FOR OLE |
|
|||
|
2.6 POS Printer Service Object and |
|
|
|
|
|
APPLICATION PROGRAMMER’S GUIDE |
|
|||
|
Precautions.) |
|
|
|
|
|
Japanese-edition Specification Version 1.8”. |
|
|||
|
(Refer1 |
to ResultCode/ |
|
|
R |
{ |
|
|
|||
|
ResultCodeExtended Property in |
|
|
|
|
|
|
|
|||
|
2.6 POS Printer Service Object and |
|
|
|
|
|
|
|
|||
|
Precautions.) |
|
|
|
|
|
|
|
|||
|
|
|
|
|
|
R |
{ |
In other than OPO_S_IDLE, refer to State |
|
||
|
|
|
|
|
|
|
|
|
|
properties in “OPENPOS FOR OLE |
|
|
|
|
|
|
|
|
|
|
|
APPLICATION PROGRAMMER’S GUIDE |
|
|
|
|
|
|
|
|
|
|
|
Japanese-edition Specification Version 1.8”. |
|
|
|
|
|
|
|
R |
{ |
1.8*** |
|
||
R { 1.8***
R{ CITIZEN Service Object for Thermal Printers ver *.**.**
R |
{ |
1****** |
R |
{ |
CITIZEN Thermal POSPrinter |
R |
{ |
"CBM1000II" |
R |
{ |
PTR_CCS_KANJI |
16
CITIZEN OPOS DRIVER 1.8 Application Development Guide
Property
CapConcurrentJrnRec
CapConcurrentJrnSlp
CapConcurrentRecSlp
CapCoverSensor
CapTransaction
CapJrnPresent
CapJrn2Color
CapJrnBold
CapJrnDhigh
CapJrnDwide
CapJrnDwideDhigh
CapJrnEmptySensor
CapJrnItalic
CapJrnNearEndSensor
CapJrnUnderline
CapJrnCartridgeSensor
CapJrnColor
CapRecPresent
CapRec2Color
CapRecBarCode
CapRecBitmap
CapRecBold
CapRecDhigh
CapRecDwide
CapRecDwideDhigh
CapRecEmptySensor
CapRecItalic
CapRecLeft90
CapRecNearEndSensor
CapRecPapercut
CapRecRight90
CapRecRotate180
CapRecStamp
CapRecUnderline
CapRecCartridgeSensor
CapRecColor
CapRecMarkFeed
CapSlpPresent
CapSlpFullslip
CapSlp2Color
CapSlpBarCode
CapSlpBitmap
CapSlpBold
CapSlpDhigh
CapSlpDwide
CapSlpDwideDhigh
CapSlpEmptySensor
CapSlpItalic
CapSlpLeft90
CapSlpNearEndSensor
Notes
(Refer to CapRecEmptySensor/ RecEmpty Property in 2.6 POS Printer Service Object and Precautions.)
Attribu |
|
|
|
Supporting status |
|
te |
|
|
|
(CBM1000TYPEII_*) |
|
R |
|
× |
Not supported |
|
|
R |
|
× |
Not supported |
|
|
R |
|
× |
Not supported |
|
|
R |
{ |
TRUE: With cover open sensor |
|
||
R{ TRUE: Batch processing of characters is possible.
R |
× |
Not supported |
|
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
{ |
TRUE Receipt is possible. |
R |
|
{ |
TRUE 2-color printing is possible. |
|
(Using paper printable in 2 colors) |
||
R |
|
{ |
TRUE: Barcode printing is possible. |
R |
|
{ |
TRUE: Bitmap printing is possible. |
R |
{ |
TRUE: Bold attribute setting is possible. |
|
R{ TRUE: Double height attribute setting is possible.
R |
{ |
TRUE: Double width setting is possible. |
R |
{ |
TRUE: Quadruple attribute setting is possible. |
R{ TRUE: Paper-Out sensor is active. FALSE: Paper-Out sensor is non-active.
R |
× |
Not supported |
R |
{ |
TRUE: 90-degree CCW rotation attribute |
|
|
setting is possible. |
R |
{ |
TRUE: With Paper Near-End sensor |
R |
{ |
Only partial cut (90) is supported. |
R{ TRUE: 90-degree CW rotation attribute setting is possible.
R |
{ |
TRUE: 180-degree rotation attribute setting is |
|
|
|
|
possible. |
R |
|
× |
Not supported |
R |
|
{ |
TRUE: Underline attribute setting is possible. |
R |
|
{ |
PTR_CART_OK |
R |
|
{ |
PTR_CUSTOM_COLOR1 |
R |
{ |
PTR_MF_TO_CUTTER |
|
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
17
CITIZEN OPOS DRIVER 1.8 Application Development Guide
Property
CapSlpRight90
CapSlpRotate180
CapSlpUnderline
CapSlpBothSidesPrint
CapSlpCartridgeSensor
CapSlpColor
AsyncMode
CartridgeNotify
CharacterSet
CharacterSetList
CoverOpen
ErrorLevel
ErrorStation
ErrorString
FontTypefaceList
FlagWhenIdle
MapMode
RotateSpecial
JrnLineChars
JrnLineCharsList
JrnLineHeight
JrnLineSpacing
JrnLineWidth
JrnLetterQuality
JrnEmpty
JrnNearEnd
JrnCartridgeState
JrnCurrentCartridge
Notes
(Refer to AsyncMode Property in 2.6 POS Printer Service Object and Precautions.)
(Refer to ErrorLevel Property in 2.6 POS Printer Service Object and Precautions.)
Attribu
te
R
R
R
R
R
R
R/W
R/W
R/W
R
R
R
R
R
R
R/W
R/W
R/W
R/W
R
R/W
R/W
R
R/W
R
R
R
R/W
Supporting status (CBM1000TYPEII_*)
×Not supported
×Not supported
×Not supported
×Not supported
×Not supported
×Not supported { TRUE/FALSE
×Not supported { Default value
Japanese version: Code932 English version: Code437
{437: Code437
850:Code850 Multilingual
860:Code860 Portugal
863:Code863 Canada-French
865:Code865 Norway
852:Code852 Eastern Europe
866:Code866 Russia
857:Code857 Turkey
932:KANA
998:A SCII
999:Windows Code 1252: Windows Code
{TRUE: POS printer cover is open. FALSE: POS printer cover is closed.
{PTR_EL_NONE PTR_EL_RECOVERABLE PTR_EL_FATAL
{PTR_S_RECEIPT
{Description on present error is retained.
{Font A, B
{
{PTR_MM_DOTS (Default value) PTR_MM_TWIPS PTR_MM_ENGLISH PTR_MM_METRIC
UPTR_RP_NORMAL (OPOS_SUCCESS) PTR_RP_RIGHT90 (OPOS_E_ ILLEGAL) PTR_RP_LEFT90: Not supported (OPOS_E_ILLEGAL) PTR_RP_ROTATE180: Supported (OPOS SUCCESS)
×Not supported
×Not supported
×Not supported
×Not supported
×Not supported
×Not supported
×Not supported
×Not supported
×Not supported
×Not supported
18
CITIZEN OPOS DRIVER 1.8 Application Development Guide
Property
RecLineChars
RecLineCharsList
RecLineHeight
RecLineSpacing
RecLineWidth
RecLetterQuality
RecEmpty
RecNearEnd
RecSidewaysMaxLines
RecSidewaysMaxChars
RecLinesToPaperCut
RecBarCodeRotationLis t
RecCartridgeState
RecCurrentCartridge
RecBitmapRotationList
SlpLineChars
SlpLineCharsList
SlpLineHeight
SlpLineSpacing
SlpLineWidth
SlpLetterQuality
SlpEmpty
SlpNearEnd
SlpSidewaysMaxLines
SlpSidewaysMaxChars
SlpMaxLines
SlpLinesNearEndToEnd
SlpBarCodeRotationList
SlpPrintSide
SlpCartridgeState
SlpCurrentCartridge
Notes
The Font size is changed depending on the set value.
Select the value from RecLineCharsList property. (Refer to RecLineChars/ RecLineCharsLis Property in 2.6 POS Printer Service Object and Precautions.)
(Refer1 to RecLineChars/ RecLineCharsLis Property in 2.6 POS Printer Service Object and Precautions.)
The value is changed according to the RecLineChars property.
Only if the value is smaller than RecLineHeight property, the value is changed in accordance with to the RecLineHeight property.
(Refer to RecEmpty Property in 2.6 POS Printer Service Object and Precautions.)
(Refer to RecSidewaysMaxLines Property in 2.6 POS Printer Service Object and Precautions.)
(Refer to RecSidewaysMaxChars Property in 2.6 POS Printer Service Object and Precautions.)
Attribu |
|
Supporting status |
|
te |
|
(CBM1000TYPEII_*) |
|
R/W |
|
{ OPOS_SUCCESS |
|
|
|
(Normal setting) |
|
|
|
OPOS_E_ILLEGAL |
|
|
|
(Illegal line character width is specified.) |
|
R{ 58 mm paper "30, 40"
"36, 48"
80 mm paper "42, 56"
"48, 64"
R/W {
R/W {
R |
{ |
|
|
R/W |
|
× |
Not supported |
R○ TRUE: Receipt paper out FALSE: With receipt paper
*Always FALSE if CapRecSensor is False.
R |
|
{ |
|
R |
{ |
|
|
|
|
|
|
R |
{ |
|
|
|
|
|
|
R |
|
{ |
|
R |
{ |
0 (Default value), 180 |
|
|
|
Not supported |
|
R |
|
× |
|
R/W |
{ |
PTR_CUSTOM_COLOR1 |
|
R |
|
{ |
0 (Default value), 180 |
R/W |
|
× |
Not supported |
R |
|
× |
Not supported |
R/W |
|
× |
Not supported |
R/W |
|
× |
Not supported |
R |
|
× |
Not supported |
R/W |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R |
|
× |
Not supported |
R/W |
|
× |
Not supported |
19