BIXOLON SRP-F310 User manual

iOS SDK API Reference Guide
POS Printer
Rev. 2.00
SRP-F310 / SRP-F312
SRP-350plus / SRP-352plus
SRP-350plusII / SRP-352plusII
SRP-350II / SRP-350IIOBE
SRP-350III / SRP-352III
SRP-275 / SRP-275II
http://www.bixolon.com

POS Printer
Rev. 2.00
- 2 -
■Table of Contents
1. Manual Information...................................................................................................................................... 4
1-1 Supported Platform & Development Environment................................................................................... 4
1-2 Supported Platform & Supported Devices............................................................................................... 4
1-3 Supported Properties List ........................................................................................................................ 4
1-4 Supported Properties List ........................................................................................................................ 5
2. Constant Definition...................................................................................................................................... 6
2-1 Character Set........................................................................................................................................... 6
2-2 International Character Set...................................................................................................................... 7
2-3 Barcode/Image/Text Alignment................................................................................................................ 7
2-4 Text Size................................................................................................................................................... 7
2-5 Text Attribute ............................................................................................................................................ 8
2-6 Bar Code Text Position ............................................................................................................................ 8
2-7 Bar Code Symbology............................................................................................................................... 9
2-8 Image Width............................................................................................................................................. 9
2-9 Power..................................................................................................................................................... 10
2-10 State..................................................................................................................................................... 10
2-11 Connection Control .............................................................................................................................. 10
2-12 Drawer kick-out connector pin ..............................................................................................................11
2-13 Drawer open level.................................................................................................................................11
2-14 Model ID................................................................................................................................................11
2-15 Connection Class..................................................................................................................................11
2-16 Result Code......................................................................................................................................... 12
3. BXBarcode Class Reference .................................................................................................................... 14
3-1 Overview................................................................................................................................................ 14
3-2 Properties............................................................................................................................................... 14
3-2-1 barNumber............................................................................................................................... 14
3-2-2 name........................................................................................................................................ 14
3-2-3 support..................................................................................................................................... 14
4. BXPrinter Class Reference....................................................................................................................... 15
4-1 Overview................................................................................................................................................ 15
4-2 Properties............................................................................................................................................... 15
4-2-1 name........................................................................................................................................ 15
4-2-2 address.................................................................................................................................... 15
4-2-3 port........................................................................................................................................... 15
4-2-4 modelStr................................................................................................................................... 16
4-2-5 versionStr................................................................................................................................. 16
4-2-6 connectionClass ...................................................................................................................... 16
5. BXPrinterController Class Reference...................................................................................................... 17
5-1 Overview................................................................................................................................................ 17
5-2 Properties............................................................................................................................................... 17
5-2-1 version ..................................................................................................................................... 17
5-2-2 delegate................................................................................................................................... 17
5-2-3 target........................................................................................................................................ 17
5-2-4 lookupDuration......................................................................................................................... 18
5-2-5 lookupCount............................................................................................................................. 18
5-2-6 alignment ................................................................................................................................. 18
5-2-7 attribute.................................................................................................................................... 18
5-2-8 textSize.................................................................................................................................... 19
5-2-9 characterSet............................................................................................................................. 19
5-2-10 internationalCharacterSet...................................................................................................... 19
5-2-11 textEncoding .......................................................................................................................... 19
5-2-12 state....................................................................................................................................... 20
5-2-13 power..................................................................................................................................... 20
5-2-14 AutoConnection ..................................................................................................................... 20
5-2-15 drawerPin............................................................................................................................... 20
5-2-16 drawerOpenLevel .................................................................................................................. 21

