javapos driver 1 - citizen · pdf filecitizen javapos driver 1.11 setup guide 2 revision...

JavaPOS DRIVER 1.11

Setup Guide

For Ver. 1.11.3.5

CITIZEN JavaPOS DRIVER 1.11 Setup Guide

2

Revision Record

Date Version Description

2010/05/07 1.00 New issue

2010/10/08 1.01 - Add Windows7-32bit to Supported Operating systems. - Add note about Java version.

- Update as follows accompanied by memory switch change for printer setting; Add Full Col Print

Change CBM1000-compatible mode

2011/04/05 1.02 - The CT-S310II model was added to each item. - USB Interface Connection wad changed.

2011/10/31 1.11.2.6 - Version number is changed to same version as driver itself.

- Added explanation of the tested Linux OS. - Added explanation of Java Virtual Machine.

- Added explanation of USB Interface Connection of the Linux environment. - Release Notes and Library files were added to installation structure.

2012/03/26 1.11.2.7 - The CD-S500 model was added to each item.

2013/03/11 1.11.2.8 - Changed the installation files of this product. - Changed the jpos.xml setting examples.

2014/01/17 1.11.3.0 - Added Windows8/8.1 to Operating systems.

- Added CT-S281BT/BD to the supported models.

2015/02/16 1.11.3.2 - The CT-S251, CT-S601II/651II/801II/851II model was added to each item.

2015/09/30 1.11.3.3 - Added CT-S310II Ethernet to the supported models.

- Added CD-S500 USB to the supported models of Linux. - Modified the access method to USB interface of Linux, deleted explanation of USB

Connection of the Linux environment.

2016/11/28 1.11.3.4 - Added Windows10 to Operating systems. - Added CT-D150/CT-E351 to the supported models.

2017/06/13 1.11.3.5 - Added CT-D151/CT-E651 to the supported models. (Page 5,6,19,21)


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 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 are registered trademarks of Microsoft Corporation in the United States and/or other

countries. (Official name for Windows is Microsoft Windows Operating System.)

Java is registered trademarks of Sun Microsystems, Inc. in the United States and/or other countries.

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 Watch Co., Ltd.


4

Index

1. About the Product ................................................................................................................................... 5

2. Operating Environments ........................................................................................................................ 5

2.1. Operating System ................................................................................................................... 5

2.2. Java Virtual Machine ............................................................................................................... 5

2.3. Supported Models ................................................................................................................... 5

2.4. USB Interface Connection of the Windows environment ............................................................. 7

3. Installation ............................................................................................................................................... 8

3.1. Pre-Installation Instructions ..................................................................................................... 8

3.2. Installation Steps for Windows ................................................................................................. 8

3.3. Installation Steps for Linux .................................................................................................... 12

3.4. How to use the Driver for windows ......................................................................................... 14

3.5. How to use the Driver for Linux ............................................................................................. 14

3.6. Setting of JavaPOS entry ....................................................................................................... 15

4. Printer Setting ....................................................................................................................................... 17

4.1. CBM-1000II Series ................................................................................................................ 17

4.2. CT-D150 Series .................................................................................................................... 18

4.3. CT-D151 Series .................................................................................................................... 19

4.4. CT-E351 Series ..................................................................................................................... 20

4.5. CT-E651 Series ..................................................................................................................... 21

4.6. CT-S251 Series ..................................................................................................................... 22

4.7. CT-S281 Series ..................................................................................................................... 23

4.8. CT-S300 Series ..................................................................................................................... 24

4.9. CT-S310 Series ..................................................................................................................... 25

4.10. CT-S310II Series ................................................................................................................. 26

4.11. CT-S601/651/801/851 Series ............................................................................................... 27

4.12. CT-S601II/651II/801II/851II Series ...................................................................................... 28

4.13. CT-S2000 Series ................................................................................................................. 29

4.14. CT-S4000 Series ................................................................................................................. 30

4.15. CD-S500 Series .................................................................................................................. 31


5

1. About the Product

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 Java.

2. Operating Environments

2.1. Operating System

This driver supports the following operating systems.

Windows XP, Windows7, Windows8, Windows8.1, Windows10

Linux (32bit)

* Tested Linux OS: CentOS6.7, Ubuntu12.04, Ubuntu14.04

2.2. Java Virtual Machine

This driver supports the following 32bit Java Virtual Machine.

Version 5 and higher

* Tested version: Version 5 Update 22, Version 6 Update 45, Version 7 Update 72

Version 8 Update 60

2.3. Supported Models

Supported models of this product and the corresponding interface are as shown below.

For details of each model, refer to the Printer User’s Guide.

