CITIZEN SYSTEMS CATEGORY MENU

SKIP MENU
Support & Download
HOME > Support & Download > Information Systems > SDK(Software Development Kit)

START CONTENTS

Layout SDK

File Download

Using these software development kits, the function to print according to the layout data can be implemented to your application easily.
The versions for Windows(Diver base/SDK base), Android, iOS and JavaScript are available.
Since the layout data is created using dedicated tool(layout editor) that runs on Windows, Base Set for Windows is required.
"Sample code" plus "Programming manual" and "Basic set" are sufficient combination for each operating environment.
lauout1 lauout1 lauout1 lauout1
  • Base Set
  • Driver
  • Win POS Print SDK
  • Android
  • iOS
  • JavaScript
Outline Here is the Layout SDK Basic Set including the Layout Editor that creates the layout file. It works on Windows.
It includes files necessary for the development environment and execution environment of Windows Driver version and Windows POS Print SDK version.
Version 1.4.0.0
File Name Layout Utility Setup file(10.6MB) LayoutSDK_Setup_en.exe
Layout SDK User Guide(1.7MKB) LayoutSDK_UsersGuide_en.pdf
Execution Environment
  • Windows XP/Vista/7/8/10 and derived OS + .Net Framework4.0
  • CITIZEN Winodws driver
Outline Here is the documentation and sample code for programmers who create Windows printing applications using layout files.
Library files are included in the Basic Set.
Using the font / barcode on Windows, graphic printing is done through CITIZEN Windows driver.
Version 1.4.0.0
File Name Windows Layout Programing Manual(242KB) WindowsLayoutSDKviaPrinterDriver_en.pdf
Sample Code(1.47MB) Sample_WinLayoutSDKviaPrinterDriver_en.zip
Development Environment
Layout data Production
  • Windows XP/Vista/7/8/10 and derived OS + .Net Framework4.0
  • Layout Editor(Layout SDK Base set v1.4.0.0 or later)
  • CITIZEN Winodws driver(POS, Kiosk, Panel, Mobile, Barcode)
App Development
  • Windows XP/Vista/7/8/10 and derived OS + .Net Framework4.0
  • Layout Editor(LayoutSDK Base set v1.4.0.0 or later)
  • CITIZEN Winodws driver(POS, Kiosk, Panel, Mobile, Barcode)
Execution Environment
  • Windows XP/Vista/7/8/10 and derived OS + .Net Framework4.0
  • Layout Editor(LayoutSDK Base set v1.4.0.0 or later)
  • CITIZEN Winodws driver(POS, Kiosk, Panel, Mobile, Barcode)
Please use Windows POS Print SDK version when using at slow communication speed such as Bluetooth or if you want to grasp the detailed status.
Target Models The models that CITIZEN Window driver can print in graphics. (POS, Kiosk, Panel, Mobile, Barcode)
Outline Here is the documentation and sample code for programmers who create Windows printing applications using layout files.
Library files are included in the Basic Set.
Printing is done through Windows POS Print SDK using the font / barcode implemented on the printer.
Version 1.4.0.0
File Name Windows Layout Programing Manual(242KB) WindowsLayoutSDKviaPosPrintSDK_en.pdf
Sample Code(1.47MB) Sample_WinLayoutSDKviaPOSPrintSDK_en.zip
Development Environment
Layout data Production and export
  • Windows XP/Vista/7/8/10 and derived OS + .Net Framework4.0
  • Layout Editor(Layout SDK Base set v1.4.0.0 or later)
  • CITIZEN Winodws driver(POS, Kiosk, Panel, Mobile)
App Development
  • Windows XP/Vista/7/8/10 and derived OS + .Net Framework4.0
  • Layout Editor(LayoutSDK Base set v1.4.0.0 or later)
  • Windows POS Print SDK Ver1.06.4 or later (included in Layout SDK Base set)
Execution Environment
  • Windows XP/Vista/7/8/10 and derived OS + .Net Framework4.0
  • Layout Editor(Layout SDK Base set v1.4.0.0 or later)
  • Windows POS Print SDK Ver1.06.4 or later (included in Layout SDK Base set)
Target Models The models that Windows POS Print SDK supports
CT-S251 LAN/WLAN/USB/COM/Bluetooth
CT-S281 USB/COM/Bluetooth
CT-S310II LAN/USB/COM
CT-E651 LAN/WLAN/USB/COM/Bluetooth
CT-S801/851/601/651 LAN/WLAN/USB/COM/LPT
CT-S801II/851II/601II/651II LAN/WLAN/USB/COM/LPT/Bluetooth
CT-S2000 USB/COM/LPT
CT-S4000 USB/COM/LPT
CMP-20 WLAN/USB/COM/Bluetooth
CMP-30(ESC/POS) WLAN/USB/COM/Bluetooth
(For the new model not yet described here, it may be necesary to exchange the library file.)
Outline Here is the documentation and sample code for programmers who create Windows printing applications using layout files.
Library files are included in the Basic Set.
Printing is done through Android POS Print SDK using the font / barcode implemented on the printer.
Version 1.3.0.0
File Name
Android Layout SDK Programing Manual(211KB) AndroidLayoutSDK_en.pdf
Sample Code(636KB) SampleAndroid1300.zip
Development Environment
Layout data production and export
  • Windows XP/Vista/7/8/10 and derived OS + .Net Framework4.0
  • Layout Editor(Layout SDK Base set v1.4.0.0 or later)
  • CITIZEN Winodws driver(POS, Kiosk, Panel, Mobile)
