BIXOLON SLP-DL413 User manual

Linux SDK Reference Guide
Label Printer
Rev. 1.00
SLP-TX400/SLP-TX403
SLP-TX420/SLP-TX423
SLP-TX220/SLP-TX223
SLP-DX420/SLP-DX423
SLP-DX220/SLP-DX223
SLP-DL410/SLP-DL413
SRP-770II
http://www.bixolon.com

Label Printer
Rev. 1.00
- 2 -
■Table of Contents
1. About This Manual.........................................................................................................3
1-1 Supported Kernel & Platforms ....................................................................................3
1-2 Supported Interfaces ..................................................................................................3
2. Property..........................................................................................................................4
2-1 CharacterSet & International CharacterSet(LONG R/W)............................................4
2-2 State (LONG R) ..........................................................................................................6
3. Method............................................................................................................................7
3-1 ConnectToPrinter........................................................................................................7
3-2 DisconnectPrinter .......................................................................................................8
3-3 InitializePrinter............................................................................................................8
3-4 FeedOneLabel............................................................................................................9
3-5 SetSpeed..................................................................................................................10
3-6 SetDensity................................................................................................................11
3-7 SetOrientation...........................................................................................................12
3-8 SetCutter ..................................................................................................................13
3-9 SetBackFeed............................................................................................................14
3-10 SetPaper.................................................................................................................15
3-11 SetMargin................................................................................................................16
3-12 SetOffset.................................................................................................................17
3-13 PrintDeviceFont......................................................................................................18
3-14 PrintDeviceFontW...................................................................................................20
3-15 PrintVectorFont.......................................................................................................22
3-16 PrintVectorFontW....................................................................................................24
3-17 Prints ......................................................................................................................27
3-18 Print1DBarcode ......................................................................................................28
3-19 PrintMaxiCode........................................................................................................30
3-20 PrintPDF417...........................................................................................................31
3-21 PrintQRCode ..........................................................................................................33
3-22 PrintDataMatrix.......................................................................................................35
3-23 PrintAztec ...............................................................................................................36
3-24 PrintCode49............................................................................................................38
3-25 PrintCODABLOCK..................................................................................................40
3-26 PrintMicroPDF ........................................................................................................42
3-27 PrintGS1DataBar....................................................................................................44
3-28 PrintBlock ...............................................................................................................46
3-29 PrintCircle...............................................................................................................48
3-30 PrintImage ..............................................................................................................49
3-31 DirectIO ..................................................................................................................50
3-32 CalibrateMedia........................................................................................................51
3-33 ResetPrinter............................................................................................................52
3-34 ClearBuffer..............................................................................................................53

Label Printer
Rev. 1.00
- 3 -
1. About This Manual
This SDK manual describes the contents of the library required to develop Linux OS
application programs.
At BIXOLON, we are constantly making improvements to the functions and quality of our
products. The specifications and contents of this manual are subject to change without
prior notice for this reason.
1-1 Supported Kernel & Platforms
* Supported Kernel Versions
- Kernel 2.6.32 or higher
* Supported Platforms
- Linux 32bit
- Linux 64bit
- Raspberry PI
1-2 Supported Interfaces
- USB, Serial, Parallel, Bluetooth, Ethernet, WLAN

Label Printer
Rev. 1.00
- 4 -
2. Property
The constants used by the library are declared in BxlLabelConst.h. The development
environment is based on C.
2-1 CharacterSet & International CharacterSet(LONG R/W)
This is the property for defining the printer's code page and International character Set and
set to CS_CP437 and ICS_USA by default. The values can be set using SetCharacterSet().
The following code pages can be used:
Constant
Value
Description
CS_CP437
0
U.S.A
CS_CP850
1
Latin 1
CS_CP852
2
Latin 2
CS_CP860
3
Portuguese
CS_CP863
4
Canadian French
CS_CP865
5
Nordic
CS_WPC1252
6
Latin I
CS_CP865_WCP1252
7
European Combined
CS_CP857
8
Turkish
CS_CP737
9
Greek
CS_WCP1250
10
Latin 2
CS_WCP1253
11
Greek
CS_WCP1254
12
Turkish
CS_CP855
13
Cyrillic
CS_CP862
14
Hebrew
CS_CP866
15
Cyrillic
CS_WCP1251
16
Cyrillic
CS_WCP1255
17
Hebrew
CS_CP928
18
Greek
CS_CP864
19
Arabic
CS_CP775
20
Baltic
CS_WCP1257
21
Baltic
CS_CP858
22
Latin 1 + Euro