Windows environment

Series of Model Supported Model Interface Printer Functions

CBM-1000II

CBM-1000TypeII

Serial, USB

Standard

CBM-1000TypeII- L Blackmark paper and label paper are

supported.

CT-D150 CT-D150 Serial, USB, Ethernet Standard


CT-E351 CT-E351 Serial, USB, Ethernet Standard


CT-S251 CT-S251 Serial, USB, Ethernet, Bluetooth

Standard

CT-S281

CT-S281/281BT/281BD Serial, USB, Bluetooth Standard

CT-S281-XL-M1 Serial, USB

Blackmark paper is supported

CT-S281-XL Label paper is supported.

CT-S300

CT-S300

Serial, USB, Ethernet

Standard (Paper with blackmark on

front side is supported.)

CT-S300-M1/M2 Paper with blackmark on back side is supported.

CT-S310

CT-S310






6

CT-S310II CT-S310II Serial, USB, Ethernet Standard

CT-S601/651/801/

851

CT-S601/651/801/851


Standard

CT-S801/851-M Blackmark paper is supported

CT-S801-L Label paper is supported.

CT-S601II/651II/ 801II/851II

CT-S601II/651II/801II/851II Serial, USB, Ethernet,

Bluetooth

Standard

CT-S801II/851II-M Blackmark paper is supported

CT-S801II-L Label paper is supported.

CT-S2000

CT-S2000


Standard

CT-S2000-M Blackmark paper is supported


CT-S4000

CT-S4000




CT-S4000-M Paper with blackmark on back side is supported.


CD-S500

CD-S500


Standard type (Without cutting feature)

CD-S501 With cutting feature

CD-S503 Rewinder equipped (With cutting feature)

Linux environment

Series of Model Supported Model Interface Printer Functions

CBM-1000II

CBM-1000TypeII

Serial

Standard

CBM-1000TypeII- L Blackmark paper and label paper are

supported.





CT-S251 CT-S251 Serial, USB, Ethernet Standard

CT-S281

CT-S281/281BT/281BD

Serial, USB

Standard

CT-S281-XL-M1 Blackmark paper is supported

CT-S281-XL Label paper is supported.

CT-S300

CT-S300

Serial, Ethernet




CT-S310

CT-S310





CT-S310II CT-S310II Serial, USB, Ethernet Standard

CT-S601/651/801/

851

CT-S601/651/801/851


Standard

CT-S801/851-M Blackmark paper is supported


CT-S601II/651II/ 801II/851II

CT-S601II/651II/801II/851II


Standard

CT-S801II/851II-M Blackmark paper is supported

CT-S801II-L Label paper is supported.


7

CT-S2000

CT-S2000


Standard

CT-S2000-M Blackmark paper is supported


CT-S4000

CT-S4000




CT-S4000-M Paper with blackmark on back side is supported.


CD-S500

CD-S500

Serial, Ethernet

Standard type (Without cutting feature)

CD-S501 With cutting feature

CD-S503 Rewinder equipped (With cutting feature)

2.4. USB Interface Connection of the Windows environment

Installation of printer driver is required when using this product with USB connection of the Windows

environment. Perform the installation of Windows Driver. Designate USB Interface Port (Virtual Printer

Port for USB) which is designated by the Windows Driver at JavaPOS Driver side.

This driver cannot be used with the status function (language monitor) of the Windows driver that

shows the printer status. When using this driver, install the Windows driver without the status

function, or uncheck the “Enable bidirectional support” option under the Ports setting of

the Windows driver. (Need to reboot the computer in order for the changes to take effect.)


8

3. Installation

3.1. Pre-Installation Instructions

Please download the file according to your operating system from the URL below to get the latest Java

for your computer and install the Java run time environment in your system.

Note that Java version 5 or higher is required.

http://www.java.com/

Before installation, shut down all applications in operation.

The installer should be run with Administrator (Windows) or root (Linux) privileges.

3.2. Installation Steps for Windows

1) The installer for Windows is “CSJ_JPOSxxxxx_setupEN.exe” (xxxxx is version number).

To run the installer, double click on it. After starting, follow the installation procedure in accordance

with the dialog.

2) Setup wizard starts. Click [Next].

http://www.java.com/


9

3) “License Agreement” window is displayed. If you agree with the product license agreement, select

“I accept the terms in the license agreement” and click [Next]. If you do not agree with the product

license agreement, select “I do not accept the terms in the agreement” and click [Next] to exit the

wizard.

4) “Destination Folder” window is displayed. Specify the folder to install. If you use a default folder,

click [Next]. If you want to change the folder, change the folder you want to install.