POS Printer
Rev. 2.00
- 3 -
5-3 Instance Methods................................................................................................................................... 21
5-3-1 getInstance .............................................................................................................................. 21
5-3-2 open......................................................................................................................................... 21
5-3-3 close......................................................................................................................................... 22
5-3-4 lookup ...................................................................................................................................... 22
5-3-5 selectTarget.............................................................................................................................. 22
5-3-6 connect .................................................................................................................................... 23
5-3-7 disconnect................................................................................................................................ 23
5-3-8 enableLSB ............................................................................................................................... 23
5-3-9 printText ................................................................................................................................... 24
5-3-10 printBox.................................................................................................................................. 24
5-3-11 lineFeed ................................................................................................................................. 25
5-3-12 nextPrintPos .......................................................................................................................... 25
5-3-13 printBarcode .......................................................................................................................... 26
5-3-14 printBitmap............................................................................................................................. 27
5-3-15 checkPrinter........................................................................................................................... 27
5-3-16 msrReadReady...................................................................................................................... 28
5-3-17 msrReadCancel..................................................................................................................... 28
5-3-18 msrReadTrack ....................................................................................................................... 28
5-3-19 msrGetTrack .......................................................................................................................... 29
5-3-20 msrReadFullTrack.................................................................................................................. 29
5-3-21 directIO .................................................................................................................................. 30
5-3-22 icON....................................................................................................................................... 30
5-3-23 icOFF..................................................................................................................................... 30
5-3-24 icApdu.................................................................................................................................... 31
5-3-25 icGetStatus............................................................................................................................. 31
5-3-26 nvImageList............................................................................................................................ 32
5-3-27 downloadNVImage (Diffusion)............................................................................................... 33
5-3-28 downloadNVImage (Normal) ................................................................................................. 34
5-3-29 printNVImage......................................................................................................................... 34
5-3-30 removeNVImage.................................................................................................................... 35
5-3-31 removeAllNVImages.............................................................................................................. 35
5-3-32 openDrawer ........................................................................................................................... 35
5-3-33 isSupport_MSR...................................................................................................................... 36
5-3-34 isSupport_IC.......................................................................................................................... 36
5-3-35 isSupport_Config ................................................................................................................... 36
5-3-36 isSupport_CashDrawer.......................................................................................................... 36
5-3-37 isSupport_LSB....................................................................................................................... 37
5-3-38 getBarcodeSupportTable....................................................................................................... 37
6. BXPrinterControllerDelegate Protocol Reference.................................................................................. 38
6-1 Overview................................................................................................................................................ 38
6-2 Instance Methods................................................................................................................................... 38
6-2-1 didStart..................................................................................................................................... 38
6-2-2 didStop..................................................................................................................................... 38
6-2-3 didFindPrinter .......................................................................................................................... 39
6-2-4 didConnect............................................................................................................................... 39
6-2-5 didNotConnect......................................................................................................................... 39
6-2-6 willLookupPrinters.................................................................................................................... 40
6-2-7 didLookupPrinters.................................................................................................................... 40
6-2-8 didNotLookup........................................................................................................................... 40
6-2-9 didBeBrokenConnection.......................................................................................................... 41
6-2-10 msrArrived.............................................................................................................................. 41
6-2-11 didUpdateStatus..................................................................................................................... 42

POS Printer
Rev. 2.00
- 4 -
1. Manual Information
This SDK manual contains the descriptions of the Library required for the applications
program development.
BIXOLON makes continuous improvements for better functions and quality of its products,
and the specifications of the product and contents of the manual are subject to change
without prior notice because of this reason.
1-1 Supported Platform & Development Environment
- Platform
• iOS 4.3 or higher
- Development environment
• XCode 3.2.6 or higher
1-2 Supported Platform & Supported Devices
Compatibilities of the following list of devices were verified.
Besides the devices in the list, it is compatible with iPod touch second generation or later
version.
• iPhone 3GS / 4G / 5G
• iPad / iPad2 / iPad mini
1-3 Supported Properties List
Method/Property
POS Printer
Version
O
delegate
O
Target
O
lookupDuration
O
lookupCount
O
alignment
O
attribute
O
textSize
O
characterSet
O
internationalCharacterSet
O
State
O
Power
O
AutoConnection
O
drawerPin
O
drawerOpenLevel
O

POS Printer
Rev. 2.00
- 5 -
1-4 Supported Properties List
Method/Property
POS Printer
getInstance
O
open
O
close
O
lookup
O
selectTarget
O
connect
O
disconnect
O
enableLSB
O
printText
O
printBox
O
lineFeed
O
nextPrintPos
O
printBarcode
O
printBitmap
O
checkPrinter
O
msrReadReady
X
msrReadCancel
X
msrReadTrack
X
msrGetTrack
X
msrReadFullTrack
X
directIO
O
icON
X
icOFF
X
icApdu
X
icGetStatus
X
nvImageList
O
downloadNVImage
(Diffusion)
O
downloadNVImage
(Normal)
O
printNVImage
O
removeNVImage
O
removeAllNVImages
O
openDrawer
O
isSupport_MSR
O
isSupport_IC
O
isSupport_Config
O
isSupport_CashDrawer
O
isSupport_LSB
O
getBarcodeSupportTable
O