Label Printer
Rev. 1.00
- 5 -
The following International character Set can be used:
Constant
Value
Description
ICS_USA
0
USA code
ICS_FRANCE
1
FRANCE code
ICS_GERMANY
2
GERMANY code
ICS_UK
3
UK code
ICS_DENMARK_I
4
DENMARK1 code
ICS_SWEDEN
5
SWEDEN code
ICS_ITALY
6
ITALY code
ICS_SPAIN_I
7
SPAIN code
ICS_NORWAY
8
NORWAY code
ICS_DENMARK_II
9
DENMARK 2 code
ICS_JAPAN
10
JAPAN code
ICS_SPAIN_II
11
SPAIN 2 code
ICS_LATIN
12
LATIN code
ICS_KOREA
13
KOREA code
ICS_SLOVENIA
14
SLOVENIA code
ICS_CHINA
15
CHINA code
* Example
int ret;
ret = ConnectPrinter (“portinfo…”);
……
SetCharacterSet(CS_PC850, ICS_UK);
…...

Label Printer
Rev. 1.00
- 6 -
2-2 State (LONG R)
This is the property that sets the printer status and calls the CheckPrinterStatus function to
check the printer status and receive the data. The status value can be set in duplicate and
each value can be checked using bitwise operation.
These are the printer status values:
Constant
Value
Description
STS_NORMAL
0
Printer ready
STS_RIBONEND
4
Ribbon end error
STS_GAPERROR
8
Unable to recognize gap(auto sensing failure)
STS_TPHOVERHEAT
16
TPH overheat
STS_CUTTERJAM
32
Cutter jammed
STS_COVEROPEN
64
Cover open
STS_PAPEREMPTY
128
No paper
* Example
int ret;
ret = ConnectToPrinter (“portinfo…”);
……
int state;
state = CheckPrinterStatus();
if ((state & STS_RIBONEND) == STS_RIBONEND)
……
if ((state & STS_GAPERROR) == STS_GAPERROR)
……
…….

Label Printer
Rev. 1.00
- 7 -
3. Method
The functions provided by Linux SDK are declared in BxlLabelAPI.h.
The development environment is based on C.
3-1 ConnectToPrinter
Set the connection for communication with the printer.
int ConnectToPrinter(const char *port)
[Parameters]
* const char *port
[in] Interface to be connected to the printer
Interface
Input Data
Example
USB
USB:
ConnectToPrinter(“USB:”)
Serial
serial:(baudrate)
/dev/ttyX:(baudrate)
ConnectToPrinter(“serial:115200”)
ConnectToPrinter(“/dev/tty0:115200”)
Parallel
parallel
/dev/lpX
ConnectToPrinter(“parallel”)
ConnectToPrinter(“/dev/lp0”)
Bluetooth
Device MAC address
ConnectToPrinter(“7d:f0:7d:e4:e0:78”)
Ethernet, Wifi
IP address, port no.
ConnectToPrinter(“192.168.0.10:9100”)
[Return Values]
Constant
Value
Description
SUCCESS
0
The operation is successful.
PORT_OPEN_ERROR
-99
The communication port cannot be opened.
NO_CONNECTED_PRINTER
-100
The printer is not connected.
NO_BIXOLON_PRINTER
-101
It is not a BIXOLON printer.
* Example
int ret;
// USB
ret = ConnectToPrinter(“USB:”);
// Serial
ret = ConnectToPrinter(“serial:115200”);
// Parallel
ret = ConnectToPrinter(“parallel”);
// bluetooth
ret = ConnectToPrinter(“7d:f0:7d:e4:e0:78”);
// Ethernet or WiFi
ret = ConnectToPrinter(“192.168.0.10:9100”);
……

Label Printer
Rev. 1.00
- 8 -
3-2 DisconnectPrinter
Disconnect the printer.
int DisconnectPrinter()
[Parameters]
None
[Return Values]
None
* Example
ConnectToPrinter(“portinfo…”);
……
DisconnectPrinter();
3-3 InitializePrinter
Initialize the printer.
int InitializePrinter();
[Parameters]
None
[Return Values]
Constant
Value
Description
SUCCESS
0
The function is successful.
WRITE_ERROR
-105
Data transmission failed.
* Example
int ret;
ret = ConnectToPrinter(“portinfo…”);
……
InitializePrinter();
……

Label Printer
Rev. 1.00
- 9 -
3-4 FeedOneLabel
Feed a label.
int FeedOneLabel ()
[Parameters]
None
[Return Values]
Constant
Value
Description
SUCCESS
0
The function is successful.
WRITE_ERROR
-105
Data transmission failed.
* Example
int ret;
ret = ConnectToPrinter(“portinfo…”);
……
ret = FeedOneLabel();
……

