Citizen CT-D101 Owner's manual

UWP POS Print SDK
Programming Manual
For Ver. 2.00

2
CITIZEN UWP POS Print SDK - Programming Manual
Revision Record
Date
Version
Description
May 22 2017
1.00
New issue.
May 8, 2019
1.01
- Added CT-S751/CT-S4500 to supported models.
- Added “3.3 About printing UTF-8 encode characters”.
Jul. 28, 2021
2.00
- Added CT-D101/CT-E301/CT-E601 and CT-D151-L/CT-E651-L to supported
models. (page 8-11)
- SDK supports USB host interface and line display or barcode scanner which is
connected to it. (page 18-19, 76-113)
- Added SetPrintCompletedTimeout method. (page 61)
- Unused constants were removed. (page 73-75)

3
CITIZEN UWP POS Print SDK - Programming Manual
Caution
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 Library.
Trademark
Microsoft, Windows, Visual Studio, Visual Basic, Visual C#, 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 Watch Co., Ltd.

4
CITIZEN UWP POS Print SDK - Programming Manual
Table of Contents
1. Introduction ........................................................................................................................................................7
1.1. Document target range..............................................................................................................................7
1.2. System summary........................................................................................................................................7
1.3. Supported printer models..........................................................................................................................7
1.4. Printer setting ............................................................................................................................................9
1.5. Supported Peripheral Devices models ....................................................................................................18
1.6. Install instruction ....................................................................................................................................20
1.7. Definition method ....................................................................................................................................22
2. Printer Control .................................................................................................................................................25
2.1. Program structure....................................................................................................................................25
2.2. Functions list............................................................................................................................................26
2.3. Library interfaces.....................................................................................................................................28
2.3.1. Return value.........................................................................................................................................28
2.3.2. Constructor...........................................................................................................................................29
2.3.3. ConnectAsync method .........................................................................................................................30
2.3.4. DisconnectAsync method .....................................................................................................................32
2.3.5. SetEncoding method ............................................................................................................................33
2.3.6. PrinterCheckAsync method ..................................................................................................................34
2.3.7. Status method ......................................................................................................................................35
2.3.8. PrintTextAsync method ........................................................................................................................37
2.3.9. PrintBitmapAsync method ....................................................................................................................38
2.3.10. PrintNVBitmapAsync method .............................................................................................................40
2.3.11. PrintBarCodeAsync method................................................................................................................41
2.3.12. PrintPDF417Async method .................................................................................................................43
2.3.13. PrintQRCodeAsync method ................................................................................................................44
2.3.14. PrintGS1DataBarStackedAsync method .............................................................................................45
2.3.15. CutPaperAsync method ......................................................................................................................46
2.3.16. UnitFeedAsync method ......................................................................................................................47
2.3.17. MarkFeedAsync method .....................................................................................................................48
2.3.18. OpenDrawerAsync method ................................................................................................................49
2.3.19. TransactionPrintAsync method ...........................................................................................................50
2.3.20. RotatePrintAsync method...................................................................................................................51
2.3.21. PageModePrintAsync method.............................................................................................................52
2.3.22. ClearPrintArea method .......................................................................................................................54
2.3.23. ClearOutputAsync method .................................................................................................................55
2.3.24. PrintDataAsync method......................................................................................................................56
2.3.25. PrintNormalAsync method..................................................................................................................57
2.3.26. GetVersionCode method.....................................................................................................................58
2.3.27. GetVersionName method....................................................................................................................59
2.3.28. WatermarkPrintAsync method............................................................................................................60
2.3.29. SetPrintCompletedTimeout method ...................................................................................................61
2.3.30. SetLog method ...................................................................................................................................62
2.3.31. PageModeArea property.....................................................................................................................63
2.3.32. PageModePrintArea property .............................................................................................................64
2.3.33. PageModePrintDirection property.......................................................................................................65
2.3.34. PageModeHorizontalPosition property................................................................................................66
2.3.35. PageModeVerticalPosition property ....................................................................................................67