POS Printer
Rev. 2.00
- 6 -
2. Constant Definition
Constants used in the provided SDK are defined in the “BXCode.h” file.
2-1 Character Set
This defines the code page and the default value is set to BXL_CS_437.
Available Code Pages are as follows.
Code
Value
Description
BXL_CS_PC437
0
Code page PC437
BXL_CS_Katakana
1
Katakana
BXL_CS_PC850
2
Code page PC850
BXL_CS_PC860
3
Code page PC860
BXL_CS_PC863
4
Code page PC863
BXL_CS_PC865
5
Code page PC860
BXL_CS_WPC1252
16
Code page WPC1252
BXL_CS_PC866
17
Code page PC860
BXL_CS_PC852
18
Code page PC852
BXL_CS_PC858
19
Code page PC858
BXL_CS_PC864
22
Code page PC864
BXL_CS_THAI42
23
Code page THAI42
BXL_CS_WPC1253
24
Code page WPC1253
BXL_CS_WPC1254
25
Code page WPC1254
BXL_CS_WPC1257
26
Code page WPC1257
BXL_CS_FARSI
27
Code page FARSI
BXL_CS_WPC1251
28
Code page WPC1251
BXL_CS_PC737
29
Code page PC737
BXL_CS_PC775
30
Code page PC775
BXL_CS_THAI14
31
Code page THAI14
BXL_CS_PC862
33
Code page PC862
BXL_CS_PC855
36
Code page PC855
BXL_CS_PC857
37
Code page PC857
BXL_CS_PC928
38
Code page PC928
BXL_CS_THAI16
39
Code page THAI16
BXL_CS_WPC1256
40
Code page WPC1256
BXL_CS_USER
255
User set page

POS Printer
Rev. 2.00
- 7 -
2-2 International Character Set
This defines the international character set and the default value is set to BXL_ICS_USA.
Available International Character Sets are as follows.
Code
Value
Description
BXL_ICS_USA
0
U.S.A.
BXL_ICS_FRANCE
1
France
BXL_ICS_GERMANY
2
Germany
BXL_ICS_UK
3
U.K.
BXL_ICS_DENMARK1
4
Denmark I
BXL_ICS_SWEDEN
5
Sweden
BXL_ICS_ITALY
6
Italy
BXL_ICS_SPAIN
7
Spain
BXL_ICS_NORWAY
9
Norway
BXL_ICS_DENMARK2
10
Denmark II
2-3 Barcode/Image/Text Alignment
This defines the bar code/image/text alignment and the value is set to BXL_ALIGNMENT
_LEFT.
Available settings are as follows.
Code
Value
Description
BXL_ALIGNMENT_LEFT
0
Left align
BXL_ALIGNMENT_CENTER
1
Center align
BXL_ALIGNMENT_RIGHT
2
Right align
2-4 Text Size
This defines the settings for the text size, and horizontal and vertical ratio can be defined
simultaneously with OR operation.
Available settings are as follows.
Code
Value
Description
BXL_TS_0WIDTH
0
Set the ratio of horizontal width to X1
BXL_TS_1WIDTH
16
Set the ratio of horizontal width to X2
BXL_TS_2WIDTH
32
Set the ratio of horizontal width to X3
BXL_TS_3WIDTH
48
Set the ratio of horizontal width to X4
BXL_TS_4WIDTH
64
Set the ratio of horizontal width to X5
BXL_TS_5WIDTH
80
Set the ratio of horizontal width to X6
BXL_TS_6WIDTH
96
Set the ratio of horizontal width to X7
BXL_TS_7WIDTH
112
Set the ratio of horizontal width to X8