10

5) Click [Install] to begin the installation.

6) The installation progress status window is displayed. (It may take longer time to install depending

on the environment or specifications of the terminal.)


11

7) When the installation is successful, “Installation Completed” window is displayed. Click [Close].

8) The following provides the description on the installation files of this product.

c:\program files\CITIZEN\CITIZEN JPOS Service Object (default)

JPOSApplication.bat : Test application execute file

JPOSConfig.bat : Configuration (JCL) execute file

jpos.xml : JavaPOS configuration file

CBMjpos.jar : CITIZEN JavaPOS driver library

JPOSApplication.jar : Test application library

jcl.jar : jpos.config/loader (JCL) library

jpos18-controls.jar : JavaPOS service object library

lib\comm.jar : Library for driver

lib\jna.jar : Library for driver

lib\xerces2.jar : Library for driver

lib\xerces-2.6.0.jar : Library for driver

lib\swing-layout-1.0.jar : Library for test application

CSJjposBcw.dll : Expansion library for driver

CSJjposCom.dll : Expansion library for driver

win32com.dll : Expansion library for driver

ReleaseNotes_EN.txt : Release Notes file

Log : Work folder for test application

Macro : Work folder for test application

Sample : Sample code folder


12

3.3. Installation Steps for Linux

1) The installer for Linux is “CSJ_JPOSxxxxx_setupEN.bin” (xxxxx is version number, self-extracting

file). Please make sure the JAVA_HOME environment property is set to the Java runtime

environment installation folder. To run the installer, open the terminal window, change to the

directory in which the installer is located, and type “./CSJ_JPOSxxxxx_setpuEN.bin” (xxxxx is

version number).

After starting, follow the installation procedure in accordance with the dialog.

2) Installer starts. Type the space key.

3) If you agree with the product license agreement, type “yes”. If you do not agree with the product

license agreement, type “no” to exit.


13

4) When the installation is successful, installed places is displayed.

5) The following provides the description on the installation files of this product.

/usr/local/CITIZEN/JPOS_Service_Object

JPOSApplication.sh : test application execute file

JPOSConfig.sh : configuration (JCL) execute file

jpos.xml : JavaPOS configuration file

CBMjpos.jar : CITIZEN JavaPOS driver library

JPOSApplication.jar : Test application library

jcl.jar : jpos.config/loader (JCL) library

jpos18-controls.jar : JavaPOS service object library

lib/LinuxCommAPI.jar : Library for driver

lib/LinuxCommLib.jar : Library for driver

lib/comm.jar : Library for driver

lib/jna.jar : Library for driver

lib/xerces2.jar : Library for driver

lib/xerces-2.6.0.jar : Library for driver

lib/swing-layout-1.0.jar : Library for test application

ReleaseNotes_EN.txt : Release Notes file

Log : work directory for test application

Macro : work directory for test application

Sample : sample code directory

$JAVA_HOME/lib/i386 (JAVA_HOME is the Java runtime environment installation folder)

libCSJjposBcw.so : Expansion library for driver

libCSJjposCom.so : Expansion library for driver

librxtxParallel.so : Expansion library for driver

librxtxSerial.so : Expansion library for driver


14

3.4. How to use the Driver for windows

Change to the Windows installation folder and double clicking the following file.

For starting the test application

JPOSApplication.bat

For starting the JPOS entry editor

JPOSConfig.bat

3.5. How to use the Driver for Linux

Open the terminal window and change to the Linux installation directory and type the following

command on the command prompt.

For starting the test application

./JPOSApplication.sh

For starting the JPOS entry editor

./JPOSConfig.sh


15

3.6. Setting of JavaPOS entry

In order for Control Object to be connected to Service Object exactly and initialize the corresponding

device, the JavaPOS control requires data of the jpos.xml file.

The following is the jpos.xml setting when it connects CT-S801 (printer) by Serial as an example. It is

necessary to revise a value of "portName", "parity ", "flowControl", "stopBits" and "baudRate".