5
CITIZEN UWP POS Print SDK - Programming Manual
2.3.36. RecLineSpacing property....................................................................................................................68
2.3.37. MapMode property .............................................................................................................................69
2.4. Notes .........................................................................................................................................................70
2.4.1. Function to detect the completion of printing......................................................................................70
2.4.2. Log function .........................................................................................................................................70
2.4.3. About printing UTF-8 encode characters .............................................................................................71
2.4.4. List of Constants Predefined ................................................................................................................73
3. Linedisplay Control..........................................................................................................................................76
3.1. Program structure....................................................................................................................................76
3.2. Functions list............................................................................................................................................77
3.3. Library interfaces.....................................................................................................................................78
3.3.1. Return value.........................................................................................................................................78
3.3.2. Constructor...........................................................................................................................................79
3.3.3. ConnectAsync method .........................................................................................................................80
3.3.4. DisconnectAsync method .....................................................................................................................81
3.3.5. DisplayTextAsync method ....................................................................................................................82
3.3.6. ClearDisplayAsync method ...................................................................................................................83
3.3.7. BlinkDisplayAsync method....................................................................................................................84
3.3.8. SetDisplayModeAsync method .............................................................................................................85
3.3.9. SetDisplayConfigAsync method............................................................................................................86
3.3.10. SetCursorPositionAsync method.........................................................................................................87
3.3.11. MoveCursorAsync method..................................................................................................................88
3.3.12. SetCursorTypeAsync method .............................................................................................................89
3.3.13. InitializeDisplayAsync method............................................................................................................90
3.3.14. DisplayDataAsync method..................................................................................................................91
3.3.15. SetEncoding method ..........................................................................................................................92
3.3.16. SetCodePageAsync method................................................................................................................93
3.3.17. SetInternationalCharactersetAsync method .......................................................................................94
3.3.18. DisplayCheckAsync method ...............................................................................................................95
3.3.19. GetVersionCode method.....................................................................................................................96
3.3.20. GetVersionName method ...................................................................................................................97
3.3.21. SetLog method ...................................................................................................................................98
3.4. Notes .........................................................................................................................................................99
3.4.1. Logging function ..................................................................................................................................99
3.4.2. List of Constants Predefined ..............................................................................................................100
4. Barcode Scanner Control ...............................................................................................................................101
4.1. Program structure..................................................................................................................................101
4.2. Functions list..........................................................................................................................................102
4.3. Library interfaces...................................................................................................................................103
4.3.1. Return value.......................................................................................................................................103
4.3.2. Constructor.........................................................................................................................................104
4.3.3. ConnectAsync method........................................................................................................................105
4.3.4. DisconnectAsync method ...................................................................................................................106
4.3.5. GetVersionCode method.....................................................................................................................107
4.3.6. GetVersionName method ...................................................................................................................108
4.3.7. SetLog method ...................................................................................................................................109
4.3.8. DataEvent event.................................................................................................................................110
4.3.9. StatusUpdate event............................................................................................................................ 111
4.4. Notes .......................................................................................................................................................112

6
CITIZEN UWP POS Print SDK - Programming Manual
4.4.1. Logging function ................................................................................................................................112
4.4.2. List of Constants Predefined ..............................................................................................................113

7
CITIZEN UWP POS Print SDK - Programming Manual
1. Introduction
This document is a programming manual for the CITIZEN UWP POS Print SDK.
1.1. Document target range
This document is intended for developers who integrate their UWP (Universal Windows Platform)
application programs with CITIZEN POS printers.
1.2. System summary
This SDK is referred by UWP application program to control CITIZEN POS printers.
System diagram of the SDK
SDK files
This SDK is structured by some files included in the VSIX installer package. Visual Studio will locate
these files automatically when an application is built.
Supported operating systems
This SDK supports the following Microsoft Windows operating systems.
・Windows 10 (x86 or x64. ARM is not supported).
Supported Integrated Development Environment.
This SDK supports the following Integrated Development Environment.
・Visual Studio 2015 Update 1 or later.
1.3. Supported printer models
The models supported by this SDK and the corresponding interfaces are as listed below.
Refer to the user’s manual of the printer for the detailed functions of each model.
Windows
LAN / Bluetooth
Printer
UWP Application
CITIZEN UWP POS Print SDK
Drawer
Line
Display*
Scanner*
* An I/F with USB host function is required for peripheral device control.

