Skip to main content

Intraface: FilterOption

In order to filter the search result, set the filter option, specify it in the parameter of PrintersDiscovery start method.

The following filter options supported:

portType​

  • Optional portType: DiscoveryFilterOption.PORTTYPE_ALL | DiscoveryFilterOption.PORTTYPE_TCP | DiscoveryFilterOption.PORTTYPE_BLUETOOTH | DiscoveryFilterOption.PORTTYPE_USB | DiscoveryFilterOption.PORTTYPE_BLUETOOTH_LE

Selects the port to search.

ValueDescription
PORTTYPE_ALL (default)Search for all devices which can be connected via TCP, Bluetooth, USB or BLE.
PORTTYPE_TCPSearch for devices connected to the network.
PORTTYPE_BLUETOOTHSearch for devices which can be connected via Blue- tooth.
PORTTYPE_USBSearch for devices which can be connected via USB.
PORTTYPE_BLUETOOTH_LESearch for devices that can be connected via Bluetooth Low Energy. (iOS only)

broadcast​

  • Optional broadcast: string

Specify a Broadcast Address for TCP search as a string.

ValueDescription
"255.255.255.255" (default)-

deviceModel​

  • Optional deviceModel: DiscoveryFilterOption.MODEL_ALL
ValueDescription
MODEL_ALLSearch for all models.

epsonFilter (Android only)​

  • Optional epsonFilter: DiscoveryFilterOption.FILTER_NAME | DiscoveryFilterOption.FILTER_NONE

Filters the search result by the Epson printers. Search can be performed for printers connected via Bluetooth or USB.

ValueDescription
FILTER_NAME(default)Filters the search result by the Epson printers.
FILTER_NONEDoes not filter the search result.

deviceType​

  • Optional deviceType: DiscoveryFilterOption.TYPE_ALL | DiscoveryFilterOption.TYPE_PRINTER | DiscoveryFilterOption.TYPE_HYBRID_PRINTER | DiscoveryFilterOption.TYPE_DISPLAY | DiscoveryFilterOption.TYPE_KEYBOARD | DiscoveryFilterOption.TYPE_SCANNER | DiscoveryFilterOption.TYPE_SERIAL | DiscoveryFilterOption.TYPE_POS_KEYBOARD | DiscoveryFilterOption.TYPE_MSR | DiscoveryFilterOption.TYPE_GFE | DiscoveryFilterOption.TYPE_OTHER_PERIPHERAL

Specifies the device type to search for.

The device type settings other than "TYPE_ALL" can be used for the following systems connected using Wi-Fi or Ethernet.

  • Customer Display Models (SSL/TLS communication only)
  • TM Printer + DM-D + barcode scanner model
  • TM Printer + barcode scanner model
  • POS Terminal Model
ValueDescription
TYPE_ALL (default)Search for all devices.
TYPE_PRINTERSearch for printers.
TYPE_HYBRID_PRINTERSearches for hybrid model printers.
TYPE_DISPLAYSearch for customer displays.
TYPE_KEYBOARDSearch for keyboards.
TYPE_SCANNERSearch for barcode scanners.
TYPE_SERIALSearch for serial communication devices.
TYPE_POS_KEYBOARDSearch for the POS keyboard.
TYPE_MSRSearch for the MSR.
TYPE_GFESearch for the German fiscal element (TSE).
TYPE_OTHER_PERIPHERALSearch for other peripheral devices.

bondedDevices (Android only)​

  • Optional bondedDevices: DiscoveryFilterOption.TRUE | DiscoveryFilterOption.FALSE

Specifies the search target when searching for a device that can be connected via Bluetooth.

ValueDescription
TRUESearch for devices that can be connected, and devices that were previously connected.
FALSE (default)Search for devices that can be connected.

usbDeviceName (Android only)​

  • Optional usbDeviceName: DiscoveryFilterOption.TRUE | DiscoveryFilterOption.FALSE

Specifies whether to search USB devices by their names or not.

ValueDescription
TRUESearch for USB compatible devices by their name.
FALSE (default)Does not search for USB compatible devices by their name.