3.2. StarPrinterStatus
Class to hold the printer status.
Member |
Contents |
Type |
Detail |
Library version |
---|---|---|---|---|
paperDetectionError |
Paper Detection Error |
SM_BOOLEAN |
SM_TRUE … No paper separator is detected. SM_FALSE … Paper separator is detected correctly. | 2.8.0+ |
compulsionSwitch |
Compulsion SW |
SM_BOOLEAN |
You can check status of Cash Drawer (Open or Close). SM_TRUE … Compulsion SW is pressed. SM_FALSE … Compulsion SW is not pressed. | 2.2.3+ |
coverOpen |
Cover Status |
SM_BOOLEAN |
You can check status of Cover. SM_TRUE … Cover is opened. SM_FALSE … Cover is closed. | 2.2.3+ |
cutterError |
Auto-cutter Error |
SM_BOOLEAN |
You can check status of Cutter. SM_TRUE … Cutter error occurs. SM_FALSE … Cutter error does not occur. | 2.2.3+ |
etbAvailable |
ETB available or not |
SM_BOOLEAN |
SM_TRUE … available to use. SM_FALSE … not available to use. | 2.2.3+ |
etbCounter |
ETB Counter |
UCHAR |
You can get current value of ETB. | 2.2.3+ |
headThermistorError |
Head Thermistor Error |
SM_BOOLEAN |
You can check status of Head Thermistor. SM_TRUE … Head thermistor detects an abnormal value. SM_FALSE … Head thermistor does not detect an abnormal value. | 2.2.3+ |
offline |
ONLINE/OFFLINE Status |
SM_BOOLEAN |
You can check status of Online or offline. SM_TRUE … Printer is Offline. SM_FALSE … Printer is Online | 2.2.3+ |
overTemp |
Stopped by high head temperature |
SM_BOOLEAN |
SM_TRUE … Printer is stopped by head temperature. SM_FALSE … Printer is not stopped by head temperature. | 2.2.3+ |
jamError |
Paper Jam Error |
SM_BOOLEAN |
SM_TRUE … Paper jam is detected. SM_FALSE … Paper jam is not detected. | 2.8.0+ |
raw |
Byte column of status |
UCHAR[63] |
Byte column of status | 2.2.3+ |
rawLength |
raw length |
CHAR |
raw length | 2.2.3+ |
rollPositionError |
Roll Position Error |
SM_BOOLEAN |
SM_TRUE … The loaded paper roll has fallen from the paper guide shaft. SM_FALSE … Roll paper is correctly set in the paper guide shaft. | 2.10.0+ |
receiptPaperEmpty |
Paper end |
SM_BOOLEAN |
SM_TRUE … Paper end. SM_FALSE … Paper does not end. | 2.2.3+ |
receiptPaperNearEmptyInner |
Paper Near-end (Inner Side) |
SM_BOOLEAN |
SM_TRUE … Paper near-end. SM_FALSE … Paper does not near-end. | 2.2.3+ |
receiveBufferOverflow |
Receive Buffer Overflow |
SM_BOOLEAN |
You can check status of received Buffer. SM_TRUE … Received buffer is full. SM_FALSE … Received buffer is not full. | 2.2.3+ |
unrecoverableError |
Non-recoverable Error |
SM_BOOLEAN |
SM_TRUE … Unrecoverable error occurs.
SM_FALSE … Unrecoverable error does not occur.
Unrecoverable error : Head Thermistor Error, Auto-cutter Error, Electric Voltage Error and etc.
| 2.2.3+ |
voltageError |
Electric Voltage Error |
SM_BOOLEAN |
SM_TRUE … Printers detects an abnormal power supply voltage. SM_FALSE … Printers does not detect an abnormal power supply voltage. | 2.2.3+ |
connectedInterface |
Type of interface that is currently connected |
UCHAR |
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.0+ |
paperPresent |
Hold print status |
SM_BOOLEAN |
SM_TRUE … Holding paper.
SM_FALSE … Does not holding paper.
| 2.8.0+ |
drawer1OpenedMethod |
Cash Drawer 1 Opened Method |
UCHAR |
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.10.0+ |
drawer1OpenCloseSignal |
Cash Drawer 1 Open/Close Signal |
SM_BOOLEAN |
You can check open/close signal status for the Cash Drawer 1. SM_TRUE or SM_FALSE
| 2.10.0+ |
drawer2OpenedMethod |
Cash Drawer 2 Opened Method |
UCHAR |
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.10.0+ |
drawer2OpenCloseSignal |
Cash Drawer 2 Open/Close Signal |
SM_BOOLEAN |
You can check open/close signal status for the Cash Drawer 2. SM_TRUE or SM_FALSE
| 2.10.0+ |
externalDevice1Connected |
External Device Channel1 Connection Status |
SM_BOOLEAN |
You can check whether Cash Drawer or Buzzer is connected to the External Device Channel1
SM_TRUE : Connected.
SM_FALSE : Not Connected.
| 2.10.0+ |
externalDevice2Connected |
External Device Channel2 Connection Status |
SM_BOOLEAN |
You can check whether Cash Drawer or Buzzer is connected to the External Device Channel2
SM_TRUE : Connected.
SM_FALSE : Not Connected.
| 2.10.0+ |
partsReplacementNotification |
Parts Replacement Notification |
SM_BOOLEAN |
This is to inform you of the approximate timing of parts replacement.
SM_TRUE : The time to replace parts has been reached.
SM_FALSE : The estimated time for parts replacement has not been reached.
| 2.10.0+ |
cleaningNotification |
Cleaning Notification |
SM_BOOLEAN |
Notification of periodic cleaning schedule.
SM_TRUE : Periodic cleaning time.
SM_FALSE : This is not periodic cleaning time.
| 2.10.0+ |
detectedPaperWidth |
Detected Paper Width |
UCHAR |
You can check the width of the paper loaded in the printer.
Please refer to StarPRNT command manual for details of Automatic Status.
| 2.10.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] | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - |
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. |