8
CITIZEN UWP POS Print SDK - Programming Manual
Series of Model
Object Model
Interface
Printer Functions
CT-D101 Series
CT-D101
Wired LAN
Standard
CT-D150 Series
CT-D150
Wired LAN
Standard
CT-D151 Series
CT-D151
Wired/Wireless LAN,
Bluetooth
Standard
CT-D151-L
Blackmark paper is supported
CT-E301 Series
CT-E301
Wired LAN
Standard
CT-E351 Series
CT-E351
Wired LAN
Standard
CT-E601 Series
CT-E601
Wired/Wireless LAN,
Bluetooth
Standard
CT-E651 Series
CT-E651
Wired/Wireless LAN,
Bluetooth
Standard
CT-E651-L
Blackmark paper is supported
CT-S251 Series
CT-S251
Wired/Wireless LAN,
Bluetooth
Standard
CT-S281 Series
CT-S281BT/281BD
Bluetooth
Standard
CT-S310II Series
CT-S310II
Wired LAN
Standard
CT-S601/651/801/
851 Series
CT-S601/651/801/851
Wired/Wireless LAN
Standard
CT-S801/851-M
Blackmark paper is supported.
CT-S801-L
Label paper is supported.
CT-S601II/651II/
801II/851II Series
CT-S601II/651II/801II
/851II
Wired/Wireless LAN,
Bluetooth
Standard
CT-S801II/851II-M
Blackmark paper is supported.
CT-S801II-L
Label paper is supported.
CT-S751 Series
CT-S751
Wired/Wireless LAN,
Bluetooth
Standard
CT-S2000 Series
CT-S2000
Wired LAN
Standard
CT-S2000-M
Blackmark paper is supported.
CT-S2000-L
Label paper is supported.
CT-S4000 Series
CT-S4000
Wired LAN
Standard (Paper with blackmark
on front side is supported.)
CT-S4000-M
Paper with blackmark on back
side is supported.
CT-S4000-L
Label paper is supported.
CT-S4500 Series
CT-S4500
Wired/Wireless LAN,
Bluetooth
Standard (Label/Blackmark
paper is supported.)

9
CITIZEN UWP POS Print SDK - Programming Manual
1.4. Printer setting
It is the prerequisite for the use of this SDK that the memory switch of the printer is set as listed below.
CT-D101 Series Memory Switch Setting
MSW No.
Function
Setting
1-1
Power ON Info
Valid
1-2
Buffer Size
4K bytes
1-3
Busy condition
Full
1-4
Receive Error
Print ?
1-5
CR Mode
Ignored
2-2
Auto cutter
Valid
2-4
Full Col Print
Wait Data
3-1
Resume Cttr Err
Valid
3-7
CBM1000 Mode
Valid
3-8
Resume Open Err
Close
4-8
Partial Only
Invalid
5-2
Line Pitch
1/360
6-1
Act. For Driver
Valid
9-1
Code page
Katakana (*1)
9-2
Int'Char Set
Japan (*1)
9-4
Multi-byte Char (*2)
SJIS(CP932)
GB18030
EUC Hangul
BIG5
CT-D150 Series Memory Switch Setting
MSW No.
Function
Setting
1-1
Power ON Info
Valid
1-2
Buffer Size
4K bytes
1-3
Busy condition
Full
1-4
Receive Error
Print ?
1-5
CR Mode
Ignored
2-2
Auto cutter
Valid
2-4
Full Col Print
Wait Data
3-1
Resume Cttr Err
Valid
3-7
CBM1000 Mode
Valid
3-8
Resume Open Err
Close
4-8
Partial Only
Invalid
5-2
Line Pitch
1/360
6-1
Act. For Driver
Valid
9-1
Code page
Katakana (*1)
9-2
Int'Char Set
Japan (*1)
9-4
Multi-byte Char (*2)
SJIS(CP932)
GB18030
EUC Hangul
BIG5

