Star PassPRNT (For iOS) Software Manual

Rev. 2.0.0
Star PassPRNT
(For iOS)
Software Manual
Rev. 2.0.0
1
Rev. 2.0.0
Revision History
Rev. No.
Changes
1.0.0
First edition
Date of Revision
Sep. 18, 2015
Added portable printer-compatible models
Added desktop printer compatible printing widths
1.1.0
Added emulation automatic detection function for
Nov. 12, 2015
portable printers
Corresponding to Star PassPRNT Ver.1.3 release.
1.2.0
Added printer models
March 22, 2016
Corresponding to Star PassPRNT Ver.2.0 release.
Added printer models
2.0.0
Added Ethernet I/F
Nov. 14, 2016
Corresponding to BlackMark, PDF printing, and All
Receipts
CAUTION

IOS
is a trademark or registered trademark of Cisco in the U.S. and other countries
and is used under license.
Android
The
and Google Play are trademarks of Google Inc.
Bluetooth® word mark and logos are registered trademarks owned by the
Bluetooth SIG, Inc.
The
information in this manual is subject to change without notice.
STAR
MICRONICS CO., LTD. has taken every measure to provide accurate
information, but assumes no liability for errors or omissions.
STAR
MICRONICS CO., LTD. is not liable for any damages resulting from the use of
information contained in this manual.
Reproduction
in whole or in part is prohibited.
2
Rev. 2.0.0
Contents
1.
Introduction .................................................................................................................... 5
1-1
2.
Functions of PassPRNT ......................................................................................... 6
Functions ..................................................................................................................... 10
2-1
Outline (System Configuration) ............................................................................ 10
2-2
Hardware Configuration........................................................................................ 12
2-3
Software Configuration ......................................................................................... 15
2-4
PassPRNT Screens.............................................................................................. 15
"Configuration" Screen ................................................................................................ 15
"Payment" Screen ....................................................................................................... 16
"Now printing…" screen ............................................................................................... 17
"Star Cloud Services" screen ....................................................................................... 18
3.
Data Specifications ...................................................................................................... 20
3-1
URL scheme ......................................................................................................... 20
3-2
Path ...................................................................................................................... 21
3-3
Queries ................................................................................................................. 22
1.
html....................................................................................................................... 23
2.
pdf ........................................................................................................................ 24
3.
size ....................................................................................................................... 25
4.
drawer .................................................................................................................. 26
5.
port ....................................................................................................................... 26
6.
settings ................................................................................................................. 27
7.
timeout.................................................................................................................. 27
8.
back ...................................................................................................................... 28
9.
blackmark ............................................................................................................. 29
10.
bmposition ........................................................................................................ 30
11.
popup ................................................................................................................ 31
3-4
Error Codes .......................................................................................................... 32
Error Code:
0 ............................................................................................................ 33
Error Code:
1 ............................................................................................................ 33
Error Code:
2 ............................................................................................................ 33
Error Code:
3 ............................................................................................................ 34
Error Code:
4 ............................................................................................................ 34
Error Code:
5 ............................................................................................................ 35
Error Code:
6 ............................................................................................................ 35
Error Code:
7 ............................................................................................................ 36
3
Rev. 2.0.0
Error Code:
8 ............................................................................................................ 36
Error Code:
9 ............................................................................................................ 37
Error code: 13 .............................................................................................................. 37
Error code: 14 .............................................................................................................. 38
4.
Terminology ................................................................................................................. 39
4
Rev. 2.0.0
1. Introduction
Star PassPRNT (hereafter referred to as PassPRNT) is a printing application made by Star
Micronics co., Ltd.
PassPRNT is called by the host application using a URL scheme, accepts the printing data,
and then outputs it to a Star Micronics-brand printer.
This manual describes the functions of PassPRNT and the application interactions between
PassPRNT and the host application.
The application interaction of this software uses the iOS standard URL scheme (including
path and query). The printing layout is defined using HTML or PDF. Other printer settings
use the queries described in this manual. Accordingly, this manual is intended for
application/system developers who use HTML and Objective-C. A basic understanding of
HTML and Objective-C are assumed for the users of this manual and software.
Note that the content of this manual applies to Star PassPRNT(for iOS) Ver. 2.0, and will be
updated on an ongoing basis as the application is updated.
5
Rev. 2.0.0
1-1
Functions of PassPRNT
The functions of PassPRNT are described below.
A) Starting the Software
i.
Selecting 'Print' will start the software in conjunction with the host application. After
printing is completed, the host application is automatically displayed. (After printing
is completed, PassPRNT will send any error codes to the host application.)
ii.
Selecting 'Settings' will be displayed as the Configuration screen when the
application is started.
B) Functions
In the iOS environment, PassPRNT is called by the host application using a URL
scheme, accepts the printing data, and then prints to a Star Micronics-brand printer.
Note that the "Star logo" is added to the beginning of the printing data accepted from
the host application in the initial state. Granted printing contents can be canceled by
using the "payment" screen in the application.
C) Setting Method
i.
Printer Settings
There are two setting methods:
settings can be made from the PassPRNT
settings screen, or settings can be configured using queries from the host
application. Settings made using queries are given priority. For information on
making settings using queries, refer to "3-3 Queries".
1)
Printer Designation
(a) Designation of printer type ("Desktop"/"Portable"/"mPOP")
(b) Printer Selection
(c) Automatic selection of emulation (only when a portable printer is selected)
2)
Specification of cash drawer activation (desktop types only)
The activation timing is for the timing before printing and after printing.
ii.
Purchase functionality for cancel of granted printing contents
From the Update screen, by using an Apple ID and purchasing the functionality for
delete of the granted printing contents, the beginning of the granted printing
contents can be deleted.
6
Rev. 2.0.0
iii.
Settings Star Cloud Services
From the dialog box, ‘Register’ and ‘Enable/Disable’ after registering can be
selected.
When ‘Register’ is selected, User Name/Password input screen appears.
D) Screen Configuration
i.
Printer Configuration
On the settings screen, the settings described in C)-i can be made.
1)
View/select a printer from a list of available printers (The 'Search' function can
be used)
(1) Select the communication interface
When selecting "Desktop", the interface selection window is displayed
(LAN/Bluetooth/All).
The interface when selecting "Portable" or "mPOP" does not display the
selection window because it is only for Bluetooth.
(2) Display search results for the selected printer type
When selecting "Portable", only mobile printers will be displayed. When
selecting "Desktop"/"mPOP", printers other than "Portable" will be
displayed.
2)
Check communication with the selected printer
(1) Firmware version acquisition is performed after the printer is selected
(2) Check the selected printer supports Firmware version (see section 2–2),
and then the result is displayed. If a communication confirmation error
occurs, a warning message is displayed.
The following factors are considered to be the main causes of a
communication confirmation error.
<Settings error>
- The selected printer type is incorrect
- The selected printer is incorrect
<Communication error>
- The device and the printer are not paired correctly
- The printer is offline (the power is off or there is no paper in the
printer)
In this case, the printing item will be cleared. Check communication with
the new printer.
7
Rev. 2.0.0
3)
Selecting Drawer OFF, before printing, and after printing
The query ("drawer" value) is prioritized in this setting.
If the value is not included in the query, this setting will be enabled.
If selecting drawer configuration as "before printing" and printer was offline,
drawer is opened after recovering online except mPOP.
*The settings made (shown below) are saved in the application until it is
uninstalled.
ii.
Item
Screen
Default value
Type
Desktop
Desktop
Printer
NONE
NONE
Drawer
Off
Off
Purchase functionality for delete of granted printing contents
On the Update screen, the settings described above in C)-ii can be made.
1)
The cancel of the granted printing as described in B) above can be purchased.
*If the application is accidentally deleted, the purchased functionality can be
correctly reactivated.
iii.
Settings Star Cloud Services
From the dialog box, ‘Register’ and ‘Enable/Disable’ after registering can be
selected.
When ‘Register’ is selected, User Name/Password input screen appears.
E) Languages
This application supports the following 2 languages. If the language setting of this
device is not set to Japanese, it will be set to English.
- Japanese
- English
8
Rev. 2.0.0
F)
Cautions
i.
During printing
<Data storage period>
The period from when PassPRNT is launched by the host application until the
transition back to the host application.
<Reusability>
The received printing data cannot be printed unless there are instructions from the
user (select "retry" during printing).
<Canceling Application>
Do not hold down the "home" button to cancel the operation when printing. If the
application has been canceled, the operating system may close the application
even when printing. Therefore, the printing result cannot be sent to the host
application.
ii.
Printing error due to settings failure
When "Type" and "Printer" are not selected on the settings screen, PassPRNT will
connect to "Desktop" as the desired printer. The printer being used is one of the
paired Star printers. Consequently, if printing to Portable and mPOP, make sure to
select "Type" and "Printer" on the settings screen or through the query settings.
iii.
User registration of Star Cloud Services
The number of users that can be registered is 1 user.
The Star Cloud Services server and the PassPRNT application has a one-to-one
relationship. Even if printing from PassPRNT to multiple printers according to
instructions from the host application, the data is always uploaded to the same
storage location on the server.
9
Rev. 2.0.0
2. Functions
2-1
Outline (System Configuration)
An outline of PassPRNT operation is shown below.
A-1.
A-2.
1.
2.
4.
3.
Host
application
Host device
Printer
"Host application", "PassPRNT", and "Printer" exist as players in the processing. The host
application and PassPRNT are installed in the host device. Data communication between
the host device and printer is done using Bluetooth/Ethernet etc.
The key processes that occur at the time of printing are described below from the viewpoint
of the data flowing between the players.
Data specifications are described later in this manual.
1.
In the host application, printing data (HTML) for PassPRNT is generated, and a
URL scheme is used to send the data to PassPRNT. (*At this time the OS
automatically switches screens from the host application to PassPRNT.)
2.
PassPRNT displays/generates the printing data in accordance with the received
URL scheme data. After the data is generated, the printing data is sent using
Bluetooth communication. Also, PassPRNT starts the A process simultaneously.
10
Rev. 2.0.0
3.
After the printing data is sent, PassPRNT monitors the printer's status to determine
whether the printing was successful or not. (*The paper loading status and any
opened covers are also monitored, and when an error occurs, the retry/cancel
screen is displayed so that the printing process can be attempted again.)
4.
When switching back to the host application from PassPRNT, printing success
judgment result data is generated and sent to the host application at the time of the
switch.
A-1. The printing data (PNG format) generated in Step 2 is uploaded to the Star Cloud
Services. Also, the status during printing is updated.
A-2. Upload success judgment result data is received.
11
Rev. 2.0.0
2-2
Hardware Configuration
The Hardware Configuration consists of the printing device ("Printer") and the device on
which PassPRNT is installed ("Host device"). These devices connect and communicate
using Bluetooth.
<Compatible Printers>
Model
Emulation
Firmware Version
Communication Interface
SM-S210i
(Japan model only)
StarPRNT
3.0 or later
Bluetooth
ESC/POS
2.5 or later
Bluetooth
SM-S220i
(EU/US model only)
StarPRNT
3.0 or later
Bluetooth
ESC/POS
2.1 or later
Bluetooth
SM-S230i
(EU/US model only)
StarPRNT
1.0 or later
Bluetooth
ESC/POS
1.0 or later
Bluetooth
StarPRNT
ESC/POS
StarPRNT
ESC/POS
3.0 or later
2.5 or later
3.0 or later
2.5 or later
Bluetooth
Bluetooth
Bluetooth
Bluetooth
SM-L200
StarPRNT
1.1 or later
Bluetooth Low Energy
TSP650II
Star Line
2.1 or later
TSP700II
Star Line
5.1 or later
TSP800II
Star Line
2.1 or later
mPOP
StarPRNT
1.0.1 or later
Bluetooth
FVP10
Star Line
2.0 or later
Bluetooth
Ethernet
BSC10
(Only non-Japanese
models)
ESC/POS
1.0 or later
Ethernet
TSP100IIIBI
Star Graphic
1.0 or later
Bluetooth
TSP100IIIW
Star Graphic
1.4 or later
Ethernet
TSP100IIILAN
Star Graphic
1.3 or later
Ethernet
SM-T300i
SM-T400i
Bluetooth
Ethernet
Bluetooth
Ethernet
Bluetooth
Ethernet
To change emulation for a portable printer from ESC/POS to StarPRNT, refer to the
procedure below.
You can check the current emulation setting in the connection status of the settings
screen
12
Rev. 2.0.0
◆ Emulation Changing (ESC/POS→StarPRNT) for Portable Printers
1. Turn on the printer power and open the printer cover.
2. Press and hold both the power button and the FEED button, and once the
ERROR lamp flashes 5 times quickly release the power and FEED buttons. The
emulation change will be automatically performed.
3. After setting the paper, closing the printer cover will start printing using the set
emulation mode.
For ESC/POS mode: EMU = ESC/POS
For StarPRNT mode: EMU = StarPRNT
If the emulation mode does not change correctly, perform steps 1 through 3 of
the procedure again.
When doing so, for step 2, do not release the buttons during the flashing, and
take care to only release the buttons after flashing has completed 5 times.
4. After switching from ESC/POS to StarPRNT, turn the power to the printer off and
then turn it on again.
The selected emulation will become active after the power to the printer is turned
on again.
13
Rev. 2.0.0
Host devices (iOS devices) compatible with the printers are shown in the table below.
Compatible OS versions are listed for each host device.
<Compatible Host Devices>
Device
iPad 2
iOS
7.0 or later
iPad (3rd generation)
7.0 or later
iPad (4th generation)
7.0 or later
iPad Air
7.0 or later
iPad Air 2
7.0 or later
iPad mini
7.0 or later
iPad mini 2
7.0 or later
iPad mini 3
7.0 or later
iPhone 4s
7.0 or later
iPhone 5
7.0 or later
iPhone 5s
7.0 or later
iPhone 5c
7.0 or later
iPhone 6
7.0 or later
iPhone 6 Plus
iPod touch (5th generation)
7.0 or later
7.0 or later
Note: iPad, iPhone, iPod, and iPod touch are registered trademarks of Apple Inc. in
the United States and/or other countries. iPad Air and iPad mini are trademarks
of Apple Inc. The trademark "iPhone" is used under license from Aiphone Co.,
Ltd. IOS is a trademark or registered trademark of Cisco in the United States
and/or other countries and is used under license.
14
Rev. 2.0.0
2-3
Software Configuration
The software configuration for this product is the OS of the host device, which should be iOS
version 7.0 or later.
2-4
PassPRNT Screens
The various parts that make up PassPRNT are described here according to the screen they
are displayed on.
"Configuration" Screen
The printer to be used is selected and set by the user on this screen. The description of
each part of this screen is provided below.
Displays the Star Cloud
Services Configuration
screen. Registration
(confirmation) and
Enable/Disable settings
are available.
When the type
"Desktop" /”mPOP” is
selected, the Drawer
setting becomes
available.
Switches to the
"Payment" screen
Selects the type of
printer to connect to.
Searches for printers
that can be connected
and then displays them
in a list. After a printer is
selected, a
communication check is
performed.
After a search is
performed, the selected
printer is displayed.
(The iOSPortName is
displayed.)
Communication checks
are performed with the
applicable printer
according to the "Type"
and "Printer" settings.
15
Rev. 2.0.0
"Payment" Screen
After starting the application, selecting tab at the bottom of the screen will display this
screen.
This screen is for purchasing the unlocking of the Star advertisement automatically granted
print at the end of the printing data.
The description of each display/button of this screen is provided below.
The name of the
functionality being
purchased.
Purchase the
functionality
*Input of account ID and
password may be
required.
The price of the
functionality being
purchased.
Use this button to
restore the purchase
functionality after
purchase.
Describes the
functionality of the
purchase.
Back to the
"Configuration"
screen.
16
Rev. 2.0.0
"Now printing…" screen
This is the screen that is displayed when switching from the host application to print.
Error messages may be displayed according to the status during printing.
17
Rev. 2.0.0
"Star Cloud Services" screen
This is the alert display window that appears after the "Star Cloud Services" icon is pressed.
<Unregistered state>
<Registered and Enabled state>
< Registered and Disabled state>
18
Rev. 2.0.0
"Star Cloud Services" Registration and Confirmation alert display
<Registration>
<Confirmation>
19
Rev. 2.0.0
3. Data Specifications
To realize the functionality of PassPRNT, application interaction using a URL scheme follows
the iOS standard URL scheme (including path and query). Using this method allows data to
be accepted from the host application. Refer to the following for individual specifications.
<Cautions>
For data passed from the host application side (especially the printing layout data of a html
or pdf query etc.) through linkage between the application, set the lowest possible OS
memory limitation.
Especially if examining the application of shared specifications with Android OS, be aware
that the Android OS is set to a maximum of 1M (this value will decrease depending on the
memory usage state of the device and other applications).
When data that exceeds the usable memory size is sent from the host application, the OS
may not operate successfully (does not switch to PassPRNT).
3-1
URL scheme
This application's URL scheme is:
starpassprnt://
When the host application call this URL scheme, iOS automatically switches to this
application. As the operations that occur after switching refer to the path settings shown in
the next section, both need to be set correctly. Refer to the content of the SDK for the
method for calling from the host application. The following is for when calling from
Objective-C.
[[UIApplicationsharedApplication]openURL:@”starpassprnt://”];
While the URL scheme settings do not recognize differences between upper case and lower
case letters, setting using lower case letters is recommended.
20
Rev. 2.0.0
3-2
Path
The path after the URL scheme is defined based on the following rule:
URL Version/Main Process/Sub-process
(1) URL Version:
Version of the URL path (for switching internal processes)
(2) Main Process: Declares the main process (function) in PassPRNT
(3) Sub-process:
Declares the sub-process (function) derived from the main
process described above.
The URL Version is defined using (1) described above, with flexibility ensured by retaining
the functionality of the old version and specifying the functional enhancement of the new
version. The (2) Main Process is not just for setting functions of 'Print', but for subdivisions of
the primary function such as 'Settings' and 'Register' as well. This makes functional
additions easier to implement, and increases possibilities for when the host application calls
the applications. As with (2), the functions of (3) are subdivided as well. The applicable path
setting in this case is:
v1/print/nopreview
This means:
"Operate the application using URL version 1 for the printing function, with the
preview disabled".
The result of this path being processed is the display of the "Now printing" screen described
in "PassPRNT Screens" above. If a path other than this one is defined, an error will result.
While the path settings do not recognize differences between upper case and lower case
letters, setting using lower case letters is recommended.
21
Rev. 2.0.0
3-3
Queries
The data passed between PassPRNT and the host application is handled in the form of
query parameters. The variable name and value are expressed using "=", and the query
must start with "?" to set the boundaries of the path. An "&" between values allows linking of
multiple values, with no restriction on their order. Refer to the following for parameter
settings.
While the query settings do not recognize differences between upper case and lower case
letters, setting using lower case letters is recommended.
<Query List>
Variable name
Name
1. html
HTML format print layout data
2. pdf
PDF format printing data
3. size
Printing width
4. drawer
Drawer activation instruction
5. port
Printer Setting (iOSPortName)
6. settings
Printer Setting (Printer Type)
7. timeout
Printer Setting (Timeout)
8. back
Callback URL scheme
9. blackmark
Blackmark settings (Enable/Disable)
10. bmposition
Blackmark settings (Sensor position)
11.
popup
Error detection pop-up settings
(Enable/Disable)
Example of URL scheme including a query:
starpassprnt://v1/print/nopreview?html=<Printing Data>&size=3&drawer=ahead&back=
<Callback URL scheme>
22
Rev. 2.0.0
1. html
Name
HTML format print layout data
Variable
name
Variable
value
Default
value
Conditions
html
Data described in accordance with html5 specifications
Required (*1,*2), URL encoding is required
Description When the html-based data is received by PassPRNT, the printing image is
generated internally, and then converted to raster data. The results of that are
converted to a command system which can be used for printing on a Star printer.
The maximum length of the layout data is 1 meter (8,000 pixels). When this limit
is exceeded, Error (1) is issued.
Either this parameter or PDF is required, and if it is not set, Error (2) is issued.
<Cautions>
For data passed from the host application side (especially the printing layout
data of a "html" or "pdf" query etc.) through linkage between the application, set
the lowest possible OS memory limitation. When data that exceeds the usable
memory size is sent from the host application, the OS may not operate
successfully (does not switch to PassPRNT).
*1 - As an exception, if "drawer=ahead" or "drawer=after" is being executed at
the same time, the operation will still occur even if this parameter is not set (for
cases when there is no printing but the cash drawer is opened). This is disabled
when "Drawer" is set to ON on the Configuration screen.
*2 - Set only one of either the "pdf" query for printing data or this query.
Error (1)
This error occurs when the maximum printing length is exceeded.
Code: 3
Text: ERROR_INVALID_DATA_LENGTH
Message: Print data has exceeded the upper limit
Error (2)
This error occurs when the parameter is not set.
Code: 9
Text: ERROR_INVALID_RECEIPT_DATA
Message: No print data
<Cautions>
Consecutive digits (such as telephone numbers) in printing layout data may be
unintentionally formatted with underlines by the automatic linking function. To avoid this
phenomenon, add the following structure to disable the automatic link function for telephone
numbers.
<meta name="format-detection" content="telephone=no">
23
Rev. 2.0.0
2. pdf
Name
PDF file format printing data
Variable
name
Variable
value
Initial value
pdf
Conditions
Required (*1, *2), Base64 data format and URL encoding are required
Description
The host application side changes the PDF data to binary data using the base64
format, and the result of the encoded URL is appended to this query.
When PassPRNT accepts the data, the URL is decoded → Base64 is decoded, and
then the PDF image is reconstructed. Then, the PDF printing image is converted to
RasterData internally. As a result, it converts to the printable command system on
the Star printer.
When PassPRNT accepts the data, the URL is decoded → Base64 is decoded, and
then the PDF image is reconstructed. Then, the PDF printing image is converted to
RasterData internally. As a result, it converts to the printable command system on
the Star printer.
This parameter or any html is required, and if it is not set, Error (2) is issued.
If a format data other than a PDF is appended, Error (3) is issued.
<Cautions>
For data passed from the host application side (especially the printing layout data of
a "html" or "pdf" query etc.) through linkage between the application, set the lowest
possible OS memory limitation. When data that exceeds the usable memory size is
sent from the host application, the OS may not operate successfully (does not
switch to PassPRNT).
*1 - As an exception, if "drawer" is being executed at the same time, the operation
will still occur even if this parameter is not set (for cases when there is no printing
but the cash drawer is opened). This is disabled when "Drawer" is set to ON on the
Configuration screen.
*2 – Set only one of either the "html" query for printing data or this query.
*3 - The calculation method of the printing length from the PDF data paper size
(resolution) is as follows.
Printing length (vertical) = (pdf vertical resolution) × (query ‘size’)/(pdf horizontal
resolution).
Error (1)
An error if the maximum printing length is exceeded
Code: 3
Character string: ERROR_INVALID_DATA_LENGTH
Message: Print data has exceeded the upper limit
An error if the parameter is not set
Code: 9
Character string: ERROR_INVALID_RECEIPT_DATA
Message: No print data
An error if the file format settings are not supported
Code: 14
Character string: ERROR_NONSUPPORTED_FILEFORMA
Message: Non-compatible file format
Error (2)
Error (3)
PDF file format printing data
-
24
Rev. 2.0.0
3. size
Name
Variable
name
Variable
value
Default
value
Conditions
Printing width
size
One of the following values: 2, 2w1, 2w2, 2w3, 3w, 3w2 or 4.
3
Optional
Description Specifies the printing paper width.
The printing image drawing size is adjusted based on this parameter. If it is not
specified, or the setting is invalid, "3" (inches) will be set.
The printing size corresponding to each variable is as follows:
Refer to the MSW4 specifications for the printing areas settings on the
printer side.
dot
(mm)
Error
size
2
2w1
2w2
2w3
3
3w
3w2
4
TSP650II
406
(50.8)
-
-
-
576
(72)
-
-
-
TSP700II
406
(50.8)
416
(52)
420
(52.5)
-
576
(72)
640
(80)
-
-
TSP800II
-
-
-
-
576
(72)
-
-
832
(104)
SM-S210i
384
(48)
-
-
-
-
-
-
-
SM-S220i
384
(48)
-
-
-
-
-
-
-
SM-S230i
384
(48)
-
-
-
-
-
-
-
SM-L200
384
(48)
-
-
-
-
-
-
-
SM-T300i
-
-
-
-
576
(72)
-
-
-
SM-T400i
-
-
-
-
-
-
-
832
(104)
mPOP
384
(48)
432
(54)
406
(50.8)
-
-
-
-
-
FVP10
406
(50.8)
416
(52)
420
(52.5)
-
576
(72)
-
-
-
BCS10
406
(50.8)
-
-
360
(45)
576
(72)
-
512
(64)
-
TSP100IIIB
406
(50.8)
-
-
-
576
(72)
-
-
-
TSP100IIIW
406
(50.8)
-
-
-
576
(72)
-
-
-
TSP100IIILAN
406
(50.8)
-
-
-
576
(72)
-
-
-
-
25
Rev. 2.0.0
4. drawer
Name
Variable
name
Variable
value
Drawer activation instruction
drawer
One of the following values: off, ahead and after.
off:
Drawer OFF
ahead: Open before printing
after: Open after printing
Default
value
The switch setting for "Drawer" on the 'Configuration' screen
Conditions
Optional
Description Instructs the drawer.
Drawer operation after printing is determined by this parameter. If it is not
specified, or the setting is invalid, the setting for 'Drawer' on the 'Configuration'
screen is used.
This allows situations where the cash drawer is activated (without printing) even
when a html or pdf query is not set.
If selecting drawer configuration as "before printing" and printer was offline,
drawer is opened after recovering online except mPOP.
This is only enabled for Desktop/mPOP type printers, and is ignored when a
Portable type printer is selected.
Error
-
5. port
Name
Variable
name
Variable
value
Default
value
Conditions
Printer Setting (iOSPortName)
port
Data conforming to StarIO portName
The setting for "Printer" on the 'Configuration' screen.
Required, URL encoding is required
Description Conforms to StarIO (v2.2.3) portName specifications for iOS.
If communicating with the Bluetooth printer, it assigns the iAP Name of the
printer after "bt:".
If communicating with the Ethernet printer, it assigns the IP address after "tcp:".
If it is not specified, the setting for 'Printer' on the 'Configuration' screen is used.
If this is also not set, a communication test is performed with the first printer
found by StarIO with "bt:" set for "setting".
Error
-
26
Rev. 2.0.0
6. settings
Name
Variable
name
Variable
value
Default
value
Conditions
Printer Setting (Printer Type)
settings
Data conforming to StarIO portSettings
The setting for "Type" on the 'Configuration' screen
Required, URL encoding is required
Description Conforms to StarIO (v2.2.3) portSettings specifications for iOS.
Set according to the type of printer being communicated with: for Desktop types
(except BSC10), nothing (a blank entry) is set; for BSC10, "escpos;" for
Portable/mPOP types, "portable;" is set.
If it is not specified, the setting for 'Type' on the 'Configuration' screen is used. If
this is also not set, a communication test is performed with the first printer found
by StarIO with nothing (a blank entry) set for "port".
Error
-
7. timeout
Name
Variable
name
Variable
value
Default
value
Conditions
Printer Setting (Timeout)
timeout
Data conforming to StarIO timeout
10 seconds
Optional
Description Conforms to StarIO (v2.2.3) timeout specifications for iOS.
Used as the timeout value for waiting until a status change from the printer is
acquired, such as StarIO's internal getPort or begin/end CheckedBlock. If it is
not specified, or the setting is invalid, the default value will be set.
If a write timeout (fixed value of 60 seconds) occurs, an error is issued.
Error
This error occurs when the parameter is not set.
Code: 6
Text: ERROR_WRITE_FAILURE
Message: Timeout occurred while sending data
27
Rev. 2.0.0
8. back
Name
Variable
name
Variable
value
Default
value
Conditions
Callback URL scheme
back
URL scheme for the application performing the callback
Required, URL encoding is required
Description Used for callback (returning) to the specified application after printing completes.
When the callback is made, a query consisting of the printing result and any
error codes and messages is appended. Further details can be found later in this
manual.
Error
This error occurs when the parameter is not set.
Code: 2
Text: ERROR_INVALID_CALLBACK_DATA
Message: Callback parameter not set
28
Rev. 2.0.0
9. blackmark
Name
Blackmark settings (Enable/Disable)
Variable
blackmark
name
Variable
disable, enable, enablewithtopsearch, none,
value
Initial value Conditions
Optional, URL encoding is required
Description Blackmark settings are configured immediately before printing starts based on this
parameter. If it is not specified, or the setting was invalid, this query is ignored and it
continues the settings from immediately before printing.
The position of the sensor according to this setting is specified based on the settings
of the "bmposition" query.
Operations that correspond with each variable are as follows.
blackmark
Details
disable
Disables the blackmark setting
enable
Enables the blackmark setting
enablewithtopsearch
Enables the blackmark setting. Also detects the
blackmark position when printing after the power has
been turned on.
For models that do not support blackmark, these settings can all be ignored.
Blackmark supported SM-S210i / S220i / S230i, SM-T300i / T400i
models
SM-L200, TSP700II, TSP800II, FVP10
Blackmark
TSP650II, TSP100IIIBI / W / LAN, mPOP,BSC10
unsupported models
These settings are cleared when the printer is turned OFF. The host application
must be set appropriately.
If blackmark detection fails, an error (1) is issued.
Error (1)
An error if there is a blackmark detection failure
Code: 13
Character string: ERROR_BLACKMARK_DETECTION
Message: Black mark could not be detected
29
Rev. 2.0.0
10. bmposition
Name
Blackmark settings (Sensor position)
Variable
name
bmposition
Variable
value
surface, back, gaphole
Initial value
surface(Portable)
Conditions
Optional, URL encoding is required
Description Configures the settings of the blackmark detection sensor immediately before
printing starts based on this parameter.
Use as a set with the "blackmark" query (if there is no "blackmark", this setting is
disabled). If it is not specified, or the setting was invalid, the Portable printer is set as
"surface". The Desktop printer disables this setting, and always operates as "back".
Operations that correspond with each variable are as follows.
bmposition
surface
back
gaphole
SM-S210i
○
-
-
SM-S220i
○
-
-
SM-S230i
○
-
-
SM-L200
○
○
-
SM-T300i
○
-
-
SM-T400i
○
○
○
bmposition
surface
back
gaphole
TSP700II
-
○
-
TSP800II
-
○
-
FVP10
-
○
-
For models that do not support blackmark, these settings can all be ignored.
Blackmark
supported model
Blackmark
unsupported
models
SM-S210i / S220i / S230i, SM-L200, SM-T300i / T400i
TSP700II, TSP800II, FVP10
TSP650II, TSP100IIIBI / W / LAN, mPOP, BSC10
These settings are cleared when the printer is turned OFF. The host application
must be set appropriately.
If blackmark detection fails, an error (1) is issued.
Error (1)
An error if there is a blackmark detection failure
Code: 13
Character string: ERROR_BLACKMARK_DETECTION
Message: Black mark could not be detected
30
Rev. 2.0.0
11. popup
Name
Error detection pop-up settings (Enable/Disable)
Variable
popup
name
Variable
enable, disable
value
Initial value
enable
Conditions
Optional, URL encode is required
Description When errors are detected during the printing process, a pop-up displaying the error
status is displayed.
Use "enable/disable" to specify the settings of this display.
If it is not specified, or the setting is invalid, "enable" will be specified.
Error
-
31
Rev. 2.0.0
3-4
Error Codes
For errors that occur while PassPRNT is processing printing, the displayed codes and
messages for those errors are defined as shown below. The codes and messages are
appended to the query for the callback from PassPRNT. The host application can then
reference these values to determine the outcome of the printing. Reasons for printing failure
can also be determined. The variable name of the error code is "passprnt_code", and the
variable name of the error message is "passprnt_message".
The error code and message appended at the time of the callback is for the final result only.
For example, if at the beginning of printing, a no paper error occurred, but then reprinting is
selected and succeeds, only the "Success" judgment is notified.
An example of a callback URL scheme with an error code appended is shown below.
Example:
sampleapp://action?passprnt_code=0&passprnt_message=SUCCESS
Only when FileMakerGo (URL scheme "fmp://") is specified as the host application will "$"
be appended to the beginning of the variable names of error codes and error messages
from FileMakerGo specifications, and then be notified.
<Error List>
Text
Code
Message
0
SUCCESS
Success
1
ERROR_INVALID_PATH
Path is invalid
2
ERROR_INVALID_CALLBACK_DATA
Callback parameter not set
3
ERROR_INVALID_DATA_LENGTH
Print data has exceeded the upper limit
4
ERROR_GETPORT_FAILURE
Device connection error
5
ERROR_DEVICE_OFFLINE_BEGINCHECKEDBLOCK
The device is offline
6
ERROR_WRITE_FAILURE
Timeout occurred while sending data
7
ERROR_DEVICE_OFFLINE_ENDCHECKEDBLOCK
The device is offline
8
ERROR_PORTEXCEPTION
PORTEXCEPTION error
9
ERROR_INVALID_RECEIPT_DATA
No print data
13
ERROR_BLACKMARK_DETECTION
Black mark could not be detected
14
ERROR_NONSUPPORTED_FILEFORMAT
Non-compatible file format
32
Rev. 2.0.0
Error Code:
0
Code
0
Text
SUCCESS
Message
Printing succeeded
Description
This is issued when the printing operation is successful.
Pop-up message
-
Solution
-
Error Code:
1
Code
1
Text
ERROR_INVALID_PATH
Message
Path is invalid
Description
Issued when a path not conforming to standard values is
received.
This judgment is performed immediately after switching to
PassPRNT.
When an error occurs, subsequent processes are canceled, and
then a pop-up message is displayed while a notification
(callback) for this error is made to the host application.
Pop-up message
Path is invalid
Solution
Use the URL scheme to set a correct path.
Error Code:
2
Code
2
Text
ERROR_INVALID_CALLBACK_DATA
Message
Callback parameter not set
Description
Issued when the callback parameter is not set.
Since printing processes are prioritized, judgment is performed
when printing is completed (immediately before callback
processing).
If an error occurs, the PassPRNT Configuration screen is
opened, and an error pop-up message is displayed. Since the
callback destination is unclear, this error cannot be received by
the host application.
Pop-up message
Callback parameter not set
Solution
Set an URL-encoded value for the callback parameter.
33
Rev. 2.0.0
Error Code:
3
Code
3
Text
ERROR_INVALID_DATA_LENGTH
Message
Print data has exceeded the upper limit
Description
This error is issued when layout data greater than the standard
length (1 meter, or about 8,000 pixels) is sent.
This judgment is performed immediately after switching to
PassPRNT.
When an error occurs, subsequent processes are canceled, and
then a pop-up message is displayed while a notification
(callback) for this error is made to the host application.
Pop-up message
Print data has exceeded the upper limit
Solution
Set layout data less than 1 meter (8,000 pixels) in length.
Error Code:
4
Code
4
Text
ERROR_GETPORT_FAILURE
Message
Device connection error
Description
This error is issued when StarIO.getPort is executed using the
values for "port", "settings", and "timeout" or the setting on the
settings screen, and a failure occurs as a result.
This judgment is executed at the first stage of the printing
process.
If an error occurs, a pop-up message with buttons to retry or
cancel is displayed. If 'Cancel' is selected, subsequent
processes are canceled and a notification (callback) for this error
is made to the host application.
Pop-up message
Device connection error
Solution
・ Check that the printer's power is ON and pairing using
Bluetooth is set.
・ Select a printer correctly from the settings screen or with a
URL scheme (port, settings).
34
Rev. 2.0.0
Error Code:
5
Code
5
Text
ERROR_DEVICE_OFFLINE_BEGINCHECKEDBLOCK
Message
The device is offline
Description
This is issued when, in the step following success for
StarIO.getPort, the printer's status is offline.
This judgment is executed at the second stage of the printing
process (before printing data is sent).
If an error occurs, a pop-up message with buttons to retry or
cancel is displayed. If 'Cancel' is selected, subsequent
processes are canceled and a notification (callback) for this error
is made to the host application.
Pop-up message
<When cover is open>
The device is offline
Please close the cover
<When paper is out>
The device is offline
Please load paper
Solution
Error Code:
Check that the printer's power is ON and that it is not in an error
state.
6
Code
6
Text
ERROR_WRITE_FAILURE
Message
Timeout occurred while sending data
Description
This error is issued if StarIO.writeport continues for more than a
fixed time (*). However, the following processes as long as the
OS continues the write processing, and therefore this error may
not occur even if the fixed time is exceeded. In such cases, this
error will be issued if the OS has finished processing and the
write data still remains.
This judgment is executed at the third stage of the printing
process (while printing data is being sent).
If an error occurs, subsequent processes are canceled and a
notification (callback) for this error is made to the host
application.
* 60 seconds for Bluetooth and 150 seconds for BLE
communication.
Pop-up message
Timeout occurred while sending data
35
Rev. 2.0.0
Error Code:
7
Code
7
Text
ERROR_DEVICE_OFFLINE_ENDCHECKEDBLOCK
Message
The device is offline
Description
This is issued when, during printing completion monitoring, the
printer's status is offline.
This judgment is executed at the fourth stage of the printing
process (during printing until monitoring of printing completion).
If an error occurs, a pop-up message with buttons to retry or
cancel is displayed. If 'Cancel' is selected, subsequent
processes are canceled and a notification (callback) for this error
is made to the host application.
Pop-up message
<When cover is open>
The device is offline
Please close the cover
<When paper is out>
The device is offline
Please load paper
Solution
Check that the printer's power is ON and that it is not in an error
state.
Error Code:
8
Code
8
Text
ERROR_PORTEXCEPTION
Message
PORTEXCEPTION error
Description
Issued during a printing process.
When an error occurs, subsequent processes are canceled, and
then a pop-up message is displayed while a notification
(callback) for this error is made to the host application.
Pop-up message
PORTEXCEPTION error
Solution
Check that the printer's power is ON, that it is not in an error
state, and that pairing using Bluetooth is set.
36
Rev. 2.0.0
Error Code:
9
Code
9
Text
ERROR_INVALID_RECEIPT_DATA
Message
No print data
Description
Issued when the printing data is not set. However, an exception
is made if "drawer=ahead" or "drawer=after" is being executed at
the same time (for cases when there is no printing but the cash
drawer is opened).
This judgment is performed immediately after switching to
PassPRNT.
When an error occurs, subsequent processes are canceled, and
then a pop-up message is displayed while a notification
(callback) for this error is made to the host application.
Pop-up message
No print data
Solution
Set printing layout data using URL encoding to the URL scheme.
Error code: 13
Code
13
Character string
ERROR_BLACKMARK_DETECTION
Message
Black mark could not be detected
Description
In monitoring of printing completion, the printer status is issued to
be a blackmark detection error.
This judgment is executed at the fourth stage of the printing
process (during printing to monitoring of printing completion).
If an error occurs, a pop-up message with buttons to retry or cancel
is displayed. If ‘Cancel’ is selected, subsequent processes are
canceled and a notification (callback) for this error is made to the
host application.
Pop-up message
Black mark could not be detected
Resolution
Check that the blackmark paper is set correctly.
37
Rev. 2.0.0
Error code: 14
Code
14
Character string
ERROR_NONSUPPORTED_FILEFORMAT
Message
Non-compatible file format
Description
This message is issued when an unspecified data format has been
sent.
A judgment is executed immediately after the PassPRNT switches.
When an error occurs, subsequent processes are canceled, and
then a pop-up message is displayed while a notification (callback)
for this error is made to the host application.
Pop-up message
Non-compatible file format
Resolution
Check that the supported format of the data is set.
38
Rev. 2.0.0
4. Terminology
The following is a description of the words used frequently in these specifications.
Term
URL scheme
Path
Query
URL encoding
Base64
Meaning/explanation
Abbreviation
A text string that describes the location and attributes of
contents on a network. In an iOS application, it is used
to start or enable access to a specified application.
Also, by appended paths or queries, further detailed
instructions or the transfer of data can be performed.
Example:
sample://path/?q=xxx
URL scheme: sample://
Path: path/
Query: q=xxx
This is the text string used for defining the contents at
the end of the URL scheme.
This is the text string following "?" used for defining
contents. "=" marks are inserted between a variable
name and its variable value. Multiple definitions can be
made by linking them with "&" marks.
This is the conversion of text such as
"http://www.star-m.jp//" into
"http://%3A%2F%2Fwww.star-m.jp%2F". This is also
referred to as percent-encoding.
The reverse of this conversion is called "URL
decoding".
The reason URL encoding is required is that the letters
used in URLs are fixed, so a conversion method
specified in RFC is used.
In PassPRNT version 1.0, encoding compliant with
RFC3986 is required.
In PassPRNT, encoding compliant with RFC3986 is
required.
This is an encoding format that is used to handle
multi-byte characters and binary data in environments
that cannot handle other characters using 64 types
(A-Z, a-z, 0-9, +, /) of printable alphanumeric
characters. In addition to the 64 types, "=" is used to fill
(padding) the extra spaces. Through this conversion,
the amount of data is 4/3 (133%). For the MIME
standard, because a newline code is included in each
76 characters, 2 bytes are added for this lot, and the
amount of data becomes approximately 137%.
39
URL: http://www.starmicronics.com/support/