App Development
  • OS that Android Studio or Eclipse support
  • Android Layout SDK (included in Sample Code file)
  • Android POS Print SDK Ver1.14 or later (included in Sample Code file)
Execution Environment
  • OS: Android 3.1(API 12) or later
  • Android Layout SDK (included in Sample Code file)
  • Android POS Print SDK Ver1.14 or later (included in Sample Code file)
Target Models The models that Android POS Print SDK supports
CT-S251 Bluetooth/LAN/WLAN
CT-S281 BD
CT-E651 Bluetooth/LAN/WLAN
CT-S801/851/601/651 LAN/WLAN/USB model
CT-S310II (USB interface only)
CT-S2000/4000 LAN/USB model
(For the new model not yet described here, it may be necesary to exchange the library file.)
Caution : Following condition is required for the use with USB.
  • Machine with Android 3.1 or later / USB host function
  • USB OTG cable (Host cable)
Outline Here is the documentation and sample code for programmers who create Windows printing applications using layout files.
Library files are included in the Basic Set.
Printing is done through iOS POS Print SDK using the font / barcode implemented on the printer.
Version 1.3.0.1
File Name iOS Layout SDK (16.1MB) iOSLayoutSDK_v1301_en.zip
This includes PrintEngine, Programing manual and Sample Code.
It covers Swift3.1, Swift3.0.1, Swift4.0 and Swift4.0.2.
Development Environment
Layout data production and export
  • Windows XP/Vista/7/8/10 and derived OS + .Net Framework4.0
  • Layout Editor(Layout SDK Base set v1.4.0.0 or later)
  • CITIZEN Winodws driver(POS, Kiosk, Panel)
App Development
  • OS : iOS8.0 - iOS11.2 (Xcode8.1 or later)
  • iOS Layout SDK (included in iOS Layout SDK file)
  • iOS POS Print SDK (included in iOS Layout SDK file)
Execution Environment OS : iOS8.0 - iOS11.2
Target Models The models that iOS POS Print SDK supports
CT-S251 Bluetooth/LAN/WLAN
CT-S281BD
CT-S310IILAN model
CT-E651 Bluetooth/LAN/WLAN
CT-S801/851/601/651 LAN/WLAN model
CT-S801II/851II/601II/651II Bluetooth/LAN/WLAN model
(For the new model not yet described here, it may be necesary to exchange the library file.)
Outline Here is the documentation and sample code for programmers who create Windows printing applications using layout files.
Library files are included in the Basic Set.
Printing is done through iOS POS Print SDK using the font / barcode implemented on the printer.
Deploy the layout data to Web server and printing is done through JavaScript POS Print SDK using the font / barcode implemented on the printer.
Version 1.3.0.0
File Name
JavaScript Layout SDK Programing Manual(313KB) JavaScriptLayoutSDK_en.pdf
Sample Code(301KB) SampleJavaScript1300.zip
Development Environment
Layout data production and export
  • Windows XP/Vista/7/8/10 and derived OS + .Net Framework4.0
  • Layout Editor(Layout SDK Base set v1.4.0.0 or later)
  • CITIZEN Winodws driver(POS, Kiosk, Panel)
App Development
  • JavaScript Layout SDK (included in Sample Code file.)
  • JavaScript POS Print SDK (included in Sample Code file)
Execution Environment
  • HTML5 browser
  • JavaScript Layout SDK (included in Sample Code file)
  • JQuery v1.14 or later (included in Sample Code file)
  • JavaScript POS Print SDK (included in Sample Code file)
Target Models W model series that JavaScript POS Print SDK supports
CT-S251W
CT-S801IIW
CT-S601IIW
(For the new model not yet described here, it may be necesary to exchange the library file.)

Introduction of Lauout Utility(SDK)

You can generate layout data on dedicated software(Layout editor) easily
and you can insert the print data to the layout data from your program easily.

lauout1 lauout2

* Suitable cases to use Layout SDK *
  • Not farmiliar with printing program
  • Eraborate design is required.
  • Multiple design receipt is required depending on the customer damand but it is hard

Example of elaborate design
printA printC
printB

*Features*
  • Parts such such text, image, 1D/2D barcode, time and line can be placed freely.
  • Seperate frame can be allocated to header/footer and each item data so that it can handle flexible length receipt easily.
  • As it is printed as full graphic data, sizes of each parts are free.
  • Any of Windows drver for our thermal printer can be used.
  • Window driver function such as cutter, cash drawer can be used as it is.
  • Layout data manager software comes together.
(Android version has functionality limination because it uses printer's internal function.)

Layout SDK system configuration

Layout SDK consist of 3 tools which handle layout files.

LE05
(Layout file and layout engine are different between Windows version and Android version)

Advantage to use Layout SDK

Without changing program, print result can look fully different by exchanging layout file.

LE06

How to handle logo, item data and total data

By seperating frame, it is possible to handle complicated transaction such as repeating item data only.

LE07

Example of program

Printing with layout data can be done from the program using only 10 methods. You do not need to know pritner command or technique for printing on Windows
(Android version work togeter with printing function SDK and implemented in the application together. Sample program for printing function with layout data is available.)

LE08

* Demo of software operation *


Please carefully read and agree the terms and conditions of the User License Agreement to use or download any of the software or documentation provided from the web site. By using or downloading the software, you are agreeing to be bound by the terms of the applicable license agreement. If you do not agree to these terms, or the terms of any other agreements contained in the Software, do not download or use the Software.