10
CITIZEN UWP POS Print SDK - Programming Manual
CT-D151 Series Memory Switch Setting
MSW No.
Function
Setting
1-1
Power ON Info
Valid
1-2
Buffer Size
4K bytes
1-3
Busy condition
Full
1-4
Receive Error
Print ?
1-5
CR Mode
Ignored
2-2
Auto cutter
Valid
2-4
Full Col Print
Wait Data
3-1
Resume Cttr Err
Valid
3-7
CBM1000 Mode
Valid
3-8
Resume Open Err
Close
4-8
Partial Only
Invalid
5-2
Line Pitch
1/360
6-1
Act. For Driver
Valid
9-1
Code Page
Katakana (*1)
9-2
Int'Char Set
Japan (*1)
9-4
Multi-byte Char (*2)
SJIS(CP932)
GB18030
EUC Hangul
BIG5
13-6
Auto Reconnect
(When Bluetooth I/F is used)
Invalid
CT-E301 Series Memory Switch Setting
MSW No.
Function
Setting
1-1
Power ON Info
Valid
1-2
Buffer Size
4K bytes
1-3
Busy condition
Full
1-4
Receive Error
Print ?
1-5
CR Mode
Ignored
2-2
Auto cutter
Valid
2-4
Full Col Print
Wait Data
3-1
Resume Cttr Err
Valid
3-7
CBM1000 Mode
Valid
3-8
Resume Open Err
Close
4-8
Partial Only
Invalid
5-2
Line Pitch
1/360
6-1
Act. For Driver
Valid
9-1
Code page
Katakana (*1)
9-2
Int'Char Set
Japan (*1)
9-4
Multi-byte Char (*2)
SJIS(CP932)
GB18030
EUC Hangul
BIG5

11
CITIZEN UWP POS Print SDK - Programming Manual
CT-E351 Series Memory Switch Setting
MSW No.
Function
Setting
1-1
Power ON Info
Valid
1-2
Buffer Size
4K bytes
1-3
Busy condition
Full
1-4
Receiving Error
Print ?
1-5
CR Mode
Ignored
2-2
Auto cutter
Valid
2-4
Full Col Print
Wait Data
3-1
Resume Cttr Err
Valid
3-7
CBM1000 Mode
Valid
3-8
Resume Open Err
Close
4-8
Partial Only
Invalid
5-2
Line Pitch
1/360
6-1
Act. For Driver
Valid
9-1
Code page
Katakana (*1)
9-2
Int'Char Set
Japan (*1)
9-4
Multi-byte Char (*2)
SJIS(CP932)
GB18030
EUC Hangul
BIG5
CT-E601 Series Memory Switch Setting
MSW No.
Function
Setting
1-1
Power ON Info
Valid
1-2
Buffer Size
4K bytes
1-3
Busy condition
Full
1-4
Receiving Error
Print ?
1-5
CR Mode
Ignored
2-2
Auto cutter
Valid
2-4
Full Col Print
Wait Data
3-1
Resume Cttr Err
Valid
3-7
CBM1000-compatible mode
Valid
3-8
Resume Open Err
Close
4-8
Partial Only
Invalid
5-2
Line Pitch
1/360
6-1
Act. For Driver
Valid
9-1
Code page
Katakana (*1)
9-2
Int'Char Set
Japan (*1)
9-4
Multi-byte Char (*2)
SJIS(CP932)
GB18030
EUC Hangul
BIG5-HKSCS
13-6
Auto Reconnect
(When Bluetooth I/F is used)
Invalid