POS Printer
Rev. 2.00
- 8 -
Code
Value
Description
BXL_TS_0HEIGHT
0
Set the ratio of vertical height to X1
BXL_TS_1HEIGHT
16
Set the ratio of vertical height to X2
BXL_TS_2HEIGHT
32
Set the ratio of vertical height to X3
BXL_TS_3HEIGHT
48
Set the ratio of vertical height to X4
BXL_TS_4HEIGHT
64
Set the ratio of vertical height to X5
BXL_TS_5HEIGHT
80
Set the ratio of vertical height to X6
BXL_TS_6HEIGHT
96
Set the ratio of vertical height to X7
BXL_TS_7HEIGHT
112
Set the ratio of vertical height to X8
2-5 Text Attribute
This is a text property and each property can be combined with OR operation.
Available settings are as follows.
Code
Value
Description
BXL_FT_DEFAULT
0
Default setting
NOT BOLD, FONTA, NOT UNDERLINE,
NOT REVERSE
BXL_FT_FONTB
1
Use FONTB
BXL_FT_FONTC
16
Use FONTC
BXL_FT_BOLD
2
Use Bold font
BXL_FT_UNDERLINE
4
Set Underline property
BXL_FT_REVERSE
8
Set Reverse property
BXL_ExFT_CHINA_FONTB
32
2-6 Bar Code Text Position
This is for setting the position where bar code data is printed.
Available settings are as follows.
Code
Value
Description
BXL_BC_TEXT_NONE
0
Do not print bar code data
BXL_BC_TEXT_ABOVE
1
Print bar code data above bar code
BXL_BC_TEXT_BELOW
2
Print bar code data below bar code

POS Printer
Rev. 2.00
- 9 -
2-7 Bar Code Symbology
This defines the bar code type.
Available settings are as follows.
Code
Value
Number of data
Range of data
BXL_BCS_UPCA
101
11 <= n <= 12
48 <= data <= 57
BXL_BCS_UPCE
102
11 <= n <= 12
48 <= data <= 57
BXL_BCS_EAN13
103
12 <= n <= 13
48 <= data <= 47
BXL_BCS_JAN13
104
7 <= n <= 8
48 <= data <= 57
64 <= data <= 90
data = 32,36,37,43,45,46,47
BXL_BCS_EAN8
105
7 <= n <= 8
48 <= data <= 57
BXL_BCS_JAN8
106
7 <= n <= 8
48 <= data <= 57
BXL_BCS_Code39
107
1 <= n <= 255
48 <= data <= 57
65 <= data <= 68
data = 32,36,37,43,45,46,47
BXL_BCS_ITF
108
1 <= n <= 255
(Even)
48 <= data <= 57
BXL_BCS_Codabar
109
1 <= n <= 255
48 <= data <= 57
65 <= data <= 68
data = 36,43,45,46,47,58
BXL_BCS_Code93
110
1 <= n <= 255
0 <= data <= 127
BXL_BCS_Code128
111
2 <= n <= 255
0 <= data <= 127
BXL_BCS_PDF417
200
2 <= n <= 928
0 <= data <= 255
BXL_BCS_QRCODE
202~203
2 <= n <= 928
0 <= data <= 255
BXL_BCS_DATAMATRIX
204
2 <= n <= 928
0 <= data <= 255
BXL_BCS_MAXICODE
205~6
2 <= n <= 928
0 <= data <= 255
2-8 Image Width
Set the width of image and valid range is 0~ max width.
Image is resized for the conditions according to the given conditions when the following
values are set.
Available settings are as follows.
Code
Value
Description
BXL_WIDTH_FULL
-1
Value is set to max width and the image is
resized to the full paper size
BXL_WIDTH_NONE
-2
Image is not resized

