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

Select your printer model

Parameters are refined by the selected printer.

getPrinterInformation

Acquires the printer serial number and the missing dot information of the thermal head.

The value acquired by this API is notified to the callback method specified in the delegate parameter.

Syntax

 
 
- (int) getPrinterInformation:(long)timeout delegate:(id<Epos2PrinterInformationDelegate>)delegate;

Parameter

timeout

Specifies the timeout period before completion of command transmission in milliseconds.

Value

Description

Integer from 5000 to 60000

Timeout period (in milliseconds)

EPOS2_PARAM_DEFAULT

Specifies the default value (30000).

delegate

Registers the callback method that returns the processing result of this API.

 
 
- (void) onGetPrinterInformation:(int)code jsonString:(NSString *)jsonString;
  • code
    The processing result is stored.

  • Error status

    Description

    EPOS2_CODE_SUCCESS

    Successful

    EPOS2_CODE_ERR_PARAM

    An invalid parameter was passed.

    EPOS2_CODE_ERR_MEMORY

    Sufficient memory required for processing could not be allocated.

    EPOS2_CODE_ERR_TIMEOUT

    Failed to communicate with the devices within the specified time.

    EPOS2_CODE_ERR_PROCESSING

    Could not run the process.

    EPOS2_CODE_ERR_ILLEGAL

    This API was called while no communication had been started.

    EPOS2_CODE_ERR_FAILURE

    An unknown error occurred.

    EPOS2_CODE_ERR_DEVICE_BUSY

    Could not run the process because the printer is operating.
  • jsonString
    The acquired printer information is stored in the JSON format.

Return value

Error status

Description

EPOS2_SUCCESS

The function was executed successfully.

EPOS2_ERR_PARAM

An invalid parameter was passed.

EPOS2_ERR_ILLEGAL

This API was called while no communication had been started.

EPOS2_ERR_FAILURE

An unknown error occurred.

jsonString

Example of acquisition execution result

 
 
{
	"PrinterSpec": {
		"Product": {
			"SerialNo": "ABC1234567"
		}
	},
	"Maintenance": {
		"ThermalHead": {
			"NumberOfWarningDot": "0",
			"PositionOfWarningDot": "",
			"NumberOfBrokenDot": "0",
			"PositionOfBrokenDot": ""
		}
	}
}

SerialNo

Value

Description

String

Printer serial number

NumberOfWarningDot

The number of dots exceeding the Warning threshold value of the thermal head is stored.

Value

Description

-1

Failed to detect missing dots.

0

No dots exceeding the Warning threshold value.

Integer from 1 to 512

Number of dots exceeding the Warning threshold value.

PositionOfWarningDot

If there are dots exceeding the Warning threshold value of the thermal head, a 128-byte hexadecimal string is stored.

In this hexadecimal string, the position of the left-end dots on the print surface is treated as the most significant bit, and the position of the dots exceeding the Warning threshold value is treated as bit 1.

Value

Description

"" (Blank character)

Failed to detect missing dots.

Alternatively, there are no dots exceeding the Warning threshold value.

Hexadecimal string

Most significant bit: Position of the left-end dots on the print surface

bit 1: Position of the dots exceeding the Warning threshold value.

NumberOfBrokenDot

The number of dots exceeding the Fault threshold value of the thermal head is stored.

Value

Description

-1

Failed to detect missing dots.

0

No dots exceeding the Fault threshold value.

Integer from 1 to 512

Number of dots exceeding the Fault threshold value.

PositionOfBrokenDot

If there are dots exceeding the Fault threshold value of the thermal head, a 128-byte hexadecimal string is stored.

In this hexadecimal string, the position of the left-end dots on the print surface is treated as the most significant bit, and the position of the dots exceeding the Fault threshold value is treated as bit 1.

Value

Description

"" (Blank character)

Failed to detect missing dots.

Alternatively, there are no dots exceeding the Fault threshold value.

Hexadecimal string

Most significant bit: Position of the left-end dots on the print surface

bit 1: Position of the dots exceeding the Fault threshold value.

Supplementary explanation

  • This API cannot be used simultaneously with other APIs.
    After executing this API, do not execute any other API until the callback is returned.
  • This API can be used in the system configuration of the TM printer model and customer display model.
    With the system configuration of the TM printer + DM-D + barcode scanner model, this API can be used when connecting via Bluetooth and USB.
  • This API cannot be used with SSL/TLS communication.
  • When this API is used with the system configuration of a POS terminal model and TM printer + DM-D + barcode scanner model (Wi-Fi/Ethernet connection), EPOS2_ERR_FAILURE is returned in the return value.
  • If this API is executed in a non-supported printer, "" (Blank character) is stored in jsonString.
  • It may take some time to acquire printer information depending on the printer used or the connection method with the printer.
 

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. getPrinterInformation

Jump to the top