12
CITIZEN UWP POS Print SDK - Programming Manual
CT-E651 Series Memory Switch Setting
MSW No.
Function
Setting
1-1
Power ON Info
Valid
1-2
Buffer Size
4K bytes
1-3
Busy condition
Full
1-4
Receiving Error
Print ?
1-5
CR Mode
Ignored
2-2
Auto cutter
Valid
2-4
Full Col Print
Wait Data
3-1
Resume Cttr Err
Valid
3-7
CBM1000 Mode
Valid
3-8
Resume Open Err
Close
4-8
Partial Only
Invalid
5-2
Line Pitch
1/360
6-1
Act. For Driver
Valid
9-1
Code Page
Katakana (*1)
9-2
Int'Char Set
Japan (*1)
9-4
Multi-byte Char (*2)
SJIS(CP932)
GB18030
EUC Hangul
BIG5
13-6
Auto Reconnect
(When Bluetooth I/F is used)
Invalid
CT-S251 Series Memory Switch Setting
MSW No.
Function
Setting
1-1
Power ON Info
Valid
1-2
Buffer Size
4K bytes
1-3
Busy condition
Full
1-4
Receiving Error
Print ?
1-5
CR Mode
Ignored
2-2
Auto cutter
Valid
2-4
Full Col Print
Wait Data
3-1
Resume Cttr Err
Valid
3-7
CBM1000-compatible mode
Valid
3-8
Resume Open Err
Close
4-8
Partial Only
Invalid
5-2
Line Pitch
1/360
6-1
Act. For Driver
Valid
9-1
Code page
Katakana (*1)
9-2
Int'Char Set
Japan (*1)
9-3
Kanji
ON (*1)
9-4
JIS/Shift-JIS
Shift-JIS (*1)
13-6
Auto Reconnect
(When Bluetooth I/F is used)
Invalid

13
CITIZEN UWP POS Print SDK - Programming Manual
CT-S281 Series Memory Switch Setting
MSW No.
Function
Setting
1-1
Power ON Info
Valid
1-2
Buffer Size
4K bytes
1-3
Busy condition
Full
1-4
Receiving Error
Print ?
1-5
CR Mode
Ignored
2-2
Auto cutter
Valid
2-4
Full Col Print
Wait Data
3-1
Resume Cttr Err
L/F enabled
3-7
CBM-270-compatible mode
Valid
3-8
Resume Open Err
Close
4-8
Partial Only
Invalid
9-1
Code page
Katakana (*1)
9-2
Int'Char Set
Japan (*1)
9-3
Kanji
ON (*1)
9-4
JIS/Shift-JIS
Shift-JIS (*1)
13-6
Auto Reconnect
(When Bluetooth I/F is used)
Invalid
CT-S310II Series Memory Switch Setting
MSW No.
Function
Setting
1-1
Power ON Info
Valid
1-2
Buffer Size
4K bytes
1-3
Busy condition
Full
1-4
Receiving Error
Print ?
1-5
CR Mode
Ignored
2-2
Auto cutter
Valid
2-4
Full Col Print
Wait Data
3-1
Resume Cttr Err
Valid
3-7
CBM1000-compatible mode
Valid
3-8
Resume Open Err
Close
4-8
Partial Only
Invalid
5-2
Line Pitch
1/360
6-1
Act. For Driver
Valid
9-1
Code page
Katakana (*1)
9-2
Int'Char Set
Japan (*1)
9-3
Kanji
ON (*1)
9-4
JIS/Shift-JIS
Shift-JIS (*1)

14
CITIZEN UWP POS Print SDK - Programming Manual
CT-S601/651/801/851 Series Memory Switch Setting
MSW No.
Function
Setting
1-1
Power ON Info
Valid
1-2
Buffer Size
4K bytes
1-3
Busy condition
Full
1-4
Receiving Error
Print ?
1-5
CR Mode
Ignored
2-2
Auto cutter
Valid
2-4
Full Col Print
Wait Data
3-1
Resume Cttr Err
Valid
3-7
CBM1000-compatible mode
Valid
3-8
Resume Open Err
Close
4-8
Partial Only
Invalid
5-2
Line Pitch
1/360
6-1
Act. For Driver
Valid
9-1
Code page
Katakana (*1)
9-2
Int'Char Set
Japan (*1)
9-3
Kanji
ON (*1)
9-4
JIS/Shift-JIS
Shift-JIS (*1)
10-3
ACK output timing
Before BUSY
CT-S601II/651II/801II/851II Series Memory Switch Setting
MSW No.
Function
Setting
1-1
Power ON Info
Valid
1-2
Buffer Size
4K bytes
1-3
Busy condition
Full
1-4
Receiving Error
Print ?
1-5
CR Mode
Ignored
2-2
Auto cutter
Valid
2-4
Full Col Print
Wait Data
3-1
Resume Cttr Err
Valid
3-7
CBM1000-compatible mode
Valid
3-8
Resume Open Err
Close
4-8
Partial Only
Invalid
5-2
Line Pitch
1/360
6-1
Act. For Driver
Valid
9-1
Code page
Katakana (*1)
9-2
Int'Char Set
Japan (*1)
9-4
Multi-byte Char (*2)
SJIS(CP932)
GB18030
EUC Hangul
BIG5
10-3
ACK Timing
Before BUSY
13-6
Auto Reconnect
(When Bluetooth I/F is used)
Invalid