POS Printer
Rev. 2.00
- 10 -
2-9 Power
This indicates the remaining battery capacity of the printer. It is read only and a change of
battery status is automatically shown.
Support Device : Only Mobile printer, POS Printer is not support.
The remaining battery capacity status values are as follows.
Code
Value
Description
BXL_PWR_HIGH
0
Remaining battery capacity is 95%
BXL_PWR_MIDDLE
1
Remaining battery capacity is 85%
BXL_PWR_LOW
2
Remaining battery capacity is 50%
BXL_PWR_SMALL
3
Remaining battery capacity is 25%
BXL_PWR_NOT
4
Remaining battery capacity is less than 25%
2-10 State
This indicates the status of the printer. It is read only and the status of the printer is
automatically shown when printer status is checked by calling the CheckPrinter function.
Status values can be combined and each setting can be checked through bit operation.
Printer status settings are as follows.
Code
Value
Description
BXL_STS_NORMAL
0
Normal
BXL_STS_PAPEREMPTY
1
No paper
BXL_STS_CONVEROPEN
2
Printer cover open
BXL_STS_POWEROVER
4
Not enough remaining battery of printer
BXL_STS_MSR_READY
8
No printing
MSR read only mode
BXL_STS_PRINTING
16
Printer is printing or receiving data
BXL_STS_ERROR
32
Error in communication with printer
BXL_STS_NOT_OPEN
64
Open method of BXPrinterControl was not
called
BXL_STS_ERROR_OCCUR
128
Printer internal error
BXL_STS_NOT_CONNECTED
-1
Currently printer is not connected
2-11 Connection Control
This defines the type of printer connection.
Available settings are as follows.
Code
Value
Description
BXL_CONNECTIONMODE_AUTO
0
Automatic connect mode
BXL_CONNECTIONMODE_NOAUTO
100
Not automatic connect mode

POS Printer
Rev. 2.00
- 11 -
2-12 Drawer kick-out connector pin
This defines the number of drawer kick-out connector pin.
Available settings are as follows.
Code
Value
Description
BXL_CASHDRAWER_PIN_2
0
Drawer kick-out connector pin 2
BXL_CASHDRAWER_PIN_5
1
Drawer kick-out connector pin 5
2-13 Drawer open level
This defines the type of cash drawer
Available settings are as follows.
Code
Value
Description
BXL_CASHDRAWER_OPENLEVEL_LOW
0
If Cash drawer is open,
Drawer kick-out connector
pin 3 is LOW
BXL_CASHDRAWER_OPENLEVEL_HIGH
1
If Cash drawer is open,
Drawer kick-out connector
pin 3 is HIGH
2-14 Model ID
This defines the type of printer.
Available settings are as follows.
Code
Value
Description
BXL_MODEL_ID_SPPR200II
0x12000002
SPP-R200II
BXL_MODEL_ID_SRPR300
0x13000000
SPP-R300
BXL_MODEL_ID_SPPR400
0x14000000
SPP-R400
BXL_MODEL_ID_SRP350II
0x23500002
SRP-350II
BXL_MODEL_ID_SRP350plus
0x23507000
SRP-350plus
BXL_MODEL_ID_SRP352plus
0x23527000
SRP-352plus
BXL_MODEL_ID_SRP350plusII
0x23507002
SRP-350plusII
BXL_MODEL_ID_SRP352plusII
0x23527002
SRP-352plusII
BXL_MODEL_ID_SRP350III
0x23500003
SRP-350III
BXL_MODEL_ID_SRP352III
0x23520003
SRP-352III
BXL_MODEL_ID_SRP275
0x32750000
SRP-275, SRP-275II
BXL_MODEL_ID_SRPF310
0x93100000
SRP-F310
BXL_MODEL_ID_SRPF312
0x93120000
SRP-F312
2-15 Connection Class
When the method named 'didFindPrinter' is called,
This value is updated to connectionClass in BXPrinter class
Refer to 6-2-3 didFindPrinter
Code
Value
Description
BXL_CONNECTIONCLASS_WIFI
0x0000
WIFI Connection
BXL_CONNECTIONCLASS_ETHERNET
0x0001
Ethernet Connection

