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

Select your printer model

Parameters are refined by the selected printer.

connect

Starts communication with the printer.

Syntax

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

Parameter

target

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

The connection method varies according to the system configuration.

  • TM Printer Models

  • <connection type>:<identifier>

    I/F

    Connection type

    Identifier

    Example

    Wi-Fi/Ethernet

    "TCP"
    • IP address in IPv4 format
    • MAC address
    • Printer host name
    		 
     
    		 
    "TCP:192.168.192.168"

    Bluetooth

    "BT"

    BD address

    		 
     
    		 
    "BT:00:22:15:7D:70:9C"

    USB

    "USB"
    • USB Serial number
    • Omitted
    		 
     
    		 
    "USB:000000000000000000"
"USB:"

    Bluetooth Low Energy

    "BLE"

    Bluetooth Low Energy BD address

    		 
     
    		 
    "BLE:00:22:15:7D:70:9C"

  • Customer Display Models

  • <connection type>:<identifier>

    I/F

    Connection type

    Identifier

    Example

    Wi-Fi/Ethernet

    "TCP"
    • IP address in IPv4 format
    • MAC address
    • Printer host name
    		 
     
    		 
    "TCP:192.168.192.168"

    Bluetooth

    "BT"

    BD address

    		 
     
    		 
    "BT:00:22:15:7D:70:9C"

    USB

    "USB"
    • USB Serial number
    • Omitted
    		 
     
    		 
    "USB:000000000000000000"
"USB:"

    To connect to the printer via SSL/TLS communication, specify using the following syntax.

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

    I/F

    Connection type

    Identifier

    Example

    Wi-Fi/Ethernet

    "TCPS"
    • IP address in IPv4 format
    • MAC address
    • Printer host name
    		 
     
    		 
    "TCPS:192.168.192.168[local_printer]"

  • TM Printer + DM-D + barcode scanner model/
    TM Printer + barcode scanner model

  • To connect via Wi-Fi/Ethernet network communication, specify using the following syntax.

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

    I/F

    Connection type

    Identifier

    Example

    Wi-Fi/Ethernet

    "TCP"
    • IP address in IPv4 format
    • MAC address
    • Printer host name
    		 
     
    		 
    "TCP:192.168.192.168[local_printer]"

    The device ID is fixed as [local_printer].

    To connect via Bluetooth or USB, specify using the following syntax.

    <connection type>:<identifier>

    I/F

    Connection type

    Identifier

    Example

    Bluetooth

    "BT"

    BD address

    		 
     
    		 
    "BT:00:22:15:7D:70:9C"

    USB

    "USB"
    • USB Serial number
    • Omitted
    		 
     
    		 
    "USB:000000000000000000"
"USB:"

  • POS Terminal Model

  • <connection type>:<identifier>[<device ID>]

    I/F

    Connection type

    Identifier

    Example

    Wi-Fi/Ethernet
    • "TCP"
    • "TCPS"
    • IP address in IPv4 format
    • MAC address
    • Printer host name
    		 
     
    		 
    "TCP:192.168.192.168[local_printer]"

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

Return value

The result of the API is returned.

Error status

Description

EPOS2_SUCCESS

The function was executed successfully.

EPOS2_ERR_PARAM

An invalid parameter was passed.

EPOS2_ERR_CONNECT

Failed to open the device.

EPOS2_ERR_TIMEOUT

Failed to communicate with the devices within the specified time.

EPOS2_ERR_ILLEGAL

Tried to start communication with a printer with which communication had been already established.

Tried to start communication with a printer during reconnection process.

EPOS2_ERR_MEMORY

Necessary memory could not be allocated.

EPOS2_ERR_FAILURE

An unknown error occurred.

EPOS2_ERR_PROCESSING

Could not run the process.

EPOS2_ERR_NOT_FOUND

The printer could not be found.

EPOS2_ERR_IN_USE

The device was in use.

EPOS2_ERR_TYPE_INVALID

The device type is different.

EPOS2_ERR_RECOVERY_FAILURE

Failed to recover the printer.

Supplementary explanation

  • This API is not executed on the main thread. Execute it on the sub-thread.
  • When communication with the printer is no longer necessary, be sure to call disconnect to terminate it.
  • When using multi-threading to connect to multiple printers or peripheral devices, this API and disconnect cannot be started for other printers or peripheral devices until this API finishes processing. Start the next process after this API finishes processing.
  • The printer status is returned to the event registered with the Epos2Printer class.
    For details, refer to Chapter 2 "Programming Flow" and Chapter 6 "To use the same printer from multiple mobile devices."Epson ePOS SDK for iOS ユーザーズマニュアル
  • The device ID is an arbitrary character string that is set when the peripheral device is registered to the TM printer (master).
    For details, refer to the Technical Reference Guide of each printer.
  • If you are using DHCP to assign the IP address of the printer, specify the MAC address or host name of the printer as the identifier.
  • For TM-DT series, MAC address cannot be specified.
  • If you specify the host name of the printer as the identifier, use in the environment where it can be found by the DNS server.
  • When connecting with the printer using Bluetooth, complete pairing before calling the connect command.
  • Depending on the project settings, Bluetooth communication may be disconnected if the application runs in the background.
  • If the identifier is omitted in the USB connection, the OS connects with the USB device found first.
  • If Bluetooth and USB are used simultaneously, priority is given to the USB.
  • 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.
  • Since it takes time to send and receive a large amount of data with BLE connection, the following APIs cannot be used.
    addImage/verifyPassword/getPrinterSettingEx/setPrinterSettingEx/setPrinterSettingEx[Obsolete]/downloadFirmwareList/getPrinterFirmwareInfo/verifyUpdate/updateFirmware
 

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

Jump to the top