15
CITIZEN UWP POS Print SDK - Programming Manual
CT-S751 Series Memory Switch Setting
MSW No.
Function
Setting
1-1
Power ON Info
Valid
1-2
Buffer Size
4K bytes
1-3
Busy condition
Full
1-4
Receiving Error
Print ?
1-5
CR Mode
Ignored
2-2
Auto cutter
Valid
2-4
Full Col Print
Wait Data
3-1
Resume Cttr Err
Valid
3-7
CBM1000-compatible mode
Valid
3-8
Resume Open Err
Close
4-8
Partial Only
Invalid
5-2
Line Pitch
1/360
6-1
Act. For Driver
Valid
9-1
Code page
Katakana (*1)
9-2
Int'Char Set
Japan (*1)
9-4
Multi-byte Char (*2)
SJIS(CP932)
GB18030
EUC Hangul
BIG5-HKSCS
13-6
Auto Reconnect
(When Bluetooth I/F is used)
Invalid
CT-S2000 Series Memory Switch Setting
MSW No.
Function
Setting
1-1
Power ON Info
Valid
1-2
Buffer Size
4K bytes
1-3
Busy condition
Full
1-4
Receiving Error
Print ?
1-5
CR Mode
Ignored
2-2
Auto cutter
Valid
2-4
Full Col Print
Wait Data
3-1
Resume Cttr Err
Valid
3-7
CBM1000-compatible mode
Valid
3-8
Resume Open Err
Close
4-8
Partial Only
Disabled
5-2
Line Pitch
1/360
9-1
Code page
Katakana (*1)
9-2
Int'Char Set
Japan (*1)
9-3
Kanji
ON (*1)
9-4
JIS/Shift-JIS
Shift-JIS (*1)
10-3
ACK Timing
Before BUSY

16
CITIZEN UWP POS Print SDK - Programming Manual
CT-S4000 Series Memory Switch Setting
MSW No.
Function
Setting
1-1
Power ON Info
Valid
1-2
Buffer Size
4K bytes
1-3
Busy condition
Full
1-4
Receiving Error
Print ?
1-5
CR Mode
Ignored
2-2
Auto cutter
Valid
2-4
Full Col Print
Wait Data
3-1
Resume Cttr Err
Valid
3-7
CBM1000-compatible mode
Valid
3-8
Resume Open Err
Close
4-8
Partial Only
Invalid
5-2
Line Pitch
1/360
9-1
Code page
Katakana (*1)
9-2
Int'Char Set
Japan (*1)
9-3
Kanji
ON (*1)
9-4
JIS/Shift-JIS
Shift-JIS (*1)
10-3
ACK Timing
Before BUSY
CT-S4500 Series Memory Switch Setting
MSW No.
Function
Setting
1-1
Power ON Info
Valid
1-2
Buffer Size
4K bytes
1-3
Busy condition
Full
1-4
Receiving Error
Print ?
1-5
CR Mode
Ignored
2-2
Auto cutter
Valid
2-4
Full Col Print
Wait Data
3-1
Resume Cttr Err
Valid
3-7
CBM1000 Mode
Valid
3-8
Resume Open Err
Close
4-8
Partial Only
Invalid
5-2
Line Pitch
1/360
6-1
Act. For Driver
Valid
9-1
Code Page
Katakana (*1)
9-2
Int'Char Set
Japan (*1)
9-4
Multi-byte Char (*2)
SJIS(CP932)
GB18030
EUC Hangul
BIG5-HKSCS
13-6
Auto Reconnect
(When Bluetooth I/F is used)
Invalid
*1 MSW No.9-1~4 in the previous tables are the settings to use Japanese. Please set up them for your
environment.
*2 CT-D101/150/151, CT-E301/351/601/651, CT-S601II/651II/801II/851II/751/4500 series can be set
up Multi-byte character as Shift_JIS, GB18030, EUC-KR or BIG5. Please select from them for your
environment.
Firmware
The firmware version of the printer must be the followings to use this SDK with CT-S601/651/801/851