<JposEntry logicalName="CITIZEN S801 Serial Windows"> <creation factoryClass="jpos.loader.simple.SimpleJPOSServiceInstanceFactory" serviceClass="jpos.services.Citizen801PrinterServices"/> <vendor name="CITIZEN" url="http://www.citizen-systems.co.jp"/> <jpos category="POSPrinter" version="1.11"/> <product description="Jpos printer driver" name="CITIZEN CT-S801 POS printer" url="http://www.citizen-systems.co.jp"/> <prop name="portName" type="String" value="COM1"/> <prop name="PhysicalDevice" type="String" value="CITIZEN CT-S801 POS Printer"/> <prop name="dataBits" type="String" value="8"/> <prop name="PrinterLanguage" type="String" value="8"/> <prop name="parity" type="String" value="None"/> <prop name="flowControl" type="String" value="Hardware"/> <prop name="CharacterSet" type="String" value="437"/> <prop name="Columns" type="String" value="48"/> <prop name="stopBits" type="String" value="1"/> <prop name="UseNVRAM" type="String" value="0"/> <prop name="PaperModel" type="String" value="80mm"/> <prop name="deviceBus" type="String" value="RS232"/> <prop name="baudRate" type="String" value="19200"/> <prop name="ResponseCheck" type="String" value="1"/> </JposEntry>

The following is the jpos.xml setting when it connects CT-S801 (printer) by USB as an example. It is

necessary to revise a value of "PortName".

<JposEntry logicalName="CITIZEN S801 USB Windows"> <creation factoryClass="jpos.loader.simple.SimpleJPOSServiceInstanceFactory" serviceClass="jpos.services.Citizen801PrinterServices"/> <vendor name="CITIZEN" url="http://www.citizen-systems.co.jp"/> <jpos category="POSPrinter" version="1.11"/> <product description="Jpos printer driver" name="CITIZEN CT-S801 POS printer" url="http://www.citizen-systems.co.jp"/> <prop name="PhysicalDevice" type="String" value="CITIZEN CT-S801 POS Printer"/> <prop name="PortName" type="String" value="USB001"/> <prop name="PrinterLanguage" type="String" value="8"/> <prop name="Columns" type="String" value="48"/> <prop name="CharacterSet" type="String" value="932"/> <prop name="UseNVRAM" type="String" value="0"/> <prop name="PaperModel" type="String" value="80mm"/> <prop name="deviceBus" type="String" value="USB"/> <prop name="ResponseCheck" type="String" value="1"/> </JposEntry>


16

The following is the jpos.xml setting when it connects CT-S801 (printer) by Ethernet as an example. It is

necessary to revise a value of "PortName" and "IPAddress".

<JposEntry logicalName="CITIZEN S801 Ethernet Windows"> <creation factoryClass="jpos.loader.simple.SimpleJPOSServiceInstanceFactory" serviceClass="jpos.services.Citizen801PrinterServices"/> <vendor name="CITIZEN" url="http://www.citizen-systems.co.jp"/> <jpos category="POSPrinter" version="1.11"/> <product description="Jpos printer driver" name="CITIZEN CT-S801 POS printer" url="http://www.citizen-systems.co.jp"/> <prop name="PhysicalDevice" type="String" value="CITIZEN CT-S801 POS printer"/> <prop name="PortName" type="String" value="IP_192.168.82.21"/> <prop name="PrinterLanguage" type="String" value="8"/> <prop name="PortNumber" type="String" value="9100"/> <prop name="Columns" type="String" value="48"/> <prop name="CharacterSet" type="String" value="437"/> <prop name="UseNVRAM" type="String" value="0"/> <prop name="PaperModel" type="String" value="80mm"/> <prop name="deviceBus" type="String" value="Ethernet"/> <prop name="IPAddress" type="String" value="192.168.82.21"/> <prop name="ResponseCheck" type="String" value="1"/> </JposEntry>


17

4. Printer Setting

Using this product assumes that the DIP switch and memory switch of the printer are set as shown

below. For the details of the method of operating each switch and the content of setting, refer to

User’s Guide of each model.

4.1. CBM-1000II Series

DIP Switch Setting DSW No. Function Setting Description

1-1 Auto cutter ON With auto cutter

1-5 CR mode OFF Ignored

1-6 Input buffer OFF 4KB

2-1

Select character code table.

ON

Katakana 2-2 OFF

2-3 OFF

2-4 OFF

2-5 JIS/Shift-JIS ON Shift-JIS

2-6 Condition for BUSY state ON Receiving buffer full

3-7 DSR

(when serial I/F is used) OFF DSR

3-8 INIT

(when serial I/F is used) OFF Disabled

* This model has no software switch function.


18

4.2. CT-D150 Series

Memory Switch Setting MSW No. Function Setting Description

1-1 Power ON Info OFF Enabled

1-2 Buffer Size OFF 4KB

1-3 Busy condition ON Buffer full

1-4 Receiving error OFF Character?

1-5 CR mode OFF Disabled

1-7 DSR signal


1-8 Init signal

(when serial I/F is used) OFF -

2-2 Auto cutter ON Enabled

2-4 Full Col Print ON Wait Data

3-1 Resume Cttr Err OFF L/F enabled