POS Printer
Rev. 2.00
- 12 -
2-16 Result Code
Code DEFINE
Value
Description
BXL_SUCCESS
0
Success
BXL_NOT_CONNECTED
-1
Printer is not connected
BXL_NOT_OPENED
101
SDK is not open
BXL_STATUS_ERROR
103
Error in status check
BXL_CONNECT_ERROR
105
Connection failure
BXL_NOT_SUPPORT
107
Not supported
BXL_BAD_ARGUMENT
108
Wrong function arguments
BXL_BUFFER_ERROR
109
Error in MSR buffer
BXL_NOT_CONNECTED
110
Printer is not connected
BXL_RGBA_ERROR
111
Error while converting image file to
RGBA data
BXL_MEMORY_ERROR
112
Memory allocation failure
BXL_TOO_LARGE_IMAGE
113
Size of image file is too big while downloading
image to NV area
BXL_NOT_SUPPORT_DEVICE
114
The printer device does not support
BXL_READ_ERROR
301
Failure in data reception
BXL_WRITE_ERROR
300
Failure in data transmission
BXL_BITMAPLOAD_ERROR
400
Fail to read image file
BXL_BC_DATA_ERROR
500
Error in bar code data
BXL_BC_NOT_SUPPORT
501
Unsupported bar code type
BXLMSR_NOTREADY
602
Not MSR READY state
BXLMSR_FAILEDMODE
601
Not automatic read mode
BXLMSR_DATAEMPTY
603
No data read from MSR
1001H
Unknown command
1002H
Command cannot be executed
1003H
Incorrect number of arguments
1004H
First byte of unknown command of
invalid command
1005H
Response time out
1010H
Response error due to card reset,
or first byte of response is not valid
1012H
Message limit is exceeded. Maximum is 254
bytes, and card data is 248 bytes
1013H
Error in reading bytes from asynchronous
routine
1015H
Card mode is terminated
Card mode command needs to be transmitted
101BH
Transmission of command with
incorrect arguments
101DH
Incorrect TCK check byte
10A0H
Error in card reset response (unknown
protocol or TA1 byte recognition error),
unsupported card, no card response value for
card reset
10A1H
Card protocol error (T=0/T=1)
10A2H
Time out due to no card response
10A3H
Parity error
10A4H
Card has aborted chaining (T=1)
10A5H
Reader has aborted chaining (T=2)

POS Printer
Rev. 2.00
- 13 -
Code DEFINE
Value
Description
10A6H
Successful execution of IC module
and RESYNCH
10A7H
PPS error
10A8H
IC module has already been set to IC CARD
mode
10B0H
PC link command is not supported
10E4H
The card has just sent an invalid “Procedure
byte”
10E5H
The card has interrupted an exchange
10E7H
Card returns an error
10F7H
Card is removed while executing a command
10F8H
Card is not useable because it is electrically
damaged
10FBH
Card recognition failure or car entry failure

POS Printer
Rev. 2.00
- 14 -
3. BXBarcode Class Reference
Inherits from
NSObject
Confirms to
Framework
BXPrinter.a
[Availability]
iOS 4.3 and later
Declared
BXBarcodeInfo.h
3-1 Overview
BXBarcode class is an object that contains information about which barcode types are
supported for each printer to control.
3-2 Properties
3-2-1 barNumber
Barcode Define Number
@property int barNumber
[Discussion]
Printer name is saved automatically by collecting information from the connected printer.
[Availability]
SDK 3.0.3 and later
3-2-2 name
Barcode Name
@property(readwrite) NSString * address
[Discussion]
Printer name is saved automatically by collecting information from the connected printer.
[Availability]
SDK 3.0.3 and later
3-2-3 support
The availability of the barcode.
@property BOOL support
[Discussion]
Printer name is saved automatically by collecting information from the connected printer.
[Availability]
SDK 3.0.3 and later

POS Printer
Rev. 2.00
- 15 -
4. BXPrinter Class Reference
Inherits from
NSObject
Confirms to
Framework
BXPrinter.a
[Availability]
iOS 4.3 and later
Declared
BXPrinterObject.h
4-1 Overview
BXPrinter Class contains the information of control target printer (name / network address /
port).
4-2 Properties
4-2-1 name
Printer name
@property(readonly) NSString * name
[Discussion]
Printer name is saved automatically by collecting information from the connected printer.
[Availability]
SDK 0.6.0 and later
4-2-2 address
Network address of printer
@property(readwrite) NSString * address
[Discussion]
Network address of the printer should be assigned first before connection.
[Availability]
SDK 0.6.0 and later
4-2-3 port
Network port of printer
@property(readwrite) unsigned short port
[Discussion]
Network port of the printer should be assigned first before connection.
[Availability]
SDK 0.6.0 and later

POS Printer
Rev. 2.00
- 16 -
4-2-4 modelStr
Model name of printer
Name is provided by the firmware, and it is _SRP-350II in case of SRP-350II printer.
@property(readwrite) NSString * modelStr
[Discussion]
This value is updated by the checkPrinter method of BXPrinterController.
[Availability]
SDK 0.8.0 and later
4-2-5 versionStr
Firmware version of printer
Version name is provided by firmware, and it is in the form of _V01.00 STOB 040711.
@property(readwrite) NSString * versionStr
[Discussion]
This value is updated by the checkPrinter method of BXPrinterController.
[Availability]
SDK 0.8.0 and later
4-2-6 connectionClass
Printer interface type.
This value represents the way that the printer is connected.
Refer 2-15 Connection Class.
@property(readwrite) unsigned short * connectionClass
[Availability]
SDK 3.0.3 and later

