1. TOP»
  2. Epson ePOS SDK for iOS »
  3. Epos2Printer class »
  4. getStatus

Select your printer model

Parameters are refined by the selected printer.

getStatus

Acquires the current status information.

Syntax

 
 
- (Epos2PrinterStatusInfo *)getStatus;

Return value

The current status is returned in the Epos2PrinterStatusInfo type.
The following status information is stored in the object as a member.

Printer status

Status

Description

connection:
Connection status

EPOS2_TRUE

Connected

EPOS2_FALSE

Status is unknown.

online:
Online status

EPOS2_TRUE

Online

EPOS2_FALSE

Offline

EPOS2_UNKNOWN

Status is unknown.

coverOpen:
Cover status

EPOS2_TRUE

Cover is open.

EPOS2_FALSE

Cover is closed.

EPOS2_UNKNOWN

Status is unknown.

paper:
Paper status

EPOS2_PAPER_OK

Paper remains.

EPOS2_PAPER_NEAR_END

Paper is running out.

EPOS2_PAPER_EMPTY

Paper has run out.

EPOS2_UNKNOWN

Status is unknown.

paperFeed:
Paper feed

EPOS2_TRUE

Paper feed in progress

EPOS2_FALSE

Stopped

EPOS2_UNKNOWN

Status is unknown.

panelSwitch:
Panel switch (Feed button) status

EPOS2_SWITCH_ON

Pressed

EPOS2_SWITCH_OFF

Not pressed

EPOS2_UNKNOWN

Status is unknown.

drawer:
Offline status due to the battery level (Mobile models)

EPOS2_DRAWER_HIGH

High

EPOS2_DRAWER_LOW

Low

EPOS2_UNKNOWN

Status is unknown.

drawer:
Drawer kick connector pin No.3 status (except for the Mobile models)

EPOS2_DRAWER_HIGH

High

EPOS2_DRAWER_LOW

Low

EPOS2_UNKNOWN

Status is unknown.

errorStatus:
Error status

EPOS2_NO_ERR

Normal

EPOS2_MECHANICAL_ERR

Mechanical error occurred.

EPOS2_AUTOCUTTER_ERR

Auto cutter error occurred.

EPOS2_UNRECOVER_ERR

Unrecoverable error occurred.

EPOS2_AUTORECOVER_ERR

Automatic recovery error occurred.

EPOS2_UNKNOWN

Status is unknown.

autoRecoverError:
Automatic recovery error status

EPOS2_HEAD_OVERHEAT

Head overheat error

EPOS2_MOTOR_OVERHEAT

Motor driver IC overheat error

EPOS2_BATTERY_OVERHEAT

Battery overheat error

EPOS2_WRONG_PAPER

Paper error

EPOS2_COVER_OPEN

Cover is open.

EPOS2_UNKNOWN

Unknown status

buzzer:
Buzzer sound status

EPOS2_TRUE

Sounding (Applicable printer only)

EPOS2_FALSE

Stopped (Applicable printer only)

EPOS2_UNKNOWN

Status is unknown.

adapter:
AC adapter connection status

EPOS2_TRUE

Connected

EPOS2_FALSE

Disconnected

EPOS2_UNKNOWN

Status is unknown.

batteryLevel:
Remaining battery capacity

EPOS2_BATTERY_LEVEL_6

Remaining battery capacity 6

EPOS2_BATTERY_LEVEL_5

Remaining battery capacity 5

EPOS2_BATTERY_LEVEL_4

Remaining battery capacity 4

EPOS2_BATTERY_LEVEL_3

Remaining battery capacity 3

EPOS2_BATTERY_LEVEL_2

Remaining battery capacity 2

EPOS2_BATTERY_LEVEL_1

Remaining battery capacity 1 (almost run out)

EPOS2_BATTERY_LEVEL_0

Remaining battery capacity 0 (run out)

EPOS2_UNKNOWN

Status is unknown.

removalWaiting:
Paper removal wait status

EPOS2_REMOVAL_WAIT_PAPER

Waiting for removal.

EPOS2_REMOVAL_WAIT_NONE

Not waiting for removal.

EPOS2_UNKNOWN

Status is unknown.

paperTakenSensor:
Paper removal sensor status

EPOS2_REMOVAL_DETECT_PAPER

The paper removal sensor is detecting paper.

EPOS2_REMOVAL_DETECT_PAPER_NONE

The paper removal sensor is not detecting paper.

EPOS2_REMOVAL_DETECT_UNKNOWN

A state that is not detectable by the paper removal sensor.

EPOS2_UNKNOWN

Status is unknown.

unrecoverError:
Unrecoverable error status

EPOS2_HIGH_VOLTAGE_ERR

High voltage error

EPOS2_LOW_VOLTAGE_ERR

Low voltage error

EPOS2_UNKNOWN

Status is unknown.

Supplementary explanation

  • This API is not executed on the main thread. Execute it on the sub-thread.
  • If this API is called while communication is not available, printer states other than "connection" will be set to "EPOS2_UNKNOWN."
  • The status object is set to the status at the timing of execution of this API and will not be updated.
  • If this function is executed within a callback function, nil will be returned.
  • To get the "adapter" or "batteryLevel" status, you need to enable transmission of power on/off and battery status using Epson TM Utility.
  • To get the "paperTakenSensor" status, you need to enable the "Paper Taken Sensor Status" setting using Epson TM Utility.
 

Quick Access

  • [Name]
  • [Format]
  • [Range]
  • [Description]
  • [Notes]
Epson ePOS SDK includes patented or patent pending functions. The contents must not be disclosed to third parties.


Epson ePOS SDK for iOS

  1. TOP»
  2. Epson ePOS SDK for iOS »
  3. Epos2Printer class »
  4. getStatus

Jump to the top