Select your printer model

Parameters are refined by the selected printer.

connect


Starts communication with the communication box.

Syntax

 
- (int)connect: (NSString *)target timeout:(long)timeout  myId:(NSString *)myId;

Parameter

target

Specifies the method of connecting to the printer by a character string.

Specify the connection method using the following syntax.

<connection type>:<identifier>[<box ID>]

I/F

Connection type

Identifier

Example

Wi-Fi/Ethernet

  • "TCP"
  • "TCPS"
  • IP address in IPv4 format
  • MAC address
  • Host name
 
"TCP:192.168.192.168[Box1]"

To connect to the printer via SSL/TLS communication, specify TCPS in the connection type.

timeout

Specifies the maximum time (in milliseconds) to wait for communication with the printer to be established.

Value

Description

Integer from 1000 to 300000

Maximum wait time before an error is returned (in milliseconds).

EPOS2_PARAM_DEFAULT

Specifies the default value (15000).

myId

Specifies a member ID to identify the application itself in the communication box.

Return value

Error status

Description

EPOS2_SUCCESS

The function was executed successfully.

EPOS2_ERR_PARAM

An invalid parameter was passed.

EPOS2_ERR_CONNECT

Could not open the device.

EPOS2_ERR_TIMEOUT

Failed to communicate with the devices within the specified time.

EPOS2_ERR_MEMORY

Memory necessary for processing could not be allocated.

EPOS2_ERR_FAILURE

An unknown error occurred.

EPOS2_ERR_PROCESSING

Could not run the process.

EPOS2_ERR_ALREADY_OPENED

Communication box is already open.

EPOS2_ERR_ALREADY_USED

Specified member ID is already in use.

EPOS2_ERR_BOX_COUNT_OVER

The number of created communication boxes has exceeded the upper limit.

EPOS2_ERR_BOX_CLIENT_OVER

The number of members belong to the communication box has exceeded the upper limit.

EPOS2_ERR_RECOVERY_FAILURE

Failed to recover the printer.

Supplementary explanation

  • This API will succeed regardless of the connection status of the TM printer (master) and peripheral devices.
  • Devices other than printers are exclusively locked.
  • When EPOS2_ERR_RECOVERY_FAILURE is returned in the return value, restart 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

Jump to the top