3.4. StarPrinterStatus
Class to hold the printer status.
Member |
Contents |
Type |
Detail |
Library version |
---|---|---|---|---|
PaperDetectionError |
Paper Detection Error |
bool |
true … No paper separator is detected. false … Paper separator is detected correctly. | 2.7.0+ |
CompulsionSwitch |
Compulsion SW |
bool |
You can check status of Cash Drawer (Open or Close). true … Compulsion SW is pressed. false … Compulsion SW is not pressed. | 2.3.0+ |
CoverOpen |
Cover Status |
bool |
You can check status of Cover. true … Cover is opened. false … Cover is closed. | 2.3.0+ |
CutterError |
Auto-cutter Error |
bool |
You can check status of Cutter. true … Cutter error occurs. false … Cutter error does not occur. | 2.3.0+ |
EtbAvailable |
ETB available or not |
bool |
true … available to use. false … not available to use. | 2.3.0+ |
EtbCounter |
ETB Counter |
byte |
You can get current value of ETB. | 2.3.0+ |
HeadThermistorError |
Head Thermistor Error |
bool |
You can check status of Head Thermistor. true … Head thermistor detects an abnormal value. false … Head thermistor does not detect an abnormal value. | 2.3.0+ |
Offline |
ONLINE/OFFLINE Status |
bool |
You can check status of Online or offline. true … Printer is Offline. false … Printer is Online | 2.3.0+ |
OverTemp |
Stopped by high head temperature |
bool |
true … Printer is stopped by head temperature. false … Printer is not stopped by head temperature. | 2.3.0+ |
JamError |
Paper Jam Error |
bool |
true … Paper jam is detected. false … Paper jam is not detected. | 2.6.0+ |
RawStatus |
Byte column of status |
byte[] |
Byte column of status | 2.3.0+ |
RollPositionError |
Roll Position Error |
bool |
true … The loaded paper roll has fallen from the paper guide shaft. false … Roll paper is correctly set in the paper guide shaft. | 2.9.0+ |
ReceiptPaperEmpty |
Paper end |
bool |
true … Paper end. false … Paper does not end. | 2.3.0+ |
ReceiptPaperNearEmptyInner |
Paper Near-end (Inner Side) |
bool |
true … Paper near-end. false … Paper does not near-end. | 2.3.0+ |
ReceiveBufferOverflow |
Receive Buffer Overflow |
bool |
You can check status of received Buffer. true … Received buffer is full. false … Received buffer is not full. | 2.3.0+ |
UnrecoverableError |
Non-recoverable Error |
bool |
true … Unrecoverable error occurs.
false … Unrecoverable error does not occur.
Unrecoverable error : Head Thermistor Error, Auto-cutter Error, Electric Voltage Error and etc.
| 2.3.0+ |
VoltageError |
Electric Voltage Error |
bool |
true … Printers detects an abnormal power supply voltage. false … Printers does not detect an abnormal power supply voltage. | 2.3.0+ |
ConnectedInterface |
Type of interface that is currently connected |
byte |
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)
| 2.4.1+ |
PaperPresent |
Hold print status |
bool |
true … Holding paper.
false … Does not holding paper.
| 2.7.0+ |
Drawer1OpenedMethod |
Cash Drawer 1 Opened Method |
byte |
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.9.0+ |
Drawer1OpenCloseSignal |
Cash Drawer 1 Open/Close Signal |
bool |
You can check open/close signal status for the Cash Drawer 1. true or false
| 2.9.0+ |
Drawer2OpenedMethod |
Cash Drawer 2 Opened Method |
byte |
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.9.0+ |
Drawer2OpenCloseSignal |
Cash Drawer 2 Open/Close Signal |
bool |
You can check open/close signal status for the Cash Drawer 2. true or false
| 2.9.0+ |
ExternalDevice1Connected |
External Device Channel1 Connection Status |
bool |
You can check whether Cash Drawer or Buzzer is connected to the External Device Channel1
true : Connected.
false : Not Connected.
| 2.9.0+ |
ExternalDevice2Connected |
External Device Channel2 Connection Status |
bool |
You can check whether Cash Drawer or Buzzer is connected to the External Device Channel2
true : Connected.
false : Not Connected.
| 2.9.0+ |
PartsReplacementNotification |
Parts Replacement Notification |
bool |
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.9.0+ |
CleaningNotification |
Cleaning Notification |
bool |
Notification of periodic cleaning schedule.
true : Periodic cleaning time.
false : This is not periodic cleaning time.
| 2.9.0+ |
DetectedPaperWidth |
Detected Paper Width |
byte |
You can check the width of the paper loaded in the printer.
Please refer to StarPRNT command manual for details of Automatic Status.
| 2.9.0+ |
Supported member for each model.
Model/Emulation |
mC-Print2 | mC-Print3 | mC-Label3 | mPOP | FVP10 | TSP100IV | TSP100IV SK | TSP100IIIW | TSP100IIIBI | TSP100IIIU | TSP100IIU+ | TSP100ECO | TSP100U | TSP100GT | TSP100LAN | TSP650II | TSP650IISK | TSP700II | TSP800II | SM-S210i | SM-S220i | SM-S230i | SM-T300i/T300 | SM-T400i | BSC10II | BSC10 | SM-L200 | SM-L300 | SP700 | |||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
StarPRNT | StarPRNT | StarPRNT | StarPRNT | StarLine | StarPRNT | StarPRNT | StarGraphic | StarGraphic | StarGraphic | StarGraphic | StarGraphic | StarGraphic | StarGraphic | StarGraphic | StarLine | StarLine | StarLine | StarLine | StarPRNT | EscPosMobile | StarPRNT | EscPosMobile | StarPRNT | EscPosMobile | StarPRNT | EscPosMobile | StarPRNT | EscPosMobile | StarPRNT | EscPos | StarPRNT | StarPRNT | StarDotImpact | |
PaperDetectionError |
- | - | ✔ | - | ✔ | - | - | - | - | - | - | - | - | - | - | - | - | ✔ | ✔ | ✔ | - | ✔ | - | ✔ | - | ✔ | - | ✔ | - | - | - | ✔ | ✔ | ✔ |
CompulsionSwitch |
✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | - | - | - | - | - | - | - | - | - | - | ✔ | ✔ | - | - | ✔ |
CoverOpen |
✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
CutterError |
✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | - | - | - | - | - | - | - | - | - | - | ✔ | - | - | - | ✔ |
EtbAvailable |
✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | - | ✔ | - | ✔ | - | ✔ | - | ✔ | - | ✔ | - | ✔ | ✔ | ✔ |
EtbCounter |
✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | - | ✔ | - | ✔ | - | ✔ | - | ✔ | - | ✔ | - | ✔ | ✔ | ✔ |
HeadThermistorError |
✔ | ✔ | ✔ | ✔ | - | ✔ | ✔ | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✔ | - | - | - | - |
Offline |
✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
OverTemp |
✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | - | ✔ | - | ✔ | - | ✔ | - | ✔ | - | ✔ | - | ✔ | ✔ | ✔ |
JamError |
- | - | ✔ | - | - | - | ✔[5] | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - |
RawStatus |
✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | - | ✔ | ✔ | ✔ |
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. |