17
CITIZEN UWP POS Print SDK - Programming Manual
Series.
The firmware of a printer with older than followings, it is necessary to update the firmware.
Model
Firmware Version
CT-S601
DL00-2000 or newer
CT-S651
DM00-2000 or newer
CT-S801
DH00-2000 or newer
CT-S851
DK00-2000 or newer

18
CITIZEN UWP POS Print SDK - Programming Manual
1.5. Supported Peripheral Devices models
The models of peripheral devices applicable for control with this service are as follows.
For details on the functions of each model, refer to the instruction manual of each peripheral device.
Network I/F or Bluetooth I/F with USB host function is required for peripheral device control.
[Line Display]
Applicable Display
I/F
Product Specification Overview
DSP01-LT
USB
TFT line display
DSP02-LS
USB
STN line display
[Barcode Scanner]
Applicable Display
I/F
Product Specification Overview
SCN01-Z1D
USB
1D barcode scanner
SCN02-Z2D
USB
2D barcode scanner
BC-NL3000U
USB
2D barcode scanner
Check that the scanner to be connected is set as follows. For the setting procedure, refer to the instruction
manual of the peripheral device to be used.
Item
Value
Description
Interface
USB HID Class
Communication protocol
Keyboard
US Keyboard
Keyboard language
Terminator
Enter
Data suffix
About connection to printer
For the connection to the applicable peripheral device, first turn off the printer power and then connect to
a USB port of the corresponding interface shown in the figure below. Next, turn on the printer power, wait
about 30 seconds until the applicable peripheral device becomes ready to use so as to ensure stable
operation, and then execute the control start process of the peripheral device.
The following lists prohibited actions that must not be performed with regard to a peripheral device
connection.
IF2-BT03/IF2-BT04
IF2-EFX2/IF2-WFx6
IF2-WFx5
IF1-EFX2/IF1-WFx6

19
CITIZEN UWP POS Print SDK - Programming Manual
Prohibited Actions
⚫Connecting other than a supported peripheral device (USB hub, smartphone, etc.) to a USB
port of the interface.
⚫Inserting and removing the cable connector of the peripheral device into/from a USB port of
the interface while the printer power is on.
⚫Connecting multiple peripheral devices of the same type to a USB port of the interface (e.g.
connecting two displays).
If any of the above actions is performed, it may lead to the misoperation and, in the worst case, cause a
failure of the printer or connected peripheral device.
About the Network I/F setting
When using the line display and the barcode scanner with the Network I/F, it is necessary to change the
setting related to the service. For the basic operation, refer to the instruction manual of the interface
board of the printer.
Please connect to each printer from web browser and display the following Service screen. You can set the
services provided by the printer.
Select "Enable" of "VCOM Converter" and "HID Scanner Convert" with reference to the inside of the red
frame. Then scroll to the bottom and press the "Submit" button.
Finally, press the "Save & Reboot" button on the "Maintenance" tab, select "Yes", and when the buzzer
beeps from the printer, the setting is completed
When checking "Show configuration" in the above red frame, the setting screen of "Media Converter
Configuration / VCOM Convert" is displayed, but since it already has an appropriate value for the
corresponding display, it is not changed by normal use Please do.
Each setting value holds the value even when the power is turned off. When factory default setting (Factor
Default) processing is done, set each setting value to the initial value.

20
CITIZEN UWP POS Print SDK - Programming Manual
1.6. Install instruction
1. Close Visual Studio if you are using it.
2. Open "CITIZEN_UWP_POS_SDK###.vsix" (the installer, where ### represents its version).
3. Click "Install" on the "VSIX Installer" window.
4. Click "Close"
5. Start Visual Studio and trace menu "Tools", "Extensions and Updates..." (See below),