3.2. StarPrinterStatus

Class to hold the printer status.

Member

Contents

Type

Detail

Library version

paperDetectionError

Paper Detection Error

boolean

true … No paper separator is detected. false … Paper separator is detected correctly.

2.7.0+

compulsionSwitch

Compulsion SW

boolean

You can check status of Cash Drawer (Open or Close). true … Compulsion SW is pressed. false … Compulsion SW is not pressed.

2.2.0+

coverOpen

Cover Status

boolean

You can check status of Cover. true … Cover is opened. false … Cover is closed.

2.2.0+

cutterError

Auto-cutter Error

boolean

You can check status of Cutter. true … Cutter error occurs. false … Cutter error does not occur.

2.2.0+

etbAvailable

ETB available or not

boolean

true … available to use. false … not available to use.

2.2.0+

etbCounter

ETB Counter

int

You can get current value of ETB.

2.2.0+

headThermistorError

Head Thermistor Error

boolean

You can check status of Head Thermistor. true … Head thermistor detects an abnormal value. false … Head thermistor does not detect an abnormal value.

2.2.0+

offline

ONLINE/OFFLINE Status

boolean

You can check status of Online or offline. true … Printer is Offline. false … Printer is Online

2.2.0+

overTemp

Stopped by high head temperature

boolean

true … Printer is stopped by head temperature. false … Printer is not stopped by head temperature.

2.2.0+

jamError

Paper Jam Error

boolean

true … Paper jam is detected. false … Paper jam is not detected.

2.7.0+

presenterState

Presenter Paper Position

int
You can check status of Presenter.
0 : State where there is no paper in presenter
1 : State where paper is supplied (loop state)
3 : State where paper is discharged (Can be pulled out)
6 : State where paper is recovered
7 : State where paper is pulled out
2.6.0+

raw

Byte column of status

byte[]

Byte column of status

2.2.0+

rawLength

raw length

int

raw length

2.2.0+

rollPositionError

Roll Position Error

boolean

true … The loaded paper roll has fallen from the paper guide shaft. false … Roll paper is correctly set in the paper guide shaft.

2.11.0+

receiptPaperEmpty

Paper end

boolean

true … Paper end. false … Paper does not end.

2.2.0+

receiptPaperNearEmptyInner

Paper Near-end (Inner Side)

boolean

true … Paper near-end. false … Paper does not near-end.

2.2.0+

receiveBufferOverflow

Receive Buffer Overflow

boolean

You can check status of received Buffer. true … Received buffer is full. false … Received buffer is not full.

2.2.0+

unrecoverableError

Non-recoverable Error

boolean
true … Unrecoverable error occurs. false … Unrecoverable error does not occur.
Unrecoverable error : Head Thermistor Error, Auto-cutter Error, Electric Voltage Error and etc.
2.2.0+

voltageError

Electric Voltage Error

boolean

true … Printers detects an abnormal power supply voltage. false … Printers does not detect an abnormal power supply voltage.

2.2.0+

connectedInterface

Type of interface that is currently connected

int
You can check type of interface that is currently connected.
0: USB-B
1, 7: USB(iOS)
2: Bluetooth
3: Ethernet
4: USB-C(USB PD support)
5: USB-C(USB PD not support)
6: USB-A(Android)
20: Wireless LAN
2.13.0+

paperPresent

Hold print status

boolean
true … Holding paper. false … Does not holding paper.
2.7.0+

drawer1OpenedMethod

Cash Drawer 1 Opened Method

int
Indicates the cause by which method Cash Drawer 1 was opened.
Please confirm the open/close polarity of the Cash Drawer to be used with drawer1OpenCloseSignal before use.
0: Open Cash Drawer by hand
1: Open Cash Drawer by command
2.11.0+

drawer1OpenCloseSignal

Cash Drawer 1 Open/Close Signal

boolean
You can check open/close signal status for the Cash Drawer 1. true or false
2.11.0+

drawer2OpenedMethod

Cash Drawer 2 Opened Method

int
Indicates the cause by which method Cash Drawer 2 was opened.
Please confirm the open/close polarity of the Cash Drawer to be used with drawer2OpenCloseSignal before use.
0: Open Cash Drawer by hand
1: Open Cash Drawer by command
2.11.0+

drawer2OpenCloseSignal

Cash Drawer 2 Open/Close Signal

boolean
You can check open/close signal status for the Cash Drawer 2. true or false
2.11.0+

externalDevice1Connected

External Device Channel1 Connection Status

boolean
You can check whether Cash Drawer or Buzzer is connected to the External Device Channel1
true : Connected.
false : Not Connected.
2.11.0+

externalDevice2Connected

External Device Channel2 Connection Status

boolean
You can check whether Cash Drawer or Buzzer is connected to the External Device Channel2
true : Connected.
false : Not Connected.
2.11.0+

partsReplacementNotification

Parts Replacement Notification

boolean
This is to inform you of the approximate timing of parts replacement.
true : The time to replace parts has been reached.
false : The estimated time for parts replacement has not been reached.
2.11.0+

cleaningNotification

Cleaning Notification

boolean
Notification of periodic cleaning schedule.
true : Periodic cleaning time.
false : This is not periodic cleaning time.
2.11.0+

detectedPaperWidth

Detected Paper Width

int
You can check the width of the paper loaded in the printer.
Please refer to StarPRNT command manual for details of Automatic Status.
2.11.0+

Note

Members not listed in this table are not currently supported.

Supported member for each model.