3-7 CBM1000 Mode ON Compatible

3-8 Resume Open Err OFF Auto restore

4-8 Partial Only OFF Disabled

5-2 Line pitch OFF 360 dots

6-1 Act. For Driver ON Valid

7-6 DMA control Enabled -

8-4 Line Gap Reduce Invalid -

8-5 Reduced Char V/H 100% / 100% -

9-1 Code page Katakana -

9-2 Int’Char Set Japan -

9-4 Multi-Byte Char SJIS(CP932) -


19

4.3. CT-D151 Series







1-7 DSR signal


1-8 Init signal












8-5 Reduced Char V/H 100% / 100% -




13-6 Auto Reconnect

(when Bluetooth I/F is used) Invalid -


20

4.4. CT-E351 Series







1-7 DSR signal


1-8 Init signal












8-5 Reduced Char V/H 100% / 100% -





21

4.5. CT-E651 Series







1-7 DSR signal


1-8 Init signal












8-5 Reduced Char V/H 100% / 100% -




13-6 Auto Reconnect



22

4.6. CT-S251 Series


1-1 Power ON notify setting OFF Enabled



1-4 Receiving error character OFF Character?


1-7 Select DSR signal


1-8 Select INIT signal


2-2 Auto cutter operation ON Enabled


3-1 Auto cutter restore OFF L/F enabled

3-7 CBM1000-compatible mode ON Compatible

3-8 Cover opened while printing OFF Auto restore

4-8 Forced partial OFF Disabled

5-2 Vertical basic calculation pitch OFF 360 dots




8-5 Reduced Char 100% / 100% -

8-6 Auto Side Shift Invalid -


9-2 Foreign language characters Japan -

9-3 Kanji Enabled -

9-4 JIS/Shift-JIS Shift-JIS -

13-6 Auto Reconnect



23

4.7. CT-S281 Series


8 INIT








1-7 DSR signal


1-8 INIT signal



2-4 Full Col Print ON WaitData


3-7 CBM270-compatible mode ON compatible


4-8 Full cut command OFF Full cut



9-3 Kanji Enabled -



24

4.8. CT-S300 Series


8 INIT








1-7 DSR signal


1-8 INIT signal





3-3 Parallel 31 Pin

(when USB I/F are used) OFF Reset





25

4.9. CT-S310 Series


8 INIT








1-7 DSR signal

(when serial interface is used) OFF DSR

1-8 INIT signal

(when serial interface is used) OFF -




3-3 Parallel 31 Pin







9-3 Kanji Enabled -



26

4.10. CT-S310II Series














3-3 Parallel 31Pin









8-5 Reduced Char 100% / 100% -



9-3 Kanji Enabled -



27

4.11. CT-S601/651/801/851 Series


8 INIT















3-3 Parallel 31Pin










9-3 Kanji Enabled -


10-3 ACK output timing

(when USB I/F are used) Before BUSY -


28

4.12. CT-S601II/651II/801II/851II Series


8 INIT















3-3 Parallel 31Pin









8-5 Reduced Char 100% / 100% -



9-4 Multi-byte Char SJIS(CP932) -



13-6 Auto Reconnect



29

4.13. CT-S2000 Series


8 INIT















3-3 Parallel 31Pin









9-3 Kanji Enabled -





30

4.14. CT-S4000 Series


8 INIT









(when serial interface is used) OFF DSR


(when serial interface is used) OFF -




3-3 Parallel 31Pin






5-5 Power OFF notify Disabled -




9-3 Kanji Enabled -





31

4.15. CD-S500 Series


8 INIT



SoftCtrl-1 Command Type EPSON -

SoftCtrl-5 Paper End

(when USB I/F are used) DIS

At paper end

Only Busy signal is output.

SoftCtrl-6 Paper Near-End

(when USB I/F are used) DIS

At paper near-end

Signal not output

SoftCtrl-8 Print Direct

(Specifies print direction) BI-DIR

Print from right or left end nearer from the print stop

position.

SoftCtrl-9 Auto LF OFF -

SoftCtrl-11 Buffer Size 4Kbyte -

SoftCtrl-12 Init Signal ENB Initialize signal enabled

Mechanical-2 Auto-Cutter FREE -

Mechanical-3 Color Ribbon ON Command switching


32


2017/06/13 For Ver. 1.11.3.5

CITIZEN SYSTEMS JAPAN CO., LTD.

http://www.citizen-systems.co.jp/

http://www.citizen-systems.co.jp/

javapos driver 1 - citizen · pdf filecitizen javapos driver 1.11 setup guide 2 revision...

Documents