Label Printer
Rev. 1.00
- 10 -
3-5 SetSpeed
Set the speed.
int SetSpeed(int speed)
[Parameters]
* int speed
[in] Printing speed
Constant
Value
Description
SPEED_25
0
2.5 ips
SPEED_30
1
3.0 ips
SPEED_40
2
4.0 ips
SPEED_50
3
5.0 ips
SPEED_60
4
6.0 ips
SPEED_70
5
7.0 ips
SPEED_80
6
8.0 ips
[Return Values]
Constant
Value
Description
SUCCESS
0
The function is successful.
WRITE_ERROR
-105
Data transmission failed.
* Example
int ret;
ret = ConnectToPrinter(“portinfo…”);
……
SetSpeed(SPEED_60);
……

Label Printer
Rev. 1.00
- 11 -
3-6 SetDensity
Set the density.
int SetDensity(int density)
[Parameters]
* int density
[in] Printing density (0 ~ 20)
[Return Values]
Constant
Value
Description
SUCCESS
0
The function is successful.
WRITE_ERROR
-105
Data transmission failed.
* Example
int ret;
ret = ConnectToPrinter(“portinfo…”);
……
SetDensity(20);
……

Label Printer
Rev. 1.00
- 12 -
3-7 SetOrientation
Set the orientation.
int SetOrientation(int orientation)
[Parameters]
* int orientation
[in] Printing orientation
Constant
Value
Description
TOP_TO_BOTTOM
84
Print from top to bottom.
BOTTOM_TO_TOP
66
Print from bottom to top.
[Return Values]
Constant
Value
Description
SUCCESS
0
The function is successful.
WRITE_ERROR
-105
Data transmission failed.
* Example
int ret;
ret = ConnectToPrinter(“portinfo…”);
……
SetOrientation(TOP_TO_BOTTOM);
……

Label Printer
Rev. 1.00
- 13 -
3-8 SetCutter
Set the cutting options.
int SetCutter(bool autoCut, int cutPeriod)
[Parameters]
* bool autoCut
[in] Enable/disable auto cutting. false: disable auto cutting, true: enable auto cutting
* int cuttingPeriod
[in] Cut interval
[Return Values]
Constant
Value
Description
SUCCESS
0
The function is successful.
WRITE_ERROR
-105
Data transmission failed.
* Example
int ret;
ret = ConnectToPrinter(“portinfo…”);
……
SetCutter(false, 0);
……

Label Printer
Rev. 1.00
- 14 -
3-9 SetBackFeed
Set the back-feeding options.
int SetBackFeed(bool backFeed)
[Parameters]
* bool backFeed
[in] Enable/disable back-feed. false: disable back-feed, true: enable back-feed
[Return Values]
Constant
Value
Description
SUCCESS
0
The function is successful.
WRITE_ERROR
-300
Data transmission failed.
* Example
int ret;
ret = ConnectToPrinter(“portinfo…”);
……
SetBackFeed(false);
……

Label Printer
Rev. 1.00
- 15 -
3-10 SetPaper
Set the paper options.
int SetPaper(int width, int height, int mediaType, int offset, int gapLength);
[Parameters]
* int width
[in] Paper width. max. 832(4.1 inch) [dot]
* int height
[in] Paper height. max. 2432(12 inch) [dot]
* int mediaType
[in] Paper type
Constant
Value
Description
MEDIA_GAP
0
Gap
MEDIA_CONTINUOUS
1
Continuous
MEDIA_BLACKMARK
2
Black Mark
* int offset
[in] Gap or Blackmark offset
* int gapLength
[in] Gap length or Blackmark depth [dot]
[Return Values]
Constant
Value
Description
SUCCESS
0
The function is successful.
WRITE_ERROR
-105
Data transmission failed.
* Example
int ret;
ret = ConnectToPrinter(“portinfo…”);
……
SetPaper(832, 1261, MEDIA_GAP, 0, 20);
……

Label Printer
Rev. 1.00
- 16 -
3-11 SetMargin
Set the paper margins.
int SetMargin(int horizontalMargin, int verticalMargin)
[Parameters]
* int horizontalMargin
[in] Horizontal margin [dot]
* int verticalMargin
[in] Vertical margin [dot]
[Return Values]
Constant
Value
Description
SUCCESS
0
The function is successful.
WRITE_ERROR
-105
Data transmission failed.
* Example
int ret;
ret = ConnectToPrinter(“portinfo…”);
……
SetMargin(10, 10);
……

Label Printer
Rev. 1.00
- 17 -
3-12 SetOffset
Set the offset between Black Mark/Gap and cutting line.
int SetOffset(int offset)
[Parameters]
* int offset
[in] Offset length [dot] (-100 ~ 100)
[Return Values]
Constant
Value
Description
SUCCESS
0
The function is successful.
WRITE_ERROR
-105
Data transmission failed.
* Example
int ret;
ret = ConnectToPrinter(“portinfo…”);
……
SetOffset(10);
……