Model/Emulation

 mC-Print2 mC-Print3 mC-Label3 mPOP FVP10 TSP100IV TSP100IV SK TSP100IIIW TSP100IIIBITSP100IIIU TSP100IIU+ TSP100ECO TSP100U TSP100GTTSP100LAN TSP650II TSP650IISK TSP700II TSP800IITUP500SM-S210i SM-S220i SM-S230i SM-T300i/T300 SM-T400i BSC10II BSC10 SM-L200 SM-L300 SP700SK1-211/221/V211 SK1-211/221/V211 Presenter SK1-311/321/V311 SK1-311/V311 Presenter
StarPRNT StarPRNT StarPRNT StarPRNT StarLine StarPRNT StarPRNT StarGraphic StarGraphic StarGraphic StarGraphic StarGraphic StarGraphic StarGraphic StarGraphic StarLine StarLine StarLine StarLine StarLine StarPRNT EscPosMobile StarPRNT EscPosMobile StarPRNT EscPosMobile StarPRNT EscPosMobile StarPRNT EscPosMobile StarPRNT EscPos StarPRNT StarPRNT StarDotImpact StarPRNT StarPRNT StarPRNT StarPRNT

paperDetectionError

 - - ✔ - ✔ - - - - - - - - - - - - ✔ ✔ ✔ ✔ - ✔ - ✔ - ✔ - ✔ - - - ✔ ✔ ✔ ✔ ✔ ✔ ✔

compulsionSwitch

 ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ - - - - - - - - - - - ✔ ✔ - - ✔ - - - -

coverOpen

 ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔

cutterError

 ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ - - - - - - - - - - ✔ - - - ✔ ✔ ✔ ✔ ✔

etbAvailable

 ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ - ✔ - ✔ - ✔ - ✔ - ✔ - ✔ ✔ ✔ ✔ ✔ ✔ ✔

etbCounter

 ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ - ✔ - ✔ - ✔ - ✔ - ✔ - ✔ ✔ ✔ ✔ ✔ ✔ ✔

headThermistorError

 ✔ ✔ ✔ ✔ - ✔ ✔ - - - - - - - - - - - - ✔ - - - - - - - - - - ✔ - - - - ✔ ✔ ✔ ✔

offline

 ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔

overTemp

 ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ - ✔ - ✔ - ✔ - ✔ - ✔ - ✔ ✔ ✔ ✔ ✔ ✔ ✔

jamError

 - - ✔ - - - ✔[5] - - - - - - - - - - - - ✔ - - - - - - - - - - - - - - - ✔ ✔ ✔ ✔

presenterState

 - - - - - - - - - - - - - - - - - - - ✔ - - - - - - - - - - - - - - - - ✔ - ✔

raw

 ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ - ✔ ✔ ✔ ✔ ✔ ✔ ✔

rawLength

 ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ - ✔ ✔ ✔ ✔ ✔ ✔ ✔

rollPositionError

 - - ✔ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

receiptPaperEmpty

 ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔

receiptPaperNearEmptyInner

 - ✔[1] - - ✔ - - - - - - - - - - ✔ - ✔ ✔ ✔ - - - - - - - - - - - - - - ✔ ✔ ✔ ✔ ✔

receiveBufferOverflow

 - - - - ✔ - - - - - - - - - - ✔ ✔ ✔ ✔ ✔ - - - - - - - - - - - - - - ✔ ✔ ✔ ✔ ✔

unrecoverableError

 ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ - - - - - - - - - - ✔ - - - ✔ ✔ ✔ ✔ ✔

voltageError

 ✔ ✔ ✔ ✔ - ✔ ✔ - - - - - - - - - - - - ✔ - - - - - - - - - - ✔ - - - - ✔ ✔ ✔ ✔

connectedInterface

 ✔ ✔ ✔ - - ✔ ✔ - - - - - - - - - - - - - - - - - - - - - - - ✔ - - - - - - - -

paperPresent

 - - ✔ - - - ✔ - - - - - - - - - ✔ - - - - - - - - - - - - - - - - - - ✔ - ✔ -

drawer1OpenedMethod

 - ✔[2][4] ✔[2] - - ✔[2] ✔[2] - - - - - - - - - - - - - - - - - - - - - - - ✔[2] - - - - - - - -

drawer1OpenCloseSignal

 - ✔[3][4] ✔[3] - - ✔[3] ✔[3] - - - - - - - - - - - - - - - - - - - - - - - ✔[3] - - - - - - - -

drawer2OpenedMethod

 - ✔[2][4] ✔[2] - - ✔[2] ✔[2] - - - - - - - - - - - - - - - - - - - - - - - ✔[2] - - - - - - - -

drawer2OpenCloseSignal

 - ✔[3][4] ✔[3] - - ✔[3] ✔[3] - - - - - - - - - - - - - - - - - - - - - - - ✔[3] - - - - - - - -

externalDevice1Connected

 - ✔[4] ✔ - - ✔ ✔ - - - - - - - - - - - - - - - - - - - - - - - ✔ - - - - - - - -

externalDevice2Connected

 - ✔[4] ✔ - - ✔ ✔ - - - - - - - - - - - - - - - - - - - - - - - ✔ - - - - - - - -

partsReplacementNotification

 - - ✔ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

cleaningNotification

 - - ✔ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

detectedPaperWidth

 - - ✔ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
[1]

MCP30 is not supported
[2]

drawer1OpenedMethod and drawer2OpenedMethod always have the same value.
[3]

drawer1OpenCloseSignal and drawer2OpenCloseSignal always have the same value.
[4]

Only available for MCP31CI, MCP31CBI.
[5]

F/W Version 2.1 or later is required.