POS Printer
Rev. 2.00
- 17 -
5. BXPrinterController Class Reference
Inherits from
NSObject
Confirms to
Framework
BXPrinter.a
[Availability]
iOS 4.3 and later
Declared
BXPrinter.h
5-1 Overview
BXPrinterController Class is the main object for printer control.
5-2 Properties
5-2-1 version
SDK version
@property(readonly) NSString * version
[Discussion]
It is a string in the form of “1.0.0” and it is read only.
[Availability]
SDK 0.6.0 and later
5-2-2 delegate
Assign the object to apply BXPrinterControlDelegate method
@property(readwrite) id<BXPrinterControlDelegate> delegate
[Availability]
SDK 0.6.0 and later
5-2-3 target
Control target printer object
@property(readwrite) BXPrinter * target
[Discussion]
It is a control target printer object and should be assigned before starting printer control.
[Availability]
SDK 0.6.0 and later

POS Printer
Rev. 2.00
- 18 -
5-2-4 lookupDuration
Printer lookup time (unit: second)
@property(readwrite) CGFloat lookupDuration
[Discussion]
It could be a fractional number such as 0.5.
[Availability]
SDK 0.6.0 and later
5-2-5 lookupCount
Number of repeat on signal transmission for printer search
@property(readwrite) unsigned lookupCount
[Discussion]
Default value is set to 1. When it is set to a number bigger than 1, the printer search
signal transmission is repeated by this number at intervals of 0.2 seconds.
[Availability]
SDK 0.6.0 and later
5-2-6 alignment
Horizontal alignment setting
@property(readwrite) int alignment
[Discussion]
Default value is set to left alignment, and this setting affects all output printing including
text and bar code.
[Availability]
SDK 0.8.0 and later
5-2-7 attribute
Text printing property
@property(readwrite) int attribute
[Discussion]
Refer to 2-5 Text Attribute
[Availability]
SDK 0.8.0 and later

POS Printer
Rev. 2.00
- 19 -
5-2-8 textSize
Size of the printed text
@property(readwrite) int textSize
[Discussion]
Refer to 2-4 Text Size
[Availability]
SDK 0.6.0 and later
5-2-9 characterSet
Defines the code page of printer
@property(readwrite) CGFloat lookupDuration
[Discussion]
Refer to 2-1 Character Set
Default value is set to BXL_CS_437.
[Availability]
SDK 0.6.0 and later
5-2-10 internationalCharacterSet
@property(readwrite) char internationalCharacterSet
[Discussion]
Refer to 2-2 International Character Set. Default value is set to BXL_CS_437.
[Availability]
SDK 0.6.0 and later
5-2-11 textEncoding
Type of the text Encoding.
@property(readwrite) long textEncoding
[Discussion]
Refer to NSStringEncoding in NSString.h
[Availability]
SDK 3.0.2 and later

POS Printer
Rev. 2.00
- 20 -
5-2-12 state
Printer state code
This value is updated when checkPrinter method of BXPrinterController is called.
@property(readonly) long state
[Discussion]
Refer to 2-10 State
[Availability]
SDK 0.6.0 and later
5-2-13 power
@property(readonly) long state
[Discussion]
Refer to 2-9 Power
[Availability]
SDK 0.6.0 and later
5-2-14 AutoConnection
@property(assign) int AutoConnection
[Discussion]
Refer to 2-11 Connection Control
[Availability]
SDK 2.0.2 and later
<Note>
※Printer connection is controlled automatically without using connect/disconnect
function in the automatic connection mode.
※Consecutive use of printText function may slow down the printing speed because
most functions have a connect/disconnect job at the beginning and end of it.
Use the manual connection mode to address this issue.
5-2-15 drawerPin
@property(assign) int drawerPin
[Discussion]
Refer to 2-12 Drawer kick-out connector pin.
[Availability]
SDK 3.0.1 and later