Label Printer
Rev. 1.00
- 18 -
3-13 PrintDeviceFont
Print the device font.
int PrintDeviceFont(const char *text, const int xPos, const int yPos, const int fontName,
const int xMulti, const int yMulti, const int rotation, const bool bold);
[Parameters]
* const char *text
[in] Character strings to print
* const int xPos
[in] Horizontal position (X) [dot]
* const int yPos
[in] Vertical position (Y) [dot]
* const int fontName
[in] Font name
Barcode
Value
Description
DEVICE_ENG_9X15
0
Size 6 (9 X 15)
DEVICE_ENG_12X20
1
Size 8 (12 X 20)
DEVICE_ENG_16X25
2
Size 10 (16 X 25)
DEVICE_ENG_19X30
3
Size 12 (19 X 30)
DEVICE_ENG_24X38
4
Size 15 (24 X 38)
DEVICE_ENG_32X50
5
Size 20 (32 X 50)
DEVICE_ENG_48X76
6
Size 30 (48 X 76)
DEVICE_ENG_22X34
7
Size 14 (22 X 34)
DEVICE_ENG_28X44
8
Size 18 (28 X 44)
DEVICE_ENG_37X58
9
Size 24 (37 X 58)
DEVICE_KOR_16X16
0x61
Size 1 (16 X 16)
DEVICE_KOR_24X24
0x62
Size 2 (24 X 24)
DEVICE_KOR_20X20
0x63
Size 3 (20 X 20)
DEVICE_KOR_26X26
0x64
Size 4 (26 X 26)
DEVICE_KOR_20X26
0x65
Size 5 (20 X 26)
DEVICE_KOR_38X38
0x66
Size 6 (38 X 38)
DEVICE_CHN_GB2312
0x6D
GB2312 (24 X 24)
DEVICE_CHN_BIG5
0x6E
BIG5 (24 X 24)
* const int xMulti
[in] Horizontal zoom in (1 ~ 4)
* const int yMulti
[in] Vertical zoom in (1 ~ 4)

Label Printer
Rev. 1.00
- 19 -
* const int rotation
[in] Rotation value
Constant
Value
Description
ROTATE_0
0
Rotate by 0 degree
ROTATE_90
1
Rotate by 90 degrees
ROTATE_180
2
Rotate by 180 degrees
ROTATE_270
3
Rotate by 270 degrees
* bool bold
[in] Bold. false: disable, true: enable
[Return Values]
Constant
Value
Description
BXL_SUCCESS
0
The function is successful.
BXL_NOT_OPENED
-101
ConnectPrinter must be executed.
BXL_WRITE_ERROR
-105
Data transmission failed.
* Example
int ret;
ret = ConnectToPrinter(“portinfo…”);
……
PrintDeviceFont(“BIXOLON LABEL SDK TEST.”, 20, 10, DEVICE_ENG_24X38,
1, 1, ROTATE_0, false);
Prints(1, 1);
……

Label Printer
Rev. 1.00
- 20 -
3-14 PrintDeviceFontW
Print the device font.
int PrintDeviceFontW(const char *text, const int xPos, const int yPos, const int fontName,
const int xMulti, const int yMulti, const int rotation, const bool bold,
const unsigned codePage);
[Parameters]
* const char *text
[in] Character strings to print
* const int xPos
[in] Horizontal position (X) [dot]
* const int yPos
[in] Vertical position (Y) [dot]
* const int fontName
[in] Font name
Barcode
Value
Description
DEVICE_ENG_9X15
0
Size 6 (9 X 15)
DEVICE_ENG_12X20
1
Size 8 (12 X 20)
DEVICE_ENG_16X25
2
Size 10 (16 X 25)
DEVICE_ENG_19X30
3
Size 12 (19 X 30)
DEVICE_ENG_24X38
4
Size 15 (24 X 38)
DEVICE_ENG_32X50
5
Size 20 (32 X 50)
DEVICE_ENG_48X76
6
Size 30 (48 X 76)
DEVICE_ENG_22X34
7
Size 14 (22 X 34)
DEVICE_ENG_28X44
8
Size 18 (28 X 44)
DEVICE_ENG_37X58
9
Size 24 (37 X 58)
DEVICE_KOR_16X16
0x61
Size 1 (16 X 16)
DEVICE_KOR_24X24
0x62
Size 2 (24 X 24)
DEVICE_KOR_20X20
0x63
Size 3 (20 X 20)
DEVICE_KOR_26X26
0x64
Size 4 (26 X 26)
DEVICE_KOR_20X26
0x65
Size 5 (20 X 26)
DEVICE_KOR_38X38
0x66
Size 6 (38 X 38)
DEVICE_CHN_GB2312
0x6D
GB2312 (24 X 24)
DEVICE_CHN_BIG5
0x6E
BIG5 (24 X 24)
* const int xMulti
[in] Horizontal zoom in (1 ~ 4)
* const int yMulti
[in] Vertical zoom in (1 ~ 4)